]> git.mxchange.org Git - friendica.git/blob - src/Util/HTTPSignature.php
Don't transmit to archived inboxes
[friendica.git] / src / Util / HTTPSignature.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Util;
23
24 use Friendica\Core\Logger;
25 use Friendica\Database\DBA;
26 use Friendica\DI;
27 use Friendica\Model\APContact;
28 use Friendica\Model\User;
29
30 /**
31  * Implements HTTP Signatures per draft-cavage-http-signatures-07.
32  *
33  * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/Zotlabs/Web/HTTPSig.php
34  *
35  * Other parts of the code for HTTP signing are taken from the Osada project.
36  * https://framagit.org/macgirvin/osada
37  *
38  * @see https://tools.ietf.org/html/draft-cavage-http-signatures-07
39  */
40
41 class HTTPSignature
42 {
43         // See draft-cavage-http-signatures-08
44         /**
45          * Verifies a magic request
46          *
47          * @param $key
48          *
49          * @return array with verification data
50          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
51          */
52         public static function verifyMagic($key)
53         {
54                 $headers   = null;
55                 $spoofable = false;
56                 $result = [
57                         'signer'         => '',
58                         'header_signed'  => false,
59                         'header_valid'   => false
60                 ];
61
62                 // Decide if $data arrived via controller submission or curl.
63                 $headers = [];
64                 $headers['(request-target)'] = strtolower($_SERVER['REQUEST_METHOD']).' '.$_SERVER['REQUEST_URI'];
65
66                 foreach ($_SERVER as $k => $v) {
67                         if (strpos($k, 'HTTP_') === 0) {
68                                 $field = str_replace('_', '-', strtolower(substr($k, 5)));
69                                 $headers[$field] = $v;
70                         }
71                 }
72
73                 $sig_block = null;
74
75                 $sig_block = self::parseSigheader($headers['authorization']);
76
77                 if (!$sig_block) {
78                         Logger::log('no signature provided.');
79                         return $result;
80                 }
81
82                 $result['header_signed'] = true;
83
84                 $signed_headers = $sig_block['headers'];
85                 if (!$signed_headers) {
86                         $signed_headers = ['date'];
87                 }
88
89                 $signed_data = '';
90                 foreach ($signed_headers as $h) {
91                         if (array_key_exists($h, $headers)) {
92                                 $signed_data .= $h . ': ' . $headers[$h] . "\n";
93                         }
94                         if (strpos($h, '.')) {
95                                 $spoofable = true;
96                         }
97                 }
98
99                 $signed_data = rtrim($signed_data, "\n");
100
101                 $algorithm = 'sha512';
102
103                 if ($key && function_exists($key)) {
104                         $result['signer'] = $sig_block['keyId'];
105                         $key = $key($sig_block['keyId']);
106                 }
107
108                 Logger::log('Got keyID ' . $sig_block['keyId'], Logger::DEBUG);
109
110                 if (!$key) {
111                         return $result;
112                 }
113
114                 $x = Crypto::rsaVerify($signed_data, $sig_block['signature'], $key, $algorithm);
115
116                 Logger::log('verified: ' . $x, Logger::DEBUG);
117
118                 if (!$x) {
119                         return $result;
120                 }
121
122                 if (!$spoofable) {
123                         $result['header_valid'] = true;
124                 }
125
126                 return $result;
127         }
128
129         /**
130          * @param array   $head
131          * @param string  $prvkey
132          * @param string  $keyid (optional, default 'Key')
133          *
134          * @return array
135          */
136         public static function createSig($head, $prvkey, $keyid = 'Key')
137         {
138                 $return_headers = [];
139
140                 $alg = 'sha512';
141                 $algorithm = 'rsa-sha512';
142
143                 $x = self::sign($head, $prvkey, $alg);
144
145                 $headerval = 'keyId="' . $keyid . '",algorithm="' . $algorithm
146                         . '",headers="' . $x['headers'] . '",signature="' . $x['signature'] . '"';
147
148                 $sighead = 'Authorization: Signature ' . $headerval;
149
150                 if ($head) {
151                         foreach ($head as $k => $v) {
152                                 $return_headers[] = $k . ': ' . $v;
153                         }
154                 }
155
156                 $return_headers[] = $sighead;
157
158                 return $return_headers;
159         }
160
161         /**
162          * @param array  $head
163          * @param string $prvkey
164          * @param string $alg (optional) default 'sha256'
165          *
166          * @return array
167          */
168         private static function sign($head, $prvkey, $alg = 'sha256')
169         {
170                 $ret = [];
171                 $headers = '';
172                 $fields  = '';
173
174                 foreach ($head as $k => $v) {
175                         $headers .= strtolower($k) . ': ' . trim($v) . "\n";
176                         if ($fields) {
177                                 $fields .= ' ';
178                         }
179                         $fields .= strtolower($k);
180                 }
181                 // strip the trailing linefeed
182                 $headers = rtrim($headers, "\n");
183
184                 $sig = base64_encode(Crypto::rsaSign($headers, $prvkey, $alg));
185
186                 $ret['headers']   = $fields;
187                 $ret['signature'] = $sig;
188
189                 return $ret;
190         }
191
192         /**
193          * @param string $header
194          * @return array associative array with
195          *   - \e string \b keyID
196          *   - \e string \b created
197          *   - \e string \b expires
198          *   - \e string \b algorithm
199          *   - \e array  \b headers
200          *   - \e string \b signature
201          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
202          */
203         public static function parseSigheader($header)
204         {
205                 // Remove obsolete folds
206                 $header = preg_replace('/\n\s+/', ' ', $header);
207
208                 $token = "[!#$%&'*+.^_`|~0-9A-Za-z-]";
209
210                 $quotedString = '"(?:\\\\.|[^"\\\\])*"';
211
212                 $regex = "/($token+)=($quotedString|$token+)/ism";
213
214                 $matches = [];
215                 preg_match_all($regex, $header, $matches, PREG_SET_ORDER);
216
217                 $headers = [];
218                 foreach ($matches as $match) {
219                         $headers[$match[1]] = trim($match[2] ?: $match[3], '"');
220                 }
221
222                 // if the header is encrypted, decrypt with (default) site private key and continue
223                 if (!empty($headers['iv'])) {
224                         $header = self::decryptSigheader($headers, DI::config()->get('system', 'prvkey'));
225                         return self::parseSigheader($header);
226                 }
227
228                 $return = [
229                         'keyId'     => $headers['keyId'] ?? '',
230                         'algorithm' => $headers['algorithm'] ?? 'rsa-sha256',
231                         'created'   => $headers['created'] ?? null,
232                         'expires'   => $headers['expires'] ?? null,
233                         'headers'   => explode(' ', $headers['headers'] ?? ''),
234                         'signature' => base64_decode(preg_replace('/\s+/', '', $headers['signature'] ?? '')),
235                 ];
236
237                 if (!empty($return['signature']) && !empty($return['algorithm']) && empty($return['headers'])) {
238                         $return['headers'] = ['date'];
239                 }
240
241                 return $return;
242         }
243
244         /**
245          * @param array  $headers Signature headers
246          * @param string $prvkey  The site private key
247          * @return string Decrypted signature string
248          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
249          */
250         private static function decryptSigheader(array $headers, string $prvkey)
251         {
252                 if (!empty($headers['iv']) && !empty($headers['key']) && !empty($headers['data'])) {
253                         return Crypto::unencapsulate($headers, $prvkey);
254                 }
255
256                 return '';
257         }
258
259         /*
260          * Functions for ActivityPub
261          */
262
263         /**
264          * Transmit given data to a target for a user
265          *
266          * @param array   $data   Data that is about to be send
267          * @param string  $target The URL of the inbox
268          * @param integer $uid    User id of the sender
269          *
270          * @return boolean Was the transmission successful?
271          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
272          */
273         public static function transmit($data, $target, $uid)
274         {
275                 $owner = User::getOwnerDataById($uid);
276
277                 if (!$owner) {
278                         return;
279                 }
280
281                 $content = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
282
283                 // Header data that is about to be signed.
284                 $host = parse_url($target, PHP_URL_HOST);
285                 $path = parse_url($target, PHP_URL_PATH);
286                 $digest = 'SHA-256=' . base64_encode(hash('sha256', $content, true));
287                 $content_length = strlen($content);
288                 $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
289
290                 $headers = ['Date: ' . $date, 'Content-Length: ' . $content_length, 'Digest: ' . $digest, 'Host: ' . $host];
291
292                 $signed_data = "(request-target): post " . $path . "\ndate: ". $date . "\ncontent-length: " . $content_length . "\ndigest: " . $digest . "\nhost: " . $host;
293
294                 $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
295
296                 $headers[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date content-length digest host",signature="' . $signature . '"';
297
298                 $headers[] = 'Content-Type: application/activity+json';
299
300                 $postResult = DI::httpRequest()->post($target, $content, $headers);
301                 $return_code = $postResult->getReturnCode();
302
303                 Logger::log('Transmit to ' . $target . ' returned ' . $return_code, Logger::DEBUG);
304
305                 $success = ($return_code >= 200) && ($return_code <= 299);
306
307                 self::setInboxStatus($target, $success);
308
309                 return $success;
310         }
311
312         /**
313          * Set the delivery status for a given inbox
314          *
315          * @param string  $url     The URL of the inbox
316          * @param boolean $success Transmission status
317          * @param boolean $shared  The inbox is a shared inbox
318          */
319         static public function setInboxStatus($url, $success, $shared = false)
320         {
321                 $now = DateTimeFormat::utcNow();
322
323                 $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
324                 if (!DBA::isResult($status)) {
325                         DBA::insert('inbox-status', ['url' => $url, 'created' => $now, 'shared' => $shared]);
326                         $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
327                 }
328
329                 if ($success) {
330                         $fields = ['success' => $now];
331                 } else {
332                         $fields = ['failure' => $now];
333                 }
334
335                 if ($status['failure'] > DBA::NULL_DATETIME) {
336                         $new_previous_stamp = strtotime($status['failure']);
337                         $old_previous_stamp = strtotime($status['previous']);
338
339                         // Only set "previous" with at least one day difference.
340                         // We use this to assure to not accidentally archive too soon.
341                         if (($new_previous_stamp - $old_previous_stamp) >= 86400) {
342                                 $fields['previous'] = $status['failure'];
343                         }
344                 }
345
346                 if (!$success) {
347                         if ($status['success'] <= DBA::NULL_DATETIME) {
348                                 $stamp1 = strtotime($status['created']);
349                         } else {
350                                 $stamp1 = strtotime($status['success']);
351                         }
352
353                         $stamp2 = strtotime($now);
354                         $previous_stamp = strtotime($status['previous']);
355
356                         // Archive the inbox when there had been failures for five days.
357                         // Additionally ensure that at least one previous attempt has to be in between.
358                         if ((($stamp2 - $stamp1) >= 86400 * 5) && ($previous_stamp > $stamp1)) {
359                                 $fields['archive'] = true;
360                         }
361                 } else {
362                         $fields['archive'] = false;
363                 }
364
365                 DBA::update('inbox-status', $fields, ['url' => $url]);
366         }
367
368         /**
369          * Fetches JSON data for a user
370          *
371          * @param string  $request request url
372          * @param integer $uid     User id of the requester
373          *
374          * @return array JSON array
375          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
376          */
377         public static function fetch($request, $uid)
378         {
379                 $opts = ['accept_content' => 'application/activity+json, application/ld+json'];
380                 $curlResult = self::fetchRaw($request, $uid, false, $opts);
381
382                 if (empty($curlResult)) {
383                         return false;
384                 }
385
386                 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
387                         return false;
388                 }
389
390                 $content = json_decode($curlResult->getBody(), true);
391                 if (empty($content) || !is_array($content)) {
392                         return false;
393                 }
394
395                 return $content;
396         }
397
398         /**
399          * Fetches raw data for a user
400          *
401          * @param string  $request request url
402          * @param integer $uid     User id of the requester
403          * @param boolean $binary  TRUE if asked to return binary results (file download) (default is "false")
404          * @param array   $opts    (optional parameters) assoziative array with:
405          *                         'accept_content' => supply Accept: header with 'accept_content' as the value
406          *                         'timeout' => int Timeout in seconds, default system config value or 60 seconds
407          *                         'nobody' => only return the header
408          *                         'cookiejar' => path to cookie jar file
409          *
410          * @return object CurlResult
411          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
412          */
413         public static function fetchRaw($request, $uid = 0, $binary = false, $opts = [])
414         {
415                 $header = [];
416
417                 if (!empty($uid)) {
418                         $owner = User::getOwnerDataById($uid);
419                         if (!$owner) {
420                                 return;
421                         }
422                 } else {
423                         $owner = User::getSystemAccount();
424                         if (!$owner) {
425                                 return;
426                         }
427                 }
428
429                 if (!empty($owner['uprvkey'])) {
430                         // Header data that is about to be signed.
431                         $host = parse_url($request, PHP_URL_HOST);
432                         $path = parse_url($request, PHP_URL_PATH);
433                         $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
434
435                         $header = ['Date: ' . $date, 'Host: ' . $host];
436
437                         $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host;
438
439                         $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
440
441                         $header[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"';
442                 }
443
444                 if (!empty($opts['accept_content'])) {
445                         $header[] = 'Accept: ' . $opts['accept_content'];
446                 }
447
448                 $curl_opts = $opts;
449                 $curl_opts['header'] = $header;
450
451                 if (!empty($opts['nobody'])) {
452                         $curlResult = DI::httpRequest()->head($request, $curl_opts);
453                 } else {
454                         $curlResult = DI::httpRequest()->get($request, $curl_opts);
455                 }
456                 $return_code = $curlResult->getReturnCode();
457
458                 Logger::log('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code, Logger::DEBUG);
459
460                 return $curlResult;
461         }
462
463         /**
464          * Gets a signer from a given HTTP request
465          *
466          * @param $content
467          * @param $http_headers
468          *
469          * @return string Signer
470          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
471          */
472         public static function getSigner($content, $http_headers)
473         {
474                 if (empty($http_headers['HTTP_SIGNATURE'])) {
475                         return false;
476                 }
477
478                 if (!empty($content)) {
479                         $object = json_decode($content, true);
480                         if (empty($object)) {
481                                 return false;
482                         }
483
484                         $actor = JsonLD::fetchElement($object, 'actor', 'id');
485                 } else {
486                         $actor = '';
487                 }
488
489                 $headers = [];
490                 $headers['(request-target)'] = strtolower($http_headers['REQUEST_METHOD']) . ' ' . parse_url($http_headers['REQUEST_URI'], PHP_URL_PATH);
491
492                 // First take every header
493                 foreach ($http_headers as $k => $v) {
494                         $field = str_replace('_', '-', strtolower($k));
495                         $headers[$field] = $v;
496                 }
497
498                 // Now add every http header
499                 foreach ($http_headers as $k => $v) {
500                         if (strpos($k, 'HTTP_') === 0) {
501                                 $field = str_replace('_', '-', strtolower(substr($k, 5)));
502                                 $headers[$field] = $v;
503                         }
504                 }
505
506                 $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
507
508                 if (empty($sig_block) || empty($sig_block['headers']) || empty($sig_block['keyId'])) {
509                         return false;
510                 }
511
512                 $signed_data = '';
513                 foreach ($sig_block['headers'] as $h) {
514                         if (array_key_exists($h, $headers)) {
515                                 $signed_data .= $h . ': ' . $headers[$h] . "\n";
516                         }
517                 }
518                 $signed_data = rtrim($signed_data, "\n");
519
520                 if (empty($signed_data)) {
521                         return false;
522                 }
523
524                 $algorithm = null;
525
526                 // Wildcard value where signing algorithm should be derived from keyId
527                 // @see https://tools.ietf.org/html/draft-ietf-httpbis-message-signatures-00#section-4.1
528                 // Defaulting to SHA256 as it seems to be the prevalent implementation
529                 // @see https://arewehs2019yet.vpzom.click
530                 if ($sig_block['algorithm'] === 'hs2019') {
531                         $algorithm = 'sha256';
532                 }
533
534                 if ($sig_block['algorithm'] === 'rsa-sha256') {
535                         $algorithm = 'sha256';
536                 }
537
538                 if ($sig_block['algorithm'] === 'rsa-sha512') {
539                         $algorithm = 'sha512';
540                 }
541
542                 if (empty($algorithm)) {
543                         return false;
544                 }
545
546                 $key = self::fetchKey($sig_block['keyId'], $actor);
547
548                 if (empty($key)) {
549                         return false;
550                 }
551
552                 if (!Crypto::rsaVerify($signed_data, $sig_block['signature'], $key['pubkey'], $algorithm)) {
553                         return false;
554                 }
555
556                 $hasGoodSignedContent = false;
557
558                 // Check the digest when it is part of the signed data
559                 if (!empty($content) && in_array('digest', $sig_block['headers'])) {
560                         $digest = explode('=', $headers['digest'], 2);
561                         if ($digest[0] === 'SHA-256') {
562                                 $hashalg = 'sha256';
563                         }
564                         if ($digest[0] === 'SHA-512') {
565                                 $hashalg = 'sha512';
566                         }
567
568                         /// @todo add all hashes from the rfc
569
570                         if (!empty($hashalg) && base64_encode(hash($hashalg, $content, true)) != $digest[1]) {
571                                 return false;
572                         }
573
574                         $hasGoodSignedContent = true;
575                 }
576
577                 //  Check if the signed date field is in an acceptable range
578                 if (in_array('date', $sig_block['headers'])) {
579                         $diff = abs(strtotime($headers['date']) - time());
580                         if ($diff > 300) {
581                                 Logger::log("Header date '" . $headers['date'] . "' is with " . $diff . " seconds out of the 300 second frame. The signature is invalid.");
582                                 return false;
583                         }
584                         $hasGoodSignedContent = true;
585                 }
586
587                 // Check the content-length when it is part of the signed data
588                 if (in_array('content-length', $sig_block['headers'])) {
589                         if (strlen($content) != $headers['content-length']) {
590                                 return false;
591                         }
592                 }
593
594                 // Ensure that the authentication had been done with some content
595                 // Without this check someone could authenticate with fakeable data
596                 if (!$hasGoodSignedContent) {
597                         return false;
598                 }
599
600                 return $key['url'];
601         }
602
603         /**
604          * fetches a key for a given id and actor
605          *
606          * @param $id
607          * @param $actor
608          *
609          * @return array with actor url and public key
610          * @throws \Exception
611          */
612         private static function fetchKey($id, $actor)
613         {
614                 $url = (strpos($id, '#') ? substr($id, 0, strpos($id, '#')) : $id);
615
616                 $profile = APContact::getByURL($url);
617                 if (!empty($profile)) {
618                         Logger::log('Taking key from id ' . $id, Logger::DEBUG);
619                         return ['url' => $url, 'pubkey' => $profile['pubkey']];
620                 } elseif ($url != $actor) {
621                         $profile = APContact::getByURL($actor);
622                         if (!empty($profile)) {
623                                 Logger::log('Taking key from actor ' . $actor, Logger::DEBUG);
624                                 return ['url' => $actor, 'pubkey' => $profile['pubkey']];
625                         }
626                 }
627
628                 return false;
629         }
630 }