Merge branch 'nightly' into deletenotice_form_fix

[quix0rs-gnu-social.git] / plugins / OStatus / classes / Magicsig.php

diff --git a/plugins/OStatus/classes/Magicsig.php b/plugins/OStatus/classes/Magicsig.php
index b240dfd098a38ecb310ea56b51958a6ff4946ee8..890f525862ead99c7aa997a7f9b3fcbc70d1b27e 100644 (file)
--- a/plugins/OStatus/classes/Magicsig.php
+++ b/plugins/OStatus/classes/Magicsig.php
@@ -37,6 +37,9 @@ class Magicsig extends Managed_DataObject
 {
     const PUBLICKEYREL = 'magic-public-key';
 
+    const DEFAULT_KEYLEN = 1024;
+    const DEFAULT_SIGALG = 'RSA-SHA256';
+
     public $__table = 'magicsig';
 
     /**
@@ -76,7 +79,7 @@ class Magicsig extends Managed_DataObject
      */
     public $privateKey;
 
-    public function __construct($alg = 'RSA-SHA256')
+    public function __construct($alg=self::DEFAULT_SIGALG)
     {
         $this->alg = $alg;
     }
@@ -132,7 +135,7 @@ class Magicsig extends Managed_DataObject
      */
     function insert()
     {
-        $this->keypair = $this->toString();
+        $this->keypair = $this->toString(true);
 
         return parent::insert();
     }
@@ -143,59 +146,67 @@ class Magicsig extends Managed_DataObject
      * 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)
     {
+        $magicsig = new Magicsig($alg);
+        $magicsig->user_id = $user->id;
+
         $rsa = new Crypt_RSA();
 
         $keypair = $rsa->createKey($bits);
 
-        $this->privateKey = new Crypt_RSA();
-        $this->privateKey->loadKey($keypair['privatekey']);
+        $magicsig->privateKey = new Crypt_RSA();
+        $magicsig->privateKey->loadKey($keypair['privatekey']);
+
+        $magicsig->publicKey = new Crypt_RSA();
+        $magicsig->publicKey->loadKey($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 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
-        $text = preg_replace('/\s+/', '', $text);
-        $magic_sig->importKeys($text);
+        // 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($format=CRYPT_RSA_PUBLIC_FORMAT_PKCS1)
+    {
+        $this->publicKey->setPublicKey();
+        return $this->publicKey->getPublicKey($format);
     }
 
     /**
@@ -206,10 +217,10 @@ class Magicsig extends Managed_DataObject
      */
     public function importKeys($keypair=null)
     {
-        $keypair = $keypair ?: $this->keypair;
+        $this->keypair = $keypair===null ? $this->keypair : preg_replace('/\s+/', '', $keypair);
 
         // parse components
-        if (!preg_match('/RSA\.([^\.]+)\.([^\.]+)(\.([^\.]+))?/', $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.');
         }
@@ -238,10 +249,8 @@ class Magicsig extends Managed_DataObject
      */
     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->setSignatureMode(CRYPT_RSA_SIGNATURE_PKCS1);
         $rsa->setHash($this->getHash());
         $rsa->modulus = new Math_BigInteger(Magicsig::base64_url_decode($mod), 256);
         $rsa->k = strlen($rsa->modulus->toBytes());