[Laravel] Passportを使用したBearer token認証[2]

PHPのLaravelフレームワークのPassportを使用したBearer token認証の方法について紹介いたします。本記事は前回の「[Laravel] Passportを使用したBearer token認証[1]」の続きとなります。今回はPassportのインストール方法からLaravel標準の認証機能をPassportに変更するところまでを説明します。

Passportのインストール

Passportのインストールは以下のコマンドで実行します。

composer require laravel/passport

下図の画面が表示されればPassportのインストールは完了です。

次にPassportの機能を使用するためにはoauth系のテーブルの生成も必要ですので、再度migrateを実行します。

php artisan migrate

上図のようにoauthからはじまる名称のテーブルが生成されました。

Laravel標準の認証機能をPassportに変更する

今回はLaravel標準のusersテーブルをPassport認証に使用したいと思いますので、「app/User.php」を以下のように編集します。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Passport\HasApiTokens;

class User extends Authenticatable
{
    use Notifiable;
    use HasApiTokens;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

次に「app/Providers/AuthServiceProvider.php」を以下のように編集します。

<?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Gate;
use Laravel\Passport\Passport;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        // 'App\Model' => 'App\Policies\ModelPolicy',
    ];

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        //
        Passport::routes();
    }
}

次に「config/auth.php」の編集をおこないます。標準の状態では「api」の「driver」は「token」になっていますが、その部分を「passport」に変更します。

<?php

/* 中略 */

    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            //'driver' => 'token',
            'driver' => 'passport',
            'provider' => 'users',
            'hash' => false,
        ],
    ],

以上で、Laravel標準の認証機能をPassportに変更することができました。次回はBearer tokenを使用したユーザー認証についての説明をいたします。

金曜日担当: nishida