3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * A sample module to show best practices for StatusNet plugins
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.
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.
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/>.
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/
30 if (!defined('GNUSOCIAL')) { exit(1); }
32 class Magicsig extends Managed_DataObject
34 const PUBLICKEYREL = 'magic-public-key';
36 const DEFAULT_KEYLEN = 1024;
37 const DEFAULT_SIGALG = 'RSA-SHA256';
39 public $__table = 'magicsig';
42 * Key to user.id/profile.id for the local user whose key we're storing.
49 * Flattened string representation of the key pair; callers should
50 * usually use $this->publicKey and $this->privateKey directly,
51 * which hold live \phpseclib\Crypt\RSA key objects.
58 * Crypto algorithm used for this key; currently only RSA-SHA256 is supported.
65 * Public RSA key; gets serialized in/out via $this->keypair string.
67 * @var \phpseclib\Crypt\RSA
72 * PrivateRSA key; gets serialized in/out via $this->keypair string.
74 * @var \phpseclib\Crypt\RSA
78 public function __construct($alg=self::DEFAULT_SIGALG)
84 * Fetch a Magicsig object from the cache or database on a field match.
90 static function getKV($k, $v=null)
92 $obj = parent::getKV($k, $v);
93 if ($obj instanceof Magicsig) {
94 $obj->importKeys(); // Loads \phpseclib\Crypt\RSA objects etc.
96 // Throw out a big fat warning for keys of less than 1024 bits. (
97 // The only case these show up in would be imported or
98 // legacy very-old-StatusNet generated keypairs.
99 if (strlen($obj->publicKey->modulus->toBits()) < 1024) {
100 common_log(LOG_WARNING, sprintf('Salmon key with <1024 bits (%d) belongs to profile with id==%d',
101 strlen($obj->publicKey->modulus->toBits()),
109 public static function schemaDef()
113 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user id'),
114 'keypair' => array('type' => 'text', 'description' => 'keypair text representation'),
115 'alg' => array('type' => 'varchar', 'length' => 64, 'description' => 'algorithm'),
117 'primary key' => array('user_id'),
118 'foreign keys' => array(
119 'magicsig_user_id_fkey' => array('profile', array('user_id' => 'id')),
125 * Save this keypair into the database.
127 * Overloads default insert behavior to encode the live key objects
128 * as a flat string for storage.
134 $this->keypair = $this->toString(true);
136 return parent::insert();
140 * Generate a new keypair for a local user and store in the database.
142 * Warning: this can be very slow on systems without the GMP module.
143 * Runtimes of 20-30 seconds are not unheard-of.
145 * FIXME: More than 1024 bits please. But StatusNet _discards_ non-1024 bits,
146 * so we'll have to wait the last mohican out before switching defaults.
148 * @param User $user the local user (since we don't have remote private keys)
150 public static function generate(User $user, $bits=self::DEFAULT_KEYLEN, $alg=self::DEFAULT_SIGALG)
152 $magicsig = new Magicsig($alg);
153 $magicsig->user_id = $user->id;
155 $rsa = new \phpseclib\Crypt\RSA();
157 $keypair = $rsa->createKey($bits);
159 $magicsig->privateKey = new \phpseclib\Crypt\RSA();
160 $magicsig->privateKey->loadKey($keypair['privatekey']);
162 $magicsig->publicKey = new \phpseclib\Crypt\RSA();
163 $magicsig->publicKey->loadKey($keypair['publickey']);
165 $magicsig->insert(); // will do $this->keypair = $this->toString(true);
166 $magicsig->importKeys(); // seems it's necessary to re-read keys from text keypair
172 * Encode the keypair or public key as a string.
174 * @param boolean $full_pair set to true to include the private key.
177 public function toString($full_pair=false, $base64url=true)
179 $base64_func = $base64url ? 'Magicsig::base64_url_encode' : 'base64_encode';
180 $mod = call_user_func($base64_func, $this->publicKey->modulus->toBytes());
181 $exp = call_user_func($base64_func, $this->publicKey->exponent->toBytes());
184 if ($full_pair && $this->privateKey instanceof \phpseclib\Crypt\RSA && $this->privateKey->exponent->toBytes()) {
185 $private_exp = '.' . call_user_func($base64_func, $this->privateKey->exponent->toBytes());
188 return 'RSA.' . $mod . '.' . $exp . $private_exp;
191 public function toFingerprint()
193 // This assumes a specific behaviour from toString, to format as such:
194 // "RSA." + base64(pubkey.modulus_as_bytes) + "." + base64(pubkey.exponent_as_bytes)
195 // We don't want the base64 string to be the "url encoding" version because it is not
196 // as common in programming libraries. And we want it to be base64 encoded since ASCII
197 // representation avoids any problems with NULL etc. in less forgiving languages and also
198 // just easier to debug...
199 return strtolower(hash('sha256', $this->toString(false, false)));
202 public function exportPublicKey($type='PKCS1')
204 $this->publicKey->setPublicKey();
205 return $this->publicKey->getPublicKey($type);
209 * importKeys will load the object's keypair string, which initiates
210 * loadKey() and configures \phpseclib\Crypt\RSA objects.
212 * @param string $keypair optional, otherwise the object's "keypair" property will be used
214 public function importKeys($keypair=null)
216 $this->keypair = $keypair===null ? $this->keypair : preg_replace('/\s+/', '', $keypair);
219 if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(\.([^\.]+))?/', $this->keypair, $matches)) {
220 common_debug('Magicsig error: RSA key not found in provided string.');
221 throw new ServerException('RSA key not found in keypair string.');
226 if (!empty($matches[4])) {
227 $private_exp = $matches[4];
229 $private_exp = false;
232 $this->loadKey($mod, $exp, 'public');
234 $this->loadKey($mod, $private_exp, 'private');
239 * Fill out $this->privateKey or $this->publicKey with a \phpseclib\Crypt\RSA object
240 * representing the give key (as mod/exponent pair).
242 * @param string $mod base64url-encoded
243 * @param string $exp base64url-encoded exponent
244 * @param string $type one of 'public' or 'private'
246 public function loadKey($mod, $exp, $type = 'public')
248 $rsa = new \phpseclib\Crypt\RSA();
249 $rsa->setHash($this->getHash());
250 $rsa->modulus = new \phpseclib\Math\BigInteger(Magicsig::base64_url_decode($mod), 256);
251 $rsa->k = strlen($rsa->modulus->toBytes());
252 $rsa->exponent = new \phpseclib\Math\BigInteger(Magicsig::base64_url_decode($exp), 256);
254 if ($type == 'private') {
255 $this->privateKey = $rsa;
257 $this->publicKey = $rsa;
261 public function loadPublicKeyPKCS1($key)
263 $rsa = new \phpseclib\Crypt\RSA();
264 if (!$rsa->setPublicKey($key, 'PKCS1')) {
265 throw new ServerException('Could not load PKCS1 public key. We probably got this from a remote Diaspora node as the profile public key.');
267 $this->publicKey = $rsa;
271 * Returns the name of the crypto algorithm used for this key.
275 public function getName()
281 * Returns the name of a hash function to use for signing with this key.
285 public function getHash()
287 switch ($this->alg) {
291 throw new ServerException('Unknown or unsupported hash algorithm for Salmon');
295 * Generate base64-encoded signature for the given byte string
296 * using our private key.
298 * @param string $bytes as raw byte string
299 * @return string base64url-encoded signature
301 public function sign($bytes)
303 $sig = $this->privateKey->sign($bytes, \phpseclib\Crypt\RSA::PADDING_PKCS1);
304 if ($sig === false) {
305 throw new ServerException('Could not sign data');
307 return Magicsig::base64_url_encode($sig);
312 * @param string $signed_bytes as raw byte string
313 * @param string $signature as base64url encoded
316 public function verify($signed_bytes, $signature)
318 $signature = self::base64_url_decode($signature);
319 return $this->publicKey->verify($signed_bytes, $signature);
323 * URL-encoding-friendly base64 variant encoding.
325 * @param string $input
328 public static function base64_url_encode($input)
330 return strtr(base64_encode($input), '+/', '-_');
334 * URL-encoding-friendly base64 variant decoding.
336 * @param string $input
339 public static function base64_url_decode($input)
341 return base64_decode(strtr($input, '-_', '+/'));