LimeSurvey API - Master branch
Back to top  

TwoFactorAuth

package

Default

Methods

__construct

__construct( $issuer = null, $digits = 6, $period = 30, $algorithm = 'sha1',\RobThree\Auth\Providers\Qr\IQRCodeProvider $qrcodeprovider = null,\RobThree\Auth\Providers\Rng\IRNGProvider $rngprovider = null,\RobThree\Auth\Providers\Time\ITimeProvider $timeprovider = null)

Arguments

$issuer

$digits

$period

$algorithm

$qrcodeprovider

\RobThree\Auth\Providers\Qr\IQRCodeProvider

$rngprovider

\RobThree\Auth\Providers\Rng\IRNGProvider

$timeprovider

\RobThree\Auth\Providers\Time\ITimeProvider

base32Decode

base32Decode( $value)

Arguments

$value

Timing-attack safe comparison of 2 codes (see http://blog.ircmaxell.com/2014/11/its-all-about-time.html)

codeEquals( $safe, $user)

Arguments

$safe

$user

Create a new secret

createSecret( $bits = 80, $requirecryptosecure = true)

Arguments

$bits

$requirecryptosecure

Compare default timeprovider with specified timeproviders and ensure the time is within the specified number of seconds (leniency)

ensureCorrectTime(array $timeproviders = null, $leniency = 5)

Arguments

$timeproviders

array

$leniency

Calculate the code with given secret and point in time

getCode( $secret, $time = null)

Arguments

$secret

$time

Get data-uri of QRCode

getQRCodeImageAsDataUri( $label, $secret, $size = 200)

Arguments

$label

$secret

$size

getQrCodeProvider

getQrCodeProvider(): \RobThree\Auth\Providers\Qr\IQRCodeProvider
Throws
\RobThree\Auth\TwoFactorAuthException

Response

\RobThree\Auth\Providers\Qr\IQRCodeProvider

Builds a string to be encoded in a QR code

getQRText( $label, $secret)

Arguments

$label

$secret

getRngprovider

getRngprovider(): \RobThree\Auth\Providers\Rng\IRNGProvider
Throws
\RobThree\Auth\TwoFactorAuthException

Response

\RobThree\Auth\Providers\Rng\IRNGProvider

getTime

getTime( $time)

Arguments

$time

getTimeProvider

getTimeProvider(): \RobThree\Auth\Providers\Time\ITimeProvider
Throws
\RobThree\Auth\TwoFactorAuthException

Response

\RobThree\Auth\Providers\Time\ITimeProvider

getTimeSlice

getTimeSlice( $time = null, $offset)

Arguments

$time

$offset

Check if the code is correct. This will accept codes starting from ($discrepancy * $period) sec ago to ($discrepancy * period) sec from now

verifyCode( $secret, $code, $discrepancy = 1, $time = null, &$timeslice)

Arguments

$secret

$code

$discrepancy

$time

$timeslice

Properties

algorithm

algorithm :

Type(s)

period

period :

Type(s)

digits

digits :

Type(s)

issuer

issuer :

Type(s)

qrcodeprovider

qrcodeprovider :

Type(s)

rngprovider

rngprovider :

Type(s)

timeprovider

timeprovider :

Type(s)

_base32dict

_base32dict :
static

Type(s)

_base32

_base32 :
static

Type(s)

_base32lookup

_base32lookup :
static

Type(s)

_supportedalgos

_supportedalgos :
static

Type(s)