plugins/OStatus/lib/magicenvelope.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29 class MagicEnvelope
  30 {
  31     const ENCODING = 'base64url';
  32
  33     const NS = 'http://salmon-protocol.org/ns/magic-env';
  34
  35     private function normalizeUser($user_id)
  36     {
  37         if (substr($user_id, 0, 5) == 'http:' ||
  38             substr($user_id, 0, 6) == 'https:' ||
  39             substr($user_id, 0, 5) == 'acct:') {
  40             return $user_id;
  41         }
  42
  43         if (strpos($user_id, '@') !== FALSE) {
  44             return 'acct:' . $user_id;
  45         }
  46
  47         return 'http://' . $user_id;
  48     }
  49
  50     public function getKeyPair($signer_uri)
  51     {
  52         $disco = new Discovery();
  53
  54         try {
  55             $xrd = $disco->lookup($signer_uri);
  56         } catch (Exception $e) {
  57             return false;
  58         }
  59         if ($xrd->links) {
  60             if ($link = Discovery::getService($xrd->links, Magicsig::PUBLICKEYREL)) {
  61                 $keypair = false;
  62                 $parts = explode(',', $link['href']);
  63                 if (count($parts) == 2) {
  64                     $keypair = $parts[1];
  65                 } else {
  66                     // Backwards compatibility check for separator bug in 0.9.0
  67                     $parts = explode(';', $link['href']);
  68                     if (count($parts) == 2) {
  69                         $keypair = $parts[1];
  70                     }
  71                 }
  72
  73                 if ($keypair) {
  74                     return $keypair;
  75                 }
  76             }
  77         }
  78         // TRANS: Exception.
  79         throw new Exception(_m('Unable to locate signer public key.'));
  80     }
  81
  82     /**
  83      * The current MagicEnvelope spec as used in StatusNet 0.9.7 and later
  84      * includes both the original data and some signing metadata fields as
  85      * the input plaintext for the signature hash.
  86      *
  87      * @param array $env
  88      * @return string
  89      */
  90     public function signingText($env) {
  91         return implode('.', array($env['data'], // this field is pre-base64'd
  92                             Magicsig::base64_url_encode($env['data_type']),
  93                             Magicsig::base64_url_encode($env['encoding']),
  94                             Magicsig::base64_url_encode($env['alg'])));
  95     }
  96
  97     /**
  98      *
  99      * @param <type> $text
 100      * @param <type> $mimetype
 101      * @param <type> $keypair
 102      * @return array: associative array of envelope properties
 103      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 104      */
 105     public function signMessage($text, $mimetype, $keypair)
 106     {
 107         $signature_alg = Magicsig::fromString($keypair);
 108         $armored_text = Magicsig::base64_url_encode($text);
 109         $env = array(
 110             'data' => $armored_text,
 111             'encoding' => MagicEnvelope::ENCODING,
 112             'data_type' => $mimetype,
 113             'sig' => '',
 114             'alg' => $signature_alg->getName()
 115         );
 116
 117         $env['sig'] = $signature_alg->sign($this->signingText($env));
 118
 119         return $env;
 120     }
 121
 122     /**
 123      * Create an <me:env> XML representation of the envelope.
 124      *
 125      * @param array $env associative array with envelope data
 126      * @return string representation of XML document
 127      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 128      */
 129     public function toXML($env) {
 130         $xs = new XMLStringer();
 131         $xs->startXML();
 132         $xs->elementStart('me:env', array('xmlns:me' => MagicEnvelope::NS));
 133         $xs->element('me:data', array('type' => $env['data_type']), $env['data']);
 134         $xs->element('me:encoding', null, $env['encoding']);
 135         $xs->element('me:alg', null, $env['alg']);
 136         $xs->element('me:sig', null, $env['sig']);
 137         $xs->elementEnd('me:env');
 138
 139         $string =  $xs->getString();
 140         common_debug($string);
 141         return $string;
 142     }
 143
 144     /**
 145      * Extract the contained XML payload, and insert a copy of the envelope
 146      * signature data as an <me:provenance> section.
 147      *
 148      * @param array $env associative array with envelope data
 149      * @return string representation of modified XML document
 150      *
 151      * @fixme in case of XML parsing errors, this will spew to the error log or output
 152      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 153      */
 154     public function unfold($env)
 155     {
 156         $dom = new DOMDocument();
 157         $dom->loadXML(Magicsig::base64_url_decode($env['data']));
 158
 159         if ($dom->documentElement->tagName != 'entry') {
 160             return false;
 161         }
 162
 163         $prov = $dom->createElementNS(MagicEnvelope::NS, 'me:provenance');
 164         $prov->setAttribute('xmlns:me', MagicEnvelope::NS);
 165         $data = $dom->createElementNS(MagicEnvelope::NS, 'me:data', $env['data']);
 166         $data->setAttribute('type', $env['data_type']);
 167         $prov->appendChild($data);
 168         $enc = $dom->createElementNS(MagicEnvelope::NS, 'me:encoding', $env['encoding']);
 169         $prov->appendChild($enc);
 170         $alg = $dom->createElementNS(MagicEnvelope::NS, 'me:alg', $env['alg']);
 171         $prov->appendChild($alg);
 172         $sig = $dom->createElementNS(MagicEnvelope::NS, 'me:sig', $env['sig']);
 173         $prov->appendChild($sig);
 174
 175         $dom->documentElement->appendChild($prov);
 176
 177         return $dom->saveXML();
 178     }
 179
 180     /**
 181      * Find the author URI referenced in the given Atom entry.
 182      *
 183      * @param string $text string containing Atom entry XML
 184      * @return mixed URI string or false if XML parsing fails, or null if no author URI can be found
 185      *
 186      * @fixme XML parsing failures will spew to error logs/output
 187      */
 188     public function getAuthor($text) {
 189         $doc = new DOMDocument();
 190         if (!$doc->loadXML($text)) {
 191             return FALSE;
 192         }
 193
 194         if ($doc->documentElement->tagName == 'entry') {
 195             $authors = $doc->documentElement->getElementsByTagName('author');
 196             foreach ($authors as $author) {
 197                 $uris = $author->getElementsByTagName('uri');
 198                 foreach ($uris as $uri) {
 199                     return $this->normalizeUser($uri->nodeValue);
 200                 }
 201             }
 202         }
 203     }
 204
 205     /**
 206      * Check if the author in the Atom entry fragment claims to match
 207      * the given identifier URI.
 208      *
 209      * @param string $text string containing Atom entry XML
 210      * @param string $signer_uri
 211      * @return boolean
 212      */
 213     public function checkAuthor($text, $signer_uri)
 214     {
 215         return ($this->getAuthor($text) == $signer_uri);
 216     }
 217
 218     /**
 219      * Attempt to verify cryptographic signing for parsed envelope data.
 220      * Requires network access to retrieve public key referenced by the envelope signer.
 221      *
 222      * Details of failure conditions are dumped to output log and not exposed to caller.
 223      *
 224      * @param array $env array representation of magic envelope data, as returned from MagicEnvelope::parse()
 225      * @return boolean
 226      *
 227      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 228      */
 229     public function verify($env)
 230     {
 231         if ($env['alg'] != 'RSA-SHA256') {
 232             common_log(LOG_DEBUG, "Salmon error: bad algorithm");
 233             return false;
 234         }
 235
 236         if ($env['encoding'] != MagicEnvelope::ENCODING) {
 237             common_log(LOG_DEBUG, "Salmon error: bad encoding");
 238             return false;
 239         }
 240
 241         $text = Magicsig::base64_url_decode($env['data']);
 242         $signer_uri = $this->getAuthor($text);
 243
 244         try {
 245             $keypair = $this->getKeyPair($signer_uri);
 246         } catch (Exception $e) {
 247             common_log(LOG_DEBUG, "Salmon error: ".$e->getMessage());
 248             return false;
 249         }
 250
 251         $verifier = Magicsig::fromString($keypair);
 252
 253         if (!$verifier) {
 254             common_log(LOG_DEBUG, "Salmon error: unable to parse keypair");
 255             return false;
 256         }
 257
 258         return $verifier->verify($this->signingText($env), $env['sig']);
 259     }
 260
 261     /**
 262      * Extract envelope data from an XML document containing an <me:env> or <me:provenance> element.
 263      *
 264      * @param string XML source
 265      * @return mixed associative array of envelope data, or false on unrecognized input
 266      *
 267      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 268      * @fixme will spew errors to logs or output in case of XML parse errors
 269      * @fixme may give fatal errors if some elements are missing or invalid XML
 270      * @fixme calling DOMDocument::loadXML statically triggers warnings in strict mode
 271      */
 272     public function parse($text)
 273     {
 274         $dom = DOMDocument::loadXML($text);
 275         return $this->fromDom($dom);
 276     }
 277
 278     /**
 279      * Extract envelope data from an XML document containing an <me:env> or <me:provenance> element.
 280      *
 281      * @param DOMDocument $dom
 282      * @return mixed associative array of envelope data, or false on unrecognized input
 283      *
 284      * @fixme it might be easier to work with storing envelope data these in the object instead of passing arrays around
 285      * @fixme may give fatal errors if some elements are missing
 286      */
 287     public function fromDom($dom)
 288     {
 289         $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'env')->item(0);
 290         if (!$env_element) {
 291             $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'provenance')->item(0);
 292         }
 293
 294         if (!$env_element) {
 295             return false;
 296         }
 297
 298         $data_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'data')->item(0);
 299         $sig_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0);
 300         return array(
 301             'data' => preg_replace('/\s/', '', $data_element->nodeValue),
 302             'data_type' => $data_element->getAttribute('type'),
 303             'encoding' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'encoding')->item(0)->nodeValue,
 304             'alg' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'alg')->item(0)->nodeValue,
 305             'sig' => preg_replace('/\s/', '', $sig_element->nodeValue),
 306         );
 307     }
 308 }
 309
 310 /**
 311  * Variant of MagicEnvelope using the earlier signature form listed in the MagicEnvelope
 312  * spec in early 2010; this was used in StatusNet up through 0.9.6, so for backwards compatiblity
 313  * we still need to accept and sometimes send this format.
 314  */
 315 class MagicEnvelopeCompat extends MagicEnvelope {
 316
 317     /**
 318      * StatusNet through 0.9.6 used an earlier version of the MagicEnvelope spec
 319      * which used only the input data, without the additional fields, as the plaintext
 320      * for signing.
 321      *
 322      * @param array $env
 323      * @return string
 324      */
 325     public function signingText($env) {
 326         return $env['data'];
 327     }
 328 }