PHP 클래스 Trianglman\Sqrl\SqrlConfiguration

저자: luisc
파일 보기 프로젝트 열기: trianglman/sqrl 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$acceptedVersions array[]mixed Defaults to only accepting version 1
$anonAllowed boolean If a user with an unrecognized identification key attempts to authenticate, should the site accept just the key as a user identification Defaults to false
$authenticationPath string Required if generating SQRL URLs and validating responses
$domain string Required if generating the SQRL URLs and validating responses
$friendlyName string Required
$nonceMaxAge integer Default 5
$nonceSalt string Random string used to salt generated nonces
$qrHeight integer Default 300
$qrPadding integer Default 10
$secure boolean Defaults to false

공개 메소드들

메소드 설명
getAcceptedVersions ( ) : array Gets the versions this SQRL server supports
getAnonAllowed ( ) : boolean Gets whether users are allowed to generate anonymous accounts
getAuthenticationPath ( ) : string Gets the path to the authentication script
getDomain ( ) : string Gets the domain clients should generate a key for
getFriendlyName ( ) : string Gets the friendly name displayed to SQRL clients during authentication
getNonceMaxAge ( ) : integer Gets the time in minutes that a nonce is considered valid
getNonceSalt ( ) : string Gets the random string used to salt generated nonces
getQrHeight ( ) : integer Gets the height, in pixels, of a generated QR code
getQrPadding ( ) : integer Gets the padding, in pixels, around a generated QR code
getSecure ( ) : boolean Gets whether responses to the server should be secure
load ( string $filePath ) Loads the configuration from the supplied file path
setAcceptedVersions ( mixed $acceptedVersions ) : SqrlConfiguration Sets the versions this SQRL server supports
setAnonAllowed ( boolean $anonAllowed ) : SqrlConfiguration Sets whether users are allowed to generate anonymous accounts
setAuthenticationPath ( string $authenticationPath ) : SqrlConfiguration Sets the path to the authentication script
setDomain ( string $domain ) : SqrlConfiguration Sets the domain clients should generate a key for
setFriendlyName ( string $friendlyName ) : SqrlConfiguration Sets the friendly name displayed to SQRL clients during authentication
setNonceMaxAge ( integer $nonceMaxAge ) : SqrlConfiguration Sets the time in minutes that a nonce is considered valid
setNonceSalt ( string $nonceSalt ) : SqrlConfiguration Sets the random string used to salt generated nonces
setQrHeight ( integer $qrHeight ) : SqrlConfiguration Sets the height, in pixels, of a generated QR code
setQrPadding ( integer $qrPadding ) : SqrlConfiguration Sets the padding, in pixels, around a generated QR code
setSecure ( boolean $secure ) : SqrlConfiguration Sets whether responses to the server should be secure

보호된 메소드들

메소드 설명
loadConfigFromJSON ( $filePath )

메소드 상세

getAcceptedVersions() 공개 메소드

Gets the versions this SQRL server supports
public getAcceptedVersions ( ) : array
리턴 array

getAnonAllowed() 공개 메소드

Gets whether users are allowed to generate anonymous accounts
public getAnonAllowed ( ) : boolean
리턴 boolean

getAuthenticationPath() 공개 메소드

Gets the path to the authentication script
public getAuthenticationPath ( ) : string
리턴 string

getDomain() 공개 메소드

Gets the domain clients should generate a key for
public getDomain ( ) : string
리턴 string

getFriendlyName() 공개 메소드

Gets the friendly name displayed to SQRL clients during authentication
public getFriendlyName ( ) : string
리턴 string

getNonceMaxAge() 공개 메소드

Gets the time in minutes that a nonce is considered valid
public getNonceMaxAge ( ) : integer
리턴 integer

getNonceSalt() 공개 메소드

Gets the random string used to salt generated nonces
public getNonceSalt ( ) : string
리턴 string

getQrHeight() 공개 메소드

Gets the height, in pixels, of a generated QR code
public getQrHeight ( ) : integer
리턴 integer

getQrPadding() 공개 메소드

Gets the padding, in pixels, around a generated QR code
public getQrPadding ( ) : integer
리턴 integer

getSecure() 공개 메소드

Gets whether responses to the server should be secure
public getSecure ( ) : boolean
리턴 boolean

load() 공개 메소드

Loads the configuration from the supplied file path
public load ( string $filePath )
$filePath string The file to load

loadConfigFromJSON() 보호된 메소드

protected loadConfigFromJSON ( $filePath )

setAcceptedVersions() 공개 메소드

Sets the versions this SQRL server supports
public setAcceptedVersions ( mixed $acceptedVersions ) : SqrlConfiguration
$acceptedVersions mixed
리턴 SqrlConfiguration

setAnonAllowed() 공개 메소드

Sets whether users are allowed to generate anonymous accounts
public setAnonAllowed ( boolean $anonAllowed ) : SqrlConfiguration
$anonAllowed boolean
리턴 SqrlConfiguration

setAuthenticationPath() 공개 메소드

Sets the path to the authentication script
public setAuthenticationPath ( string $authenticationPath ) : SqrlConfiguration
$authenticationPath string
리턴 SqrlConfiguration

setDomain() 공개 메소드

Sets the domain clients should generate a key for
public setDomain ( string $domain ) : SqrlConfiguration
$domain string
리턴 SqrlConfiguration

setFriendlyName() 공개 메소드

Sets the friendly name displayed to SQRL clients during authentication
public setFriendlyName ( string $friendlyName ) : SqrlConfiguration
$friendlyName string
리턴 SqrlConfiguration

setNonceMaxAge() 공개 메소드

Sets the time in minutes that a nonce is considered valid
public setNonceMaxAge ( integer $nonceMaxAge ) : SqrlConfiguration
$nonceMaxAge integer
리턴 SqrlConfiguration

setNonceSalt() 공개 메소드

Sets the random string used to salt generated nonces
public setNonceSalt ( string $nonceSalt ) : SqrlConfiguration
$nonceSalt string
리턴 SqrlConfiguration

setQrHeight() 공개 메소드

Sets the height, in pixels, of a generated QR code
public setQrHeight ( integer $qrHeight ) : SqrlConfiguration
$qrHeight integer
리턴 SqrlConfiguration

setQrPadding() 공개 메소드

Sets the padding, in pixels, around a generated QR code
public setQrPadding ( integer $qrPadding ) : SqrlConfiguration
$qrPadding integer
리턴 SqrlConfiguration

setSecure() 공개 메소드

Sets whether responses to the server should be secure
public setSecure ( boolean $secure ) : SqrlConfiguration
$secure boolean
리턴 SqrlConfiguration

프로퍼티 상세

$acceptedVersions 보호되어 있는 프로퍼티

Defaults to only accepting version 1
protected array[]mixed $acceptedVersions
리턴 array[]mixed

$anonAllowed 보호되어 있는 프로퍼티

If a user with an unrecognized identification key attempts to authenticate, should the site accept just the key as a user identification Defaults to false
protected bool $anonAllowed
리턴 boolean

$authenticationPath 보호되어 있는 프로퍼티

Required if generating SQRL URLs and validating responses
protected string $authenticationPath
리턴 string

$domain 보호되어 있는 프로퍼티

Required if generating the SQRL URLs and validating responses
protected string $domain
리턴 string

$friendlyName 보호되어 있는 프로퍼티

Required
protected string $friendlyName
리턴 string

$nonceMaxAge 보호되어 있는 프로퍼티

Default 5
protected int $nonceMaxAge
리턴 integer

$nonceSalt 보호되어 있는 프로퍼티

Random string used to salt generated nonces
protected string $nonceSalt
리턴 string

$qrHeight 보호되어 있는 프로퍼티

Default 300
protected int $qrHeight
리턴 integer

$qrPadding 보호되어 있는 프로퍼티

Default 10
protected int $qrPadding
리턴 integer

$secure 보호되어 있는 프로퍼티

Defaults to false
protected bool $secure
리턴 boolean