factor_token\factor Class Reference

Inheritance diagram for factor_token\factor:

Public Member Functions
	calculate_expiry_time ($basetime=null)
	Calculate the expiry time of the token, based on configuration.
	check_combination (array $combination)
	Checks whether the factor combination is valid based on factor behaviour.
	create_event_after_factor_setup (object $user)
	Creates an event when user successfully setup a factor.
	delete_factor_for_user (stdClass $user)
	Deletes all instances of factor for a user.
	get_active_user_factors (stdClass $user)
	Returns an array of active user factor records.
	get_all_user_factors (stdClass $user)
	Token implementation.
	get_display_name ()
	Returns factor name from language string.
	get_icon ()
	Get the icon associated with this factor.
	get_info ()
	Returns factor help from language string.
	get_label (int $factorid)
	Function to retrieve the label for a factorid.
	get_lastverified (int $factorid)
	Gets lastverified timestamp.
	get_login_desc ()
	Get the login description associated with this factor.
	get_manage_info (int $factorid)
	Returns factor help from language string when there is factor management available.
	get_manage_string ()
	Gets the string for manage button on preferences page.
	get_no_redirect_urls ()
	Function to get urls that should not be redirected from.
	get_remaining_attempts ()
	Return the number of remaining attempts at this factor.
	get_setup_string ()
	Gets the string for setup button on preferences page.
	get_state ()
	Token implementation.
	get_summary_condition ()
	Returns condition for passing factor.
	get_weight ()
	Returns configured factor weight.
	global_definition (\MoodleQuickForm $mform)
	Hook point for global auth form action hooks.
	global_definition_after_data ($mform)
	Token implementation.
	global_definition_after_data (\MoodleQuickForm $mform)
	Hook point for global auth form action hooks.
	global_submit ($data)
	Token implementation.
	global_submit (object $data)
	Hook point for global auth form action hooks.
	global_validation (array $data, array $files)
	Hook point for global auth form action hooks.
	has_input ()
	Token implementation.
	has_replace ()
	Returns true if factor class has factor records that can be replaced.
	has_revoke ()
	Returns true if factor class has factor records that might be revoked.
	has_setup ()
	Returns true if factor needs to be setup by user and has setup_form.
	increment_lock_counter ()
	Increments the lock counter for a factor.
	is_enabled ()
	Returns true if factor is enabled, otherwise false.
	is_lockable ()
	Returns true if a factor is able to be locked if it fails.
	load_locked_state ()
	This loads the locked state from the DB Base class implementation.
	login_form_definition (\MoodleQuickForm $mform)
	Defines login form definition page for particular factor.
	login_form_definition_after_data (\MoodleQuickForm $mform)
	Defines login form definition page after form data has been set.
	login_form_validation (array $data)
	Implements login form validation for particular factor.
	possible_states (stdClass $user)
	Token implementation.
	post_pass_state ()
	Token implementation.
	process_cancel_action ()
	Process a cancel input from a user.
	replace_user_factor (stdClass $data, int $id)
	Replaces a given factor and adds it to user's active factors list.
	revoke_user_factor (?int $factorid=null)
	Marks factor record as revoked.
	set_state ($state)
	Token Implementation.
	set_state (string $state)
	Sets the state of the factor into the session.
	setup_factor_form_definition (\MoodleQuickForm $mform)
	Defines setup_factor form definition page for particular factor.
	setup_factor_form_definition_after_data (\MoodleQuickForm $mform)
	Defines setup_factor form definition page after form data has been set.
	setup_factor_form_is_cancelled (int $factorid)
	Setups in given factor when the form is cancelled.
	setup_factor_form_submit_button_string ()
	Setup submit button string in given factor.
	setup_factor_form_validation (array $data)
	Implements setup_factor form validation for particular factor.
	setup_user_factor (stdClass $data)
	Setups given factor and adds it to user's active factors list.
	show_setup_buttons ()
	If has_setup returns true, decides if the setup buttons should be shown on the preferences page.
	update_lastverified (?int $factorid=null)
	When validation code is correct - update lastverified field for given factor.

Public Attributes
string	$name
	Factor name.

Protected Attributes
string	$icon = 'fa-lock'
	Factor icon.
tool_mfa local secret_manager	$secretmanager
	Secret manager.

Member Function Documentation

calculate_expiry_time()

factor_token\factor::calculate_expiry_time

(

$basetime = null

)

Calculate the expiry time of the token, based on configuration.

Parameters

integer | null

$basetime

time to use for calcalations.

Return values

array

check_combination()

tool_mfa\local\factor\object_factor_base::check_combination ( array $combination )

inherited

Checks whether the factor combination is valid based on factor behaviour.

E.g. a combination with nosetup and another factor is not valid, as you cannot pass nosetup with another factor.

Parameters

array

$combination

array of factors that make up the combination

Return values

bool

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_grace\factor, and factor_nosetup\factor.

create_event_after_factor_setup()

tool_mfa\local\factor\object_factor_base::create_event_after_factor_setup ( object $user )

inherited

Creates an event when user successfully setup a factor.

Parameters

object

$user

Return values

void

delete_factor_for_user()

tool_mfa\local\factor\object_factor_base::delete_factor_for_user ( stdClass $user )

inherited

Deletes all instances of factor for a user.

Parameters

stdClass

$user

the user to delete for.

Return values

void

Implements tool_mfa\local\factor\object_factor.

get_active_user_factors()

tool_mfa\local\factor\object_factor_base::get_active_user_factors ( stdClass $user )

inherited

Returns an array of active user factor records.

Filters get_all_user_factors() output.

Parameters

stdClass

$user

object to check against.

Return values

array

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_grace\factor.

get_all_user_factors()

factor_token\factor::get_all_user_factors

(

stdClass

$user

)

Token implementation.

This factor is a singleton, return single instance.

Parameters

stdClass

$user

the user to check against.

Return values

array

Reimplemented from tool_mfa\local\factor\object_factor_base.

get_display_name()

tool_mfa\local\factor\object_factor_base::get_display_name ( )

inherited

Returns factor name from language string.

Base class implementation.

Return values

string

Exceptions

coding_exception

Implements tool_mfa\local\factor\object_factor.

Reimplemented in tool_mfa\local\factor\fallback.

get_icon()

tool_mfa\local\factor\object_factor_base::get_icon ( )

inherited

Get the icon associated with this factor.

Return values

string

the icon name.

get_info()

tool_mfa\local\factor\object_factor_base::get_info ( )

inherited

Returns factor help from language string.

Base class implementation.

Return values

string

Exceptions

coding_exception

Implements tool_mfa\local\factor\object_factor.

Reimplemented in tool_mfa\local\factor\fallback.

get_label()

tool_mfa\local\factor\object_factor_base::get_label ( int $factorid )

inherited

Function to retrieve the label for a factorid.

Parameters

int

$factorid

Return values

string|dml_exception

Implements tool_mfa\local\factor\object_factor.

get_lastverified()

tool_mfa\local\factor\object_factor_base::get_lastverified ( int $factorid )

inherited

Gets lastverified timestamp.

Parameters

int

$factorid

Return values

int|bool

the lastverified timestamp, or false if not found.

Implements tool_mfa\local\factor\object_factor.

get_login_desc()

tool_mfa\local\factor\object_factor_base::get_login_desc ( )

inherited

Get the login description associated with this factor.

Override for factors that have a user input.

Return values

string

The login option.

Reimplemented in factor_email\factor, and factor_sms\factor.

get_manage_info()

tool_mfa\local\factor\object_factor_base::get_manage_info ( int $factorid )

inherited

Returns factor help from language string when there is factor management available.

Base class implementation.

Parameters

int

$factorid

The factor we want manage info for.

Return values

string

Exceptions

coding_exception

get_manage_string()

tool_mfa\local\factor\object_factor_base::get_manage_string ( )

inherited

Gets the string for manage button on preferences page.

Return values

string

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

get_no_redirect_urls()

tool_mfa\local\factor\object_factor_base::get_no_redirect_urls ( )

inherited

Function to get urls that should not be redirected from.

Return values

array

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_email\factor, and factor_grace\factor.

get_remaining_attempts()

tool_mfa\local\factor\object_factor_base::get_remaining_attempts ( )

inherited

Return the number of remaining attempts at this factor.

Return values

int	the number of attempts at this factor remaining.

get_setup_string()

tool_mfa\local\factor\object_factor_base::get_setup_string ( )

inherited

Gets the string for setup button on preferences page.

Return values

string

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

get_state()

factor_token\factor::get_state

(

)

Token implementation.

Checks whether the user has selected roles in any context.

Returns the state of the factor from session information.Implementation for factors that require input. Should be overridden in child classes with no input.

Return values

mixed

Reimplemented from tool_mfa\local\factor\object_factor_base.

get_summary_condition()

tool_mfa\local\factor\object_factor_base::get_summary_condition ( )

inherited

Returns condition for passing factor.

Implementation for basic conditions. Override for complex conditions such as auth type.

Return values

string

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_auth\factor, factor_cohort\factor, and factor_role\factor.

get_weight()

tool_mfa\local\factor\object_factor_base::get_weight ( )

inherited

Returns configured factor weight.

Base class implementation.

Return values

int

Exceptions

dml_exception

Implements tool_mfa\local\factor\object_factor.

global_definition()

tool_mfa\local\factor\object_factor_base::global_definition ( \MoodleQuickForm $mform )

inherited

Hook point for global auth form action hooks.

Parameters

MoodleQuickForm

$mform

Form to inject global elements into.

Return values

void

Implements tool_mfa\local\factor\object_factor.

global_definition_after_data() [1/2]

factor_token\factor::global_definition_after_data

(

$mform

)

Token implementation.

Inject a checkbox into every auth form if needed.

Parameters

MoodleQuickForm

$mform

Form to inject global elements into.

Return values

void

global_definition_after_data() [2/2]

tool_mfa\local\factor\object_factor_base::global_definition_after_data ( \MoodleQuickForm $mform )

inherited

Hook point for global auth form action hooks.

Parameters

MoodleQuickForm

$mform

Form to inject global elements into.

Return values

void

Implements tool_mfa\local\factor\object_factor.

global_submit() [1/2]

factor_token\factor::global_submit

(

$data

)

Token implementation.

Store information about the token status.

Parameters

object

$data

Data from the form.

Return values

void

global_submit() [2/2]

tool_mfa\local\factor\object_factor_base::global_submit ( object $data )

inherited

Hook point for global auth form action hooks.

Parameters

object

$data

Data from the form.

Return values

void

Implements tool_mfa\local\factor\object_factor.

global_validation()

tool_mfa\local\factor\object_factor_base::global_validation ( array $data, array $files )

inherited

Hook point for global auth form action hooks.

Parameters

array	$data	Data from the form.
array	$files	Files form the form.

Return values

array

of errors from validation.

Implements tool_mfa\local\factor\object_factor.

has_input()

factor_token\factor::has_input

(

)

Token implementation.

Returns true if a factor requires input from the user to verify.Override in child class if necessary

Return values

bool

Reimplemented from tool_mfa\local\factor\object_factor_base.

has_replace()

tool_mfa\local\factor\object_factor_base::has_replace ( )

inherited

Returns true if factor class has factor records that can be replaced.

Override in child class if necessary.

Return values

bool

Reimplemented in factor_totp\factor, and factor_webauthn\factor.

has_revoke()

tool_mfa\local\factor\object_factor_base::has_revoke ( )

inherited

Returns true if factor class has factor records that might be revoked.

It means that user can revoke factor record from their profile.

Override in child class if necessary.

Return values

bool

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

has_setup()

tool_mfa\local\factor\object_factor_base::has_setup ( )

inherited

Returns true if factor needs to be setup by user and has setup_form.

Override in child class if necessary.

Return values

bool

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

increment_lock_counter()

tool_mfa\local\factor\object_factor_base::increment_lock_counter ( )

inherited

Increments the lock counter for a factor.

Return values

void

is_enabled()

tool_mfa\local\factor\object_factor_base::is_enabled ( )

inherited

Returns true if factor is enabled, otherwise false.

Base class implementation.

Return values

bool

Exceptions

dml_exception

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor.

is_lockable()

tool_mfa\local\factor\object_factor_base::is_lockable ( )

inherited

Returns true if a factor is able to be locked if it fails.

Generally only input factors are lockable. Override in child class if necessary

Return values

bool

load_locked_state()

tool_mfa\local\factor\object_factor_base::load_locked_state ( )

inherited

This loads the locked state from the DB Base class implementation.

Return values

void

login_form_definition()

tool_mfa\local\factor\object_factor_base::login_form_definition ( \MoodleQuickForm $mform )

inherited

Defines login form definition page for particular factor.

Dummy implementation. Should be overridden in child class.

Parameters

MoodleQuickForm

$mform

Return values

MoodleQuickForm\$mform

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_email\factor, factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

login_form_definition_after_data()

tool_mfa\local\factor\object_factor_base::login_form_definition_after_data ( \MoodleQuickForm $mform )

inherited

Defines login form definition page after form data has been set.

Dummy implementation. Should be overridden in child class.

Parameters

MoodleQuickForm

$mform

Return values

MoodleQuickForm\$mform

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_email\factor, and factor_sms\factor.

login_form_validation()

tool_mfa\local\factor\object_factor_base::login_form_validation ( array $data )

inherited

Implements login form validation for particular factor.

Returns an array of errors, where array key = field id and array value = error text.

Dummy implementation. Should be overridden in child class.

Parameters

array

$data

Return values

array

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_email\factor, factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

possible_states()

factor_token\factor::possible_states

(

stdClass

$user

)

Token implementation.

Parameters

stdClass

$user

Return values

array

Reimplemented from tool_mfa\local\factor\object_factor_base.

post_pass_state()

factor_token\factor::post_pass_state

(

)

Token implementation.

Pass hook to set the cookie for use in subsequent auths.

Function for factor actions in the pass state.Override in child class if necessary.

Return values

void

Reimplemented from tool_mfa\local\factor\object_factor_base.

process_cancel_action()

tool_mfa\local\factor\object_factor_base::process_cancel_action ( )

inherited

Process a cancel input from a user.

Return values

void

Implements tool_mfa\local\factor\object_factor.

replace_user_factor()

tool_mfa\local\factor\object_factor_base::replace_user_factor ( stdClass $data, int $id )

inherited

Replaces a given factor and adds it to user's active factors list.

Returns the new factor if it has been successfully replaced.

Dummy implementation. Should be overridden in child class.

Parameters

stdClass	$data	The new factor data.
int	$id	The id of the factor to replace.

Return values

stdClass|null

the record if created, or null.

Reimplemented in factor_totp\factor, and factor_webauthn\factor.

revoke_user_factor()

tool_mfa\local\factor\object_factor_base::revoke_user_factor ( ?int $factorid = null )

inherited

Marks factor record as revoked.

If factorid is not provided, revoke all instances of factor.

Parameters

int | null

$factorid

Return values

bool

Exceptions

coding_exception
dml_exception

Implements tool_mfa\local\factor\object_factor.

set_state() [1/2]

factor_token\factor::set_state

(

$state

)

Token Implementation.

We can't get_state like the parent here or it will recurse forever.

Parameters

string

$state

the state constant to set

Return values

bool

set_state() [2/2]

tool_mfa\local\factor\object_factor_base::set_state ( string $state )

inherited

Sets the state of the factor into the session.

Implementation for factors that require input. Should be overridden in child classes with no input.

Parameters

string

$state

the state constant to set.

Return values

bool

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_auth\factor, factor_capability\factor, factor_cohort\factor, factor_grace\factor, factor_iprange\factor, factor_nosetup\factor, factor_role\factor, and tool_mfa\local\factor\fallback.

setup_factor_form_definition()

tool_mfa\local\factor\object_factor_base::setup_factor_form_definition ( \MoodleQuickForm $mform )

inherited

Defines setup_factor form definition page for particular factor.

Dummy implementation. Should be overridden in child class.

Parameters

MoodleQuickForm

$mform

Return values

MoodleQuickForm\$mform

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

setup_factor_form_definition_after_data()

tool_mfa\local\factor\object_factor_base::setup_factor_form_definition_after_data ( \MoodleQuickForm $mform )

inherited

Defines setup_factor form definition page after form data has been set.

Dummy implementation. Should be overridden in child class.

Parameters

MoodleQuickForm

$mform

Return values

MoodleQuickForm\$mform

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, and factor_totp\factor.

setup_factor_form_is_cancelled()

tool_mfa\local\factor\object_factor_base::setup_factor_form_is_cancelled ( int $factorid )

inherited

Setups in given factor when the form is cancelled.

Dummy implementation. Should be overridden in child class.

Parameters

int

$factorid

Return values

void

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor.

setup_factor_form_submit_button_string()

tool_mfa\local\factor\object_factor_base::setup_factor_form_submit_button_string ( )

inherited

Setup submit button string in given factor.

Dummy implementation. Should be overridden in child class.

Return values

string|null

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor.

setup_factor_form_validation()

tool_mfa\local\factor\object_factor_base::setup_factor_form_validation ( array $data )

inherited

Implements setup_factor form validation for particular factor.

Returns an array of errors, where array key = field id and array value = error text.

Dummy implementation. Should be overridden in child class.

Parameters

array

$data

Return values

array

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, and factor_totp\factor.

setup_user_factor()

tool_mfa\local\factor\object_factor_base::setup_user_factor ( stdClass $data )

inherited

Setups given factor and adds it to user's active factors list.

Returns true if factor has been successfully added, otherwise false.

Dummy implementation. Should be overridden in child class.

Parameters

stdClass

$data

Return values

stdClass|null

the record if created, or null.

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, and factor_totp\factor.

show_setup_buttons()

tool_mfa\local\factor\object_factor_base::show_setup_buttons ( )

inherited

If has_setup returns true, decides if the setup buttons should be shown on the preferences page.

Return values

bool

Implements tool_mfa\local\factor\object_factor.

Reimplemented in factor_sms\factor, factor_totp\factor, and factor_webauthn\factor.

update_lastverified()

tool_mfa\local\factor\object_factor_base::update_lastverified ( ?int $factorid = null )

inherited

When validation code is correct - update lastverified field for given factor.

If factor id is not provided, update all factor entries for user.

Parameters

int | null

$factorid

Return values

bool|dml_exception

Exceptions

dml_exception

Implements tool_mfa\local\factor\object_factor.

---

The documentation for this class was generated from the following file:

• admin/tool/mfa/factor/token/classes/factor.php