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
  30 class MagicEnvelope
  31 {
  32     const ENCODING = 'base64url';
  33
  34     const NS = 'http://salmon-protocol.org/ns/magic-env';
  35
  36     private function normalizeUser($user_id)
  37     {
  38         if (substr($user_id, 0, 5) == 'http:' ||
  39             substr($user_id, 0, 6) == 'https:' ||
  40             substr($user_id, 0, 5) == 'acct:') {
  41             return $user_id;
  42         }
  43
  44         if (strpos($user_id, '@') !== FALSE) {
  45             return 'acct:' . $user_id;
  46         }
  47
  48         return 'http://' . $user_id;
  49     }
  50
  51     public function getKeyPair($signer_uri)
  52     {
  53         $disco = new Discovery();
  54
  55         try {
  56             $xrd = $disco->lookup($signer_uri);
  57         } catch (Exception $e) {
  58             return false;
  59         }
  60         if ($xrd->links) {
  61             if ($link = Discovery::getService($xrd->links, Magicsig::PUBLICKEYREL)) {
  62                 list($type, $keypair) = explode(',', $link['href']);
  63                 if (empty($keypair)) {
  64                     // Backwards compatibility check for separator bug in 0.9.0
  65                     list($type, $keypair) = explode(';', $link['href']);
  66                 }
  67                 return $keypair;
  68             }
  69         }
  70         throw new Exception('Unable to locate signer public key');
  71     }
  72
  73
  74     public function signMessage($text, $mimetype, $keypair)
  75     {
  76         $signature_alg = Magicsig::fromString($keypair);
  77         $armored_text = base64_url_encode($text);
  78
  79         return array(
  80             'data' => $armored_text,
  81             'encoding' => MagicEnvelope::ENCODING,
  82             'data_type' => $mimetype,
  83             'sig' => $signature_alg->sign($armored_text),
  84             'alg' => $signature_alg->getName()
  85         );
  86
  87
  88     }
  89
  90     public function toXML($env) {
  91         $dom = new DOMDocument();
  92
  93         $envelope = $dom->createElementNS(MagicEnvelope::NS, 'me:env');
  94         $envelope->setAttribute('xmlns:me', MagicEnvelope::NS);
  95         $data = $dom->createElementNS(MagicEnvelope::NS, 'me:data', $env['data']);
  96         $data->setAttribute('type', $env['data_type']);
  97         $envelope->appendChild($data);
  98         $enc = $dom->createElementNS(MagicEnvelope::NS, 'me:encoding', $env['encoding']);
  99         $envelope->appendChild($enc);
 100         $alg = $dom->createElementNS(MagicEnvelope::NS, 'me:alg', $env['alg']);
 101         $envelope->appendChild($alg);
 102         $sig = $dom->createElementNS(MagicEnvelope::NS, 'me:sig', $env['sig']);
 103         $envelope->appendChild($sig);
 104
 105         $dom->appendChild($envelope);
 106
 107
 108         return $dom->saveXML();
 109     }
 110
 111
 112     public function unfold($env)
 113     {
 114         $dom = new DOMDocument();
 115         $dom->loadXML(base64_url_decode($env['data']));
 116
 117         if ($dom->documentElement->tagName != 'entry') {
 118             return false;
 119         }
 120
 121         $prov = $dom->createElementNS(MagicEnvelope::NS, 'me:provenance');
 122         $prov->setAttribute('xmlns:me', MagicEnvelope::NS);
 123         $data = $dom->createElementNS(MagicEnvelope::NS, 'me:data', $env['data']);
 124         $data->setAttribute('type', $env['data_type']);
 125         $prov->appendChild($data);
 126         $enc = $dom->createElementNS(MagicEnvelope::NS, 'me:encoding', $env['encoding']);
 127         $prov->appendChild($enc);
 128         $alg = $dom->createElementNS(MagicEnvelope::NS, 'me:alg', $env['alg']);
 129         $prov->appendChild($alg);
 130         $sig = $dom->createElementNS(MagicEnvelope::NS, 'me:sig', $env['sig']);
 131         $prov->appendChild($sig);
 132
 133         $dom->documentElement->appendChild($prov);
 134
 135         return $dom->saveXML();
 136     }
 137
 138     public function getAuthor($text) {
 139         $doc = new DOMDocument();
 140         if (!$doc->loadXML($text)) {
 141             return FALSE;
 142         }
 143
 144         if ($doc->documentElement->tagName == 'entry') {
 145             $authors = $doc->documentElement->getElementsByTagName('author');
 146             foreach ($authors as $author) {
 147                 $uris = $author->getElementsByTagName('uri');
 148                 foreach ($uris as $uri) {
 149                     return $this->normalizeUser($uri->nodeValue);
 150                 }
 151             }
 152         }
 153     }
 154
 155     public function checkAuthor($text, $signer_uri)
 156     {
 157         return ($this->getAuthor($text) == $signer_uri);
 158     }
 159
 160     public function verify($env)
 161     {
 162         if ($env['alg'] != 'RSA-SHA256') {
 163             common_log(LOG_DEBUG, "Salmon error: bad algorithm");
 164             return false;
 165         }
 166
 167         if ($env['encoding'] != MagicEnvelope::ENCODING) {
 168             common_log(LOG_DEBUG, "Salmon error: bad encoding");
 169             return false;
 170         }
 171
 172         $text = base64_url_decode($env['data']);
 173         $signer_uri = $this->getAuthor($text);
 174
 175         try {
 176             $keypair = $this->getKeyPair($signer_uri);
 177         } catch (Exception $e) {
 178             common_log(LOG_DEBUG, "Salmon error: ".$e->getMessage());
 179             return false;
 180         }
 181
 182         $verifier = Magicsig::fromString($keypair);
 183
 184         if (!$verifier) {
 185             common_log(LOG_DEBUG, "Salmon error: unable to parse keypair");
 186             return false;
 187         }
 188
 189         return $verifier->verify($env['data'], $env['sig']);
 190     }
 191
 192     public function parse($text)
 193     {
 194         $dom = DOMDocument::loadXML($text);
 195         return $this->fromDom($dom);
 196     }
 197
 198     public function fromDom($dom)
 199     {
 200         $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'env')->item(0);
 201         if (!$env_element) {
 202             $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'provenance')->item(0);
 203         }
 204
 205         if (!$env_element) {
 206             return false;
 207         }
 208
 209         $data_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'data')->item(0);
 210
 211         return array(
 212             'data' => trim($data_element->nodeValue),
 213             'data_type' => $data_element->getAttribute('type'),
 214             'encoding' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'encoding')->item(0)->nodeValue,
 215             'alg' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'alg')->item(0)->nodeValue,
 216             'sig' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0)->nodeValue,
 217         );
 218     }
 219
 220 }