Source for file DiffieHellman.php

Documentation is available at DiffieHellman.php

  1. <?php
  2. /**
  3.  * OpenID_Association_DiffieHellman
  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. require_once 'Crypt/DiffieHellman.php';
  16. require_once 'OpenID/Association/Exception.php';
  17. require_once 'OpenID/Message.php';
  18.  
  19. /**
  20.  * OpenID_Association_DiffieHellman
  21.  * 
  22.  * Segregates the DiffieHellman specific parts of an association request.  This is
  23.  * aimed at folks that don't want to use DH for associations.
  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_Association_DiffieHellman
  33. {
  34.     /**
  35.      * DiffieHellman specific constants
  36.      */
  37.     const DH_DEFAULT_MODULUS = '155172898181473697471232257763715539915724801966915404479707795314057629378541917580651227423698188993727816152646631438561595825688188889951272158842675419950341258706556549803580104870537681476726513255747040765857479291291572334510643245094715007229621094194349783925984760375594985848253359305585439638443';
  38.  
  39.     const DH_DEFAULT_GENERATOR = '2';
  40.  
  41.     /**
  42.      * The OpenID_Message being used in the request
  43.      * 
  44.      * @var OpenID_Message 
  45.      */
  46.     protected $message = null;
  47.  
  48.     /**
  49.      * The instance of Crypt_DiffieHellman.  May be passed into the constructor if
  50.      * you want to use custom keys.
  51.      * 
  52.      * @var Crypt_DiffieHellman 
  53.      */
  54.     protected $cdh = null;
  55.  
  56.     /**
  57.      * Whether or not the sharedSecretKey has been computed or not
  58.      * 
  59.      * @see getSharedSecretKey()
  60.      * @var int 
  61.      */
  62.     protected $sharedKeyComputed = 0;
  63.  
  64.     /**
  65.      * Sets the instance of OpenID_Message being used, and also an optional
  66.      * instance of Crypt_DiffieHellman
  67.      * 
  68.      * @param OpenID_Message      $message The request OpenID_Message
  69.      * @param Crypt_DiffieHellman $cdh     Optional instance of Crypt_DiffieHellman
  70.      * 
  71.      * @return void 
  72.      */
  73.     public function __construct(OpenID_Message $message, $cdh = null)
  74.     {
  75.         $this->message = $message;
  76.         if ($cdh instanceof Crypt_DiffieHellman) {
  77.             $this->cdh = $cdh;
  78.         }
  79.     }
  80.  
  81.     /**
  82.      * Initialize the diffie-hellman parameters for the association request.
  83.      * 
  84.      * @return void 
  85.      */
  86.     public function init()
  87.     {
  88.         if ($this->cdh === null) {
  89.             $this->cdh = new Crypt_DiffieHellman(self::DH_DEFAULT_MODULUS,
  90.                                                 self::DH_DEFAULT_GENERATOR);
  91.             $this->cdh->generateKeys();
  92.         }
  93.  
  94.         // Set public key
  95.         $this->message->set('openid.dh_consumer_public',
  96.             base64_encode($this->cdh->getPublicKey(Crypt_DiffieHellman::BTWOC)));
  97.  
  98.         // Set modulus
  99.         $prime = $this->cdh->getPrime(Crypt_DiffieHellman::BTWOC);
  100.         $this->message->set('openid.dh_modulus', base64_encode($prime));
  101.  
  102.         // Set prime
  103.         $gen = $this->cdh->getGenerator(Crypt_DiffieHellman::BTWOC);
  104.         $this->message->set('openid.dh_gen', base64_encode($gen));
  105.     }
  106.  
  107.     /**
  108.      * Gets the shared secret out of a response
  109.      * 
  110.      * @param array $response The response in array format
  111.      * @param array &$params  The parameters being build for
  112.      *                         OpenID_Association_Reqequest::buildAssociation()
  113.      * 
  114.      * @return void 
  115.      */
  116.     public function getSharedSecret(array $response, array &$params)
  117.     {
  118.         if (!isset($response['dh_server_public'])) {
  119.             throw new OpenID_Association_Exception(
  120.                 'Missing dh_server_public parameter in association response'
  121.             );
  122.         }
  123.  
  124.         $pubKey       = base64_decode($response['dh_server_public']);
  125.         $sharedSecret = $this->getSharedSecretKey($pubKey);
  126.  
  127.         $opSecret       = base64_decode($response['enc_mac_key']);
  128.         $bytes          = mb_strlen(bin2hex($opSecret), '8bit') / 2;
  129.         $algo           = str_replace('HMAC-', '', $params['assocType']);
  130.         $hash_dh_shared = hash($algo, $sharedSecret, true);
  131.  
  132.         $xsecret = '';
  133.         for ($i = 0; $i < $bytes; $i++) {
  134.             $xsecret .= chr(ord($opSecret[$i]) ^ ord($hash_dh_shared[$i]));
  135.         }
  136.  
  137.         $params['sharedSecret'] = base64_encode($xsecret);
  138.     }
  139.  
  140.     /**
  141.      * Gets the shared secret key in BTWOC format.  Computes the key if it has not
  142.      * been computed already.
  143.      * 
  144.      * @param string $publicKey Public key of the OP
  145.      * 
  146.      * @return BTWOC representation of the number
  147.      */
  148.     public function getSharedSecretKey($publicKey)
  149.     {
  150.         if ($this->sharedKeyComputed == 0) {
  151.             $this->cdh->computeSecretKey($publicKey, Crypt_DiffieHellman::BINARY);
  152.             $this->sharedKeyComputed = 1;
  153.         }
  154.         return $this->cdh->getSharedSecretKey(Crypt_DiffieHellman::BTWOC);
  155.     } 
  156. }
  157. ?>

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