php authenticator Download - php authenticator Quellcode Download

php authenticator

Andere Kategorien

5.2.1

Herunterladen

Chillerlan/Php-Authenticator

Ein Generator für Gegenbasis (RFC 4226) und zeitbasierte (RFC 6238) einmalige Kennwörter (OTP). (AKA noch eine Implementierung von Google Authenticator!)

Dokumentation

Anforderungen

PHP 8.2+
- ext-curl für die Zeitsynchronisation der Steam Guard-Serverzeit
- ext-sodium für konstante Zeitimplementierungen von Base64 codieren/decode und hex2bin/bin2hex ( paragonie/constant_time_encoding wird als Fallback verwendet)

Installation

Benötigt Komponist

über Terminal: composer require chillerlan/php-authenticator

Composer.json

{
	"require" : {
		"php" : " ^8.2 " ,
		"chillerlan/php-authenticator" : " dev-main "
	}
}

Hinweis: Ersetzen Sie dev-main durch eine Versionsbeschränkung, z ^5.0 - Siehe Veröffentlichungen für gültige Versionen

Profitieren!

Verwendung

Ein Geheimnis erstellen

Das Geheimnis wird normalerweise einmal während des Aktivierungsprozesses in einem Benutzer -Bedienfeld erstellt. Alles, was Sie dort tun müssen, müssen den Benutzer bequem angezeigt werden - zum Beispiel als Textzeichenfolge und QR -Code - und speichern sie irgendwo mit den Benutzerdaten.

 use chillerlan  Authenticator { Authenticator , AuthenticatorOptions };

$ options = new AuthenticatorOptions ;
$ options -> secret_length = 32 ;

$ authenticator = new Authenticator ( $ options );
// create a secret (stored somewhere in a *safe* place on the server. safe... hahaha jk)
$ secret = $ authenticator -> createSecret ();
// you can also specify the length of the secret key, which overrides the options setting
$ secret = $ authenticator -> createSecret ( 20 );
// set an existing secret
$ authenticator -> setSecret ( $ secret );

Ein mit Authenticator::createSecret() erstellter Geheimnis wird auch intern gespeichert, sodass Sie nicht das Geheimnis bereitstellen müssen, das Sie gerade bei Follow-up-Operationen mit der aktuellen Instanz erstellt haben.

Überprüfen Sie einen einmaligen Code

Während des Anmeldungsprozesses - nachdem der Benutzer seine Anmeldeinformationen erfolgreich eingegeben hat - würden Sie ihn nach einem einmaligen Code bitten, ihn gegen das Geheimnis aus Ihrer Benutzerdatenbank zu überprüfen.

 // verify the code
if ( $ authenticator -> verify ( $ otp )){
	// that's it - 2FA has never been easier! :D
}

zeitbasiert (TOTP)

Überprüfen Sie die benachbarten Codes

 // try the first adjacent
$ authenticator -> verify ( $ otp , time () - $ options -> period ); // -> true
// try the second adjacent, default is 1
$ authenticator -> verify ( $ otp , time () + 2 * $ options -> period ); // -> false
// allow 2 adjacent codes
$ options -> adjacent = 2 ;
$ authenticator -> verify ( $ otp , time () + 2 * $ options -> period ); // -> true

Gegenbasis (Hotp)

 // switch mode to HOTP
$ options -> mode = AuthenticatorInterface:: HOTP ;
// user sends the OTP for code #42, which is equivalent to
$ otp = $ authenticator -> code ( 42 ); // -> 123456
// verify [123456, 42]
$ authenticator -> verify ( $ otp , $ counterValueFromUserDatabase ) // -> true

URI -Kreation

Um einen QR -Code für einen mobilen Authentikator anzuzeigen, benötigen Sie eine otpauth:// URI, die mithilfe der folgenden Methode erstellt werden kann.

$label sollte etwas sein, das das Konto identifiziert, zu dem das Geheimnis gehört
$issuer ist beispielsweise der Name Ihrer Website oder Ihres Unternehmens, damit der Benutzer mehrere Konten identifizieren kann.

 $ uri = $ authenticator -> getUri ( $ label , $ issuer );

// -> otpauth://totp/my%20label?secret=NKSOQG7UKKID4IXW&issuer=chillerlan.net&digits=6&period=30&algorithm=SHA1

Notizen

Beachten Sie, dass mehrere URI -Einstellungen (noch) von allen Authentikatoren nicht (noch) erkannt werden. Weitere Informationen finden Sie im Google Authenticator Wiki.

 // code length, currently 6 or 8
$ options -> digits = 8 ;
// valid period between 15 and 60 seconds
$ options -> period = 45 ;
// set the HMAC hash algorithm
$ options -> algorithm = AuthenticatorInterface:: ALGO_SHA512 ;

API

`Authenticator`

Verfahren	zurückkehren	Beschreibung
`__construct(SettingsContainerInterface $options = null, string $secret = null)`	- -
`setOptions(SettingsContainerInterface $options)`	`Authenticator`	intern von `__construct()` angerufen
`setSecret(string $secret)`	`Authenticator`	intern von `__construct()` angerufen
`getSecret()`	`string`
`createSecret(int $length = null)`	`string`	`$length` überschreibt `AuthenticatorOptions` -Einstellung
`code(int $data = null)`	`string`	`$data` können ein Unix Timestamp (TOTP) oder ein Zählerwert (Hotp) sein
`verify(string $otp, int $data = null)`	`bool`	Für `$data` siehe `Authenticator::code()`
`getUri(string $label, string $issuer, int $hotpCounter = null, bool $omitSettings = null)`	`string`

`AuthenticatorOptions`

Eigenschaften

Eigentum	Typ	Standard	erlaubt	Beschreibung
`$digits`	`int`	6	6 oder 8	Auth -Code -Länge
`$period`	`int`	30	15 - 60	Validierungszeit (Sekunden)
`$secret_length`	`int`	20	> = 16	Länge der geheimen Phrase (Bytes, uneingeschränkter binär)
`$algorithm`	`string`	`SHA1`	`SHA1` , `SHA256` oder `SHA512`	HMAC -Hash -Algorithmus, siehe `AuthenticatorInterface::HASH_ALGOS`
`$mode`	`string`	`totp`	`totp` , `hotp` , `battlenet` oder `steam`	Authenticator-Modus: Zeit- oder Gegenbasis, siehe `AuthenticatorInterface::MODES`
`$adjacent`	`int`	1	> = 0	Anzahl der erlaubten benachbarten Codes
`$time_offset`	`int`	0	*	fester Zeitversatz, der zum aktuellen Zeitwert hinzugefügt wird
`$useLocalTime`	`bool`	WAHR	*	Ob Sie die lokale Zeit verwenden oder die Serverzeit anfordern möchten
`$forceTimeRefresh`	`bool`	FALSCH	*	Unabhängig davon

`AuthenticatorInterface`

Methoden

Verfahren	zurückkehren	Beschreibung
`setOptions(SettingsContainerInterface $options)`	`AuthenticatorInterface`
`setSecret(string $encodedSecret)`	`AuthenticatorInterface`
`getSecret()`	`string`
`createSecret(int $length = null)`	`string`
`getServertime()`	`int`
`getCounter(int $data = null)`	`int`	intern
`getHMAC(int $counter)`	`string`	intern
`getCode(string $hmac)`	`int`	intern
`getOTP(int $code)`	`string`	intern
`code(int $data = null)`	`string`
`verify(string $otp, int $data = null)`	`bool`

Konstanten

Konstante	Typ	Beschreibung
`TOTP`	`string`
`HOTP`	`string`
`STEAM_GUARD`	`string`
`ALGO_SHA1`	`string`
`ALGO_SHA256`	`string`
`ALGO_SHA512`	`string`
`MODES`	`array`	Karte des Modus -> Klassenname
`HASH_ALGOS`	`array`	Liste der verfügbaren Hash -Algorithmen