【Laravel】Sanctumで認証API開発方法!ログイン/ログアウトとトークン管理

この記事からわかること
- Laravelで認証APIを開発する流れ
- Sanctumの導入と使い方
- auth.php、sanctum.phpとは?
- 未認証時のハンドリング方法
index
[open]
\ アプリをリリースしました /
環境
- Laravel:8.83.29
- PHP:8.2.0
- macOS:Sonoma 14.6.1
Laravel Sanctumとは?
「Laravel Sanctum」とはLaravelにおける認証システムの1つでトークンベースでの認証APIを開発することが可能になっています。主にSPA(シングルページアプリケーション)やモバイルアプリケーションと連携して認証機能を実装するのに活用することが可能です。
APIトークン
SanctumはAPIトークンを発行してユーザー認証を行うシンプルな設計です。ユーザーのログイン時などにトークンを発行しそのトークンを使用して認証を行い不正なアクセスでないかを検知します。有効期限は年単位で設定できるようですがユーザーのタイミングでトークンをを無効にすることも可能になっています。
APIトークンをデータベーステーブルに保存し、有効なAPIトークンを含む必要があるAuthorization
ヘッダを介して受信し、HTTPリクエストを認証するといった仕組みになっています。
導入手順
最新のLaravelにはデフォルトでSanctumが導入されています。私の動作環境ではLaravel:8.83.29
で導入済みであることを確認できました。確認方法はcomposer.json
ファイル内にlaravel/sanctum
を含んでるかどうかで確認できます。
もし未導入の場合は以下のコマンドを実行します。
次に以下のコマンドを実行してSanctum設定ファイルとマイグレーションファイルをリソース公開しておきます。
ここでAPIトークンを格納するためのデータベーステーブルを生成するためにmigrate
を実行します。
最後にapp/Http/Kernel.php
ファイル内のapi
ミドルウェアグループに追加して導入は完了です。
APIの開発実装手順
認証APIを開発する上で必要になるクラスなどを先にまとめておきます。
- Userモデル
- 認証ハンドリングを行うController
- ルーティング(api.php)
Userモデル
Laravel Sanctumがデフォルトで入っているおかげかUser
モデルもデフォルトで用意されています。HasApiTokens
トレイトが記述してあればOKです。
認証ハンドリングを行うController
続いて認証ハンドリングを行うためのController
を作成します。
作成できたら「新規登録」、「ログイン」、「ログアウト」、「User情報取得」の4つのメソッドを実装していきます。User
モデルを使用してそのままDBへのCRUD処理が実装できるので楽に実装可能です。トークンを取得したい場合はcreateToken('auth_token')->plainTextToken
でAPIトークンを取得することが可能です。
またトークンを明示的に破棄するには$request->user()->tokens()->delete()
を使用します。
ルーティング(api.php)
最後にルーディングです。APIなのでapi.php
に記述します。Sanctumを使用して認証を施したいルートに対してRoute::middleware('auth:sanctum')
を付与します。以下の場合ユーザー情報取得とログアウト処理にのみ認証が必須になります。
APIの疎通テスト
これでAPIの開発が完了しました。実際に正常に動作するか確認していきます。今回は「Postman」を使用して疎通テストしていきます。
新規登録
データベースが空の状態なので最初に新規登録を行います。新規登録はPOST
メソッドでhttp://localhost/oiwai/api/register
にアクセスします。その際にbody
にJSON形式でユーザー登録情報を渡します。
※oiwai
は私の環境構造上入っているだけなので抜いてください。
Send
ボタンで実行するとデータベースにユーザーが登録されます。

ログイン
続いてログインしたいのでPOST
メソッドでhttp://localhost/oiwai/api/login
にアクセスします。こちらもbody
にJSON形式でユーザーログイン情報を渡します。
するとレスポンスでAPIトークンを返すように設定していたのでトークンを取得できます。

認証してアクセスする
最後に認証が必要なルートへアクセスする方法です。GET
メソッドでhttp://localhost/oiwai/api/user
にアクセスします。先ほど取得したトークンはAuthorization
ヘッダーに渡します。Postmanの場合は以下のようにBearer Token
を指定して、該当のトークンを記述します。
しかしなぜかサーバーエラー:500
になってしまいました。500になっている原因は未認証でリダイレクトが走り、表示されているエラー:Route [login] not defined.
はlogin
Viewが未定義なので正しいのですが、トークンを正しく指定しても認証に失敗してしまいました。解決方法は模索中です・・・

※追記:2025/1/25 認証ルートの疎通ですがPostmanだと成功せず、php artisan serve
でサーバーを立ち上げてテストした場合は正常に動作しました。環境上oiwai
が入っていたりするのが良くなかったのかもしれません。
※追記:2025/2/2 ちなみにhttp://localhost/
で認証失敗していた原因はURLのpublicを消すために.htaccessを設置したことでした。
追加した際に以下を入れておかないとAuthorization ヘッダーをリダイレクト先に回せず抜け落ちてしまっていたみたいですね・・・
Authorizationヘッダーに渡す値
ヘッダーにはAuthorization
をKey
として値にトークンを渡します。トークンはBearer トークン
形式で渡さないと正常に認証できないので注意してください。
またレスポンスで取得したトークンは接頭辞に5|
が付与されています。これはデータベースのトークンIDで5|
を付与しなくても認証は通ります。
またデータベースに格納されているトークンはハッシュ化されたものになるので認証で使用するのは$user->createToken('auth_token')->plainTextToken
で取得した生のトークンを使用してください。
未認証時のハンドリング
認証に失敗した際にどのようなハンドリングが行われているのか調べてみました。まずlogin
ViewへリダイレクトしていたのはApp/Http.Middleware/Authenticate.php
でした。
そしてredirectTo
自体はvendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php
のunauthenticated
メソッドから呼び出されているぽいですね。
vendor
の中ではなくapp/Exception/Handler.php
にも同名のものが存在しています。ここでunauthenticated
をオーバーライドすれば任意のハンドリングが行えるかもです。
Sanctumの設定ファイル
Sanctumの設定はconfig/sanctum.php
で管理されています。
Cookieベースの認証をどのドメインで許可するか
トークンの有効期限
null
は無制限。有効期限を設定したい場合は、分単位で数値を指定。(例: 60 で1時間)。
Middleware Sanctumの認証で使用するミドルウェアを指定
APIトークン認証のガード
Laravel自体の認証設定ファイル
Laravel自体の認証設定config/auth.php
で管理されています。
デフォルトで使用する認証ガード
認証の仕組みを設定
ユーザー情報を取得するデータベース設定
パスワードリセット
まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。
ご覧いただきありがとうございました。