PHP Интерфейс Trianglman\Sqrl\SqrlStoreInterface

Автор: johnj
Показать файл Открыть проект

Открытые методы

Метод Описание
checkIdentityKey ( string $key ) : integer Checks the status of an identity key
createIdentity ( string $key, string $suk, string $vuk ) : void Stores a new identity key along with the Identity Lock information
endSession ( string $requestNut ) : void Flags a session as no longer valid.
getIdentitySUK ( string $key ) : string Gets an identity's SUK value in order for the client to use the Identity Unlock protocol
getIdentityVUK ( string $key ) : string Gets an identity's VUK value in order for the client to use the Identity Unlock protocol
getNutDetails ( string $nut ) : array: Retrieves information about the supplied nut
getSessionNonce ( ) : string Gets the current active nonce for the user's session if there is any
lockIdentityKey ( string $key ) : void Locks an authentication key against further use until a successful unlock
logSessionIn ( string $requestNut ) : void Activates a session
storeNonce ( string $nonce, integer $action, string $key = '', string $previousNonce = '' ) : void Stores a nonce and the related information
unlockIdentityKey ( string $key ) : void Unlocks an authentication key allowing future authentication
updateIdentityKey ( string $oldKey, string $newKey, string $newSuk, string $newVuk ) : void Updates a user's key information after an identity update action

Описание методов

checkIdentityKey() публичный Метод

Checks the status of an identity key
public checkIdentityKey ( string $key ) : integer
$key string
Результат integer One of the class key status constants

createIdentity() публичный Метод

Stores a new identity key along with the Identity Lock information
public createIdentity ( string $key, string $suk, string $vuk ) : void
$key string
$suk string
$vuk string
Результат void

endSession() публичный Метод

This should either immediatly destroy the session, or mark the session in such a way that it will be destroyed the next time it is accessed.
public endSession ( string $requestNut ) : void
$requestNut string The nut of the curret request related to the session to be destroyed
Результат void

getIdentitySUK() публичный Метод

Gets an identity's SUK value in order for the client to use the Identity Unlock protocol
public getIdentitySUK ( string $key ) : string
$key string The identity key
Результат string The SUK value

getIdentityVUK() публичный Метод

Gets an identity's VUK value in order for the client to use the Identity Unlock protocol
public getIdentityVUK ( string $key ) : string
$key string The identity key
Результат string The VUK value

getNutDetails() публичный Метод

Retrieves information about the supplied nut
public getNutDetails ( string $nut ) : array:
$nut string The nonce to retrieve information on
Результат array:

getSessionNonce() публичный Метод

Gets the current active nonce for the user's session if there is any
public getSessionNonce ( ) : string
Результат string

lockIdentityKey() публичный Метод

Locks an authentication key against further use until a successful unlock
public lockIdentityKey ( string $key ) : void
$key string The authentication key to lock
Результат void

logSessionIn() публичный Метод

Activates a session
public logSessionIn ( string $requestNut ) : void
$requestNut string The nut of the current request that is being logged in
Результат void

storeNonce() публичный Метод

Stores a nonce and the related information
public storeNonce ( string $nonce, integer $action, string $key = '', string $previousNonce = '' ) : void
$nonce string The nonce to store
$action integer The tif related to the nonce
$key string [Optional] The identity key related to the nonce
$previousNonce string [Optional] The previous nonce related to the nonce
Результат void

unlockIdentityKey() публичный Метод

Unlocks an authentication key allowing future authentication
public unlockIdentityKey ( string $key ) : void
$key string The authentication key to lock
Результат void

updateIdentityKey() публичный Метод

Updates a user's key information after an identity update action
public updateIdentityKey ( string $oldKey, string $newKey, string $newSuk, string $newVuk ) : void
$oldKey string The key getting new information
$newKey string The authentication key replacing the old key
$newSuk string The replacement SUK
$newVuk string The replacement VUK
Результат void