Basic認証を掛ける時は通常、Apacheやnginxなどwebサーバ側で設定を行いますが、Laravelから、いわゆるアプリケーション側からもBasic認証を設定する事が出来ます。

LaravelでBasic認証～全体/一部にアプリケーションから側から気軽に設定する～

Basic認証を掛ける時は通常、Apache や nginx など web サーバ側で設定を行いますが、Laravel から、いわゆるアプリケーション側からも Basic認証を設定する事が出来ます。
今回は、Basic認証パッケージ「l5-very-basic-auth 」を用いて、Laravel で Basic認証を設定します。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#l5-very-basic-auth">l5-very-basic-auth</a></li>
<li><a href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">インストール</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E3%83%BC%E3%81%B8%E7%99%BB%E9%8C%B2">サービスプロパイダーへ登録</a></li>
<li><a href="#%E8%A8%AD%E5%AE%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB">設定ファイル</a></li>
<li><a href="#%E3%83%AB%E3%83%BC%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0">ルーティング</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
</ol>
<h2 id="開発環境">開発環境</h2>
今回の開発環境は以下の通りです。
<ul>
<li>CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.2/7.1</li>
<li>Laravel</li>
</ul>
Laravel のバージョンについては 、5.7/5.6/5.5/5.4/5.3 にて動作確認済みです。
Laravel のルートディレクトリを「laravel/」としています。
<h2 id="l5-very-basic-auth">l5-very-basic-auth</h2>
<a href="https://github.com/olssonm/l5-very-basic-auth" rel="noopener noreferrer" target="_blank">l5-very-basic-auth</a> は、Laravel 用の Basic認証パッケージです。パッケージ名に「5 」とついていますが、4 系でも使えます。（導入・設定方法は 5 系と異なります）
ちなみに Laravel には標準で auth.basic が提供されていますが、データベースを必要とします。このパッケージは DB を使う事なく Basic認証を導入できるので、その点で気軽に使う事ができます。
<h2 id="インストール">インストール</h2>
composer でパッケージを導入していきます。 laravel のルートディレクトリへ移動し、以下のコマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel のルートディレクトリへ移動
cd /path/to/laravel

# composer コマンドでパッケージのインストール
composer require olssonm/l5-very-basic-auth:5.*

# 実行結果
[demo@localhost laravel]$ composer require olssonm/l5-very-basic-auth:5.*
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
 - Installing olssonm/l5-very-basic-auth (v5.4): Downloading (100%) 
Writing lock file
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: fideloper/proxy
Discovered Package: laravel/dusk
Discovered Package: laravel/tinker
Discovered Package: nunomaduro/collision
Discovered Package: olssonm/l5-very-basic-auth
Package manifest generated successfully.
</code></pre>
コマンド末尾、「:」コロンの後には、Laravel のバージョンに応じたパッケージのバージョンを付けます。各バージョンの指定は以下の通りです。
<ul>
<li>5.1/5.2 → 1.*</li>
<li>5.3 → 2.*</li>
<li>5.4/5.5/5.5/5.6/5.7 → 5.*</li>
</ul>
composer.json でパッケージが追加されているのが確認できます。
<pre><code class="hljs language-json">"require": {
 "php": "^7.1.3",
 "fideloper/proxy": "^4.0",
 "guzzlehttp/guzzle": "^6.3",
 "laravel/framework": "5.7.*",
 "laravel/tinker": "^1.0",
 "olssonm/l5-very-basic-auth": "5.*" // ← ココ
},
</code></pre>
<h2 id="サービスプロパイダーへ登録">サービスプロパイダーへ登録</h2>
このパッケージをサービスプロパイダーへ登録します。
<dl class="description_setting">
<dt>laravel/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'providers' => [
 // l5-very-basic-auth
 Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider::class,
],
</code></pre>
</dd>
</dl>
<h2 id="設定ファイル">設定ファイル</h2>
まずは設定ファイルを生成します。下記の artisan コマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel のルートディレクトリへ移動
cd /path/to/laravel

# 設定ファイルの公開
php artisan vendor:publish --provider="Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider"

# 実行結果
[demo@localhost laravel]$ php artisan vendor:publish --provider="Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider"
Copied File [/vendor/olssonm/l5-very-basic-auth/src/config.php] To [/config/very_basic_auth.php]
Publishing complete.
</code></pre>
laravel/config 配下に very_basic_auth.php が生成されます。
<pre><code class="hljs language-shell">laravel
├─ config
｜ ├─ very_basic_auth.php
</code></pre>
設定を行います。ここで Basic認証で使うユーザ名やパスワードなどを設定します。
<dl class="description_setting">
<dt>laravel/config/very_basic_auth.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

 /**
 * Configuration for the "HTTP Very Basic Auth"-middleware
 */
 return [
 // Username
 'user' => 'user_name',

 // Password
 'password' => 'my_password',

 // Environments where the middleware is active. Use "*" to protect all envs
 'envs' => [
 '*'
 ],

 // Message to display if the user "opts out"/clicks "cancel"
 'error_message' => 'You have to supply your credentials to access this resource.',

 // Message to display in the auth dialiog in some browsers (mainly Internet Explorer).
 // Realm is also used to define a "space" that should share crentials.
 'realm' => 'Basic Auth',

 // If you prefer to use a view with your error message you can uncomment "error_view".
 // This will superseed your default response message
 // 'error_view' => 'very_basic_auth::default'
 ];
</code></pre>
</dd>
</dl>
<dl>
<dt>user</dt>
<dd>ユーザ名</dd>
<dt>password</dt>
<dd>パスワード</dd>
<dt>envs</dt>
<dd>どの環境で動作するかを設定します。デフォルトはアスタリスクで全ての環境が設定されています。環境を絞る場合は配列の形で env ファイルに記述している環境名を記述します。</dd>
</dl>
<pre><code class="hljs language-php">'envs' => [
 'production',
 'testing',
 'development',
 'local'
],
</code></pre>
<dl>
<dt>error_messageBasic</dt>
<dd>認証に失敗した時に表示するメッセージ</dd>
<dt>error_view</dt>
<dd>エラーメッセージではなく view を使う場合はコメントアウトを外します。</dd>
</dl>
<h2 id="ルーティング">ルーティング</h2>
最後に、ルーティングを設定します。
<dl class="description_setting">
<dt>laravel/routes/web.php</dt>
<dd>
<pre><code class="hljs language-php">Route::group(['middleware' => 'auth.very_basic'], function() {

Route::get('/', function () { return view('welcome'); });

});
</code></pre>
</dd>
</dl>
Basic認証を掛けたいルーティングをこの中に入れる事で対象とします。
<h2 id="動作確認">動作確認</h2>
ブラウザからアクセスしてみます。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/3/DnjbTYm69Zln2TWDPBgy.png" width="400" height="242" alt="Basic認証ダイアログ"></div>
ダイアログが出力され、Basic認証がかかっている事が確認できました。
<h2 id="まとめ">まとめ</h2>
以上で作業は完了です。このパッケージの良いところは、サーバや DB の設定が不要で、気軽にベーシック認証を導入できるところです。 また、ベーシック認証の導入箇所を自由にルーティングできる事から、使い勝手も良く、便利です。 laravel の最新バージョンにも素早く対応しているので、これからずっと使えるパッケージです。気軽に導入出来て便利なので、是非試してみてください。

Basic認証を掛ける時は通常、Apache や nginx など web サーバ側で設定を行いますが、Laravel から、いわゆるアプリケーション側からも Basic認証を設定する事が出来ます。
今回は、Basic認証パッケージ「l5-very-basic-auth 」を用いて、Laravel で Basic認証を設定します。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#l5-very-basic-auth">l5-very-basic-auth</a></li>
<li><a href="#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">インストール</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%83%97%E3%83%AD%E3%83%91%E3%82%A4%E3%83%80%E3%83%BC%E3%81%B8%E7%99%BB%E9%8C%B2">サービスプロパイダーへ登録</a></li>
<li><a href="#%E8%A8%AD%E5%AE%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB">設定ファイル</a></li>
<li><a href="#%E3%83%AB%E3%83%BC%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0">ルーティング</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
</ol>
<h2 id="開発環境">開発環境</h2>
今回の開発環境は以下の通りです。
<ul>
<li>CentOS 7</li>
<li>Apache 2.4</li>
<li>PHP 7.2/7.1</li>
<li>Laravel</li>
</ul>
Laravel のバージョンについては 、5.7/5.6/5.5/5.4/5.3 にて動作確認済みです。
Laravel のルートディレクトリを「laravel/」としています。
<h2 id="l5-very-basic-auth">l5-very-basic-auth</h2>
<a href="https://github.com/olssonm/l5-very-basic-auth" rel="noopener noreferrer" target="_blank">l5-very-basic-auth</a> は、Laravel 用の Basic認証パッケージです。パッケージ名に「5 」とついていますが、4 系でも使えます。（導入・設定方法は 5 系と異なります）
ちなみに Laravel には標準で auth.basic が提供されていますが、データベースを必要とします。このパッケージは DB を使う事なく Basic認証を導入できるので、その点で気軽に使う事ができます。
<h2 id="インストール">インストール</h2>
composer でパッケージを導入していきます。 laravel のルートディレクトリへ移動し、以下のコマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel のルートディレクトリへ移動
cd /path/to/laravel

# composer コマンドでパッケージのインストール
composer require olssonm/l5-very-basic-auth:5.*

# 実行結果
[demo@localhost laravel]$ composer require olssonm/l5-very-basic-auth:5.*
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
 - Installing olssonm/l5-very-basic-auth (v5.4): Downloading (100%) 
Writing lock file
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: fideloper/proxy
Discovered Package: laravel/dusk
Discovered Package: laravel/tinker
Discovered Package: nunomaduro/collision
Discovered Package: olssonm/l5-very-basic-auth
Package manifest generated successfully.
</code></pre>
コマンド末尾、「:」コロンの後には、Laravel のバージョンに応じたパッケージのバージョンを付けます。各バージョンの指定は以下の通りです。
<ul>
<li>5.1/5.2 → 1.*</li>
<li>5.3 → 2.*</li>
<li>5.4/5.5/5.5/5.6/5.7 → 5.*</li>
</ul>
composer.json でパッケージが追加されているのが確認できます。
<pre><code class="hljs language-json">"require": {
 "php": "^7.1.3",
 "fideloper/proxy": "^4.0",
 "guzzlehttp/guzzle": "^6.3",
 "laravel/framework": "5.7.*",
 "laravel/tinker": "^1.0",
 "olssonm/l5-very-basic-auth": "5.*" // ← ココ
},
</code></pre>
<h2 id="サービスプロパイダーへ登録">サービスプロパイダーへ登録</h2>
このパッケージをサービスプロパイダーへ登録します。
<dl class="description_setting">
<dt>laravel/config/app.php</dt>
<dd>
<pre><code class="hljs language-php">'providers' => [
 // l5-very-basic-auth
 Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider::class,
],
</code></pre>
</dd>
</dl>
<h2 id="設定ファイル">設定ファイル</h2>
まずは設定ファイルを生成します。下記の artisan コマンドを叩きます。
<pre><code class="hljs language-shell"># Laravel のルートディレクトリへ移動
cd /path/to/laravel

# 設定ファイルの公開
php artisan vendor:publish --provider="Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider"

# 実行結果
[demo@localhost laravel]$ php artisan vendor:publish --provider="Olssonm\VeryBasicAuth\VeryBasicAuthServiceProvider"
Copied File [/vendor/olssonm/l5-very-basic-auth/src/config.php] To [/config/very_basic_auth.php]
Publishing complete.
</code></pre>
laravel/config 配下に very_basic_auth.php が生成されます。
<pre><code class="hljs language-shell">laravel
├─ config
｜ ├─ very_basic_auth.php
</code></pre>
設定を行います。ここで Basic認証で使うユーザ名やパスワードなどを設定します。
<dl class="description_setting">
<dt>laravel/config/very_basic_auth.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

 /**
 * Configuration for the "HTTP Very Basic Auth"-middleware
 */
 return [
 // Username
 'user' => 'user_name',

 // Password
 'password' => 'my_password',

 // Environments where the middleware is active. Use "*" to protect all envs
 'envs' => [
 '*'
 ],

 // Message to display if the user "opts out"/clicks "cancel"
 'error_message' => 'You have to supply your credentials to access this resource.',

 // Message to display in the auth dialiog in some browsers (mainly Internet Explorer).
 // Realm is also used to define a "space" that should share crentials.
 'realm' => 'Basic Auth',

 // If you prefer to use a view with your error message you can uncomment "error_view".
 // This will superseed your default response message
 // 'error_view' => 'very_basic_auth::default'
 ];
</code></pre>
</dd>
</dl>
<dl>
<dt>user</dt>
<dd>ユーザ名</dd>
<dt>password</dt>
<dd>パスワード</dd>
<dt>envs</dt>
<dd>どの環境で動作するかを設定します。デフォルトはアスタリスクで全ての環境が設定されています。環境を絞る場合は配列の形で env ファイルに記述している環境名を記述します。</dd>
</dl>
<pre><code class="hljs language-php">'envs' => [
 'production',
 'testing',
 'development',
 'local'
],
</code></pre>
<dl>
<dt>error_messageBasic</dt>
<dd>認証に失敗した時に表示するメッセージ</dd>
<dt>error_view</dt>
<dd>エラーメッセージではなく view を使う場合はコメントアウトを外します。</dd>
</dl>
<h2 id="ルーティング">ルーティング</h2>
最後に、ルーティングを設定します。
<dl class="description_setting">
<dt>laravel/routes/web.php</dt>
<dd>
<pre><code class="hljs language-php">Route::group(['middleware' => 'auth.very_basic'], function() {

Route::get('/', function () { return view('welcome'); });

});
</code></pre>
</dd>
</dl>
Basic認証を掛けたいルーティングをこの中に入れる事で対象とします。
<h2 id="動作確認">動作確認</h2>
ブラウザからアクセスしてみます。
<div class="img_wrap"><img src="/images/posts/3/DnjbTYm69Zln2TWDPBgy.png" width="400" height="242" alt="Basic認証ダイアログ"></div>
ダイアログが出力され、Basic認証がかかっている事が確認できました。
<h2 id="まとめ">まとめ</h2>
以上で作業は完了です。このパッケージの良いところは、サーバや DB の設定が不要で、気軽にベーシック認証を導入できるところです。 また、ベーシック認証の導入箇所を自由にルーティングできる事から、使い勝手も良く、便利です。 laravel の最新バージョンにも素早く対応しているので、これからずっと使えるパッケージです。気軽に導入出来て便利なので、是非試してみてください。

Author