GoogleAuthenticator class - Documentation for SproutCMS

Info Page:

Page options:

class GoogleAuthenticator

File: /sprout/Helpers/TwoFactor/GoogleAuthenticator.php
Namespace: Sprout\Helpers\TwoFactor

Variables

Name	Visibility	Description
`$PASS_CODE_LENGTH`	(static)
`$SECRET_LENGTH`	(static)

Functions

Name	Visibility	Description
checkCode	public	Check a given code against a given secret
generateSecret	public	Generate a secret key and encode as base32
getCode	protected	Calculate what the code for a given secret/time should be
getQRData	public	For a given set of details, return the otpauth:// url for use in a QR code
getQRImageUrl	public	Return a Google Charts url which generates a QR code image from some QR code data

public checkCode

bool $GoogleAuthenticator->checkCode ( string $secret , string $code );

Check a given code against a given secret

Does the check three times, for current time, one period before, and one period after
This is to allow for clock drift

public generateSecret

string $GoogleAuthenticator->generateSecret ( );

Generate a secret key and encode as base32

NOTE: Only cryptographically secure in PHP 7.0 onwards (uses "random_bytes" method)
On earlier versions of PHP this method isn't available so rand() is used instead

protected getCode

string $GoogleAuthenticator->getCode ( string $secret , int $time );

Calculate what the code for a given secret/time should be

public getQRData

string $GoogleAuthenticator->getQRData ( string $issuer , string $user , string $host , string $secret );

For a given set of details, return the otpauth:// url for use in a QR code

public getQRImageUrl

string $GoogleAuthenticator->getQRImageUrl ( string $qr_data );

Return a Google Charts url which generates a QR code image from some QR code data

SproutCMS

Search documentation