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         return parent::staticGet(__CLASS__, $k, $v);
  53     }
  54
  55
  56     function table()
  57     {
  58         return array(
  59             'user_id' => DB_DATAOBJECT_INT,
  60             'keypair' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  61             'alg'     => DB_DATAOBJECT_STR
  62         );
  63     }
  64
  65     static function schemaDef()
  66     {
  67         return array(new ColumnDef('user_id', 'integer',
  68                                    null, true, 'PRI'),
  69                      new ColumnDef('keypair', 'varchar',
  70                                    255, false),
  71                      new ColumnDef('alg', 'varchar',
  72                                    64, false));
  73     }
  74
  75
  76     function keys()
  77     {
  78         return array_keys($this->keyTypes());
  79     }
  80
  81     function keyTypes()
  82     {
  83         return array('user_id' => 'K');
  84     }
  85
  86     function insert()
  87     {
  88         $this->keypair = $this->toString();
  89
  90         return parent::insert();
  91     }
  92
  93     public function generate($key_length = 512)
  94     {
  95         PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
  96
  97         $keypair = new Crypt_RSA_KeyPair($key_length);
  98         $params['public_key'] = $keypair->getPublicKey();
  99         $params['private_key'] = $keypair->getPrivateKey();
 100
 101         $this->_rsa = new Crypt_RSA($params);
 102         PEAR::popErrorHandling();
 103
 104         $this->insert();
 105     }
 106
 107
 108     public function toString($full_pair = true)
 109     {
 110         $public_key = $this->_rsa->_public_key;
 111         $private_key = $this->_rsa->_private_key;
 112
 113         $mod = base64_url_encode($public_key->getModulus());
 114         $exp = base64_url_encode($public_key->getExponent());
 115         $private_exp = '';
 116         if ($full_pair && $private_key->getExponent()) {
 117             $private_exp = '.' . base64_url_encode($private_key->getExponent());
 118         }
 119
 120         return 'RSA.' . $mod . '.' . $exp . $private_exp;
 121     }
 122
 123     public static function fromString($text)
 124     {
 125         PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
 126
 127         $magic_sig = new Magicsig();
 128
 129         // remove whitespace
 130         $text = preg_replace('/\s+/', '', $text);
 131
 132         // parse components
 133         if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $text, $matches)) {
 134             return false;
 135         }
 136
 137         $mod = base64_url_decode($matches[1]);
 138         $exp = base64_url_decode($matches[2]);
 139         if ($matches[4]) {
 140             $private_exp = base64_url_decode($matches[4]);
 141         }
 142
 143         $params['public_key'] = new Crypt_RSA_KEY($mod, $exp, 'public');
 144         if ($params['public_key']->isError()) {
 145             $error = $params['public_key']->getLastError();
 146             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 147             return false;
 148         }
 149         if ($private_exp) {
 150             $params['private_key'] = new Crypt_RSA_KEY($mod, $private_exp, 'private');
 151             if ($params['private_key']->isError()) {
 152                 $error = $params['private_key']->getLastError();
 153                 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 154                 return false;
 155             }
 156         }
 157
 158         $magic_sig->_rsa = new Crypt_RSA($params);
 159         PEAR::popErrorHandling();
 160
 161         return $magic_sig;
 162     }
 163
 164     public function getName()
 165     {
 166         return $this->alg;
 167     }
 168
 169     public function getHash()
 170     {
 171         switch ($this->alg) {
 172
 173         case 'RSA-SHA256':
 174             return 'sha256';
 175         }
 176
 177     }
 178
 179     public function sign($bytes)
 180     {
 181         $sig = $this->_rsa->createSign($bytes, null, 'sha256');
 182         if ($this->_rsa->isError()) {
 183             $error = $this->_rsa->getLastError();
 184             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 185             return false;
 186         }
 187
 188         return $sig;
 189     }
 190
 191     public function verify($signed_bytes, $signature)
 192     {
 193         $result =  $this->_rsa->validateSign($signed_bytes, $signature, null, 'sha256');
 194         if ($this->_rsa->isError()) {
 195             $error = $this->keypair->getLastError();
 196             common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
 197             return false;
 198         }
 199         return $result;
 200     }
 201
 202 }
 203
 204 // Define a sha256 function for hashing
 205 // (Crypt_RSA should really be updated to use hash() )
 206 function sha256($bytes)
 207 {
 208     return hash('sha256', $bytes);
 209 }
 210
 211 function base64_url_encode($input)
 212 {
 213     return strtr(base64_encode($input), '+/', '-_');
 214 }
 215
 216 function base64_url_decode($input)
 217 {
 218     return base64_decode(strtr($input, '-_', '+/'));
 219 }