PlatformTotpVerifierInterface
in
Table of Contents
Methods
- isAvailable() : bool
- Return true when production-grade TOTP verification is available.
- matchingCounter() : int|null
- Find the moving factor for the supplied code.
- verify() : bool
- Verify only the code; authentication callers must consume the counter.
Methods
isAvailable()
Return true when production-grade TOTP verification is available.
public
isAvailable() : bool
Return values
boolmatchingCounter()
Find the moving factor for the supplied code.
public
matchingCounter(string|null $totpSecretRef, string $totpCode) : int|null
Parameters
- $totpSecretRef : string|null
-
Secret-store reference for the user.
- $totpCode : string
-
User-provided TOTP code.
Return values
int|nullverify()
Verify only the code; authentication callers must consume the counter.
public
verify(string $platformUserId, string|null $totpSecretRef, string $totpCode) : bool
Parameters
- $platformUserId : string
- $totpSecretRef : string|null
- $totpCode : string