]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Magicsig.php
Merge branch 'fixtests' into 'nightly'
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Magicsig.php
index 7c249920a9a08c0ed0122359074579d77a323e2c..0a0fd2e067f94be8f29ccf587883a9871a7ce7ce 100644 (file)
  * @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';
 
     /**
@@ -49,7 +48,7 @@ class Magicsig extends Managed_DataObject
     /**
      * 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
      */
@@ -65,18 +64,18 @@ class Magicsig extends Managed_DataObject
     /**
      * 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;
     }
@@ -92,7 +91,7 @@ class Magicsig extends Managed_DataObject
     {
         $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
@@ -132,7 +131,7 @@ class Magicsig extends Managed_DataObject
      */
     function insert()
     {
-        $this->keypair = $this->toString();
+        $this->keypair = $this->toString(true);
 
         return parent::insert();
     }
@@ -143,45 +142,72 @@ 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.
      *
+     * 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 $user, $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);
 
-        $this->privateKey = new Crypt_RSA();
-        $this->privateKey->loadKey($keypair['privatekey']);
+        $magicsig->privateKey = new \phpseclib\Crypt\RSA();
+        $magicsig->privateKey->load($keypair['privatekey']);
 
-        $this->publicKey = new Crypt_RSA();
-        $this->publicKey->loadKey($keypair['publickey']);
+        $magicsig->publicKey = new \phpseclib\Crypt\RSA();
+        $magicsig->publicKey->load($keypair['publickey']);
 
-        $this->user_id = $user->id;
-        $this->insert();
+        $magicsig->insert();        // will do $this->keypair = $this->toString(true);
+        $magicsig->importKeys();    // seems it's necessary to re-read keys from text keypair
+
+        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;
     }
 
+    public function toFingerprint()
+    {
+        // 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)));
+    }
+
+    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
      */
@@ -210,23 +236,20 @@ class Magicsig extends Managed_DataObject
     }
 
     /**
-     * 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->setSignatureMode(CRYPT_RSA_SIGNATURE_PKCS1);
+        $rsa = new \phpseclib\Crypt\RSA();
         $rsa->setHash($this->getHash());
-        $rsa->modulus = new Math_BigInteger(Magicsig::base64_url_decode($mod), 256);
+        $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;
@@ -235,6 +258,15 @@ class Magicsig extends Managed_DataObject
         }
     }
 
+    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.
      *
@@ -268,7 +300,7 @@ class Magicsig extends Managed_DataObject
      */
     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');
         }
@@ -284,7 +316,7 @@ class Magicsig extends Managed_DataObject
     public function verify($signed_bytes, $signature)
     {
         $signature = self::base64_url_decode($signature);
-        return $this->publicKey->verify($signed_bytes, $signature);
+        return $this->publicKey->verify($signed_bytes, $signature, \phpseclib\Crypt\RSA::PADDING_PKCS1);
     }
 
     /**