OATHAuthKey Class Reference

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Collaboration diagram for OATHAuthKey:

Public Member Functions
	__construct ( $secret, array $scratchTokens)
	getScratchTokens ()
	getSecret ()
	isScratchToken ( $token)
	Check if a token is one of the scratch tokens for this two factor key.
	regenerateScratchTokens ()
	verifyToken ( $token, OATHUser $user)
	Verify a token against the secret or scratch tokens.

Static Public Member Functions
static	newFromRandom ()
	Make a new key from random values.

Public Attributes
const	MAIN_TOKEN = 1
	Represents that a token corresponds to the main secret.
const	SCRATCH_TOKEN = -1
	Represents that a token corresponds to a scratch token.

Private Attributes
string[]	$scratchTokens
	List of scratch tokens.
array	$secret
	Two factor binary secret.

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html Class representing a two-factor key

Keys can be tied to OATHUsers

Definition at line 26 of file OATHAuthKey.php.

Constructor & Destructor Documentation

__construct()

OATHAuthKey::__construct	(		$secret,
		array	$scratchTokens )

Parameters

string	$secret
array	$scratchTokens

Definition at line 65 of file OATHAuthKey.php.

References $scratchTokens, and $secret.

Member Function Documentation

getScratchTokens()

OATHAuthKey::getScratchTokens

(

)

Returns

array

Definition at line 86 of file OATHAuthKey.php.

References $scratchTokens.

Referenced by SpecialOATHEnable\getScratchTokensForDisplay().

getSecret()

OATHAuthKey::getSecret

(

)

Returns

string

Definition at line 79 of file OATHAuthKey.php.

Referenced by SpecialOATHEnable\getSecretForDisplay().

isScratchToken()

OATHAuthKey::isScratchToken

(

$token

)

Check if a token is one of the scratch tokens for this two factor key.

Parameters

string

$token

Token to verify

Returns

bool true if this is a scratch token.

Definition at line 183 of file OATHAuthKey.php.

newFromRandom()

static OATHAuthKey::newFromRandom ( )

static

Make a new key from random values.

Returns

OATHAuthKey

Definition at line 50 of file OATHAuthKey.php.

References Base32\encode().

Referenced by SpecialOATHEnable\getFormFields().

regenerateScratchTokens()

OATHAuthKey::regenerateScratchTokens

(

)

Definition at line 168 of file OATHAuthKey.php.

References $scratchTokens, and Base32\encode().

verifyToken()

OATHAuthKey::verifyToken	(		$token,
		OATHUser	$user )

Verify a token against the secret or scratch tokens.

Parameters

string	$token	Token to verify
OATHUser	$user

Returns

int|false Returns a constant represent what type of token was matched, or false for no match

Definition at line 99 of file OATHAuthKey.php.

References $retval, Base32\decode(), HOTP\generateByTimeWindow(), OATHAuthHooks\getOATHUserRepository(), MAIN_TOKEN, SCRATCH_TOKEN, and wfMemcKey().

Member Data Documentation

$scratchTokens

string [] OATHAuthKey::$scratchTokens

private

List of scratch tokens.

Definition at line 43 of file OATHAuthKey.php.

Referenced by __construct(), getScratchTokens(), and regenerateScratchTokens().

$secret

array OATHAuthKey::$secret

private

Two factor binary secret.

Definition at line 40 of file OATHAuthKey.php.

Referenced by __construct().

MAIN_TOKEN

const OATHAuthKey::MAIN_TOKEN = 1

Represents that a token corresponds to the main secret.

See also

verifyToken

Definition at line 31 of file OATHAuthKey.php.

Referenced by verifyToken().

SCRATCH_TOKEN

const OATHAuthKey::SCRATCH_TOKEN = -1

Represents that a token corresponds to a scratch token.

See also

verifyToken

Definition at line 37 of file OATHAuthKey.php.

Referenced by verifyToken().

---

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

• extensions/OATHAuth/includes/OATHAuthKey.php