PHP Класс Trianglman\Sqrl\SqrlRequestHandler

This class will process a request, send it to the validator, then depending on the type of request, send a success message, send an error message, or send a request for more information (e.g. initiate the second loop to create a new user)
Автор: johnj
Наследование: implements Trianglman\Sqrl\SqrlRequestHandlerInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$actions
$authenticationKey
$clientOptions
$clientSUK
$clientVUK
$config SqrlConfiguration
$ipMatch
$previousIdKey
$requestNut
$responseCode
$sqrlGenerator Trianglman\Sqrl\SqrlGenerateInterface
$store Trianglman\Sqrl\SqrlStoreInterface
$tif
$validator Trianglman\Sqrl\SqrlValidateInterface

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

Метод Описание
__construct ( SqrlConfiguration $config, Trianglman\Sqrl\SqrlValidateInterface $val, Trianglman\Sqrl\SqrlStoreInterface $store = null, Trianglman\Sqrl\SqrlGenerateInterface $gen = null )
getResponseCode ( ) : integer Gets the numeric HTTP code to return to the SQRL client
getResponseMessage ( ) : string Gets the text message to be returned to the SQRL client
parseRequest ( array $get, array $post, array $server ) : void Parses a user request
sendResponse ( ) : void A helper function to send the response message and code to the SQRL client

Защищенные методы

Метод Описание
base64URLDecode ( type $string ) : type Base 64 URL decodes a string
base64UrlEncode ( string $string, type $stripEquals = true ) : string Base 64 URL encodes a string
formatResponse ( integer $code ) : string Formats a response to send back to a client
ident ( )
lock ( )
parseClient ( string $clientInput ) : void Takes a (base64Url decoded) client value string and breaks it into its individual values
parseServer ( $serverData )
query ( )

Приватные методы

Метод Описание
identUnknownIdentity ( )
validateSignatures ( $post, $clientInfo )

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

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

public __construct ( SqrlConfiguration $config, Trianglman\Sqrl\SqrlValidateInterface $val, Trianglman\Sqrl\SqrlStoreInterface $store = null, Trianglman\Sqrl\SqrlGenerateInterface $gen = null )
$config SqrlConfiguration
$val Trianglman\Sqrl\SqrlValidateInterface
$store Trianglman\Sqrl\SqrlStoreInterface
$gen Trianglman\Sqrl\SqrlGenerateInterface

base64URLDecode() защищенный Метод

Basically the same as base64 decoding, but replacing URL safe "-" with "+" and "_" with "/". Automatically detects if the trailing "=" padding has been removed.
protected base64URLDecode ( type $string ) : type
$string type
Результат type

base64UrlEncode() защищенный Метод

Basically the same as base64 encoding, but replacing "+" with "-" and "/" with "_" to make it safe to include in a URL Optionally removes trailing "=" padding characters.
protected base64UrlEncode ( string $string, type $stripEquals = true ) : string
$string string The string to encode
$stripEquals type [Optional] Whether to strip the "=" off of the end
Результат string

formatResponse() защищенный Метод

Formats a response to send back to a client
protected formatResponse ( integer $code ) : string
$code integer The TIF code to send back to the user
Результат string

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

Currently the spec only uses the 200 code and any error message is in the test message response
public getResponseCode ( ) : integer
Результат integer

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

Gets the text message to be returned to the SQRL client
public getResponseMessage ( ) : string
Результат string

ident() защищенный Метод

protected ident ( )

lock() защищенный Метод

protected lock ( )

parseClient() защищенный Метод

Takes a (base64Url decoded) client value string and breaks it into its individual values
protected parseClient ( string $clientInput ) : void
$clientInput string
Результат void

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

This will determine what type of request is being performed and set values up for use in validation and creating the response.
public parseRequest ( array $get, array $post, array $server ) : void
$get array The user's GET request
$post array The user's POST body
$server array Server level variables (the _SERVER array)
Результат void

parseServer() защищенный Метод

protected parseServer ( $serverData )

query() защищенный Метод

protected query ( )

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

A helper function to send the response message and code to the SQRL client
public sendResponse ( ) : void
Результат void

Описание свойств

$actions защищенное свойство

protected $actions

$authenticationKey защищенное свойство

protected $authenticationKey

$clientOptions защищенное свойство

protected $clientOptions

$clientSUK защищенное свойство

protected $clientSUK

$clientVUK защищенное свойство

protected $clientVUK

$config защищенное свойство

protected SqrlConfiguration,Trianglman\Sqrl $config
Результат SqrlConfiguration

$ipMatch защищенное свойство

protected $ipMatch

$previousIdKey защищенное свойство

protected $previousIdKey

$requestNut защищенное свойство

protected $requestNut

$responseCode защищенное свойство

protected $responseCode

$sqrlGenerator защищенное свойство

protected SqrlGenerateInterface,Trianglman\Sqrl $sqrlGenerator
Результат Trianglman\Sqrl\SqrlGenerateInterface

$store защищенное свойство

protected SqrlStoreInterface,Trianglman\Sqrl $store
Результат Trianglman\Sqrl\SqrlStoreInterface

$tif защищенное свойство

protected $tif

$validator защищенное свойство

protected SqrlValidateInterface,Trianglman\Sqrl $validator
Результат Trianglman\Sqrl\SqrlValidateInterface