Class SimpleID\Auth\OTPAuthSchemeModule

`extends`	`AuthSchemeModule`

An authentication scheme module that provides two-factor authentication based on a RFC 6238 Time-Based One-Time Password (TOTP).

Prefab
- SimpleID\Module
  - SimpleID\Auth\AuthSchemeModule
    - SimpleID\Auth\OTPAuthSchemeModule

Located at core/Auth/OTPAuthSchemeModule.php

Methods


					
	public
					static

init($f3)


					
	public

setup(): void

Displays the page used to set up login verification using one-time passwords.


					
	public

onDashboardBlocks(UIBuildEvent $event): void

Returns the dashboard OTP block.

Parameters

$event

the event to collect the dashboard OTP block


					
	public

onLoginFormBuild(FormBuildEvent $event): void


					
	public

onLoginFormValidate(FormSubmitEvent $event): void


					
	public

onLoginFormSubmit(LoginFormSubmitEvent $event): void


					
	public

onLoginEvent(LoginEvent $event): void


					
	protected

verifyOTP(array<string, mixed> &$params, string $code, int $max_drift = 1): bool

Verifies a one time password (OTP) specified by the user.

This function compares an OTP supplied by a user with the OTP calculated based on the current time and the parameters of the algorithm. The parameters, such as the secret key, are supplied using in $params. These parameters are typically stored for each user in the user store.

To allow for clocks going out of sync, the current time will be by a number (in time steps) specified in $params['drift']. If the OTP supplied by the user is accepted, $params['drift'] will be also be updated with the latest difference.

To allow for network delay, the function will accepts OTPs which is a number of time steps away from the OTP calculated from the adjusted time. The maximum number of time steps is specified in the $max_drift parameter.

Parameters

`$params`	the OTP parameters stored
`$code`	the OTP supplied by the user
`$max_drift`	the maximum drift allowed for network delay, in time steps

Returns

whether the OTP supplied matches the OTP generated based on the specified parameters, within the maximum drift


					
	public

totp(
	string $secret,
	int $time = null,
	int $period = 30,
	int $drift = 0,
	string $algorithm = 'sha1',
	int $digits = 6,
): int

Calculates a Time-Based One-Time Password (TOTP) based on RFC 6238.

This function returns an integer calculated from the TOTP algorithm. The returned integer may need to be zero-padded to return a string with the required number of digits

Parameters

`$secret`	the shared secret as a binary string
`$time`	the time to use in the HOTP algorithm. If NULL, the current time is used
`$period`	the time step in seconds
`$drift`	the number of time steps to be added to the time to adjust for transmission delay
`$algorithm`	the hashing algorithm as supported by the hash_hmac() function
`$digits`	the number of digits in the one-time password

Returns

the one-time password


					
	public

hotp(string $secret, string $data, string $algorithm = 'sha1', int $digits = 6): int

Calculates a HMAC-Based One-Time Password (HOTP) based on RFC 4226.

This function returns an integer calculated from the HOTP algorithm. The returned integer may need to be zero-padded to return a string with the required number of digits

Parameters

`$secret`	the shared secret as a binary string
`$data`	the counter value as a 64 bit in big endian encoding
`$algorithm`	the hashing algorithm as supported by the hash_hmac() function
`$digits`	the number of digits in the one-time password

Returns

the one-time password


					
	public

onUserSecretDataPaths(BaseDataCollectionEvent $event): void

Methods inherited from SimpleID\Auth\AuthSchemeModule
`__construct()`

Methods inherited from SimpleID\Module
`beforeroute(), isHttps(), checkHttps(), getCanonicalURL(), getCanonicalHost(), getOrigin(), fatalError(), secureCompare()`

Properties inherited from SimpleID\Auth\AuthSchemeModule
`$auth, $mgr`

Properties inherited from SimpleID\Module
`$f3, $logger`

Namespaces

Classes

Interfaces

Traits

Class SimpleID\Auth\OTPAuthSchemeModule

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns