Merge remote-tracking branch 'upstream/master' into social-master

[quix0rs-gnu-social.git] / plugins / OStatus / lib / magicenvelope.php

diff --git a/plugins/OStatus/lib/magicenvelope.php b/plugins/OStatus/lib/magicenvelope.php
index 533cd7d201560c3e00cea17b748f3d35dcaed822..a057da515bdd84529361d29d063f71a9a3f0c7a1 100644 (file)
--- a/plugins/OStatus/lib/magicenvelope.php
+++ b/plugins/OStatus/lib/magicenvelope.php
@@ -78,14 +78,16 @@ class MagicEnvelope
      * @param boolean $discovery    Network discovery if no local cache?
      */
     public function getKeyPair(Profile $profile, $discovery=false) {
-        $magicsig = Magicsig::getKV('user_id', $profile->id);
+        if (!$profile->isLocal()) common_debug('Getting magic-public-key for non-local profile id=='.$profile->getID());
+        $magicsig = Magicsig::getKV('user_id', $profile->getID());
 
         if ($discovery && !$magicsig instanceof Magicsig) {
+            if (!$profile->isLocal()) common_debug('magic-public-key not found, will do discovery for profile id=='.$profile->getID());
             // Throws exception on failure, but does not try to _load_ the keypair string.
             $keypair = $this->discoverKeyPair($profile);
 
             $magicsig = new Magicsig();
-            $magicsig->user_id = $profile->id;
+            $magicsig->user_id = $profile->getID();
             $magicsig->importKeys($keypair);
             // save the public key for this profile in our database.
             // TODO: If the profile generates a new key remotely, we must be able to replace
@@ -113,28 +115,41 @@ class MagicEnvelope
     {
         $signer_uri = $profile->getUri();
         if (empty($signer_uri)) {
-            throw new ServerException(sprintf('Profile missing URI (id==%d)', $profile->id));
+            throw new ServerException(sprintf('Profile missing URI (id==%d)', $profile->getID()));
         }
 
         $disco = new Discovery();
 
         // Throws exception on lookup problems
-        $xrd = $disco->lookup($signer_uri);
+        try {
+            $xrd = $disco->lookup($signer_uri);
+        } catch (Exception $e) {
+            // Diaspora seems to require us to request the acct: uri
+            $xrd = $disco->lookup($profile->getAcctUri());
+        }
 
-        $link = $xrd->get(Magicsig::PUBLICKEYREL);
-        if (is_null($link)) {
-            // TRANS: Exception.
-            throw new Exception(_m('Unable to locate signer public key.'));
+        common_debug('Will try to find magic-public-key from XRD of profile id=='.$profile->getID());
+        $pubkey = null;
+        if (Event::handle('MagicsigPublicKeyFromXRD', array($xrd, &$pubkey))) {
+            $link = $xrd->get(Magicsig::PUBLICKEYREL);
+            if (is_null($link)) {
+                // TRANS: Exception.
+                throw new Exception(_m('Unable to locate signer public key.'));
+            }
+            $pubkey = $link->href;
+        }
+        if (empty($pubkey)) {
+            throw new ServerException('Empty Magicsig public key. A bug?');
         }
 
         // We have a public key element, let's hope it has proper key data.
         $keypair = false;
-        $parts = explode(',', $link->href);
+        $parts = explode(',', $pubkey);
         if (count($parts) == 2) {
             $keypair = $parts[1];
         } else {
             // Backwards compatibility check for separator bug in 0.9.0
-            $parts = explode(';', $link->href);
+            $parts = explode(';', $pubkey);
             if (count($parts) == 2) {
                 $keypair = $parts[1];
             }
@@ -205,18 +220,22 @@ class MagicEnvelope
      *
      * @return string representation of XML document
      */
-    public function toXML() {
+    public function toXML(Profile $target=null, $flavour=null) {
         $xs = new XMLStringer();
-        $xs->startXML();
-        $xs->elementStart('me:env', array('xmlns:me' => self::NS));
-        $xs->element('me:data', array('type' => $this->data_type), $this->data);
-        $xs->element('me:encoding', null, $this->encoding);
-        $xs->element('me:alg', null, $this->alg);
-        $xs->element('me:sig', null, $this->getSignature());
-        $xs->elementEnd('me:env');
-
-        $string =  $xs->getString();
-        return $string;
+        $xs->startXML();    // header, to point out it's not HTML or anything...
+        if (Event::handle('StartMagicEnvelopeToXML', array($this, $xs, $flavour, $target))) {
+            // fall back to our default, normal Magic Envelope XML.
+            // the $xs element _may_ have had elements added, or could get in the end event
+            $xs->elementStart('me:env', array('xmlns:me' => self::NS));
+            $xs->element('me:data', array('type' => $this->data_type), $this->data);
+            $xs->element('me:encoding', null, $this->encoding);
+            $xs->element('me:alg', null, $this->alg);
+            $xs->element('me:sig', null, $this->getSignature());
+            $xs->elementEnd('me:env');
+
+            Event::handle('EndMagicEnvelopeToXML', array($this, $xs, $flavour, $target));
+        }
+        return $xs->getString();
     }
 
     /*
@@ -262,9 +281,32 @@ class MagicEnvelope
 
     public function getSignature()
     {
+        if (empty($this->sig)) {
+            throw new ServerException('You must first call signMessage before getSignature');
+        }
         return $this->sig;
     }
 
+    public function getSignatureAlgorithm()
+    {
+        return $this->alg;
+    }
+
+    public function getData()
+    {
+        return $this->data;
+    }
+
+    public function getDataType()
+    {
+        return $this->data_type;
+    }
+
+    public function getEncoding()
+    {
+        return $this->encoding;
+    }
+
     /**
      * Find the author URI referenced in the payload Atom entry.
      *
@@ -298,19 +340,19 @@ class MagicEnvelope
     public function verify(Profile $profile)
     {
         if ($this->alg != 'RSA-SHA256') {
-            common_log(LOG_DEBUG, "Salmon error: bad algorithm");
+            common_debug("Salmon error: bad algorithm");
             return false;
         }
 
         if ($this->encoding != self::ENCODING) {
-            common_log(LOG_DEBUG, "Salmon error: bad encoding");
+            common_debug("Salmon error: bad encoding");
             return false;
         }
 
         try {
             $magicsig = $this->getKeyPair($profile, true);    // Do discovery too if necessary
         } catch (Exception $e) {
-            common_log(LOG_DEBUG, "Salmon error: ".$e->getMessage());
+            common_debug("Salmon error: ".$e->getMessage());
             return false;
         }