interface VerifyHandlerInterface (View source)

Define how MFA Methods will initiate and check verification attempts.

Methods

public
array
start(StoreInterface $store, MFARegisteredMethod $method)

Stores any data required to handle a login process with a method, and returns relevant state to be applied to the front-end application managing the process.

public
verify(SS_HTTPRequest $request, StoreInterface $store, MFARegisteredMethod $registeredMethod)

Verify the request has provided the right information to verify the member that aligns with any sessions state that may have been set prior

public
string
getComponent()

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

Details

array start(StoreInterface $store, MFARegisteredMethod $method)

Stores any data required to handle a login process with a method, and returns relevant state to be applied to the front-end application managing the process.

Parameters

StoreInterface $store

An object that hold session data (and the Member) that can be mutated

MFARegisteredMethod $method

The RegisteredMethod instance that is being verified

Return Value

array

Props to be passed to a front-end component

Result verify(SS_HTTPRequest $request, StoreInterface $store, MFARegisteredMethod $registeredMethod)

Verify the request has provided the right information to verify the member that aligns with any sessions state that may have been set prior

Parameters

SS_HTTPRequest $request
StoreInterface $store
MFARegisteredMethod $registeredMethod

The RegisteredMethod instance that is being verified

Return Value

Result

string getComponent()

Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)

Return Value

string