]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OStatus/lib/magicenvelope.php
send a salmon slap to mentioned person when we reply to a notice
[quix0rs-gnu-social.git] / 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                 $keypair = false;
63                 $parts = explode(',', $link['href']);
64                 if (count($parts) == 2) {
65                     $keypair = $parts[1];
66                 } else {
67                     // Backwards compatibility check for separator bug in 0.9.0
68                     $parts = explode(';', $link['href']);
69                     if (count($parts) == 2) {
70                         $keypair = $parts[1];
71                     }
72                 }
73                 
74                 if ($keypair) {
75                     return $keypair;
76                 }
77             }
78         }
79         throw new Exception('Unable to locate signer public key');
80     }
81
82
83     public function signMessage($text, $mimetype, $keypair)
84     {
85         $signature_alg = Magicsig::fromString($keypair);
86         $armored_text = Magicsig::base64_url_encode($text);
87
88         return array(
89             'data' => $armored_text,
90             'encoding' => MagicEnvelope::ENCODING,
91             'data_type' => $mimetype,
92             'sig' => $signature_alg->sign($armored_text),
93             'alg' => $signature_alg->getName()
94         );
95             
96             
97     }
98
99     public function toXML($env) {
100         $xs = new XMLStringer();
101         $xs->startXML();
102         $xs->elementStart('me:env', array('xmlns:me' => MagicEnvelope::NS));
103         $xs->element('me:data', array('type' => $env['data_type']), $env['data']);
104         $xs->element('me:encoding', null, $env['encoding']);
105         $xs->element('me:alg', null, $env['alg']);
106         $xs->element('me:sig', null, $env['sig']);
107         $xs->elementEnd('me:env');
108         
109         $string =  $xs->getString();
110         common_debug($string);
111         return $string;
112     }
113
114     
115     public function unfold($env)
116     {
117         $dom = new DOMDocument();
118         $dom->loadXML(Magicsig::base64_url_decode($env['data']));
119
120         if ($dom->documentElement->tagName != 'entry') {
121             return false;
122         }
123
124         $prov = $dom->createElementNS(MagicEnvelope::NS, 'me:provenance');
125         $prov->setAttribute('xmlns:me', MagicEnvelope::NS);
126         $data = $dom->createElementNS(MagicEnvelope::NS, 'me:data', $env['data']);
127         $data->setAttribute('type', $env['data_type']);
128         $prov->appendChild($data);
129         $enc = $dom->createElementNS(MagicEnvelope::NS, 'me:encoding', $env['encoding']);
130         $prov->appendChild($enc);
131         $alg = $dom->createElementNS(MagicEnvelope::NS, 'me:alg', $env['alg']);
132         $prov->appendChild($alg);
133         $sig = $dom->createElementNS(MagicEnvelope::NS, 'me:sig', $env['sig']);
134         $prov->appendChild($sig);
135
136         $dom->documentElement->appendChild($prov);
137
138         return $dom->saveXML();
139     }
140     
141     public function getAuthor($text) {
142         $doc = new DOMDocument();
143         if (!$doc->loadXML($text)) {
144             return FALSE;
145         }
146
147         if ($doc->documentElement->tagName == 'entry') {
148             $authors = $doc->documentElement->getElementsByTagName('author');
149             foreach ($authors as $author) {
150                 $uris = $author->getElementsByTagName('uri');
151                 foreach ($uris as $uri) {
152                     return $this->normalizeUser($uri->nodeValue);
153                 }
154             }
155         }
156     }
157     
158     public function checkAuthor($text, $signer_uri)
159     {
160         return ($this->getAuthor($text) == $signer_uri);
161     }
162     
163     public function verify($env)
164     {
165         if ($env['alg'] != 'RSA-SHA256') {
166             common_log(LOG_DEBUG, "Salmon error: bad algorithm");
167             return false;
168         }
169
170         if ($env['encoding'] != MagicEnvelope::ENCODING) {
171             common_log(LOG_DEBUG, "Salmon error: bad encoding");
172             return false;
173         }
174
175         $text = Magicsig::base64_url_decode($env['data']);
176         $signer_uri = $this->getAuthor($text);
177
178         try {
179             $keypair = $this->getKeyPair($signer_uri);
180         } catch (Exception $e) {
181             common_log(LOG_DEBUG, "Salmon error: ".$e->getMessage());
182             return false;
183         }
184         
185         $verifier = Magicsig::fromString($keypair);
186
187         if (!$verifier) {
188             common_log(LOG_DEBUG, "Salmon error: unable to parse keypair");
189             return false;
190         }
191         
192         return $verifier->verify($env['data'], $env['sig']);
193     }
194
195     public function parse($text)
196     {
197         $dom = DOMDocument::loadXML($text);
198         return $this->fromDom($dom);
199     }
200
201     public function fromDom($dom)
202     {
203         $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'env')->item(0);
204         if (!$env_element) {
205             $env_element = $dom->getElementsByTagNameNS(MagicEnvelope::NS, 'provenance')->item(0);
206         }
207
208         if (!$env_element) {
209             return false;
210         }
211
212         $data_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'data')->item(0);
213         $sig_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0);
214         return array(
215             'data' => preg_replace('/\s/', '', $data_element->nodeValue),
216             'data_type' => $data_element->getAttribute('type'),
217             'encoding' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'encoding')->item(0)->nodeValue,
218             'alg' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'alg')->item(0)->nodeValue,
219             'sig' => preg_replace('/\s/', '', $sig_element->nodeValue),
220         );
221     }
222
223 }