Source for file Nonce.php

Documentation is available at Nonce.php

  1. <?php
  2. /**
  3.  * OpenID_Nonce
  4.  * 
  5.  * PHP Version 5.2.0+
  6.  * 
  7.  * @category  Auth
  8.  * @package   OpenID
  9.  * @author    Bill Shupp <hostmaster@shupp.org>
  10.  * @copyright 2009 Bill Shupp
  11.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  12.  * @link      http://pearopenid.googlecode.com
  13.  */
  14.  
  15. /**
  16.  * Required files
  17.  */
  18. require_once 'OpenID/Store.php';
  19. require_once 'OpenID.php';
  20.  
  21. /**
  22.  * Handles nonce functionality.  Requires the OP Endpoint URL nonces are to be
  23.  * associated with.
  24.  * 
  25.  * @category  Auth
  26.  * @package   OpenID
  27.  * @author    Bill Shupp <hostmaster@shupp.org>
  28.  * @copyright 2009 Bill Shupp
  29.  * @license   http://www.opensource.org/licenses/bsd-license.php FreeBSD
  30.  * @link      http://pearopenid.googlecode.com
  31.  */
  32. class OpenID_Nonce
  33. {
  34.     /**
  35.      *  Constant for the parameter used with OpenID 1.1 nonces in the return_to URL
  36.      */
  37.     const RETURN_TO_NONCE = 'openid.1_1_nonce';
  38.  
  39.     /**
  40.      * The OP Endoint URL a nonce is associated with
  41.      * 
  42.      * @var string 
  43.      */
  44.     protected $opEndpointURL = null;
  45.  
  46.     /**
  47.      * Default clock skew, i.e. how long in the past we're willing to allow for.
  48.      * 
  49.      * @var int 
  50.      * @see validate()
  51.      */
  52.     protected $clockSkew = 18000;
  53.  
  54.     /**
  55.      * Sets the OP endpoint URL, and optionally the clock skew and custom storage
  56.      * driver.
  57.      * 
  58.      * @param string $opEndpointURL OP Endpoint URL
  59.      * @param int    $clockSkew     How many seconds old can a
  60.      *                               nonce be?
  61.      * 
  62.      * @return void 
  63.      */
  64.     public function __construct($opEndpointURL,
  65.                                 $clockSkew = null)
  66.     {
  67.         $this->opEndpointURL = $opEndpointURL;
  68.  
  69.         if ($clockSkew) {
  70.             $this->clockSkew = $clockSkew;
  71.         }
  72.     }
  73.  
  74.     /**
  75.      * Checks to see if the response nonce has been seen before.  If not, store it
  76.      * and then validate its syntax
  77.      * 
  78.      * @param string $nonce The nonce from the OP response
  79.      * 
  80.      * @return bool true on success, false on failure
  81.      */
  82.     public function verifyResponseNonce($nonce)
  83.     {
  84.         // See if it is already stored
  85.         if (OpenID::getStore()->getNonce($nonce, $this->opEndpointURL) !== false) {
  86.             return false;
  87.         }
  88.         // Store it
  89.         OpenID::getStore()->setNonce($nonce, $this->opEndpointURL);
  90.  
  91.         return $this->validate($nonce);
  92.     }
  93.  
  94.     /**
  95.      * Validates the syntax of a nonce, as well as checks to see if its timestamp is
  96.      * within the allowed clock skew
  97.      * 
  98.      * @param mixed $nonce The nonce to validate
  99.      * 
  100.      * @return bool true on success, false on failure
  101.      * @see $clockSkew
  102.      */
  103.     public function validate($nonce)
  104.     {
  105.         if (strlen($nonce) > 255) {
  106.             return false;
  107.         }
  108.  
  109.         $result = preg_match('/(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)Z(.*)/',
  110.                              $nonce,
  111.                              $matches);
  112.         if ($result != 1 || count($matches) != 8) {
  113.             return false;
  114.         }
  115.  
  116.         $stamp = gmmktime($matches[4],
  117.                           $matches[5],
  118.                           $matches[6],
  119.                           $matches[2],
  120.                           $matches[3],
  121.                           $matches[1]);
  122.  
  123.         $time = time();
  124.         if ($stamp < ($time - $this->clockSkew)
  125.             || $stamp > ($time + $this->clockSkew)) {
  126.  
  127.             return false;
  128.         }
  129.  
  130.         return true;
  131.     }
  132.  
  133.     /**
  134.      * Creates a nonce, but does not store it.  You may specify the lenth of the
  135.      * random string, as well as the time stamp to use.
  136.      * 
  137.      * @param int $length Lenth of the random string, defaults to 6
  138.      * @param int $time   A unix timestamp in seconds
  139.      * 
  140.      * @return string The nonce
  141.      * @see createNonceAndStore()
  142.      */
  143.     public function createNonce($length = 6, $time = null)
  144.     {
  145.         $time = ($time === null) ? time() : $time;
  146.  
  147.         $nonce = gmstrftime('%Y-%m-%dT%H:%M:%SZ', $time);
  148.         if ($length < 1) {
  149.             return $nonce;
  150.         }
  151.  
  152.         $length = (int) $length;
  153.         $chars  = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
  154.         $chars .= 'abcdefghijklmnopqrstuvwxyz';
  155.         $chars .= '1234567890';
  156.  
  157.         $unique = '';
  158.         for ($i = 0; $i < $length; $i++) {
  159.             $unique .= substr($chars, (rand() % (strlen($chars))), 1);
  160.         }
  161.  
  162.         return $nonce . $unique;
  163.     }
  164.  
  165.     /**
  166.      * Creates a nonce and also stores it.
  167.      * 
  168.      * @param int $length Lenth of the random string, defaults to 6
  169.      * @param int $time   A unix timestamp in seconds
  170.      * 
  171.      * @return string The nonce
  172.      * @see createNonce()
  173.      */
  174.     public function createNonceAndStore($length = 6, $time = null)
  175.     {
  176.         $nonce = $this->createNonce($length, $time);
  177.         OpenID::getStore()->setNonce($nonce, $this->opEndpointURL);
  178.         return $nonce;
  179.     }
  180. }
  181.  
  182. ?>

Documentation generated on Tue, 15 Dec 2009 19:00:56 -0800 by phpDocumentor 1.4.3