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 require_once 'Crypt/RSA.php';
32 class Magicsig extends Memcached_DataObject
35 const PUBLICKEYREL = 'magic-public-key';
37 public $__table = 'magicsig';
45 public function __construct($alg = 'RSA-SHA256')
50 public /*static*/ function staticGet($k, $v=null)
52 $obj = parent::staticGet(__CLASS__, $k, $v);
54 return Magicsig::fromString($obj->keypair);
64 'user_id' => DB_DATAOBJECT_INT,
65 'keypair' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
66 'alg' => DB_DATAOBJECT_STR
70 static function schemaDef()
72 return array(new ColumnDef('user_id', 'integer',
74 new ColumnDef('keypair', 'varchar',
76 new ColumnDef('alg', 'varchar',
83 return array_keys($this->keyTypes());
88 return array('user_id' => 'K');
91 function sequenceKey() {
92 return array(false, false, false);
97 $this->keypair = $this->toString();
99 return parent::insert();
102 public function generate($user_id, $key_length = 512)
104 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
106 $keypair = new Crypt_RSA_KeyPair($key_length);
107 $params['public_key'] = $keypair->getPublicKey();
108 $params['private_key'] = $keypair->getPrivateKey();
110 $this->_rsa = new Crypt_RSA($params);
111 PEAR::popErrorHandling();
113 $this->user_id = $user_id;
118 public function toString($full_pair = true)
120 $public_key = $this->_rsa->_public_key;
121 $private_key = $this->_rsa->_private_key;
123 $mod = base64_url_encode($public_key->getModulus());
124 $exp = base64_url_encode($public_key->getExponent());
126 if ($full_pair && $private_key->getExponent()) {
127 $private_exp = '.' . base64_url_encode($private_key->getExponent());
130 return 'RSA.' . $mod . '.' . $exp . $private_exp;
133 public static function fromString($text)
135 PEAR::pushErrorHandling(PEAR_ERROR_RETURN);
137 $magic_sig = new Magicsig();
140 $text = preg_replace('/\s+/', '', $text);
143 if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $text, $matches)) {
147 $mod = base64_url_decode($matches[1]);
148 $exp = base64_url_decode($matches[2]);
150 $private_exp = base64_url_decode($matches[4]);
153 $params['public_key'] = new Crypt_RSA_KEY($mod, $exp, 'public');
154 if ($params['public_key']->isError()) {
155 $error = $params['public_key']->getLastError();
156 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
160 $params['private_key'] = new Crypt_RSA_KEY($mod, $private_exp, 'private');
161 if ($params['private_key']->isError()) {
162 $error = $params['private_key']->getLastError();
163 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
168 $magic_sig->_rsa = new Crypt_RSA($params);
169 PEAR::popErrorHandling();
174 public function getName()
179 public function getHash()
181 switch ($this->alg) {
184 return 'magicsig_sha256';
189 public function sign($bytes)
191 $hash = $this->getHash();
192 $sig = $this->_rsa->createSign($bytes, null, $hash);
193 if ($this->_rsa->isError()) {
194 $error = $this->_rsa->getLastError();
195 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
202 public function verify($signed_bytes, $signature)
204 $hash = $this->getHash();
205 $result = $this->_rsa->validateSign($signed_bytes, $signature, null, $hash);
206 if ($this->_rsa->isError()) {
207 $error = $this->keypair->getLastError();
208 common_log(LOG_DEBUG, 'RSA Error: '. $error->getMessage());
216 // Define a sha256 function for hashing
217 // (Crypt_RSA should really be updated to use hash() )
218 function magicsig_sha256($bytes)
220 return hash('sha256', $bytes);
223 function base64_url_encode($input)
225 return strtr(base64_encode($input), '+/', '-_');
228 function base64_url_decode($input)
230 return base64_decode(strtr($input, '-_', '+/'));