Source for file Ethna_Plugin_Csrf_Session.php

Documentation is available at Ethna_Plugin_Csrf_Session.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Plugin_Csrf_Session.php
  5.  *
  6.  *  @author     Keita Arai <cocoiti@comio.info>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id$
  10.  */
  11.  
  12. // {{{ Ethna_Plugin_Csrf_Session
  13. /**
  14.  *  CSRF対策
  15.  *
  16.  *  CSRF対策をトークンを用いて対策するためのコード
  17.  *
  18.  *  @author     Keita Arai <cocoiti@comio.info>
  19.  *  @access     public
  20.  *  @package    Ethna
  21.  */
  22. class Ethna_Plugin_Csrf_Session extends Ethna_Plugin_Csrf
  23. {
  24.     /**#@+
  25.      *  @access private
  26.      */
  27.  
  28.     /** @var    object  Ethna_Session    セッションオブジェクト */
  29.     var $session;
  30.     
  31.     /**#@-*/
  32.  
  33.  
  34.     /**
  35.      *  Ethna_Plugin_Csrfのコンストラクタ
  36.      *
  37.      *  @access public
  38.      *  @param  object  Ethna_Controller    &$controller    コントローラオブジェクト
  39.      */
  40.     function Ethna_Plugin_Csrf_Session(&$controller)
  41.     {
  42.         parent::Ethna_Plugin_Csrf($controller);
  43.  
  44.         // オブジェクトの設定
  45.         $this->session =& $this->controller->getSession();
  46.     }
  47.     
  48.     /**
  49.      *  トークンをViewとローカルファイルにセットする
  50.      *
  51.      *  @access public
  52.      *  @return boolean  成功か失敗か
  53.      */
  54.     function set()
  55.     {
  56.         if (! $this->session->isStart()) {
  57.             $this->session->start();
  58.         }
  59.  
  60.         $token = $this->session->get($this->token_name);
  61.         if ($token !== null) {
  62.             return true;
  63.         }
  64.  
  65.         $key = $this->_generateKey();
  66.         $this->session->set($this->token_name, $key); 
  67.  
  68.         return true;       
  69.     }
  70.  
  71.     /**
  72.      *  トークンIDを取得する
  73.      *
  74.      *  @access public
  75.      *  @return string トークンIDを返す。
  76.      */
  77.     function get()
  78.     {
  79.         if (! $this->session->isStart()) {
  80.             $this->session->start();
  81.         }
  82.         
  83.         return $this->session->get($this->token_name);
  84.     }
  85.  
  86.     /**
  87.      *  トークンIDを削除する
  88.      *
  89.      *  @access public
  90.      */
  91.     function remove()
  92.     {
  93.         if (! $this->session->isStart()) {
  94.             $this->session->start();
  95.         }
  96.         $this->session->remove($this->token_name);        
  97.     }
  98. }
  99. // }}}
  100. ?>

Documentation generated on Fri, 11 Nov 2011 04:00:09 +0900 by phpDocumentor 1.4.3