Adapter

About 5 min

Adapter

Abstract authentication adapter.

This class is the base class for all of the supplied authentication adapters. This class takes care of the password hash generation and session management, including the autologin function.

Available options are:

encryption.hash - default: sha256

The hash algorithm to use to encrypt passwords. This can be a a single algorith, such as sha256, sha1 or any other algorithm supported by the PHP hash() function. You can use the hash_algos() function to get a list of available algorithms. Any unsupported algorithms are silently ignored.

This option can also be an array of algorithms. In which case each one will be applied in the order specified. During each iteration the hash will be appended with the original password (this helps prevent hash collisions) along with any salt value (see below) before being hashed with the next algorithm.

The default is sha256 for security. Please note that this breaks backwards compatibility with the 1.0 version of this module.

Configuration Directives

encryption.count - default: 1

For extra obfuscation, it's possible to "hash the hash" this many times. This is the old method we used to add extra security to the hash, except we now also append the original password to the hash before hashing it. (too much hash?). In the case where the encryption.hash is a list of algorithms, each one of these will be applied as above for each count. So for example, if you have a list of 3 algorithms and the count is 3, your password will be hashed 9 times.

encryption.salt - default: null

For more security a salt value can be set which will be appended to each password when being hashed. If the password is being hashed multiple times then the salt is appended to the hash + password.

This is now more often used as a cache timeout value because on logon, certain data is obtained for a user and stored in cache. Sometimes obtaining this data can be processor intensive so we don't want to do it on every page load. Instead we do it, cache it, and then only do it again once this time passes.

Example Config (app.php)

return [
    'development' => [
        'encryption' => [
            'hash' => ['md5', 'sha1', 'sha256'],
            'salt' => 'mysupersecretsalt',
        ],
        'autologin' => [
            'period' => 365,
            'hash' => 'sha1',
        ],
        'timeout' => 28800,
    ],
];

Properties

backend

public SessionBackend $backend

transport

public SessionTransport $transport

options

The configuration options.

protected array $options

identity

public string $identity

credential

public string $credential

extra

Extra data fields to store from the user record.

protected array $extra

noCredentialHashing

private bool $noCredentialHashing

instances

Instances of adapters.

private array $instances

Methods

__construct

Construct the adapter.

public __construct(array $config): void

Parameter	Type	Description
`$identity`	`string`	The identity of the user (e.g., username, email). If null, defaults to an empty string.
`$credential`	`string`	The credential of the user (e.g., password). If null, defaults to an empty string.

Parameter	Type	Description
`$key`	`string`	the key under which the value will be stored
`$value`	`mixed`	the value to be stored

Parameter	Type	Description
`$backend`	`string`	the fully qualified class name of the storage backend
`$options`	`array`	optional configuration options for the storage adapter

Parameter	Type	Description
`$transport`	`string`	the fully qualified class name of the session transport backend
`$options`	`array`	optional configuration options to pass to the transport backend

Parameter	Type	Description
`$identity`	`string`	The identity that was successfully authenticated
`$data`	`array`	The data returned from the authentication query

Parameter	Type	Description
`$identity`	`string`	the identity that failed authentication
`$data`	`array`	the data returned from the authentication query