Source for file Ethna_Plugin_Csrf.php

Documentation is available at Ethna_Plugin_Csrf.php

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

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