Skip to content

Deprecate identifier collection approach. #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 20 commits into
base: 3.x
Choose a base branch
from
Open

Deprecate identifier collection approach. #712

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
b9c2019
Deprecate identifier collection approach.
dereuromark Apr 20, 2025
1b83044
Add test case.
dereuromark Apr 20, 2025
9cb1182
Update docs/en/identifiers.rst
dereuromark Apr 20, 2025
d4d218a
Fix up deprecation texts.
dereuromark Apr 20, 2025
f2c713e
testAuthenticateSuccessWithDirectCollection
dereuromark Apr 20, 2025
67100bc
Fix up getIdentificationProvider().
dereuromark Apr 22, 2025
412b183
Fix up getIdentificationProvider().
dereuromark Apr 22, 2025
01a536d
Cleanup.
dereuromark Apr 22, 2025
733cbd4
Update docs/en/authenticators.rst
dereuromark Apr 26, 2025
e1d87be
Update docs/en/authenticators.rst
dereuromark Apr 26, 2025
cab11a7
Update docs/en/identifiers.rst
dereuromark Apr 26, 2025
5f6aa03
Update docs/en/identifiers.rst
dereuromark Apr 26, 2025
51ee9b3
Update docs/en/identifiers.rst
dereuromark Apr 26, 2025
ec86fa1
Update docs/en/identifiers.rst
dereuromark Apr 26, 2025
23cf7cd
Update docs/en/index.rst
dereuromark Apr 26, 2025
d781206
Update docs/en/migration-from-the-authcomponent.rst
dereuromark Apr 26, 2025
5c42f1f
Update docs/en/identifiers.rst
dereuromark Apr 26, 2025
340b813
Update docs/en/migration-from-the-authcomponent.rst
dereuromark Apr 26, 2025
97997ae
Update docs/en/password-hashers.rst
dereuromark Apr 26, 2025
b399c53
Update docs/en/password-hashers.rst
dereuromark Apr 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 32 additions & 18 deletions docs/en/authenticators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ Add the following to your ``Application`` class::
{
$service = new AuthenticationService();
// ...
$service->loadIdentifier('Authentication.JwtSubject');
$service->loadAuthenticator('Authentication.Jwt', [
'identifier' => 'Authentication.JwtSubject',
'secretKey' => file_get_contents(CONFIG . '/jwt.key'),
'algorithm' => 'RS256',
'returnPayload' => false
Expand Down Expand Up @@ -180,7 +180,6 @@ Using a JWKS fetched from an external JWKS endpoint is supported as well::
{
$service = new AuthenticationService();
// ...
$service->loadIdentifier('Authentication.JwtSubject');

$jwksUrl = 'https://appleid.apple.com/auth/keys';

Expand All @@ -193,6 +192,7 @@ Using a JWKS fetched from an external JWKS endpoint is supported as well::
});

$service->loadAuthenticator('Authentication.Jwt', [
'identifier' => 'Authentication.JwtSubject',
'jwks' => $jsonWebKeySet,
'returnPayload' => false
]);
Expand Down Expand Up @@ -335,14 +335,18 @@ authentication cookie is **also destroyed**. An example configuration would be::
// Put form authentication first so that users can re-login via
// the login form if necessary.
$service->loadAuthenticator('Authentication.Form', [
'identifier' => 'Authentication.Password',
'fields' => $fields,
'loginUrl' => '/users/login',
]);
// Then use sessions if they are active.
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Session', [
'identifier' => 'Authentication.Password',
]);

// If the user is on the login page, check for a cookie as well.
$service->loadAuthenticator('Authentication.Cookie', [
'identifier' => 'Authentication.Password',
'fields' => $fields,
'loginUrl' => '/users/login',
]);
Expand All @@ -366,12 +370,15 @@ and similar SAML 1.1 implementations. An example configuration is::

// Configure a token identifier that maps `USER_ID` to the
// username column
$service->loadIdentifier('Authentication.Token', [
'tokenField' => 'username',
'dataField' => 'USER_NAME',
]);
$identifier = [
'Authentication.Token', [
'tokenField' => 'username',
'dataField' => 'USER_NAME',
],
];

$service->loadAuthenticator('Authentication.Environment', [
'identifier' => $identifier,
'loginUrl' => '/sso',
'fields' => [
// Choose which environment variables exposed by your
Expand Down Expand Up @@ -477,19 +484,26 @@ authenticators must send specific challenge headers in the response::
// Instantiate the service
$service = new AuthenticationService();

// Load identifiers
$service->loadIdentifier('Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'password'
]
]);
$service->loadIdentifier('Authentication.Token');
// Define identifiers
$passwordIdentifier = [
'Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'password'
]
],
];

// Load the authenticators leaving Basic as the last one.
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Form');
$service->loadAuthenticator('Authentication.HttpBasic');
$service->loadAuthenticator('Authentication.Session', [
'identifier' => $passwordIdentifier,
]);
$service->loadAuthenticator('Authentication.Form', [
'identifier' => $passwordIdentifier,
]);
$service->loadAuthenticator('Authentication.HttpBasic', [
'identifier' => 'Authentication.Token',
]);

If you want to combine ``HttpBasic`` or ``HttpDigest`` with other
authenticators, be aware that these authenticators will abort the request and
Expand Down
127 changes: 72 additions & 55 deletions docs/en/identifiers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,29 @@ that was extracted from the request by the authenticators. Identifiers
can take options in the ``loadIdentifier`` method. A holistic example of
using the Password Identifier looks like::

$service->loadIdentifier('Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'passwd',
],
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Users',
'finder' => 'active', // default: 'all'
],
'passwordHasher' => [
'className' => 'Authentication.Fallback',
'hashers' => [
'Authentication.Default',
[
'className' => 'Authentication.Legacy',
'hashType' => 'md5',
],
$identifier = [
'Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'passwd',
],
],
]);
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Users',
'finder' => 'active', // default: 'all'
],
'passwordHasher' => [
'className' => 'Authentication.Fallback',
'hashers' => [
'Authentication.Default',
[
'className' => 'Authentication.Legacy',
'hashType' => 'md5',
],
],
],
],
];

Password
========
Expand Down Expand Up @@ -60,7 +62,7 @@ Configuration options:
- **resolver**: The identity resolver. Default is
``Authentication.Orm`` which uses CakePHP ORM.
- **hashAlgorithm**: The algorithm used to hash the incoming token
with before compairing it to the ``tokenField``. Recommended value is
with before comparing it to the ``tokenField``. Recommended value is
``sha256``. Default is ``null``.

JWT Subject
Expand Down Expand Up @@ -119,36 +121,39 @@ or an ``Authentication\Authenticator\Result`` if you want to forward error
messages::

// A simple callback identifier
$authenticationService->loadIdentifier('Authentication.Callback', [
'callback' => function($data) {
// do identifier logic
$identifier = [
'Authentication.Callback' => [
'callback' => function($data) {
// do identifier logic

// Return an array of the identified user or null for failure.
if ($result) {
return $result;
}
// Return an array of the identified user or null for failure.
if ($result) {
return $result;
}

return null;
},
]);
return null;
},
]
];

// Using a result object to return error messages.
$authenticationService->loadIdentifier('Authentication.Callback', [
'callback' => function($data) {
// do identifier logic

if ($result) {
return new Result($result, Result::SUCCESS);
}

return new Result(
null,
Result::FAILURE_OTHER,
['message' => 'Removed user.']
);
},
]);

$identifier = [
'Authentication.Callback', [
'callback' => function($data) {
// do identifier logic

if ($result) {
return new Result($result, Result::SUCCESS);
}

return new Result(
null,
Result::FAILURE_OTHER,
['message' => 'Removed user.']
);
},
];
];

Identity resolvers
==================
Expand Down Expand Up @@ -183,17 +188,29 @@ reside under ``App\Identifier\Resolver`` namespace.

Resolver can be configured using ``resolver`` config option::

$service->loadIdentifier('Authentication.Password', [
'resolver' => [
// can be a full class name: \Some\Other\Custom\Resolver::class
'className' => 'MyResolver',
// Pass additional options to the resolver constructor.
'option' => 'value',
],
]);
$identifier = [
'Authentication.Password', [
'resolver' => [
// can be a full class name: \Some\Other\Custom\Resolver::class
'className' => 'MyResolver',
// Pass additional options to the resolver constructor.
'option' => 'value',
],
];
];

Or injected using a setter::

$resolver = new \App\Identifier\Resolver\CustomResolver();
$identifier = $service->loadIdentifier('Authentication.Password');
$identifier->setResolver($resolver);

3.3.0 Deprecated.

Use object injection then:

$resolver = new \App\Identifier\Resolver\CustomResolver();
$identifier = [
'Authentication.Password', [
'resolver' => $resolver;
];
15 changes: 11 additions & 4 deletions docs/en/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,23 @@ define the ``AuthenticationService`` it wants to use. Add the following method t
'queryParam' => 'redirect',
]);

// Define identifiers
$fields = [
AbstractIdentifier::CREDENTIAL_USERNAME => 'email',
AbstractIdentifier::CREDENTIAL_PASSWORD => 'password'
];
$passwordIdentifier = [
'Authentication.Password', [
'fields' => $fields,
],
];

// Load the authenticators. Session should be first.
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Session', [
'identifier' => $passwordIdentifier,
]);
$service->loadAuthenticator('Authentication.Form', [
'identifier' => $passwordIdentifier,
'fields' => $fields,
'loginUrl' => Router::url([
'prefix' => false,
Expand All @@ -110,9 +120,6 @@ define the ``AuthenticationService`` it wants to use. Add the following method t
]),
]);

// Load identifiers
$service->loadIdentifier('Authentication.Password', compact('fields'));

return $service;
}

Expand Down
15 changes: 9 additions & 6 deletions docs/en/middleware.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,21 @@ inspecting the request object you can configure authentication appropriately::
$service = new AuthenticationService();
if (strpos($path, '/api') === 0) {
// Accept API tokens only
$service->loadAuthenticator('Authentication.Token');
$service->loadIdentifier('Authentication.Token');
$service->loadAuthenticator('Authentication.Token', [
'identifier' => 'Authentication.Token',
]);

return $service;
}

// Web authentication
// Support sessions and form login.
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Form');

$service->loadIdentifier('Authentication.Password');
$service->loadAuthenticator('Authentication.Session', [
'identifier' => 'Authentication.Password',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will we also support identifier being an object? If we're going to change how authentication is wired up, we could make it more compatible with the DI container.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already done, afaik there is a test case added
https://github.com/cakephp/authentication/pull/712/files#diff-b9a4b24bdb898b49129cd5b64f3b2f3cf9e71da882e8f07dc277d3df0d96394fR143

]);
$service->loadAuthenticator('Authentication.Form', [
'identifier' => 'Authentication.Password',
]);

return $service;
}
Expand Down
58 changes: 33 additions & 25 deletions docs/en/migration-from-the-authcomponent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,35 +134,43 @@ You’ll now have to configure it this way::
// Instantiate the service
$service = new AuthenticationService();

// Load identifiers
$service->loadIdentifier('Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'password',
]
]);

// Load the authenticators
$service->loadAuthenticator('Authentication.Session');
$service->loadAuthenticator('Authentication.Form');
// Define identifier
$passwordIdentifier = [
'Authentication.Password', [
'fields' => [
'username' => 'email',
'password' => 'password'
]
],
];

// Load the authenticators
$service->loadAuthenticator('Authentication.Session', [
'identifier' => $passwordIdentifier,
]);
$service->loadAuthenticator('Authentication.Form', [
'identifier' => $passwordIdentifier,
]);

If you have customized the ``userModel`` you can use the following
configuration::

// Instantiate the service
$service = new AuthenticationService();

// Load identifiers
$service->loadIdentifier('Authentication.Password', [
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Employees',
],
'fields' => [
'username' => 'email',
'password' => 'password',
]
]);
// Instantiate the service
$service = new AuthenticationService();

// Define identifier
$passwordIdentifier = [
'Authentication.Password', [
'resolver' => [
'className' => 'Authentication.Orm',
'userModel' => 'Employees',
],
'fields' => [
'username' => 'email',
'password' => 'password'
]
],
];

While there is a bit more code than before, you have more flexibility in
how your authentication is handled.
Expand Down
Loading