]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Magicsig.php
Merge branch 'utf8mb4' into nightly
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Magicsig.php
index 2b131a73dbea6fe4c0a25b2e4ddf56cc3e39cbdd..8d2bb4eac97b8d3a0e6ba2d8a91417de30fb54ef 100644 (file)
@@ -36,6 +36,10 @@ require_once 'Crypt/RSA.php';
 class Magicsig extends Managed_DataObject
 {
     const PUBLICKEYREL = 'magic-public-key';
+    const DIASPORA_PUBLICKEYREL = 'diaspora-public-key';
+
+    const DEFAULT_KEYLEN = 1024;
+    const DEFAULT_SIGALG = 'RSA-SHA256';
 
     public $__table = 'magicsig';
 
@@ -76,7 +80,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 +136,7 @@ class Magicsig extends Managed_DataObject
      */
     function insert()
     {
-        $this->keypair = $this->toString();
+        $this->keypair = $this->toString(true);
 
         return parent::insert();
     }
@@ -143,71 +147,68 @@ 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);
 
-        $rsa->loadKey($keypair['privatekey']);
+        $magicsig->privateKey = new Crypt_RSA();
+        $magicsig->privateKey->loadKey($keypair['privatekey']);
 
-        $this->privateKey = new Crypt_RSA();
-        $this->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)
     {
         $mod = Magicsig::base64_url_encode($this->publicKey->modulus->toBytes());
         $exp = Magicsig::base64_url_encode($this->publicKey->exponent->toBytes());
         $private_exp = '';
-        if ($full_pair && $this->privateKey->exponent->toBytes()) {
+        if ($full_pair && $this->privateKey instanceof Crypt_RSA && $this->privateKey->exponent->toBytes()) {
             $private_exp = '.' . Magicsig::base64_url_encode($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 exportPublicKey($format=CRYPT_RSA_PUBLIC_FORMAT_PKCS1)
     {
-        $magic_sig = new Magicsig();
-
-        // remove whitespace
-        $magic_sig->keypair = preg_replace('/\s+/', '', $text);
-        $magic_sig->importKeys();
-
-        // Please note this object will be missing the user_id field
-        return $magic_sig;
+        $this->publicKey->setPublicKey();
+        return $this->publicKey->getPublicKey($format);
     }
 
     /**
      * importKeys will load the object's keypair string, which initiates
      * loadKey() and configures 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.');
         }
@@ -236,11 +237,9 @@ 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->setHash('sha256');
+        $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());
         $rsa->exponent = new Math_BigInteger(Magicsig::base64_url_decode($exp), 256);
@@ -266,15 +265,14 @@ class Magicsig extends Managed_DataObject
      * 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');
     }
 
     /**
@@ -282,7 +280,7 @@ class Magicsig extends Managed_DataObject
      * 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)
     {
@@ -296,12 +294,12 @@ class Magicsig extends Managed_DataObject
     /**
      *
      * @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);
+        $signature = self::base64_url_decode($signature);
         return $this->publicKey->verify($signed_bytes, $signature);
     }