Class LdapIdentifier
LDAP Identifier
Identifies authentication credentials using LDAP.
new LdapIdentifier([
'host' => 'ldap.example.com',
'bindDN' => function($username) {
return $username; //transform into a rdn or dn
},
'options' => [
LDAP_OPT_PROTOCOL_VERSION => 3
]
]);Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault configuration
-
$_errors protected
arrayList of errors
-
$_ldap protected
Authentication\Identifier\Ldap\AdapterInterfaceLDAP connection object
Method Summary
-
__construct() public
Constructor
-
_bindUser() protected
Try to bind the given user to the LDAP server
-
_buildLdapObject() protected
Constructs the LDAP object and sets it to the property
-
_checkLdapConfig() protected
Checks the LDAP config
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_connectLdap() protected
Initializes the LDAP connection
-
_handleLdapError() protected
Handles an LDAP error
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getAdapter() public
Returns configured LDAP adapter.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getErrors() public
Returns errors
-
identify() public
Identifies an user or service by the passed credentials
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor
Parameters
-
array$config optional
_bindUser() ¶ protected
_bindUser(string $username, string $password): ArrayAccess|nullTry to bind the given user to the LDAP server
Parameters
-
string$username The username
-
string$password The password
Returns
ArrayAccess|null_buildLdapObject() ¶ protected
_buildLdapObject(): voidConstructs the LDAP object and sets it to the property
Returns
voidThrows
RuntimeException_checkLdapConfig() ¶ protected
_checkLdapConfig(): voidChecks the LDAP config
Returns
voidThrows
RuntimeExceptionInvalidArgumentException_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
array<string, mixed>|string$key Key to write to.
-
mixed$value Value to write.
-
string|bool$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_handleLdapError() ¶ protected
_handleLdapError(string $message): voidHandles an LDAP error
Parameters
-
string$message Exception message
Returns
voidconfigShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetAdapter() ¶ public
getAdapter(): Authentication\Identifier\Ldap\AdapterInterfaceReturns configured LDAP adapter.
Returns
Authentication\Identifier\Ldap\AdapterInterfacegetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns the config.
Usage
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Reading with default value:
$this->getConfig('some-key', 'default-value');Parameters
-
string|null$key optional The key to get or null for the whole config.
-
mixed$default optional The return value when the key does not exist.
Returns
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptionidentify() ¶ public
identify(array $credentials): ArrayAccess|array|nullIdentifies an user or service by the passed credentials
Parameters
-
array$credentials
Returns
ArrayAccess|array|nullsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool