class Key extends TwoFactorPlugin

Hardware key based two-factor authentication

Supports FIDO U2F tokens

Properties

static string $id
static $showSubmit Whether to show submit button in form from TwoFactorPlugin
protected TwoFactor $_twofactor from TwoFactorPlugin
protected boolean $_provided from TwoFactorPlugin
protected string $_message from TwoFactorPlugin
Template $template from TwoFactorPlugin

Methods

__construct(TwoFactor $twofactor)

Creates object

string
getError()

Returns authentication error message

boolean
check()

Checks authentication, returns true on success

string
render()

Renders user interface to enter two-factor authentication

string
setup()

Renders user interface to configure two-factor authentication

boolean
configure()

Performs backend configuration

static string
getName()

Get user visible name

static string
getDescription()

Get user visible description

string
getAppId(boolean $return_url)

Return an applicaiton ID

array
getRegistrations()

Returns array of U2F registration objects

void
loadScripts()

Loads needed javascripts into the page

Details

at line 42
__construct(TwoFactor $twofactor)

Creates object

Parameters

TwoFactor $twofactor TwoFactor instance

in TwoFactorPlugin at line 76
string getError()

Returns authentication error message

Return Value

string

at line 75
boolean check()

Checks authentication, returns true on success

Return Value

boolean

at line 119
string render()

Renders user interface to enter two-factor authentication

Return Value

string HTML code

at line 143
string setup()

Renders user interface to configure two-factor authentication

Return Value

string HTML code

Exceptions

U2FException
Throwable
Twig_Error_Loader
Twig_Error_Runtime
Twig_Error_Syntax

at line 164
boolean configure()

Performs backend configuration

Return Value

boolean

at line 198
static string getName()

Get user visible name

Return Value

string

at line 208
static string getDescription()

Get user visible description

Return Value

string

in TwoFactorPlugin at line 160
string getAppId(boolean $return_url)

Return an applicaiton ID

Either hostname or hostname with scheme.

Parameters

boolean $return_url Whether to generate URL

Return Value

string

at line 55
array getRegistrations()

Returns array of U2F registration objects

Return Value

array

at line 106
void loadScripts()

Loads needed javascripts into the page

Return Value

void