CakePHP3.xのAuthコンポーネントでログイン認証する方法

cakephp

私の愛しいアップルパイへ

CakePHPにはパスワード認証機能などを実装しやすくするAuthコンポーネントが標準で使えるようになっています。

もちろん認証まわりを独自に実装するのも良いですが、Authコンポーネントは柔軟なので、楽に実装できておすすめです。

Authコンポーネント自体は過去のバージョンからありましたが、3.xになってから大きく使い方が変わったので解説します。

Authコンポーネントの読み込みとセットアップ

さっそく使い方を見ていきましょう。まず、Authコンポーネントの読み込みと、挙動のセットアップからです。

ここでは最もよく使われるであろうForm認証を例に説明していきますが、AuthコンポーネントはBasic認証とDigest認証にも対応しています。独自に拡張すれば、他の認証方式にも対応できます。

まずはAppController.phpでAuthコンポーネントを読み込み、パラメーターで挙動を指定していきます。

▼その他の設定については以下のページをご参照ください。

Entityによるパスワードの暗号化処理

パスワードは暗号化して保存したいですよね。その場合はEntityで行います。

以下はUserEntity(Model/Entity/User.php)でパスワードハッシュ処理を実装したところです。

ここではCakePHPの標準で使えるDefaultPasswordHasherを使っています。ハッシュで使うsaltはapp.phpに記載されています。

Entityで「_set○○」というprotectedメソッドを呼ぶことで、○○というカラムをデータベースに保存する直前に、値を編集できます。○○の部分はキャメル記法です。

パラメーターには、カラム名をキャメルバック記法で指定します。ここに保存しようとしていたデータが入ってきます。

上記では、_setPasswordとすることで、passwordを保存する前にハッシュ処理を行っています。

▼このあたりのEntityの動きは以下の公式ドキュメントに書かれています。

identifyメソッドによる認証処理の実装

実際に認証する処理を実装していきましょう。

ログイン時にPostされるアクションを実装していきます。ここではUsersController.phpのlogin()メソッドを使う想定で書いています。

ハイライト箇所が実際のログイン処理です。

identify()を使うと、ユーザーから入力されたデータを$this->requestから冒頭で設定したユーザー名とパスワードを読み取り、データベースに該当するユーザーがいるか調べてくれます。

そして、該当するユーザーがいればそのユーザーオブジェクトを取得します。つまり、そのユーザーでログイン状態にすれば良いということです。

setUser()はセッション内にユーザー情報を保持してくれます。ちなみに、ここで保存されたデータは$this->Auth->user()で取得することができます。

redirectUrl()では、冒頭で設定したログイン後のURLにリダイレクトしてくれます。

これで最低限必要なログイン処理は実装できるはずです。

▼このあたりの処理は以下の公式ドキュメントに詳細な記述があります。

ログアウト処理の実装

続けてログアウト処理を実装しましょう。これはとても簡単です。

ハイライト箇所でログアウト処理と、冒頭で指定したログアウト後のURLへのリダイレクトを行っています。

allowメソッドによるログイン不要アクションの指定

ユーザー新規登録処理などのログイン不要なページを指定する方法を見ていきましょう。

ControllerのbeforeFilterでallow()の引数にアクション名を指定します。ここで指定されたアクションは、ログインせずに表示できるようになります。

Authコンポーネントの公式参考資料

最後に、Authコンポーネントを使ううえで、参考になる記事を記載しておきます。

▼Authコンポーネントを使って認証機能を実装する公式のチュートリアルです。

▼Authコンポーネントの仕様が整理された公式文書です。

貴下の従順なる下僕 松崎より

著者画像

システム系の専門学校を卒業後、システム屋として6年半の会社員生活を経て独立。ブログ「jMatsuzaki」を通して、小学生のころからの夢であった音楽家へ至るまでの全プロセスを公開することで、のっぴきならない現実を乗り越えて、諦めきれない夢に向かう生き方を伝えている。