Laravel8が大きく変わっていたので前回の記事で再入門した。
sailコマンドでコンテナの外からartisanコマンドを叩けて便利。
[clink url=\"https://ikuty.com/2021/05/16/laravel8-sail/\"]
Laravel5,6あたりでSocialiteパッケージによりSNS認証を簡単に実装することができた.
Laravel8+JetstreamにSocialiteを導入してSNS認証してみた.
Jetstreamをインストールし,Jetstreamのrouteがある状態でSocialiteが機能するようにした.
JetstreamのAuthはlaravel/uiのようにお手軽にrouteを変更できない様子.
今回はそれには触れず, 最低限の修正でJetstreamとSocialiteを両立させてみる.
[arst_toc tag=\"h4\"]
Jetstream導入
sailコマンド経由でインストールしていく。
composer, artisanだけでなく, npmもsailで実行できる.
# jetstreamをインストールする
$ ./vendor/bin/sail composer require laravel/jetstream
# livewireをインストールする migrationファイルを作成する
$ ./vendor/bin/sail artisan jetstream:install livewire
# 作成したmigrationを実行する
$ ./vendor/bin/sail artisan migrate
# npm install , npm run dev
$ ./vendor/bin/sail npm install
$ ./vendor/bin/sail npm run dev
migrationで作られたテーブル達を確認する.
sailからmysqlを叩くことはできそうだが、さらに-eオプションでSQLを続けられなかった。
sail mysqlでいつものmysql clientに繋がる. sailはあくまでもユーザインターフェースなのでこれで良いか.
$ ./vendor/bin/sail mysql
mysql> show tables;
+------------------------+
| Tables_in_example_app |
+------------------------+
| failed_jobs |
| migrations |
| password_resets |
| personal_access_tokens |
| sessions |
| users |
+------------------------+
http://localhostを叩くと、認証機能が追加されていることを確認できる。
registerから登録してログインすると認証後URL (./dashboard) にredirectされる.
profileに進むとまぁ普通に使いそうな機能が既にインプリメントされていることがわかる.
routeの確認
Jetstreamをインストールした直後にJetstreamにより作られたrouteを確認してみる.
いやー.. too much過ぎだろう...
$ ./vendor/bin/sail artisan route:list
+--------+----------+----------------------------------+---------------------------------+---------------------------------------------------------------------------------+-----------------------------------------------------------+
| Domain | Method | URI | Name | Action | Middleware |
+--------+----------+----------------------------------+---------------------------------+---------------------------------------------------------------------------------+-----------------------------------------------------------+
| | GET|HEAD | / | | Closure | web |
| | GET|HEAD | api/user | | Closure | api |
| | | | | | AppHttpMiddlewareAuthenticate:sanctum |
| | GET|HEAD | dashboard | dashboard | Closure | web |
| | | | | | AppHttpMiddlewareAuthenticate:sanctum |
| | | | | | IlluminateAuthMiddlewareEnsureEmailIsVerified |
| | GET|HEAD | forgot-password | password.request | LaravelFortifyHttpControllersPasswordResetLinkController@create | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | POST | forgot-password | password.email | LaravelFortifyHttpControllersPasswordResetLinkController@store | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | GET|HEAD | livewire/livewire.js | | LivewireControllersLivewireJavaScriptAssets@source | |
| | GET|HEAD | livewire/livewire.js.map | | LivewireControllersLivewireJavaScriptAssets@maps | |
| | POST | livewire/message/{name} | livewire.message | LivewireControllersHttpConnectionHandler | web |
| | GET|HEAD | livewire/preview-file/{filename} | livewire.preview-file | LivewireControllersFilePreviewHandler@handle | web |
| | POST | livewire/upload-file | livewire.upload-file | LivewireControllersFileUploadHandler@handle | web |
| | | | | | IlluminateRoutingMiddlewareThrottleRequests:60,1 |
| | GET|HEAD | login | login | LaravelFortifyHttpControllersAuthenticatedSessionController@create | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | POST | login | | LaravelFortifyHttpControllersAuthenticatedSessionController@store | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | | | | | IlluminateRoutingMiddlewareThrottleRequests:login |
| | POST | logout | logout | LaravelFortifyHttpControllersAuthenticatedSessionController@destroy | web |
| | GET|HEAD | register | register | LaravelFortifyHttpControllersRegisteredUserController@create | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | POST | register | | LaravelFortifyHttpControllersRegisteredUserController@store | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | POST | reset-password | password.update | LaravelFortifyHttpControllersNewPasswordController@store | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | GET|HEAD | reset-password/{token} | password.reset | LaravelFortifyHttpControllersNewPasswordController@create | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | GET|HEAD | sanctum/csrf-cookie | | LaravelSanctumHttpControllersCsrfCookieController@show | web |
| | GET|HEAD | two-factor-challenge | two-factor.login | LaravelFortifyHttpControllersTwoFactorAuthenticatedSessionController@create | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | POST | two-factor-challenge | | LaravelFortifyHttpControllersTwoFactorAuthenticatedSessionController@store | web |
| | | | | | AppHttpMiddlewareRedirectIfAuthenticated:web |
| | | | | | IlluminateRoutingMiddlewareThrottleRequests:two-factor |
| | GET|HEAD | user/confirm-password | password.confirm | LaravelFortifyHttpControllersConfirmablePasswordController@show | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | POST | user/confirm-password | | LaravelFortifyHttpControllersConfirmablePasswordController@store | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | GET|HEAD | user/confirmed-password-status | password.confirmation | LaravelFortifyHttpControllersConfirmedPasswordStatusController@show | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | PUT | user/password | user-password.update | LaravelFortifyHttpControllersPasswordController@update | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | GET|HEAD | user/profile | profile.show | LaravelJetstreamHttpControllersLivewireUserProfileController@show | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareEnsureEmailIsVerified |
| | PUT | user/profile-information | user-profile-information.update | LaravelFortifyHttpControllersProfileInformationController@update | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | POST | user/two-factor-authentication | two-factor.enable | LaravelFortifyHttpControllersTwoFactorAuthenticationController@store | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareRequirePassword |
| | DELETE | user/two-factor-authentication | two-factor.disable | LaravelFortifyHttpControllersTwoFactorAuthenticationController@destroy | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareRequirePassword |
| | GET|HEAD | user/two-factor-qr-code | two-factor.qr-code | LaravelFortifyHttpControllersTwoFactorQrCodeController@show | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareRequirePassword |
| | GET|HEAD | user/two-factor-recovery-codes | two-factor.recovery-codes | LaravelFortifyHttpControllersRecoveryCodeController@index | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareRequirePassword |
| | POST | user/two-factor-recovery-codes | | LaravelFortifyHttpControllersRecoveryCodeController@store | web |
| | | | | | AppHttpMiddlewareAuthenticate |
| | | | | | IlluminateAuthMiddlewareRequirePassword |
+--------+----------+----------------------------------+---------------------------------+---------------------------------------------------------------------------------+-----------------------------------------------------------+
Socialite導入
Laravel5とか6あたりではSocialiteパッケージを導入することでSNS認証を簡単に作れた.
Laravel8+Jetstreamでも同じように作れるのか試してみた.
以下の記事を参考にさせていただきました.
【Laravel】JetstreamでSNS認証（ソーシャルログイン）
# Socialite インストール
./vendor/bin/sail composer require laravel/socialite
# google用provider インストール
./vendor/bin/sail composer require socialiteproviders/google
OAuth idとsecret を取得しておく. (id,secretの発行にはこちらを参考にさせていただきました.)
Callback redirect先のURLとして http://localhost/login/google/callback を登録する.
Socialite実装
.envにOAuth認証id,secret,redirectURLを書く.
.env自体はhostから編集すれば良い.
GOOGLE_KEY=\"*****-*******.apps.googleusercontent.com\"
GOOGLE_SECRET=\"****-****\"
GOOGLE_REDIRECT_URI=\"http://localhost/login/google/callback\"
config/servicesに以下の設定を追加する.
\'google\' => [
\'client_id\' => env(\'GOOGLE_KEY\'),
\'client_secret\' => env(\'GOOGLE_SECRET\'),
\'redirect\' => env(\'GOOGLE_REDIRECT_URI\'),
],
Routeを追加する. Laravel7までとLaravel8ではRouteの書き方が異なる.
Laravel7までは app/Providers/RouteServiceProvider.php に名前空間が定義されているため,
Routeに書くコントローラの名前空間を書かなくても自動的に解決してくれた.
例えば, LoginController::class と書くと,
自動的にApp/Http/Controllers/LoginController::class と解釈された.
Laravel8では, 名前空間を省略できなくなった.
Route::prefix(\'login/{provider}\')->where([\'provider\'=> \'google\'])->group(function(){
Route::get(\'/\',[AppHttpControllersAuthLoginController::class, \'redirectToProvider\'])->name(\'sns_login.redirect\');
Route::get(\'/callback/\',[AppHttpControllersAuthLoginController::class, \'handleProviderCallback\'])->name(\'sns_login.callback\');
});
Socialite Providerを config/app.php のproviders に追加する
/*
* Socialite Providerをconfig/app.php の providers に追加する
*/
\'providers\' => [
...
SocialiteProvidersManagerServiceProvider::class,
...
],
app/Providers/EventServiceProvider.php を以下の通り変更する.
<?php
namespace AppProviders;
use IlluminateAuthEventsRegistered;
use IlluminateAuthListenersSendEmailVerificationNotification;
use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;
use IlluminateSupportFacadesEvent;
use SocialiteProvidersManagerSocialiteWasCalled; //追加
class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
Registered::class => [
SendEmailVerificationNotification::class,
],
// 追加
SocialiteProvidersManagerSocialiteWasCalled::class => [
\'SocialiteProviders\\Google\\GoogleExtendSocialite@handle\',
],
];
/**
* Register any events for your application.
*
* @return void
*/
public function boot()
{
//
}
}
SNS認証によるログインを担うコントローラを自力で作成する.
$ ./vendor/bin/sail artisan make:controller Auth\\LoginController
Controller created successfully.
作成したコントローラの中身は以下の通り.
<?php
namespace AppHttpControllersAuth;
use AppHttpControllersController;
use AppModelsUser;
use IlluminateHttpRequest;
use LaravelSocialiteFacadesSocialite;
use IlluminateSupportFacadesHash;
use IlluminateSupportStr;
class LoginController extends Controller {
// メディア側へのリダイレクト
public function redirectToProvider(Request $request) {
$provider = $request->provider;
return Socialite::driver($provider)->redirect();
}
// メディア側から返されるユーザー情報
public function handleProviderCallback(Request $request) {
$provider = $request->provider;
$sns_user = Socialite::driver($provider)->user();
$sns_email = $sns_user->getEmail();
$sns_name = $sns_user->getName();
// 登録済ならログイン。未登録ならアカウント登録してログイン
if(!is_null($sns_email)) {
$user = User::firstOrCreate( // Userモデルに、レコードがあれば取得、なければ保存
[ \'email\' => $sns_email ],
[ \'email\' => $sns_email, \'name\' => $sns_name, \'password\' => Hash::make(Str::random())
]);
auth()->login($user);
session()->flash(\'oauth_login\', $provider.\'でログインしました。\');
return redirect(\'/\');
}
return \'情報が取得できませんでした。\';
}
}
viewを作成する. ファイル名は app/View/auth/login.blade.php.
Routeで書いた sns_login_redirect ページに遷移するリンクがあるだけ.
<div>
<a href=\"{{ route(\'sns_login.redirect\', \'google\') }}\">Google
</div>
Welcomeページのログインを修正
普通は何らかの画面が既にあってそこにSocialiteを組み込むと思うが, 今回は何もないので,
とりあえずWelcomeページのログインをSocialite用に書き換えてみる.
Jetstreamのrouteを変えようとしたが闇が深そうなので見なかったことにする.
ちょっとJetstreamは出来が良くないのかなー..
デフォルトのWelcomeページのログインは, Jetstreamが生成する /login に合わせて作られてある.
このままだと, Jetstreamが作った認証機構が動く.
例えば以下のように変更するとWelcomeページのログインをSocialiteのものに差し替えることができる.
route(\'login\')をroute(\'sns_login.redirect\',\'google\')に変更した.
また, registerは不要なので, registerへの遷移リンクを削除した.
<body class=\"antialiased\">
<div class=\"relative flex items-top justify-center min-h-screen bg-gray-100 dark:bg-gray-900 sm:items-center py-4 sm:pt-0\">
@if (Route::has(\'sns_login.redirect\'))
<div class=\"hidden fixed top-0 right-0 px-6 py-4 sm:block\">
@auth
<a href=\"{{ url(\'/dashboard\') }}\" class=\"text-sm text-gray-700 underline\">Dashboard
@else
<a href=\"{{ route(\'sns_login.redirect\',\'google\') }}\" class=\"text-sm text-gray-700 underline\">Log in
@endauth
</div>
@endif
...
動作確認
未ログインの状態で http://localhost を開くと, Welcome画面が表示され, Login への遷移リンクが表示される.
Loginを押下すると, Googleのログイン画面に遷移する.
アカウントを選択すると, http://localhost/login/google/callback にredirectがかかる.
もし当サイトにアカウントがなければ,アカウントを作成する.
アカウントがあれば,そのユーザでログインする.
晴れて, Googleアカウントと同じメールアドレスを持つユーザでログインした状態でダッシュボード(./dashbaord)が開く.
