Source for file Csrf.php

Documentation is available at Csrf.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Csrf.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: f83ba6f30efda3986b01352abb0c8278944ef623 $
  10.  */
  11.  
  12. // {{{ Ethna_Plugin_Csrf
  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 extends Ethna_Plugin_Abstract
  23. {
  24.     /**#@+
  25.      *  @access private
  26.      */
  27.  
  28.     /** @var    string  共有トークン名 */
  29.     protected $token_name = 'ethna_csrf';
  30.  
  31.     /**#@-*/
  32.  
  33.  
  34.     /**
  35.      *  Csrfのコンストラクタ
  36.      *
  37.      *  @access public
  38.      *  @param  object  Ethna_Controller    &$controller    コントローラオブジェクト
  39.      */
  40.     /**
  41.      *  トークンをViewとローカルファイルにセットする
  42.      *
  43.      *  @access public
  44.      *  @return string  トークンのKey
  45.      */
  46.     public function set()
  47.     {
  48.  
  49.     }
  50.  
  51.     /**
  52.      *  トークンIDを取得する
  53.      *
  54.      *  @access public
  55.      *  @return string トークンIDを返す。
  56.      */
  57.     public function get()
  58.     {
  59.  
  60.     }
  61.  
  62.     /**
  63.      *  トークンIDを削除する
  64.      *
  65.      *  @access public
  66.      *  @return string トークンIDを返す。
  67.      */
  68.     public function remove()
  69.     {
  70.  
  71.     }
  72.  
  73.     /**
  74.      *  トークン名を取得する
  75.      *
  76.      *  @access public
  77.      *  @return string トークン名を返す。
  78.      */
  79.     public function getTokenName()
  80.     {
  81.         return $this->token_name;
  82.     }
  83.  
  84.     /**
  85.      *  トークンIDを検証する
  86.      *
  87.      *  @access public
  88.      *  @return mixed  正常の場合はtrue, 不正の場合はfalse
  89.      */
  90.     public function isValid()
  91.     {
  92.         $token = $this->_get_token();
  93.  
  94.         $local_token = $this->get();
  95.  
  96.         if (is_null($local_token)) {
  97.             return false;
  98.         }
  99.  
  100.         if ($token === $local_token) {
  101.             return true;
  102.         }
  103.  
  104.         return false;
  105.     }
  106.  
  107.     /**
  108.      *  キーを生成する
  109.      *
  110.      *  @access public
  111.      *  @return string  keyname
  112.      */
  113.     protected function _generateKey()
  114.     {
  115.         return Ethna_Util::getRandom(32);
  116.     }
  117.  
  118.     /**
  119.      *  リクエストからトークンIDとリクエストIDを抜き出す
  120.      *
  121.      *  @access public
  122.      *  @return mixed  正常の場合はトークン名, 不正の場合はfalse
  123.      */
  124.     protected function _get_token()
  125.     {
  126.         $token_name = $this->getTokenName();
  127.         if (strcasecmp($_SERVER['REQUEST_METHOD'], 'post') === 0) {
  128.             return isset($_POST[$token_name]) ? $_POST[$token_name] : null;
  129.         } else {
  130.             return isset($_GET[$token_name]) ? $_GET[$token_name] : null;
  131.         }
  132.     }
  133. }
  134. // }}}

Documentation generated on Fri, 11 Nov 2011 03:57:55 +0900 by phpDocumentor 1.4.3