TFASecret Class Reference

Inheritance diagram for TFASecret:

Collaboration 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)
	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 Protected Member Functions
static static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=[])
static	config ($key)

Additional Inherited Members
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
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 ($name, $arguments)
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
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)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = []
	$serialized_fields = []
	$alias_fields = []
	$i18n_fields = []
	$additional_fields = []
	$relations = []
	$has_many = []
	$has_one = []
	$belongs_to = []
	$has_and_belongs_to_many = []
	$registered_callbacks = []
	$known_slots = []
	$notification_map = []
	$additional_data = []
	$getter_setter_map = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Detailed Description

Model for a two factor authentication secret.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version

Since

Stud.IP 4.4

Member Function Documentation

configure()

static static configure (   $config = [] )

staticprotected

Configures the model.

Parameters

array

$config

Configuration

getProvisioningUri()

getProvisioningUri

(

)

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

Returns

string

Here is the call graph for this function:

getToken()

getToken

(

$timestamp = null

)

Returns a token for a given timeslice.

Parameters

int

$timestamp

Timeslice (optional, defaults to now)

Returns

string token

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

Todo:

is there a more sorm way by using registered_callbacks?

Here is the call graph for this function:

setNew()

setNew

(

$is_new

)

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

Parameters

boolean

$is_new

State of "new"

Todo:

is there a more sorm way by using registered_callbacks?

Here is the call graph for this function:

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

Here is the call graph for this function:

---

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

• lib/models/TFASecret.php