Cookieログイン

cakephp

今回は、ログイン画面でよくみかけるクッキーログインの機能を使ってみます。

CakePHPには、Cookieコンポーネントがあります。(PHPのsetcookieメソッドのラッパー)メソッドはwriteとreadです。わかりやすい。
ログイン時に、「ログインしたまま」というチェックボックスをつけてログインしてきたユーザのクッキーをwriteして、次回そのユーザが訪問した際に、クッキーをreadして自動的にログインさせます。

Cookieコンポーネントの使用

var $components = array(
    'Cookie',
}

使用する際は、コントローラ内でコンポーネントを読み込んで下さい。

writeメソッド (クッキーをつくる)

ログイン画面にチェックボックスを用意します。今回は、remember_meにします。以下は、Userモデルのusernameとpasswordという前提にしていますので、異なる場合は置き換えて下さい。

public function login() {
    if (!empty($this->data) ) {
        // ログイン OK
        if ($this->Auth->login()) {
            // remember_meがチェックされている場合
            if ($this->data['User']['remember_me']){
                // cookieへの書き込みにremember_meを除外
                unset( $this->request->data['User']['remember_me']);
                $cookie = $this->request->data;
                // cookie書き込み
                $this->Cookie->write( 'Auth', $cookie, true, '+2 weeks');

            // remember_meがチェックされていない場合
            } else {
            }
            // リダイレクト
            return $this->redirect( $this->Auth->redirect());

        // ログイン NG
        } else {
            $this->Session->setFlash( 'Invalid username or password');
        }
    }
}

これで、CakeCookie['Auth']['User']という名前で保存されます。

write(mixed $key, mixed $value, boolean $encrypt, mixed $expires)

  • $key:Cookieの変数名です。(ドット表記できます。)
  • $value:保存する値を入れます。今回は、usernameとpassword
  • $encrypt:暗号化有無。暗号化せず平文で保持する場合は、falseへ。暗号化は、Security.saltとSecurity.cipherSeedを使用して行われます。
  • $expires:クッキーの有効期限を設定します。秒数もしくは、strtotime()で変換可能な文字列で指定します。上の例だと2週間。
有効期限を無期限とする設定は特別には用意されていないようです。個人的には2038年問題にどこかでぶつからないように'+20 years'などとしています。(2030年代前半くらいまで) 基本的には今のブラウザでは取り扱いには問題ないようですが、用心のためそうしています。

readメソッド (クッキーをつかう)

ログイン画面にアクセスした際に、$keyをもとにクッキーのデータをリードして、その値でログインを試みます。

function login(){
    if (empty($this->data) ) {
        // cookie 有り
        if ($this->Cookie->check('Auth')) {
            // cookieをログイン用データに書き込み
            $this->request->data = $this->Cookie->read('Auth');
            // ログイン OK
            if ($this->Auth->login()) {
                // ログインリダイレクト
                return $this->redirect( $this->Auth->redirect());
            // ログイン NG
            } else {
                // coockie削除
                $this->Cookie->delete('Auth');    //    クッキー削除
            }
        // cookie 無し
        } else {
            // ログイン画面表示
        }
    }
}

$this->Cookie->read('Auth')の中身を確認すると、以下のようになっており、ログイン処理に使用するUserデータそのものになっているはずです。

Array
(
    [User] => Array
        (
            [username] => ユーザ名
            [password] => パスワード
        )
)
    read(mixed $key)
  • $key - Cookieの変数名です。(ドット表記できます。)

deleteメソッド (削除する)

Cookieの中身を削除します。Cookieの内容でログインできない場合は、deleteしてください。そうしないと堂々巡りになります。(上記) また、ログアウト時もdeleteして下さい。

public function logout() {
    $this->Cookie->delete('Auth');
    return $this->redirect( $this->Auth->logout());
}

destroyメソッド

Cookieそのものを破棄します。違いは、deleteはcookieの値を指定して削除できるのに対し、destroyはごっそり消します。

Cookieコンポーネントの変数

変数 デフォルト値 説明
string $name "CakeCookie" クッキーデータの「name」
string $key 'Security.salt'の値 クッキーの値を暗号化に使用される文字列。ランダムで複雑な値にする必要がある。
string $domain "" クッキーへのアクセスを許可するドメイン。".yourdomain.com" とした場合は、そのサブドメイン全てで許可されます。
int or string $time "5 Days" クッキーの有効期限。数値は秒として扱われる。0とすると"セッションCookie"として扱われます。(←ブラウザを閉じると破棄される。)文字列の場合は、PHPのstrtotime()を使用して解釈されます。この値は write()メソッド内でも設定可能
string $path "/" クッキーが適用されるパス。‘/foo/’と設定した場合は、/foo/ディレクトリとそのサブディレクトリのみで利用できる。デフォルトは、全ディレクトリになる。write()メソッド個別で設定可能
boolean $secure FALSE クッキーの送信をHTTPSのみに限定するか否か。trueで設定。これもwrite()メソッド個別で設定可能
boolean $httpOnly FALSE trueでクッキーへのアクセスをHTTPのみにして、Javascript経由でアクセスさせない。

現在の設定は、$this->log($this->Cookie, LOG_DEBUG)などで確認してみて下さい。

function beforeFilter() {
    $this->Cookie->name = 'baker_id';              // クッキー名‘baker_id’
    $this->Cookie->time = 3600;                    // 有効期間=>1時間
    $this->Cookie->path = '/bakers/preferences/';  // /bakers/preferences/
    $this->Cookie->domain = 'example.com';         // example.comドメイン
    $this->Cookie->secure = true;                  // HTTPSの場合のみ送信
    $this->Cookie->key = 'qSI232qs*&sXOw!';
}

Session用のCookieのキー名を変更する

Session用のクッキーを格納するキー名はデフォルトでは、"CAKEPHP"になっています。必須ではないですが、変更してみます。core.phpに

/* - `Session.cookie` - The name of the cookie to use. Defaults to 'CAKEPHP' */
    Configure::write( 'Session.cookie', 'NAMEOFKEY');



今回は、クッキーデータの扱い方法をログインに例にとって投稿してみました。

  • このエントリーをはてなブックマークに追加

関連記事

cakephp

RSSフィードの取得

コンロトーラ public function getrssfeed() { try { $newsItems = $this->Rss->read( 'http://

cakephp

Blowfishを使用してハッシュ化する

使用方法 Blowfishを採用してハッシュ化を行う場合、Securityクラスのhashメソッドを呼び出します。第2引数に'blowfish'を指定し、第3引数を指定しないもしくはfalseにしま

cakephp

複数ファイルアップロードフォーム

CakePHP 2.0からはHTML5が標準でサポートとなり、複数ファイルアップロードのためのフォーム記述が容易になりました。 View (ビュー) 配列 Array (

cakephp

ログインに追加の条件を付与する「scope」

ユーザ登録では、仮登録処理(status=1)から送付したメール内のリンクをクリックしてもらい本登録(status=0)を行ってもらう実装をしました。仮登録の状態ではログインできないように実装するには

cakephp

SQLクエリーをログに出力する

SQLのクエリーをデバッグするには、Debug Kitを使用すればできますが、デバッグログと一緒に出したいのでやり方を調査してみました。 別々のログやビューでみるのもいいですが、秒単位で実行される処

cakephp

Jsヘルパーを使用してAjax更新

更新処理でページ遷移を伴う場合、ページ全体をレスポンスするのに対して、Ajax処理ではページの一部のレスポンスが可能となるためサーバからの通信量を抑えることが可能となります。デモ head

cakephp

CakePHP インストール時エラーの対処

CakePHPインストール時に出くわすであろうエラーの原因と対処方法についてまとめてみました。前提として、WebサーバはApache、データベースはMySQLとしています。 Timezone未設

cakephp

CakeEmailでメール送信(@gmail)

CakePHP 2になって追加されたクラスCakeEmailがシンプルに使えます。これを使用してメール送信を行う処理を実装してみました。 CakeEmailクラスの読み込み /app/Config

cakephp

CSS/JSをひとまとめにして軽量化するプラグイン「Minify plugin for CakePHP」

「Minify plugin for CakePHP」は、インクルードするCSSもしくはJSファイルをひとまとめにしてキャッシュ化してくれるプラグインです。 導入 ダウンロード・解凍し

cakephp

コントローラ内でバリデーション処理を呼び出す

CakePHPでは、saveメソッドの際にバリデーション処理も自動で行われますが、save処理と切り離してバリデーションを行うこともできます。このときは、save時と若干異なる処理体系になります。

Comment

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


*

PAGE TOP ↑