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 bool $_provided from TwoFactorPlugin
protected string $_message from TwoFactorPlugin
Template $template from TwoFactorPlugin

Methods

__construct(TwoFactor $twofactor)

Creates object

string
getError()

Returns authentication error message

bool
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

bool
configure()

Performs backend configuration

static string
getName()

Get user visible name

static string
getDescription()

Get user visible description

string
getAppId(bool $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 37
__construct(TwoFactor $twofactor)

Creates object

Parameters

TwoFactor $twofactor TwoFactor instance

in TwoFactorPlugin at line 63
string getError()

Returns authentication error message

Return Value

string

at line 70
bool check()

Checks authentication, returns true on success

Return Value

bool

at line 114
string render()

Renders user interface to enter two-factor authentication

Return Value

string HTML code

at line 139
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 160
bool configure()

Performs backend configuration

Return Value

bool

at line 194
static string getName()

Get user visible name

Return Value

string

at line 204
static string getDescription()

Get user visible description

Return Value

string

in TwoFactorPlugin at line 147
string getAppId(bool $return_url)

Return an applicaiton ID

Either hostname or hostname with scheme.

Parameters

bool $return_url Whether to generate URL

Return Value

string

at line 50
array getRegistrations()

Returns array of U2F registration objects

Return Value

array

at line 101
void loadScripts()

Loads needed javascripts into the page

Return Value

void