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         $xrd = $disco->lookup($signer_uri);
  56         if ($link = Discovery::getService($xrd->links, Magicsig::PUBLICKEYREL)) {
  57             list($type, $keypair) = explode(';', $link['href']);
  58             return $keypair;
  59         }
  60
  61         throw new Exception('Unable to locate signer public key');
  62     }
  63
  64
  65     public function signMessage($text, $mimetype, $signer_uri)
  66     {
  67         $signer_uri = $this->normalizeUser($signer_uri);
  68
  69         if (!$this->checkAuthor($text, $signer_uri)) {
  70             throw new Exception("Unable to determine entry author.");
  71         }
  72
  73         $signature_alg = Magicsig::fromString($this->getKeyPair($signer_uri));
  74         $armored_text = base64_encode($text);
  75
  76         return array(
  77             'data' => $armored_text,
  78             'encoding' => MagicEnvelope::ENCODING,
  79             'data_type' => $mimetype,
  80             'sig' => $signature_alg->sign($armored_text),
  81             'alg' => $signature_alg->getName()
  82         );
  83
  84
  85     }
  86
  87     public function unfold($env)
  88     {
  89         $dom = new DOMDocument();
  90         $dom->loadXML(base64_decode($env['data']));
  91
  92         if ($dom->documentElement->tagName != 'entry') {
  93             return false;
  94         }
  95
  96         $prov = $dom->createElementNS(MagicEnvelope::NS, 'me:provenance');
  97         $prov->setAttribute('xmlns:me', MagicEnvelope::NS);
  98         $data = $dom->createElementNS(MagicEnvelope::NS, 'me:data', $env['data']);
  99         $data->setAttribute('type', $env['data_type']);
 100         $prov->appendChild($data);
 101         $enc = $dom->createElementNS(MagicEnvelope::NS, 'me:encoding', $env['encoding']);
 102         $prov->appendChild($enc);
 103         $alg = $dom->createElementNS(MagicEnvelope::NS, 'me:alg', $env['alg']);
 104         $prov->appendChild($alg);
 105         $sig = $dom->createElementNS(MagicEnvelope::NS, 'me:sig', $env['sig']);
 106         $prov->appendChild($sig);
 107
 108         $dom->documentElement->appendChild($prov);
 109
 110         return $dom->saveXML();
 111     }
 112
 113     public function getAuthor($text) {
 114         $doc = new DOMDocument();
 115         if (!$doc->loadXML($text)) {
 116             return FALSE;
 117         }
 118
 119         if ($doc->documentElement->tagName == 'entry') {
 120             $authors = $doc->documentElement->getElementsByTagName('author');
 121             foreach ($authors as $author) {
 122                 $uris = $author->getElementsByTagName('uri');
 123                 foreach ($uris as $uri) {
 124                     return $this->normalizeUser($uri->nodeValue);
 125                 }
 126             }
 127         }
 128     }
 129
 130     public function checkAuthor($text, $signer_uri)
 131     {
 132         return ($this->getAuthor($text) == $signer_uri);
 133     }
 134
 135     public function verify($env)
 136     {
 137         if ($env['alg'] != 'RSA-SHA256') {
 138             return false;
 139         }
 140
 141         if ($env['encoding'] != MagicEnvelope::ENCODING) {
 142             return false;
 143         }
 144
 145         $text = base64_decode($env['data']);
 146         $signer_uri = $this->getAuthor($text);
 147
 148         $verifier = Magicsig::fromString($this->getKeyPair($signer_uri));
 149
 150         return $verifier->verify($env['data'], $env['sig']);
 151     }
 152
 153     public function parse($text)
 154     {
 155         $dom = DOMDocument::loadXML($text);
 156         return $this->fromDom($dom);
 157     }
 158
 159     public function fromDom($dom)
 160     {
 161         if ($dom->documentElement->tagName == 'entry') {
 162             $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'provenance')->item(0);
 163         } else if ($dom->documentElement->tagName == 'me:env') {
 164             $env_element = $dom->documentElement;
 165         } else {
 166             return false;
 167         }
 168
 169         $data_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'data')->item(0);
 170
 171         return array(
 172             'data' => trim($data_element->nodeValue),
 173             'data_type' => $data_element->getAttribute('type'),
 174             'encoding' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'encoding')->item(0)->nodeValue,
 175             'alg' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'alg')->item(0)->nodeValue,
 176             'sig' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0)->nodeValue,
 177         );
 178     }
 179
 180 }