SilverStripe\WebAuthn\RegisterHandler
Synopsis
class RegisterHandler
implements
RegisterHandlerInterface
{
- // members
- private static string $user_help_link = 'https://userhelp.silverstripe.org/en/4/optional_features/multi-factor_authentication/user_manual/using_security_keys/';
- private static string $authenticator_attachment = AuthenticatorSelectionCriteria::AUTHENTICATOR_ATTACHMENT_CROSS_PLATFORM;
- private static array $dependencies = ;
- protected LoggerInterface $logger = NULL;
- // methods
- public RegisterHandler setLogger()
- public array start()
- public Result register()
- protected AuthenticatorAttestationResponseValidator getAuthenticatorAttestationResponseValidator()
- public string getDescription()
- public string getSupportLink()
- public string getSupportText()
- public string getComponent()
- protected PublicKeyCredentialRpEntity getRelyingPartyEntity()
- protected PublicKeyCredentialCreationOptions getCredentialCreationOptions()
- protected AuthenticatorSelectionCriteria getAuthenticatorSelectionCriteria()
- // Inherited methods from BaseHandlerTrait
- protected Decoder getDecoder()
- protected AttestationStatementSupportManager getAttestationStatementSupportManager()
- protected AttestationObjectLoader getAttestationObjectLoader()
- protected PublicKeyCredentialLoader getPublicKeyCredentialLoader()
- // Inherited methods from CredentialRepositoryProviderTrait
- protected CredentialRepository getCredentialRepository()
- protected PublicKeyCredentialUserEntity getUserEntity()
Hierarchy
Uses
- SilverStripe\WebAuthn\BaseHandlerTrait
- SilverStripe\Core\Extensible
- SilverStripe\Core\Config\Configurable
- SilverStripe\WebAuthn\CredentialRepositoryProviderTrait
Implements
- SilverStripe\MFA\Method\Handler\RegisterHandlerInterface
Members
private
- $authenticator_attachment
—
string
The default attachment mode to use for Authentication Selection Criteria. - $dependencies
—
array
Dependency injection configuration - $user_help_link
—
string
Provide a user help link that will be available when registering backup codes
protected
- $logger — Psr\Log\LoggerInterface
Methods
protected
- getAuthenticatorAttestationResponseValidator()
- getAuthenticatorSelectionCriteria() — Returns an "Authenticator Selection Criteria" object which is intended to select the appropriate authenticators to participate in the creation operation.
- getCredentialCreationOptions()
- getRelyingPartyEntity()
public
- getComponent() — Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)
- getDescription() — Provide a localised description of this MFA Method.
- getSupportLink() — Provide a localised URL to a support article about the registration process for this MFA Method.
- getSupportText() — Provide a localised string to describe the support link {@see getSupportLink} about this MFA Method.
- register() — Confirm that the provided details are valid, and create a new RegisteredMethod against the member.
- setLogger() — Sets the {@see $logger} member variable
- start() — Stores any data required to handle a registration process with a method, and returns relevant state to be applied to the front-end application managing the process.
Inherited from SilverStripe\WebAuthn\BaseHandlerTrait
protected
- getAttestationObjectLoader()
- getAttestationStatementSupportManager()
- getDecoder()
- getPublicKeyCredentialLoader()