Class SimpleID\Auth\RecoveryCodeAuthSchemeModule

`extends`	`AuthSchemeModule`

An authentication scheme module that provides account recovery through recovery codes.

Prefab
- SimpleID\Module
  - SimpleID\Auth\AuthSchemeModule
    - SimpleID\Auth\RecoveryCodeAuthSchemeModule

Located at core/Auth/RecoveryCodeAuthSchemeModule.php

Methods


					
	public
					static

init($f3)


					
	public

setupRecoveryCodes(): void

Displays the page used to generate recovery codes.


					
	public

onDashboardBlocks(UIBuildEvent $event): void

Returns the dashboard recovery code block.

$event

the event to collect the dashboard recovery code block


					
	public

onLoginFormBuild(FormBuildEvent $event): void


					
	public

onLoginFormValidate(FormSubmitEvent $event): void


					
	public

onLoginFormSubmit(LoginFormSubmitEvent $event): void


					
	protected

encodeRecoveryCode(string $code): string

Hashes and encodes a recovery code using PBKDF2.

$code

the recovery code

the encoded hash value


					
	protected

verifyRecoveryCode(string $code, string $encoded): bool

Verifies whether a specified recovery code matches the specified encode value.

`$code`	the recovery code to verify
`$encoded`	the encoded value

whether the recovery code supplied matches the specified encoded value


					
	public

onUserSecretDataPaths(BaseDataCollectionEvent $event): void

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

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`