Skip to content

refactor authentication configuration and update deprecation warnings #1153

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
arodu wants to merge 2 commits into
base: 15.next-cake5
Choose a base branch
from
Open

refactor authentication configuration and update deprecation warnings #1153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f0756d
refactor authentication configuration and update deprecation warnings
arodu Oct 29, 2025
0503e4f
phpcs fix
arodu Oct 29, 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
51 changes: 26 additions & 25 deletions config/users.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,34 @@
'Form' => [
'className' => 'CakeDC/Auth.Form',
'urlChecker' => 'Authentication.CakeRouter',
'identifier' => [
'Authentication.Password' => [
'fields' => [
'username' => ['username', 'email'],
'password' => 'password',
],
'resolver' => [
'className' => 'Authentication.Orm',
'finder' => 'active',
],
],
],
],
'Token' => [
'className' => 'Authentication.Token',
'skipTwoFactorVerify' => true,
'header' => null,
'queryParam' => 'api_key',
'tokenPrefix' => null,
'identifier' => [
'Authentication.Token' => [
'tokenField' => 'api_token',
'resolver' => [
'className' => 'Authentication.Orm',
'finder' => 'active',
],
],
],
],
'Cookie' => [
'className' => 'CakeDC/Auth.Cookie',
Expand All @@ -231,6 +252,11 @@
'Social' => [
'className' => 'CakeDC/Users.Social',
'skipTwoFactorVerify' => true,
'identifier' => [
'CakeDC/Users.Social' => [
'authFinder' => 'active',
],
],
],
'SocialPendingEmail' => [
'className' => 'CakeDC/Users.SocialPendingEmail',
Expand All @@ -244,31 +270,6 @@
],
]
],
'Identifiers' => [
'Password' => [
'className' => 'Authentication.Password',
'fields' => [
'username' => ['username', 'email'],
'password' => 'password',
],
'resolver' => [
'className' => 'Authentication.Orm',
'finder' => 'active',
],
],
'Social' => [
'className' => 'CakeDC/Users.Social',
'authFinder' => 'active',
],
'Token' => [
'className' => 'Authentication.Token',
'tokenField' => 'api_token',
'resolver' => [
'className' => 'Authentication.Orm',
'finder' => 'active',
],
],
],
'Authorization' => [
'enable' => true,
'serviceLoader' => \CakeDC\Users\Loader\AuthorizationServiceLoader::class,
Expand Down
30 changes: 14 additions & 16 deletions src/Controller/Component/LoginComponent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ protected function afterIdentifyUser($user)
$userId = $user['id'] ?? null;
Log::info(
"Unsafe redirect `$queryRedirect` ignored, user id `{$userId}` " .
"redirected to `$redirectUrl` after successful login",
"redirected to `$redirectUrl` after successful login",
);
$queryRedirect = $redirectUrl;
}
Expand All @@ -188,22 +188,20 @@ protected function afterIdentifyUser($user)
*/
protected function handlePasswordRehash($service, $user, \Cake\Http\ServerRequest $request)
{
$indentifiersNames = (array)Configure::read('Auth.PasswordRehash.identifiers');
foreach ($indentifiersNames as $indentifierName) {
/**
* @var \Authentication\Identifier\AbstractIdentifier|null $checker
*/
$checker = $service->identifiers()->get($indentifierName);
if (!$checker || method_exists($checker, 'needsPasswordRehash') && !$checker->needsPasswordRehash()) {
continue;
}
$passwordField = $checker->getConfig('fields.password', 'password');
$password = $request->getData($passwordField);
$user->set($passwordField, $password);
$user->setDirty('modified');
$this->getController()->getUsersTable()->save($user);
break;
/**
* @var \Authentication\Identifier\AbstractIdentifier|null $checker
*/
$checker = $service->getIdentificationProvider();

if (!$checker || method_exists($checker, 'needsPasswordRehash') && !$checker->needsPasswordRehash()) {
return;
}

$passwordField = $checker->getConfig('fields.password', 'password');
$password = $request->getData($passwordField);
$user->set($passwordField, $password);
$user->setDirty('modified');
$this->getController()->getUsersTable()->save($user);
}

/**
Expand Down
12 changes: 12 additions & 0 deletions src/Loader/AuthenticationServiceLoader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ public function __invoke(ServerRequestInterface $request)
protected function loadIdentifiers($service)
{
$identifiers = Configure::read('Auth.Identifiers');

if (empty($identifiers)) {
return;
}

deprecationWarning(
'15.2.0',
'Configuring identifiers globally via `Auth.Identifiers` is deprecated. ' .
'Please move each identifier\'s configuration into the `identifier` key within its specific authenticator under `Auth.Authenticators`. ' .
'For example, the `Auth.Identifiers.Password` configuration should now be placed inside `Auth.Authenticators.Form.identifier`.',
);

foreach ($identifiers as $key => $item) {
[$identifier, $options] = $this->_getItemLoadData($item, $key);

Expand Down
Loading