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     const PUBLICKEYREL = 'magic-public-key';
  35
  36     public $__table = 'magicsig';
  37
  38     public $user_id;
  39     public $keypair;
  40     public $alg;
  41
  42     public $publicKey;
  43     public $privateKey;
  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             $obj = Magicsig::fromString($obj->keypair);
  55
  56             // Double check keys: Crypt_RSA did not
  57             // consistently generate good keypairs.
  58             // We've also moved to 1024 bit keys.
  59             if (strlen($obj->publicKey->modulus->toBits()) != 1024) {
  60                 $obj->delete();
  61                 return false;
  62             }
  63         }
  64
  65         return $obj;
  66     }
  67
  68
  69     function table()
  70     {
  71         return array(
  72             'user_id' => DB_DATAOBJECT_INT,
  73             'keypair' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  74             'alg'     => DB_DATAOBJECT_STR
  75         );
  76     }
  77
  78     static function schemaDef()
  79     {
  80         return array(new ColumnDef('user_id', 'integer',
  81                                    null, false, 'PRI'),
  82                      new ColumnDef('keypair', 'text',
  83                                    false, false),
  84                      new ColumnDef('alg', 'varchar',
  85                                    64, false));
  86     }
  87
  88     function keys()
  89     {
  90         return array_keys($this->keyTypes());
  91     }
  92
  93     function keyTypes()
  94     {
  95         return array('user_id' => 'K');
  96     }
  97
  98     function sequenceKey() {
  99         return array(false, false, false);
 100     }
 101
 102     function insert()
 103     {
 104         $this->keypair = $this->toString();
 105
 106         return parent::insert();
 107     }
 108
 109     public function generate($user_id)
 110     {
 111         $rsa = new Crypt_RSA();
 112
 113         $keypair = $rsa->createKey();
 114
 115         $rsa->loadKey($keypair['privatekey']);
 116
 117         $this->privateKey = new Crypt_RSA();
 118         $this->privateKey->loadKey($keypair['privatekey']);
 119
 120         $this->publicKey = new Crypt_RSA();
 121         $this->publicKey->loadKey($keypair['publickey']);
 122
 123         $this->user_id = $user_id;
 124         $this->insert();
 125     }
 126
 127     public function toString($full_pair = true)
 128     {
 129         $mod = Magicsig::base64_url_encode($this->publicKey->modulus->toBytes());
 130         $exp = Magicsig::base64_url_encode($this->publicKey->exponent->toBytes());
 131         $private_exp = '';
 132         if ($full_pair && $this->privateKey->exponent->toBytes()) {
 133             $private_exp = '.' . Magicsig::base64_url_encode($this->privateKey->exponent->toBytes());
 134         }
 135
 136         return 'RSA.' . $mod . '.' . $exp . $private_exp;
 137     }
 138
 139     public static function fromString($text)
 140     {
 141         $magic_sig = new Magicsig();
 142
 143         // remove whitespace
 144         $text = preg_replace('/\s+/', '', $text);
 145
 146         // parse components
 147         if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $text, $matches)) {
 148             return false;
 149         }
 150
 151         $mod = $matches[1];
 152         $exp = $matches[2];
 153         if (!empty($matches[4])) {
 154             $private_exp = $matches[4];
 155         } else {
 156             $private_exp = false;
 157         }
 158
 159         $magic_sig->loadKey($mod, $exp, 'public');
 160         if ($private_exp) {
 161             $magic_sig->loadKey($mod, $private_exp, 'private');
 162         }
 163
 164         return $magic_sig;
 165     }
 166
 167     public function loadKey($mod, $exp, $type = 'public')
 168     {
 169         common_log(LOG_DEBUG, "Adding ".$type." key: (".$mod .', '. $exp .")");
 170
 171         $rsa = new Crypt_RSA();
 172         $rsa->signatureMode = CRYPT_RSA_SIGNATURE_PKCS1;
 173         $rsa->setHash('sha256');
 174         $rsa->modulus = new Math_BigInteger(Magicsig::base64_url_decode($mod), 256);
 175         $rsa->k = strlen($rsa->modulus->toBytes());
 176         $rsa->exponent = new Math_BigInteger(Magicsig::base64_url_decode($exp), 256);
 177
 178         if ($type == 'private') {
 179             $this->privateKey = $rsa;
 180         } else {
 181             $this->publicKey = $rsa;
 182         }
 183     }
 184
 185     public function getName()
 186     {
 187         return $this->alg;
 188     }
 189
 190     public function getHash()
 191     {
 192         switch ($this->alg) {
 193
 194         case 'RSA-SHA256':
 195             return 'sha256';
 196         }
 197     }
 198
 199     public function sign($bytes)
 200     {
 201         $sig = $this->privateKey->sign($bytes);
 202         return Magicsig::base64_url_encode($sig);
 203     }
 204
 205     public function verify($signed_bytes, $signature)
 206     {
 207         $signature = Magicsig::base64_url_decode($signature);
 208         return $this->publicKey->verify($signed_bytes, $signature);
 209     }
 210
 211
 212     public static function base64_url_encode($input)
 213     {
 214         return strtr(base64_encode($input), '+/', '-_');
 215     }
 216
 217     public static function base64_url_decode($input)
 218     {
 219         return base64_decode(strtr($input, '-_', '+/'));
 220     }
 221 }