Property | Type | Description | |
---|---|---|---|
$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 |
Method | Description | |
---|---|---|
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 ) : |
Sets the versions this SQRL server supports | |
setAnonAllowed ( boolean $anonAllowed ) : |
Sets whether users are allowed to generate anonymous accounts | |
setAuthenticationPath ( string $authenticationPath ) : |
Sets the path to the authentication script | |
setDomain ( string $domain ) : |
Sets the domain clients should generate a key for | |
setFriendlyName ( string $friendlyName ) : |
Sets the friendly name displayed to SQRL clients during authentication | |
setNonceMaxAge ( integer $nonceMaxAge ) : |
Sets the time in minutes that a nonce is considered valid | |
setNonceSalt ( string $nonceSalt ) : |
Sets the random string used to salt generated nonces | |
setQrHeight ( integer $qrHeight ) : |
Sets the height, in pixels, of a generated QR code | |
setQrPadding ( integer $qrPadding ) : |
Sets the padding, in pixels, around a generated QR code | |
setSecure ( boolean $secure ) : |
Sets whether responses to the server should be secure |
Method | Description | |
---|---|---|
loadConfigFromJSON ( $filePath ) |
public getAcceptedVersions ( ) : array | ||
return | array |
public getAnonAllowed ( ) : boolean | ||
return | boolean |
public getAuthenticationPath ( ) : string | ||
return | string |
public getFriendlyName ( ) : string | ||
return | string |
public getNonceMaxAge ( ) : integer | ||
return | integer |
public getNonceSalt ( ) : string | ||
return | string |
public getQrHeight ( ) : integer | ||
return | integer |
public getQrPadding ( ) : integer | ||
return | integer |
public setAcceptedVersions ( mixed $acceptedVersions ) : |
||
$acceptedVersions | mixed | |
return |
public setAnonAllowed ( boolean $anonAllowed ) : |
||
$anonAllowed | boolean | |
return |
public setAuthenticationPath ( string $authenticationPath ) : |
||
$authenticationPath | string | |
return |
public setFriendlyName ( string $friendlyName ) : |
||
$friendlyName | string | |
return |
public setNonceMaxAge ( integer $nonceMaxAge ) : |
||
$nonceMaxAge | integer | |
return |
public setNonceSalt ( string $nonceSalt ) : |
||
$nonceSalt | string | |
return |
public setQrHeight ( integer $qrHeight ) : |
||
$qrHeight | integer | |
return |
public setQrPadding ( integer $qrPadding ) : |
||
$qrPadding | integer | |
return |
protected array[]mixed $acceptedVersions | ||
return | array[]mixed |
protected bool $anonAllowed | ||
return | boolean |
protected string $authenticationPath | ||
return | string |
protected string $domain | ||
return | string |
protected string $nonceSalt | ||
return | string |