公開日: 2022年11月07日

メールアドレス以外のカラムで認証を行う

目次

環境

解決方法

結論から。
app/Http/Controllers/Auth/LoginController.phpに以下のメソッドを定義(オーバーライド)する。

app/Http/Controllers/Auth/LoginController.php
/**
* Get the login username to be used by the controller.
*
* @return string
*/
public function username()
{
return '<認証に使用するカラム名>';
}

認証のロジックを追ってみる

App\Http\Controllers\Auth\LoginController

app/Http/Controllers/Auth/LoginController.php
<?php
namespace App\Http\Controllers\Auth;
use App\Http\Controllers\Controller;
use App\Providers\RouteServiceProvider;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
class LoginController extends Controller
{
/*
|--------------------------------------------------------------------------
| Login Controller
|--------------------------------------------------------------------------
|
| This controller handles authenticating users for the application and
| redirecting them to your home screen. The controller uses a trait
| to conveniently provide its functionality to your applications.
|
*/
use AuthenticatesUsers;
/**
* Where to redirect users after login.
*
* @var string
*/
protected $redirectTo = RouteServiceProvider::HOME;
/**
* Create a new controller instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('guest')->except('logout');
}
}

Illuminate\Foundation\Auth\AuthenticatesUsers

ui/auth-backend/AuthenticatesUsers.php at 4.x · laravel/ui · GitHub

Laravel UI utilities and presets. Contribute to laravel/ui development by creating an account on GitHub.
https://github.com/laravel/ui/blob/4.x/auth-backend/AuthenticatesUsers.php

ログインのリクエストが発行されるとIlluminate\Foundation\Auth\AuthenticatesUsersloginメソッドが実行される。

./vendor/laravel/ui/auth-backend/AuthenticatesUsers.php
/**
* Handle a login request to the application.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response|\Illuminate\Http\JsonResponse
*
* @throws \Illuminate\Validation\ValidationException
*/
public function login(Request $request)
{
$this->validateLogin($request);
// If the class is using the ThrottlesLogins trait, we can automatically throttle
// the login attempts for this application. We'll key this by the username and
// the IP address of the client making these requests into this application.
if (method_exists($this, 'hasTooManyLoginAttempts') &&
$this->hasTooManyLoginAttempts($request)) {
$this->fireLockoutEvent($request);
return $this->sendLockoutResponse($request);
}
if ($this->attemptLogin($request)) {
if ($request->hasSession()) {
$request->session()->put('auth.password_confirmed_at', time());
}
return $this->sendLoginResponse($request);
}
// If the login attempt was unsuccessful we will increment the number of attempts
// to login and redirect the user back to the login form. Of course, when this
// user surpasses their maximum number of attempts they will get locked out.
$this->incrementLoginAttempts($request);
return $this->sendFailedLoginResponse($request);
}

一番最初に実行されているvalidateLoginメソッドを確認する。

./vendor/laravel/ui/auth-backend/AuthenticatesUsers.php
/**
* Validate the user login request.
*
* @param \Illuminate\Http\Request $request
* @return void
*
* @throws \Illuminate\Validation\ValidationException
*/
protected function validateLogin(Request $request)
{
$request->validate([
$this->username() => 'required|string',
'password' => 'required|string',
]);
}

ここで$this->username()とパスワードに対してバリデーションを行っている。
usernameメソッドを確認してみると…?

./vendor/laravel/ui/auth-backend/AuthenticatesUsers.php
/**
* Get the login username to be used by the controller.
*
* @return string
*/
public function username()
{
return 'email';
}

usernameメソッドの返り値に指定されたフィールドが認証の各処理に使用されていることが分かった。

余談

これを職場の同僚に共有したところ、vendorディレクトリのファイルを直接変更して対応していたらしい…。
特別な理由がない限りvendor直いじりはやめましょう。

© 2024 blog.tksn.jp. All Rights Reserved.