TFASecret Class Reference

Inheritance diagram for TFASecret:

Public Member Functions
	setNew ($is_new)
	restore ()
	getToken ($timestamp=null)
	validateToken ($token, $timestamp=null, $allow_reuse=false)
	getProvisioningUri ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isRelation ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()

Static Public Member Functions
static	getValidationDuration ($type)
static	getGreatestValidityDuration ()
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	exists ($id)
static	countBySql ($sql='1', $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic (string $name, array $arguments)

Data Fields
const	TYPES
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
const static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	db_table ()
static	db_fields ()
static	pk ()
static	default_values ()
static	serialized_fields ()
static	alias_fields ()
static	i18n_fields ()
static	additional_fields ()
static	has_many ()
static	has_one ()
static	belongs_to ()
static	has_and_belongs_to_many ()
static	registered_callbacks ()
static	known_slots ()
static	notification_map ()
static	getter_setter_map ()
static	configure ($config=[])
static	config ($key)
static	registerCallback ($types, $cb)
static	unregisterCallback ($types, $cb)

Additional Inherited Members
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
static	$performs_batch_operation = false

Member Function Documentation

configure()

const static configure (   $config = [] )

staticprotected

Configures the model.

Parameters

array

$config

Configuration

getGreatestValidityDuration()

static getGreatestValidityDuration ( )

static

Returns the greatest validity duration for all defined types.

Returns

int

getProvisioningUri()

getProvisioningUri

(

)

Returns the provisioning uri for this secret. Used in the qr code for apps.

Returns

string

getToken()

getToken

(

$timestamp = null

)

Returns a token for a given timeslice.

Parameters

int

$timestamp

Timeslice (optional, defaults to now)

Returns

string token

getValidationDuration()

static getValidationDuration (   $type )

static

Returns the duration in seconds for which a token is valid.

Parameters

string

$type

Type of token

Returns

int duration in seconds

restore()

restore

(

)

Overwrite the restore method. This ensures access to token is only valid by root accounts and the owner of the secret.

Returns

mixed

setNew()

setNew

(

$is_new

)

Overwrites the SORM setNew() method. This will create the secret string.

Parameters

boolean

$is_new

State of "new"

validateToken()

validateToken	(		$token,
			$timestamp = null,
			$allow_reuse = false
	)

Validates a 2fa token against the secret. This will create the token again on server side and checks if it matches.

Tokens may be reused if you allow it. This is used for validation tokens stored in a cookie or session. If tokens are not allowed to be reused, they are stored in the database to prevent replay attacks.

Parameters

string	$token	Token to check
int	$timestamp	Timeslice for the token (optional, defaults to now)
boolean	$allow_reuse	Allow reuse of the token

Returns

bool

Field Documentation

TYPES

const TYPES

Initial value:

= [
        'email' => [
            'window' => 60

---

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

• lib/models/TFASecret.php