1
1
# PHP Oath Server Suite
2
2
3
- [ ![ Build Status] ( https://travis-ci.org/markenwerk /php-oath-server-suite.svg?branch=master )] ( https://travis-ci.org/markenwerk /php-oath-server-suite )
4
- [ ![ Test Coverage] ( https://codeclimate.com/github/markenwerk /php-oath-server-suite/badges/coverage.svg )] ( https://codeclimate.com/github/markenwerk /php-oath-server-suite/coverage )
3
+ [ ![ Build Status] ( https://travis-ci.org/chroma-x /php-oath-server-suite.svg?branch=master )] ( https://travis-ci.org/chroma-x /php-oath-server-suite )
4
+ [ ![ Test Coverage] ( https://codeclimate.com/github/chroma-x /php-oath-server-suite/badges/coverage.svg )] ( https://codeclimate.com/github/chroma-x /php-oath-server-suite/coverage )
5
5
[ ![ Dependency Status] ( https://www.versioneye.com/user/projects/571f771cfcd19a0045442330/badge.svg )] ( https://www.versioneye.com/user/projects/571f771cfcd19a0045442330 )
6
6
[ ![ SensioLabs Insight] ( https://img.shields.io/sensiolabs/i/8f5a3440-ec20-448b-b459-057eecbc5d4a.svg )] ( https://insight.sensiolabs.com/projects/8f5a3440-ec20-448b-b459-057eecbc5d4a )
7
- [ ![ Code Climate] ( https://codeclimate.com/github/markenwerk /php-oath-server-suite/badges/gpa.svg )] ( https://codeclimate.com/github/markenwerk /php-oath-server-suite )
8
- [ ![ Latest Stable Version] ( https://poser.pugx.org/markenwerk /oath-server-suite/v/stable )] ( https://packagist.org/packages/markenwerk /oath-server-suite )
9
- [ ![ Total Downloads] ( https://poser.pugx.org/markenwerk /oath-server-suite/downloads )] ( https://packagist.org/packages/markenwerk /oath-server-suite )
10
- [ ![ License] ( https://poser.pugx.org/markenwerk /oath-server-suite/license )] ( https://packagist.org/packages/markenwerk /oath-server-suite )
7
+ [ ![ Code Climate] ( https://codeclimate.com/github/chroma-x /php-oath-server-suite/badges/gpa.svg )] ( https://codeclimate.com/github/chroma-x /php-oath-server-suite )
8
+ [ ![ Latest Stable Version] ( https://poser.pugx.org/chroma-x /oath-server-suite/v/stable )] ( https://packagist.org/packages/chroma-x /oath-server-suite )
9
+ [ ![ Total Downloads] ( https://poser.pugx.org/chroma-x /oath-server-suite/downloads )] ( https://packagist.org/packages/chroma-x /oath-server-suite )
10
+ [ ![ License] ( https://poser.pugx.org/chroma-x /oath-server-suite/license )] ( https://packagist.org/packages/chroma-x /oath-server-suite )
11
11
12
12
A collection of classes to provide second factor authentication like Yubico OTP (Yubikey), Oath (TOTP, HOTP, GoogleAuthenticator) server-side.
13
13
@@ -24,7 +24,7 @@ For more information about the Yubico OTP authentication mechanism read the „W
24
24
``` {json}
25
25
{
26
26
"require": {
27
- "markenwerk /oath-server-suite": "~4.0"
27
+ "chroma-x /oath-server-suite": "~4.0"
28
28
}
29
29
}
30
30
```
@@ -46,7 +46,7 @@ To use Yubico OTP you need YubiCloud access. You can get free API credentials fr
46
46
#### Validating a Yubico one time password
47
47
48
48
``` {php}
49
- use Markenwerk \CommonException\NetworkException\Base\NetworkException;
49
+ use ChromaX \CommonException\NetworkException\Base\NetworkException;
50
50
51
51
$otp = $_POST['otp'];
52
52
$userPublicId = 'fetchedFromDatabaseOrSimilar';
@@ -77,9 +77,9 @@ To allow authentication the client and server has to share a secret. Usually the
77
77
##### TOTP (Time-based One-time Password Algorithm)
78
78
79
79
``` {php}
80
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
81
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\TotpBase32SharedSecretUrlEncoder;
82
- use Markenwerk \QrCodeSuite\QrEncode\QrEncoder;
80
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
81
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\TotpBase32SharedSecretUrlEncoder;
82
+ use ChromaX \QrCodeSuite\QrEncode\QrEncoder;
83
83
84
84
// Initialize Oath URL encoder for TOTP (Time-based One-time Password Algorithm)
85
85
$contentEncoder = new TotpBase32SharedSecretUrlEncoder();
@@ -114,9 +114,9 @@ $sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');
114
114
##### HOTP (HMAC-based One-time Password Algorithm)
115
115
116
116
``` {php}
117
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
118
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\HotpBase32SharedSecretUrlEncoder;
119
- use Markenwerk \QrCodeSuite\QrEncode\QrEncoder;
117
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
118
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\HotpBase32SharedSecretUrlEncoder;
119
+ use ChromaX \QrCodeSuite\QrEncode\QrEncoder;
120
120
121
121
// Initialize Oath URL encoder for HOTP (HMAC-based One-time Password Algorithm)
122
122
$contentEncoder = new HotpBase32SharedSecretUrlEncoder();
@@ -190,9 +190,9 @@ if ($validator->isValid()) {
190
190
##### TOTP (Time-based One-time Password Algorithm)
191
191
192
192
``` {php}
193
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
194
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\TotpSharedSecretUrlEncoder;
195
- use Markenwerk \QrCodeSuite\QrEncode\QrEncoder;
193
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
194
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\TotpSharedSecretUrlEncoder;
195
+ use ChromaX \QrCodeSuite\QrEncode\QrEncoder;
196
196
197
197
// Initialize Oath URL encoder for TOTP (Time-based One-time Password Algorithm)
198
198
$contentEncoder = new TotpSharedSecretUrlEncoder();
@@ -227,9 +227,9 @@ $sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');
227
227
##### HOTP (HMAC-based One-time Password Algorithm)
228
228
229
229
``` {php}
230
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
231
- use Markenwerk \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\HotpSharedSecretUrlEncoder;
232
- use Markenwerk \QrCodeSuite\QrEncode\QrEncoder;
230
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretQrCodeProvider\SharedSecretQrCodeProvider;
231
+ use ChromaX \OathServerSuite\SecretSharing\SharedSecretUrlEncoder\HotpSharedSecretUrlEncoder;
232
+ use ChromaX \QrCodeSuite\QrEncode\QrEncoder;
233
233
234
234
// Initialize Oath URL encoder for HOTP (HMAC-based One-time Password Algorithm)
235
235
$contentEncoder = new HotpSharedSecretUrlEncoder();
@@ -299,14 +299,14 @@ if ($validator->isValid()) {
299
299
## Exception handling
300
300
301
301
PHP Oath Server Suite provides different exceptions – some provided by the PHP Common Exceptions project – for proper handling.
302
- You can find more information about [ PHP Common Exceptions at Github] ( https://github.com/markenwerk /php-common-exceptions ) .
302
+ You can find more information about [ PHP Common Exceptions at Github] ( https://github.com/chroma-x /php-common-exceptions ) .
303
303
304
304
---
305
305
306
306
## Contribution
307
307
308
308
Contributing to our projects is always very appreciated.
309
- ** But: please follow the contribution guidelines written down in the [ CONTRIBUTING.md] ( https://github.com/markenwerk /php-oath-server-suite/blob/master/CONTRIBUTING.md ) document.**
309
+ ** But: please follow the contribution guidelines written down in the [ CONTRIBUTING.md] ( https://github.com/chroma-x /php-oath-server-suite/blob/master/CONTRIBUTING.md ) document.**
310
310
311
311
## License
312
312
0 commit comments