* @link http://status.net/
*/
-if (!defined('STATUSNET')) {
- exit(1);
-}
-
-require_once 'Crypt/RSA.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
class Magicsig extends Managed_DataObject
{
const PUBLICKEYREL = 'magic-public-key';
+ const DEFAULT_KEYLEN = 1024;
+ const DEFAULT_SIGALG = 'RSA-SHA256';
+
public $__table = 'magicsig';
/**
/**
* Flattened string representation of the key pair; callers should
* usually use $this->publicKey and $this->privateKey directly,
- * which hold live Crypt_RSA key objects.
+ * which hold live \phpseclib\Crypt\RSA key objects.
*
* @var string
*/
/**
* Public RSA key; gets serialized in/out via $this->keypair string.
*
- * @var Crypt_RSA
+ * @var \phpseclib\Crypt\RSA
*/
public $publicKey;
/**
* PrivateRSA key; gets serialized in/out via $this->keypair string.
*
- * @var Crypt_RSA
+ * @var \phpseclib\Crypt\RSA
*/
public $privateKey;
- public function __construct($alg = 'RSA-SHA256')
+ public function __construct($alg=self::DEFAULT_SIGALG)
{
$this->alg = $alg;
}
{
$obj = parent::getKV($k, $v);
if ($obj instanceof Magicsig) {
- $obj->importKeys(); // Loads Crypt_RSA objects etc.
+ $obj->importKeys(); // Loads \phpseclib\Crypt\RSA objects etc.
// Throw out a big fat warning for keys of less than 1024 bits. (
// The only case these show up in would be imported or
// legacy very-old-StatusNet generated keypairs.
if (strlen($obj->publicKey->modulus->toBits()) < 1024) {
common_log(LOG_WARNING, sprintf('Salmon key with <1024 bits (%d) belongs to profile with id==%d',
- strlen($this->publicKey->modulus->toBits()),
+ strlen($obj->publicKey->modulus->toBits()),
$obj->user_id));
}
}
*/
function insert()
{
- $this->keypair = $this->toString();
+ $this->keypair = $this->toString(true);
return parent::insert();
}
* Warning: this can be very slow on systems without the GMP module.
* Runtimes of 20-30 seconds are not unheard-of.
*
- * @param int $user_id id of local user we're creating a key for
+ * FIXME: More than 1024 bits please. But StatusNet _discards_ non-1024 bits,
+ * so we'll have to wait the last mohican out before switching defaults.
+ *
+ * @param User $user the local user (since we don't have remote private keys)
*/
- public function generate($user_id, $bits=1024)
+ public static function generate(User $user, $bits=self::DEFAULT_KEYLEN, $alg=self::DEFAULT_SIGALG)
{
- $rsa = new Crypt_RSA();
+ $magicsig = new Magicsig($alg);
+ $magicsig->user_id = $user->id;
+
+ $rsa = new \phpseclib\Crypt\RSA();
$keypair = $rsa->createKey($bits);
- $rsa->loadKey($keypair['privatekey']);
+ $magicsig->privateKey = new \phpseclib\Crypt\RSA();
+ $magicsig->privateKey->load($keypair['privatekey']);
- $this->privateKey = new Crypt_RSA();
- $this->privateKey->loadKey($keypair['privatekey']);
+ $magicsig->publicKey = new \phpseclib\Crypt\RSA();
+ $magicsig->publicKey->load($keypair['publickey']);
- $this->publicKey = new Crypt_RSA();
- $this->publicKey->loadKey($keypair['publickey']);
+ $magicsig->insert(); // will do $this->keypair = $this->toString(true);
+ $magicsig->importKeys(); // seems it's necessary to re-read keys from text keypair
- $this->user_id = $user_id;
- $this->insert();
+ return $magicsig;
}
/**
* Encode the keypair or public key as a string.
*
- * @param boolean $full_pair set to false to leave out the private key.
+ * @param boolean $full_pair set to true to include the private key.
* @return string
*/
- public function toString($full_pair = true)
+ public function toString($full_pair=false, $base64url=true)
{
- $mod = Magicsig::base64_url_encode($this->publicKey->modulus->toBytes());
- $exp = Magicsig::base64_url_encode($this->publicKey->exponent->toBytes());
+ $base64_func = $base64url ? 'Magicsig::base64_url_encode' : 'base64_encode';
+ $mod = call_user_func($base64_func, $this->publicKey->modulus->toBytes());
+ $exp = call_user_func($base64_func, $this->publicKey->exponent->toBytes());
+
$private_exp = '';
- if ($full_pair && $this->privateKey->exponent->toBytes()) {
- $private_exp = '.' . Magicsig::base64_url_encode($this->privateKey->exponent->toBytes());
+ if ($full_pair && $this->privateKey instanceof \phpseclib\Crypt\RSA && $this->privateKey->exponent->toBytes()) {
+ $private_exp = '.' . call_user_func($base64_func, $this->privateKey->exponent->toBytes());
}
return 'RSA.' . $mod . '.' . $exp . $private_exp;
}
- /**
- * Decode a string representation of an RSA public key or keypair
- * as a Magicsig object which can be used to sign or verify.
- *
- * @param string $text
- * @return Magicsig
- */
- public static function fromString($text)
+ public function toFingerprint()
{
- $magic_sig = new Magicsig();
-
- // remove whitespace
- $magic_sig->keypair = preg_replace('/\s+/', '', $text);
- $magic_sig->importKeys();
+ // This assumes a specific behaviour from toString, to format as such:
+ // "RSA." + base64(pubkey.modulus_as_bytes) + "." + base64(pubkey.exponent_as_bytes)
+ // We don't want the base64 string to be the "url encoding" version because it is not
+ // as common in programming libraries. And we want it to be base64 encoded since ASCII
+ // representation avoids any problems with NULL etc. in less forgiving languages and also
+ // just easier to debug...
+ return strtolower(hash('sha256', $this->toString(false, false)));
+ }
- // Please note this object will be missing the user_id field
- return $magic_sig;
+ public function exportPublicKey($type='PKCS1')
+ {
+ $this->publicKey->setPublicKey();
+ return $this->publicKey->getPublicKey($type);
}
/**
* importKeys will load the object's keypair string, which initiates
- * loadKey() and configures Crypt_RSA objects.
+ * loadKey() and configures \phpseclib\Crypt\RSA objects.
+ *
+ * @param string $keypair optional, otherwise the object's "keypair" property will be used
*/
- public function importKeys()
+ public function importKeys($keypair=null)
{
+ $this->keypair = $keypair===null ? $this->keypair : preg_replace('/\s+/', '', $keypair);
+
// parse components
- if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(.([^\.]+))?/', $this->keypair, $matches)) {
+ if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(\.([^\.]+))?/', $this->keypair, $matches)) {
common_debug('Magicsig error: RSA key not found in provided string.');
throw new ServerException('RSA key not found in keypair string.');
}
}
/**
- * Fill out $this->privateKey or $this->publicKey with a Crypt_RSA object
+ * Fill out $this->privateKey or $this->publicKey with a \phpseclib\Crypt\RSA object
* representing the give key (as mod/exponent pair).
*
- * @param string $mod base64-encoded
- * @param string $exp base64-encoded exponent
+ * @param string $mod base64url-encoded
+ * @param string $exp base64url-encoded exponent
* @param string $type one of 'public' or 'private'
*/
public function loadKey($mod, $exp, $type = 'public')
{
- common_log(LOG_DEBUG, "Adding ".$type." key: (".$mod .', '. $exp .")");
-
- $rsa = new Crypt_RSA();
- $rsa->signatureMode = CRYPT_RSA_SIGNATURE_PKCS1;
- $rsa->setHash('sha256');
- $rsa->modulus = new Math_BigInteger(Magicsig::base64_url_decode($mod), 256);
+ $rsa = new \phpseclib\Crypt\RSA();
+ $rsa->setHash($this->getHash());
+ $rsa->modulus = new \phpseclib\Math\BigInteger(Magicsig::base64_url_decode($mod), 256);
$rsa->k = strlen($rsa->modulus->toBytes());
- $rsa->exponent = new Math_BigInteger(Magicsig::base64_url_decode($exp), 256);
+ $rsa->exponent = new \phpseclib\Math\BigInteger(Magicsig::base64_url_decode($exp), 256);
if ($type == 'private') {
$this->privateKey = $rsa;
}
}
+ public function loadPublicKeyPKCS1($key)
+ {
+ $rsa = new \phpseclib\Crypt\RSA();
+ if (!$rsa->setPublicKey($key, 'PKCS1')) {
+ throw new ServerException('Could not load PKCS1 public key. We probably got this from a remote Diaspora node as the profile public key.');
+ }
+ $this->publicKey = $rsa;
+ }
+
/**
* Returns the name of the crypto algorithm used for this key.
*
* Returns the name of a hash function to use for signing with this key.
*
* @return string
- * @fixme is this used? doesn't seem to be called by name.
*/
public function getHash()
{
switch ($this->alg) {
-
case 'RSA-SHA256':
return 'sha256';
}
+ throw new ServerException('Unknown or unsupported hash algorithm for Salmon');
}
/**
* using our private key.
*
* @param string $bytes as raw byte string
- * @return string base64-encoded signature
+ * @return string base64url-encoded signature
*/
public function sign($bytes)
{
- $sig = $this->privateKey->sign($bytes);
+ $sig = $this->privateKey->sign($bytes, \phpseclib\Crypt\RSA::PADDING_PKCS1);
if ($sig === false) {
throw new ServerException('Could not sign data');
}
/**
*
* @param string $signed_bytes as raw byte string
- * @param string $signature as base64
+ * @param string $signature as base64url encoded
* @return boolean
*/
public function verify($signed_bytes, $signature)
{
- $signature = Magicsig::base64_url_decode($signature);
- return $this->publicKey->verify($signed_bytes, $signature);
+ $signature = self::base64_url_decode($signature);
+ return $this->publicKey->verify($signed_bytes, $signature, \phpseclib\Crypt\RSA::PADDING_PKCS1);
}
/**
projects / quix0rs-gnu-social.git / blobdiff