plugins/OStatus/classes/Magicsig.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 require_once 'Crypt/RSA.php';
  31
  32 class Magicsig extends Memcached_DataObject
  33 {
  34
  35     const PUBLICKEYREL = 'magic-public-key';
  36
  37     public $__table = 'magicsig';
  38
  39     public $user_id;
  40     public $keypair;
  41     public $alg;
  42
  43     private $_rsa;
  44
  45     public function __construct($alg = 'RSA-SHA256')
  46     {
  47         $this->alg = $alg;
  48     }
  49
  50     public /*static*/ function staticGet($k, $v=null)
  51     {
  52         $obj =  parent::staticGet(__CLASS__, $k, $v);
  53         if (!empty($obj)) {
  54             return Magicsig::fromString($obj->keypair);
  55         }
  56
  57         return $obj;
  58     }
  59
  60     function table()
  61     {
  62         return array(
  63             'user_id' => DB_DATAOBJECT_INT,
  64             'keypair' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  65             'alg'     => DB_DATAOBJECT_STR
  66         );
  67     }
  68
  69     static function schemaDef()
  70     {
  71         return array(new ColumnDef('user_id', 'integer',
  72                                    null, true, 'PRI'),
  73                      new ColumnDef('keypair', 'varchar',
  74                                    255, false),
  75                      new ColumnDef('alg', 'varchar',
  76                                    64, false));
  77     }
  78
  79     function keys()
  80     {
  81         return array_keys($this->keyTypes());
  82     }
  83
  84     function keyTypes()
  85     {
  86         return array('user_id' => 'K');
  87     }
  88
  89     function sequenceKey() {
  90         return array(false, false, false);
  91     }
  92
  93     function insert()
  94     {
  95         $this->keypair = $this->toString();
  96
  97         return parent::insert();
  98     }
  99
 100     public function generate($user_id, $key_length = 512)
 101     {
 102         PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
 103
 104         $keypair = new Crypt_RSA_KeyPair($key_length);
 105         $params['public_key'] = $keypair->getPublicKey();
 106         $params['private_key'] = $keypair->getPrivateKey();
 107
 108         $this->_rsa = new Crypt_RSA($params);
 109         PEAR::popErrorHandling();
 110
 111         $this->user_id = $user_id;
 112         $this->insert();
 113     }
 114
 115     public function toString($full_pair = true)
 116     {
 117         $public_key = $this->_rsa->_public_key;
 118         $private_key = $this->_rsa->_private_key;
 119
 120         $mod = base64_url_encode($public_key->getModulus());
 121         $exp = base64_url_encode($public_key->getExponent());
 122         $private_exp = '';
 123         if ($full_pair && $private_key->getExponent()) {
 124             $private_exp = '.' . base64_url_encode($private_key->getExponent());
 125         }
 126
 127         return 'RSA.' . $mod . '.' . $exp . $private_exp;
 128     }
 129
 130     public static function fromString($text)
 131     {
 132         PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
 133
 134         $magic_sig = new Magicsig();
 135
 136         // remove whitespace
 137         $text = preg_replace('/\s+/', '', $text);
 138
 139         // parse components
 140         if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $text, $matches)) {
 141             return false;
 142         }
 143
 144         $mod = base64_url_decode($matches[1]);
 145         $exp = base64_url_decode($matches[2]);
 146         if ($matches[4]) {
 147             $private_exp = base64_url_decode($matches[4]);
 148         }
 149
 150         $params['public_key'] = new Crypt_RSA_KEY($mod, $exp, 'public');
 151         if ($params['public_key']->isError()) {
 152             $error = $params['public_key']->getLastError();
 153             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 154             return false;
 155         }
 156         if ($private_exp) {
 157             $params['private_key'] = new Crypt_RSA_KEY($mod, $private_exp, 'private');
 158             if ($params['private_key']->isError()) {
 159                 $error = $params['private_key']->getLastError();
 160                 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 161                 return false;
 162             }
 163         }
 164
 165         $magic_sig->_rsa = new Crypt_RSA($params);
 166         PEAR::popErrorHandling();
 167
 168         return $magic_sig;
 169     }
 170
 171     public function getName()
 172     {
 173         return $this->alg;
 174     }
 175
 176     public function getHash()
 177     {
 178         switch ($this->alg) {
 179
 180         case 'RSA-SHA256':
 181             return 'sha256';
 182         }
 183
 184     }
 185
 186     public function sign($bytes)
 187     {
 188         $sig = $this->_rsa->createSign($bytes, null, 'magicsig_sha256');
 189         if ($this->_rsa->isError()) {
 190             $error = $this->_rsa->getLastError();
 191             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 192             return false;
 193         }
 194
 195         return $sig;
 196     }
 197
 198     public function verify($signed_bytes, $signature)
 199     {
 200         $result =  $this->_rsa->validateSign($signed_bytes, $signature, null, 'magicsig_sha256');
 201         if ($this->_rsa->isError()) {
 202             $error = $this->keypair->getLastError();
 203             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 204             return false;
 205         }
 206         return $result;
 207     }
 208
 209 }
 210
 211 // Define a sha256 function for hashing
 212 // (Crypt_RSA should really be updated to use hash() )
 213 function magicsig_sha256($bytes)
 214 {
 215     return hash('sha256', $bytes);
 216 }
 217
 218 function base64_url_encode($input)
 219 {
 220     return strtr(base64_encode($input), '+/', '-_');
 221 }
 222
 223 function base64_url_decode($input)
 224 {
 225     return base64_decode(strtr($input, '-_', '+/'));
 226 }