Symfony5のログインフォーム実装
普通にやれば超簡単ですが、一部ひっかかった部分がありました。
今回はsymfony5.4です。
まずはsymfony公式の セキュリティの章 に沿ってすすめていきます。
認証方法（ログインフォームやAPIトークンなど）やユーザーデータの保存場所（データベース、シングルサインオン）に関係なく、次のステップは常に同じです。
「ユーザー」クラスを作成します。最も簡単な方法は、MakerBundleを使用することです。
Doctrineを使用してユーザーデータをデータベースに保存するとします。
>php bin/console make:user The name of the security user class (e.g. User) [User]: > User Do you want to store user data in the database (via Doctrine)? (yes/no) [yes]: > yes Enter a property name that will be the unique "display" name for the user (e.g.email, username, uuid [email] > email Does this app need to hash/check user passwords? (yes/no) [yes]: > yes created: src/Entity/User.php created: src/Repository/UserRepository.php updated: src/Entity/User.php updated: config/packages/security.yaml
以上です！
このコマンドは、必要なものを正確に生成できるように、いくつかの質問をします。最も重要なのはUser.phpファイル自体です。 Userクラスに関する唯一のルールは、 Symfony\Component\Security\Core\User\UserInterface を実装する必要があるということです。必要な他のフィールドやロジックを自由に追加してください。 Userクラスがエンティティである場合（この例のように）、 make:entity コマンドを使用してフィールドを追加できます。また、必ず新しいエンティティの移行を行って実行してください。
php bin/console make:migration php bin/console doctrine:migrations:migrate #もしくはdoctrine:schema:update --force php bin/console doctrine:schema:update --force
ユーザのハッシュパスワードを以下で作成し、Userテーブルのパスワードフィールドに入力
php bin/console security:hash-password
ログインフォーム
公式の How to Build a Login Form の手順の通りにすすめる。
ログインフォームの生成
強力なログインフォームの作成が、MakerBundleの make:auth コマンドで実行できます。セットアップに応じて、異なる質問が行われる場合があり、生成されるコードはわずかに異なる場合があります。
make:auth はMakerBundle1.8の新機能です。
>php bin/console make:auth What style of authentication do you want? [Empty authenticator]: [0] Empty authenticator [1] Login form authenticator > 1 The class name of the authenticator to create (e.g. AppCustomAuthenticator): > LoginFormAuthenticator Choose a name for the controller class (e.g. SecurityController) [SecurityController]: > SecurityController Do you want to generate a '/logout' URL? (yes/no) [yes]: > yes created: src/Security/LoginFormAuthenticator.php updated: config/packages/security.yaml created: src/Controller/SecurityController.php created: templates/security/login.html.twig
これにより、1）login/logoutルートとコントローラー、2）ログインフォームをレンダリングするテンプレート、3）ログイン送信を処理する Guardオーセンティケーター クラス、4）メインのセキュリティ構成ファイルが更新されます。
ログインフォームの完成
make:auth コマンドはあなたのためにたくさんの仕事をしてくれました。しかし、まだ終わっていません。まず、/ loginに移動して、新しいログインフォームを表示します。これは自由にカスタマイズできます。
フォームを送信すると、LoginFormAuthenticatorがリクエストをインターセプトし、フォームからメール（または使用しているフィールド）とパスワードを読み取り、Userオブジェクトを見つけ、CSRFトークンを検証し、パスワードを確認します。
ただし、設定によっては、プロセス全体が機能する前に1つ以上のTODOを完了する必要があります。少なくとも、成功後にユーザーをリダイレクトする場所を入力する必要があります。
// src/Security/LoginFormAuthenticator.php // ... public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey): Response { // ... - throw new \Exception('TODO: provide a valid redirect inside '.__FILE__); + // redirect to some "app_homepage" route - of wherever you want + return new RedirectResponse($this->urlGenerator->generate('app_homepage')); }
そのファイルに他のTODOがない限り、それだけです。データベースからユーザーをロードする場合は、ダミーユーザーをロードしたことを確認してください。次に、ログインしてみます。
成功すると、Webデバッグツールバーに、自分が誰で、どのような役割があるかが表示されます。
以上で終わりなのですが、私がログインを試したところエラーすら表示されず、何度ログインを試みてもログインフォームが表示されるだけでした。
結論からいうと原因はプロジェクトがルート / ではなく、 /project/index.php/ といったパスを使用していたために、AbstractLoginFormAuthenticator::supports メソッドでログイン対象からスルーされてしまっていたためでした。
ということで、 LoginFormAuthenticator で supports メソッドをオーバーライドします。
<?php namespace App\Security; use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Generator\UrlGeneratorInterface; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; use Symfony\Component\Security\Core\Exception\AuthenticationException; use Symfony\Component\Security\Core\Security; use Symfony\Component\Security\Http\Authenticator\AbstractLoginFormAuthenticator; use Symfony\Component\Security\Http\Authenticator\Passport\Badge\CsrfTokenBadge; use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge; use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials; use Symfony\Component\Security\Http\Authenticator\Passport\Passport; use Symfony\Component\Security\Http\Util\TargetPathTrait; class LoginFormAuthenticator extends AbstractLoginFormAuthenticator { use TargetPathTrait; public const LOGIN_ROUTE = 'app_login'; private UrlGeneratorInterface $urlGenerator; public function __construct(UrlGeneratorInterface $urlGenerator) { $this->urlGenerator = $urlGenerator; } //編集対象メソッド public function supports(Request $request): bool { //パスがルートではない場合の対処 $check_login_url = str_replace($request->getBaseUrl(), "", $this->getLoginUrl($request)); return $request->isMethod('POST') && $check_login_url === $request->getPathInfo(); } public function onAuthenticationFailure(Request $request, AuthenticationException $exception): Response { if ($request->hasSession()) { $request->getSession()->set(Security::AUTHENTICATION_ERROR, $exception); } $url = $this->getLoginUrl($request); return new RedirectResponse($url); } public function authenticate(Request $request): Passport { $email = $request->request->get('email', ''); $request->getSession()->set(Security::LAST_USERNAME, $email); return new Passport( new UserBadge($email), new PasswordCredentials($request->request->get('password', '')), [ new CsrfTokenBadge('authenticate', $request->get('_csrf_token')), ] ); } public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response { if ($targetPath = $this->getTargetPath($request->getSession(), $firewallName)) { return new RedirectResponse($targetPath); } return new RedirectResponse($this->urlGenerator->generate('default')); } protected function getLoginUrl(Request $request): string { return $this->urlGenerator->generate(self::LOGIN_ROUTE) ; } }
