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