Switch deprecated `AuthenticationMethodInterface` to `AuthenticatorInterface`/`AuthenticatorWithChallengeInterface`

[vjik]

Yiisoft\User\Method\ApiAuth and Yiisoft\User\Method\WebAuth currently implement
the deprecated Yiisoft\Auth\AuthenticationMethodInterface instead of Yiisoft\Auth\AuthenticatorInterface/Yiisoft\Auth\AuthenticatorWithChallengeInterface
directly.

ApiAuth → AuthenticatorInterface
WebAuth → AuthenticatorWithChallengeInterface

⚠️ Don't implement it before start version 3.0 development.

[klsoft-web]

In my opinion, changing the interface of ApiAuth to AuthenticatorInterface could cause confusion for users, since the AuthenticatorInterface does not refer to the Api or Web application.
The class implemented for AuthenticatorInterface is universal for any application that uses sessions.

Proposed solution:

1. Remove ApiAuth and WebAuth.
2. Create a UserAuthenticator that implements the AuthenticatorInterface:

use Yiisoft\Auth\AuthenticatorInterface;

final class UserAuthenticator implements AuthenticatorInterface
{
    public function __construct(private CurrentUser $currentUser) {}

    public function authenticate(ServerRequestInterface $request): ?IdentityInterface
    {
        if ($this->currentUser->isGuest()) {
            return null;
        }

        return $this->currentUser->getIdentity();
    }
}

3. Create a AuthenticationFailureWithLoginHandler that implements the RequestHandlerInterface:

//src/Handler/AuthenticationFailureWithLoginHandler.php
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Yiisoft\Http\Status;

final class AuthenticationFailureWithLoginHandler implements RequestHandlerInterface
{
   private string $authUrl = '/login';

    public function __construct(
        private readonly ResponseFactoryInterface $responseFactory,
    ) {}

    public function handle(ServerRequestInterface $request): ResponseInterface
    {
         return $this->responseFactory
            ->createResponse(Status::FOUND)
            ->withHeader('Location', $this->authUrl);
    }

    /**
     * Returns a new instance with the specified authentication URL.
     *
     * @param string $url The authentication URL.
     */
    public function withAuthUrl(string $url): self
    {
        $new = clone $this;
        $new->authUrl = $url;
        return $new;
    }
}

Then, in the app config (it refers to the issue):

//config/di-web.php
use App\Web\Auth\AuthenticationFailureHandler;
use Yiisoft\User\Handler\AuthenticationFailureWithLoginHandler;

return [
    // ...
    RequestHandlerInterface::class => AuthenticationFailureWithLoginHandler::class
];

For the login redirect, using AuthenticatorWithChallengeInterface is redundant, and RequestHandlerInterface is more adaptable since it also allows you to add a request redirect URL to the login.

use App\Data\Auth\AuthRepositoryInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Yiisoft\Http\Status;
use Yiisoft\Router\UrlGeneratorInterface;

final readonly class AuthenticationFailureWithLoginHandler implements RequestHandlerInterface
{
    public function __construct(
        private AuthRepositoryInterface  $authRepository,
        private ResponseFactoryInterface $responseFactory,
        private UrlGeneratorInterface    $urlGenerator)
    {
    }

    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $queryParameters = ['redirect_uri' => $request->getUri()->__toString()];

        return $this->responseFactory
            ->createResponse(Status::FOUND)
            ->withHeader('Location', $this->urlGenerator->generate('login', [], $queryParameters));
    }
}