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 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once 'Crypt/RSA.php';
  35
  36 class Magicsig extends Managed_DataObject
  37 {
  38     const PUBLICKEYREL = 'magic-public-key';
  39
  40     public $__table = 'magicsig';
  41
  42     /**
  43      * Key to user.id/profile.id for the local user whose key we're storing.
  44      *
  45      * @var int
  46      */
  47     public $user_id;
  48
  49     /**
  50      * Flattened string representation of the key pair; callers should
  51      * usually use $this->publicKey and $this->privateKey directly,
  52      * which hold live Crypt_RSA key objects.
  53      *
  54      * @var string
  55      */
  56     public $keypair;
  57
  58     /**
  59      * Crypto algorithm used for this key; currently only RSA-SHA256 is supported.
  60      *
  61      * @var string
  62      */
  63     public $alg;
  64
  65     /**
  66      * Public RSA key; gets serialized in/out via $this->keypair string.
  67      *
  68      * @var Crypt_RSA
  69      */
  70     public $publicKey;
  71
  72     /**
  73      * PrivateRSA key; gets serialized in/out via $this->keypair string.
  74      *
  75      * @var Crypt_RSA
  76      */
  77     public $privateKey;
  78
  79     public function __construct($alg = 'RSA-SHA256')
  80     {
  81         $this->alg = $alg;
  82     }
  83
  84     /**
  85      * Fetch a Magicsig object from the cache or database on a field match.
  86      *
  87      * @param string $k
  88      * @param mixed $v
  89      * @return Magicsig
  90      */
  91     static function getKV($k, $v=null)
  92     {
  93         $obj =  parent::getKV($k, $v);
  94         if ($obj instanceof Magicsig) {
  95             // Please note we're replacing the $obj
  96             // FIXME: There should be an import-key that modifies the fetched $obj
  97             $obj = Magicsig::fromString($obj->keypair);
  98
  99             // Never allow less than 1024 bit keys.
 100             // The only case these show up in would be imported or
 101             // legacy very-old-StatusNet generated keypairs.
 102             if (strlen($obj->publicKey->modulus->toBits()) < 1024) {
 103                 $obj->delete();
 104                 return false;
 105             }
 106         }
 107
 108         return $obj;
 109     }
 110
 111     public static function schemaDef()
 112     {
 113         return array(
 114             'fields' => array(
 115                 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user id'),
 116                 'keypair' => array('type' => 'text', 'description' => 'keypair text representation'),
 117                 'alg' => array('type' => 'varchar', 'length' => 64, 'description' => 'algorithm'),
 118             ),
 119             'primary key' => array('user_id'),
 120             'foreign keys' => array(
 121                 'magicsig_user_id_fkey' => array('user', array('user_id' => 'id')),
 122             ),
 123         );
 124     }
 125
 126     /**
 127      * Save this keypair into the database.
 128      *
 129      * Overloads default insert behavior to encode the live key objects
 130      * as a flat string for storage.
 131      *
 132      * @return mixed
 133      */
 134     function insert()
 135     {
 136         $this->keypair = $this->toString();
 137
 138         return parent::insert();
 139     }
 140
 141     /**
 142      * Generate a new keypair for a local user and store in the database.
 143      *
 144      * Warning: this can be very slow on systems without the GMP module.
 145      * Runtimes of 20-30 seconds are not unheard-of.
 146      *
 147      * @param int $user_id id of local user we're creating a key for
 148      */
 149     public function generate($user_id, $bits=1024)
 150     {
 151         $rsa = new Crypt_RSA();
 152
 153         $keypair = $rsa->createKey($bits);
 154
 155         $rsa->loadKey($keypair['privatekey']);
 156
 157         $this->privateKey = new Crypt_RSA();
 158         $this->privateKey->loadKey($keypair['privatekey']);
 159
 160         $this->publicKey = new Crypt_RSA();
 161         $this->publicKey->loadKey($keypair['publickey']);
 162
 163         $this->user_id = $user_id;
 164         $this->insert();
 165     }
 166
 167     /**
 168      * Encode the keypair or public key as a string.
 169      *
 170      * @param boolean $full_pair set to false to leave out the private key.
 171      * @return string
 172      */
 173     public function toString($full_pair = true)
 174     {
 175         $mod = Magicsig::base64_url_encode($this->publicKey->modulus->toBytes());
 176         $exp = Magicsig::base64_url_encode($this->publicKey->exponent->toBytes());
 177         $private_exp = '';
 178         if ($full_pair && $this->privateKey->exponent->toBytes()) {
 179             $private_exp = '.' . Magicsig::base64_url_encode($this->privateKey->exponent->toBytes());
 180         }
 181
 182         return 'RSA.' . $mod . '.' . $exp . $private_exp;
 183     }
 184
 185     /**
 186      * Decode a string representation of an RSA public key or keypair
 187      * as a Magicsig object which can be used to sign or verify.
 188      *
 189      * @param string $text
 190      * @return Magicsig
 191      */
 192     public static function fromString($text)
 193     {
 194         $magic_sig = new Magicsig();
 195
 196         // remove whitespace
 197         $text = preg_replace('/\s+/', '', $text);
 198
 199         // parse components
 200         if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $text, $matches)) {
 201             common_debug('Magicsig error: RSA key not found in provided string.');
 202             return false;
 203         }
 204
 205         $mod = $matches[1];
 206         $exp = $matches[2];
 207         if (!empty($matches[4])) {
 208             $private_exp = $matches[4];
 209         } else {
 210             $private_exp = false;
 211         }
 212
 213         $magic_sig->loadKey($mod, $exp, 'public');
 214         if ($private_exp) {
 215             $magic_sig->loadKey($mod, $private_exp, 'private');
 216         }
 217
 218         return $magic_sig;
 219     }
 220
 221     /**
 222      * Fill out $this->privateKey or $this->publicKey with a Crypt_RSA object
 223      * representing the give key (as mod/exponent pair).
 224      *
 225      * @param string $mod base64-encoded
 226      * @param string $exp base64-encoded exponent
 227      * @param string $type one of 'public' or 'private'
 228      */
 229     public function loadKey($mod, $exp, $type = 'public')
 230     {
 231         common_log(LOG_DEBUG, "Adding ".$type." key: (".$mod .', '. $exp .")");
 232
 233         $rsa = new Crypt_RSA();
 234         $rsa->signatureMode = CRYPT_RSA_SIGNATURE_PKCS1;
 235         $rsa->setHash('sha256');
 236         $rsa->modulus = new Math_BigInteger(Magicsig::base64_url_decode($mod), 256);
 237         $rsa->k = strlen($rsa->modulus->toBytes());
 238         $rsa->exponent = new Math_BigInteger(Magicsig::base64_url_decode($exp), 256);
 239
 240         if ($type == 'private') {
 241             $this->privateKey = $rsa;
 242         } else {
 243             $this->publicKey = $rsa;
 244         }
 245     }
 246
 247     /**
 248      * Returns the name of the crypto algorithm used for this key.
 249      *
 250      * @return string
 251      */
 252     public function getName()
 253     {
 254         return $this->alg;
 255     }
 256
 257     /**
 258      * Returns the name of a hash function to use for signing with this key.
 259      *
 260      * @return string
 261      * @fixme is this used? doesn't seem to be called by name.
 262      */
 263     public function getHash()
 264     {
 265         switch ($this->alg) {
 266
 267         case 'RSA-SHA256':
 268             return 'sha256';
 269         }
 270     }
 271
 272     /**
 273      * Generate base64-encoded signature for the given byte string
 274      * using our private key.
 275      *
 276      * @param string $bytes as raw byte string
 277      * @return string base64-encoded signature
 278      */
 279     public function sign($bytes)
 280     {
 281         $sig = $this->privateKey->sign($bytes);
 282         if ($sig === false) {
 283             throw new ServerException('Could not sign data');
 284         }
 285         return Magicsig::base64_url_encode($sig);
 286     }
 287
 288     /**
 289      *
 290      * @param string $signed_bytes as raw byte string
 291      * @param string $signature as base64
 292      * @return boolean
 293      */
 294     public function verify($signed_bytes, $signature)
 295     {
 296         $signature = Magicsig::base64_url_decode($signature);
 297         return $this->publicKey->verify($signed_bytes, $signature);
 298     }
 299
 300     /**
 301      * URL-encoding-friendly base64 variant encoding.
 302      *
 303      * @param string $input
 304      * @return string
 305      */
 306     public static function base64_url_encode($input)
 307     {
 308         return strtr(base64_encode($input), '+/', '-_');
 309     }
 310
 311     /**
 312      * URL-encoding-friendly base64 variant decoding.
 313      *
 314      * @param string $input
 315      * @return string
 316      */
 317     public static function base64_url_decode($input)
 318     {
 319         return base64_decode(strtr($input, '-_', '+/'));
 320     }
 321 }