3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Util;
24 use Friendica\Core\Logger;
25 use Friendica\Database\Database;
26 use Friendica\Database\DBA;
28 use Friendica\Model\APContact;
29 use Friendica\Model\Contact;
30 use Friendica\Model\ItemURI;
31 use Friendica\Model\User;
32 use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
33 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
34 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
37 * Implements HTTP Signatures per draft-cavage-http-signatures-07.
39 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/Zotlabs/Web/HTTPSig.php
41 * Other parts of the code for HTTP signing are taken from the Osada project.
42 * https://framagit.org/macgirvin/osada
44 * @see https://tools.ietf.org/html/draft-cavage-http-signatures-07
49 // See draft-cavage-http-signatures-08
51 * Verifies a magic request
55 * @return array with verification data
56 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
58 public static function verifyMagic(string $key): array
64 'header_signed' => false,
65 'header_valid' => false
68 // Decide if $data arrived via controller submission or curl.
70 $headers['(request-target)'] = strtolower(DI::args()->getMethod()).' '.$_SERVER['REQUEST_URI'];
72 foreach ($_SERVER as $k => $v) {
73 if (strpos($k, 'HTTP_') === 0) {
74 $field = str_replace('_', '-', strtolower(substr($k, 5)));
75 $headers[$field] = $v;
81 $sig_block = self::parseSigheader($headers['authorization']);
84 Logger::notice('no signature provided.');
88 $result['header_signed'] = true;
90 $signed_headers = $sig_block['headers'];
91 if (!$signed_headers) {
92 $signed_headers = ['date'];
96 foreach ($signed_headers as $h) {
97 if (array_key_exists($h, $headers)) {
98 $signed_data .= $h . ': ' . $headers[$h] . "\n";
100 if (strpos($h, '.')) {
105 $signed_data = rtrim($signed_data, "\n");
107 $algorithm = 'sha512';
109 if ($key && function_exists($key)) {
110 $result['signer'] = $sig_block['keyId'];
111 $key = $key($sig_block['keyId']);
114 Logger::info('Got keyID ' . $sig_block['keyId']);
120 $x = Crypto::rsaVerify($signed_data, $sig_block['signature'], $key, $algorithm);
122 Logger::info('verified: ' . $x);
129 $result['header_valid'] = true;
137 * @param string $prvkey
138 * @param string $keyid (optional, default 'Key')
142 public static function createSig(array $head, string $prvkey, string $keyid = 'Key'): array
144 $return_headers = [];
146 $return_headers = $head;
150 $algorithm = 'rsa-sha512';
152 $x = self::sign($head, $prvkey, $alg);
154 $headerval = 'keyId="' . $keyid . '",algorithm="' . $algorithm
155 . '",headers="' . $x['headers'] . '",signature="' . $x['signature'] . '"';
157 $return_headers['Authorization'] = ['Signature ' . $headerval];
159 return $return_headers;
164 * @param string $prvkey
165 * @param string $alg (optional) default 'sha256'
169 private static function sign(array $head, string $prvkey, string $alg = 'sha256'): array
175 foreach ($head as $k => $v) {
177 $v = implode(', ', $v);
179 $headers .= strtolower($k) . ': ' . trim($v) . "\n";
183 $fields .= strtolower($k);
185 // strip the trailing linefeed
186 $headers = rtrim($headers, "\n");
188 $sig = base64_encode(Crypto::rsaSign($headers, $prvkey, $alg));
190 $ret['headers'] = $fields;
191 $ret['signature'] = $sig;
197 * @param string $header
198 * @return array associative array with
199 * - \e string \b keyID
200 * - \e string \b created
201 * - \e string \b expires
202 * - \e string \b algorithm
203 * - \e array \b headers
204 * - \e string \b signature
205 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
207 public static function parseSigheader(string $header): array
209 // Remove obsolete folds
210 $header = preg_replace('/\n\s+/', ' ', $header);
212 $token = "[!#$%&'*+.^_`|~0-9A-Za-z-]";
214 $quotedString = '"(?:\\\\.|[^"\\\\])*"';
216 $regex = "/($token+)=($quotedString|$token+)/ism";
219 preg_match_all($regex, $header, $matches, PREG_SET_ORDER);
222 foreach ($matches as $match) {
223 $headers[$match[1]] = trim($match[2] ?: $match[3], '"');
226 // if the header is encrypted, decrypt with (default) site private key and continue
227 if (!empty($headers['iv'])) {
228 $header = self::decryptSigheader($headers, DI::config()->get('system', 'prvkey'));
229 return self::parseSigheader($header);
233 'keyId' => $headers['keyId'] ?? '',
234 'algorithm' => $headers['algorithm'] ?? 'rsa-sha256',
235 'created' => $headers['created'] ?? null,
236 'expires' => $headers['expires'] ?? null,
237 'headers' => explode(' ', $headers['headers'] ?? ''),
238 'signature' => base64_decode(preg_replace('/\s+/', '', $headers['signature'] ?? '')),
241 if (!empty($return['signature']) && !empty($return['algorithm']) && empty($return['headers'])) {
242 $return['headers'] = ['date'];
249 * @param array $headers Signature headers
250 * @param string $prvkey The site private key
251 * @return string Decrypted signature string
252 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
254 private static function decryptSigheader(array $headers, string $prvkey): string
256 if (!empty($headers['iv']) && !empty($headers['key']) && !empty($headers['data'])) {
257 return Crypto::unencapsulate($headers, $prvkey);
264 * Functions for ActivityPub
268 * Post given data to a target for a user, returns the result class
270 * @param array $data Data that is about to be sent
271 * @param string $target The URL of the inbox
272 * @param array $owner Sender owner-view record
274 * @return ICanHandleHttpResponses
276 public static function post(array $data, string $target, array $owner): ICanHandleHttpResponses
278 $content = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
280 // Header data that is about to be signed.
281 $host = parse_url($target, PHP_URL_HOST);
282 $path = parse_url($target, PHP_URL_PATH);
283 $digest = 'SHA-256=' . base64_encode(hash('sha256', $content, true));
284 $content_length = strlen($content);
285 $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
289 'Content-Length' => $content_length,
294 $signed_data = "(request-target): post " . $path . "\ndate: ". $date . "\ncontent-length: " . $content_length . "\ndigest: " . $digest . "\nhost: " . $host;
296 $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
298 $headers['Signature'] = 'keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date content-length digest host",signature="' . $signature . '"';
300 $headers['Content-Type'] = 'application/activity+json';
302 $postResult = DI::httpClient()->post($target, $content, $headers, DI::config()->get('system', 'curl_timeout'));
303 $return_code = $postResult->getReturnCode();
305 Logger::info('Transmit to ' . $target . ' returned ' . $return_code);
307 self::setInboxStatus($target, ($return_code >= 200) && ($return_code <= 299));
313 * Transmit given data to a target for a user
315 * @param array $data Data that is about to be sent
316 * @param string $target The URL of the inbox
317 * @param array $owner Sender owner-vew record
319 * @return boolean Was the transmission successful?
321 public static function transmit(array $data, string $target, array $owner): bool
323 $postResult = self::post($data, $target, $owner);
324 $return_code = $postResult->getReturnCode();
326 return ($return_code >= 200) && ($return_code <= 299);
330 * Set the delivery status for a given inbox
332 * @param string $url The URL of the inbox
333 * @param boolean $success Transmission status
334 * @param boolean $shared The inbox is a shared inbox
337 static public function setInboxStatus(string $url, bool $success, bool $shared = false)
339 $now = DateTimeFormat::utcNow();
341 $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
342 if (!DBA::isResult($status)) {
343 $insertFields = ['url' => $url, 'uri-id' => ItemURI::getIdByURI($url), 'created' => $now, 'shared' => $shared];
344 if (!DBA::insert('inbox-status', $insertFields, Database::INSERT_IGNORE)) {
345 Logger::warning('Unable to insert inbox-status row', $insertFields);
349 $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
353 $fields = ['success' => $now];
355 $fields = ['failure' => $now];
358 if ($status['failure'] > DBA::NULL_DATETIME) {
359 $new_previous_stamp = strtotime($status['failure']);
360 $old_previous_stamp = strtotime($status['previous']);
362 // Only set "previous" with at least one day difference.
363 // We use this to assure to not accidentally archive too soon.
364 if (($new_previous_stamp - $old_previous_stamp) >= 86400) {
365 $fields['previous'] = $status['failure'];
370 if ($status['success'] <= DBA::NULL_DATETIME) {
371 $stamp1 = strtotime($status['created']);
373 $stamp1 = strtotime($status['success']);
376 $stamp2 = strtotime($now);
377 $previous_stamp = strtotime($status['previous']);
379 // Archive the inbox when there had been failures for five days.
380 // Additionally ensure that at least one previous attempt has to be in between.
381 if ((($stamp2 - $stamp1) >= 86400 * 5) && ($previous_stamp > $stamp1)) {
382 $fields['archive'] = true;
385 $fields['archive'] = false;
388 if (empty($status['uri-id'])) {
389 $fields['uri-id'] = ItemURI::getIdByURI($url);
392 DBA::update('inbox-status', $fields, ['url' => $url]);
396 * Fetches JSON data for a user
398 * @param string $request request url
399 * @param integer $uid User id of the requester
401 * @return array JSON array
402 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
404 public static function fetch(string $request, int $uid): array
406 $curlResult = self::fetchRaw($request, $uid);
408 if (empty($curlResult)) {
412 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
416 $content = json_decode($curlResult->getBody(), true);
417 if (empty($content) || !is_array($content)) {
425 * Fetches raw data for a user
427 * @param string $request request url
428 * @param integer $uid User id of the requester
429 * @param boolean $binary TRUE if asked to return binary results (file download) (default is "false")
430 * @param array $opts (optional parameters) assoziative array with:
431 * 'accept_content' => supply Accept: header with 'accept_content' as the value
432 * 'timeout' => int Timeout in seconds, default system config value or 60 seconds
433 * 'nobody' => only return the header
434 * 'cookiejar' => path to cookie jar file
436 * @return \Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses CurlResult
437 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
439 public static function fetchRaw(string $request, int $uid = 0, array $opts = [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::JSON_AS]])
444 $owner = User::getOwnerDataById($uid);
449 $owner = User::getSystemAccount();
455 if (!empty($owner['uprvkey'])) {
456 // Header data that is about to be signed.
457 $host = parse_url($request, PHP_URL_HOST);
458 $path = parse_url($request, PHP_URL_PATH);
459 $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
461 $header['Date'] = $date;
462 $header['Host'] = $host;
464 $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host;
466 $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
468 $header['Signature'] = 'keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"';
472 $curl_opts[HttpClientOptions::HEADERS] = $header;
474 if (!empty($opts['nobody'])) {
475 $curlResult = DI::httpClient()->head($request, $curl_opts);
477 $curlResult = DI::httpClient()->get($request, HttpClientAccept::JSON_AS, $curl_opts);
479 $return_code = $curlResult->getReturnCode();
481 Logger::info('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code);
487 * Fetch the apcontact entry of the keyId in the given header
489 * @param array $http_headers
491 * @return array APContact entry
493 public static function getKeyIdContact(array $http_headers): array
495 if (empty($http_headers['HTTP_SIGNATURE'])) {
496 Logger::debug('No HTTP_SIGNATURE header', ['header' => $http_headers]);
500 $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
502 if (empty($sig_block['keyId'])) {
503 Logger::debug('No keyId', ['sig_block' => $sig_block]);
507 $url = (strpos($sig_block['keyId'], '#') ? substr($sig_block['keyId'], 0, strpos($sig_block['keyId'], '#')) : $sig_block['keyId']);
508 return APContact::getByURL($url);
512 * Gets a signer from a given HTTP request
514 * @param string $content
515 * @param array $http_headers
517 * @return string|null|false Signer
518 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
520 public static function getSigner(string $content, array $http_headers)
522 if (empty($http_headers['HTTP_SIGNATURE'])) {
523 Logger::debug('No HTTP_SIGNATURE header');
527 if (!empty($content)) {
528 $object = json_decode($content, true);
529 if (empty($object)) {
530 Logger::info('No object');
534 $actor = JsonLD::fetchElement($object, 'actor', 'id') ?? '';
540 $headers['(request-target)'] = strtolower(DI::args()->getMethod()) . ' ' . parse_url($http_headers['REQUEST_URI'], PHP_URL_PATH);
542 // First take every header
543 foreach ($http_headers as $k => $v) {
544 $field = str_replace('_', '-', strtolower($k));
545 $headers[$field] = $v;
548 // Now add every http header
549 foreach ($http_headers as $k => $v) {
550 if (strpos($k, 'HTTP_') === 0) {
551 $field = str_replace('_', '-', strtolower(substr($k, 5)));
552 $headers[$field] = $v;
556 $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
558 // Add fields from the signature block to the header. See issue 8845
559 if (!empty($sig_block['created']) && empty($headers['(created)'])) {
560 $headers['(created)'] = $sig_block['created'];
563 if (!empty($sig_block['expires']) && empty($headers['(expires)'])) {
564 $headers['(expires)'] = $sig_block['expires'];
567 if (empty($sig_block) || empty($sig_block['headers']) || empty($sig_block['keyId'])) {
568 Logger::info('No headers or keyId');
573 foreach ($sig_block['headers'] as $h) {
574 if (array_key_exists($h, $headers)) {
575 $signed_data .= $h . ': ' . $headers[$h] . "\n";
577 Logger::info('Requested header field not found', ['field' => $h, 'header' => $headers]);
580 $signed_data = rtrim($signed_data, "\n");
582 if (empty($signed_data)) {
583 Logger::info('Signed data is empty');
589 // Wildcard value where signing algorithm should be derived from keyId
590 // @see https://tools.ietf.org/html/draft-ietf-httpbis-message-signatures-00#section-4.1
591 // Defaulting to SHA256 as it seems to be the prevalent implementation
592 // @see https://arewehs2019yet.vpzom.click
593 if ($sig_block['algorithm'] === 'hs2019') {
594 $algorithm = 'sha256';
597 if ($sig_block['algorithm'] === 'rsa-sha256') {
598 $algorithm = 'sha256';
601 if ($sig_block['algorithm'] === 'rsa-sha512') {
602 $algorithm = 'sha512';
605 if (empty($algorithm)) {
606 Logger::info('No alagorithm');
610 $key = self::fetchKey($sig_block['keyId'], $actor);
612 Logger::info('Empty key');
616 if (!empty($key['url']) && !empty($key['type']) && ($key['type'] == 'Tombstone')) {
617 Logger::info('Actor is a tombstone', ['key' => $key]);
619 if (!Contact::isLocal($key['url'])) {
620 // We now delete everything that we possibly knew from this actor
621 Contact::deleteContactByUrl($key['url']);
626 if (empty($key['pubkey'])) {
627 Logger::info('Empty pubkey');
631 if (!Crypto::rsaVerify($signed_data, $sig_block['signature'], $key['pubkey'], $algorithm)) {
632 Logger::info('Verification failed', ['signed_data' => $signed_data, 'algorithm' => $algorithm, 'header' => $sig_block['headers'], 'http_headers' => $http_headers]);
636 $hasGoodSignedContent = false;
638 // Check the digest when it is part of the signed data
639 if (!empty($content) && in_array('digest', $sig_block['headers'])) {
640 $digest = explode('=', $headers['digest'], 2);
641 if ($digest[0] === 'SHA-256') {
644 if ($digest[0] === 'SHA-512') {
648 /// @todo add all hashes from the rfc
650 if (!empty($hashalg) && base64_encode(hash($hashalg, $content, true)) != $digest[1]) {
651 Logger::info('Digest does not match');
655 $hasGoodSignedContent = true;
658 if (in_array('date', $sig_block['headers']) && !empty($headers['date'])) {
659 $created = strtotime($headers['date']);
660 } elseif (in_array('(created)', $sig_block['headers']) && !empty($sig_block['created'])) {
661 $created = $sig_block['created'];
666 if (in_array('(expires)', $sig_block['headers']) && !empty($sig_block['expires'])) {
667 $expired = min($sig_block['expires'], $created + 300);
669 $expired = $created + 300;
672 // Check if the signed date field is in an acceptable range
673 if (!empty($created)) {
676 // Calculate with a grace period of 60 seconds to avoid slight time differences between the servers
677 if (($created - 60) > $current) {
678 Logger::notice('Signature created in the future', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
682 if ($current > $expired) {
683 Logger::notice('Signature expired', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
687 Logger::debug('Valid creation date', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
688 $hasGoodSignedContent = true;
691 // Check the content-length when it is part of the signed data
692 if (in_array('content-length', $sig_block['headers'])) {
693 if (strlen($content) != $headers['content-length']) {
694 Logger::info('Content length does not match');
699 // Ensure that the authentication had been done with some content
700 // Without this check someone could authenticate with fakeable data
701 if (!$hasGoodSignedContent) {
702 Logger::info('No good signed content');
710 * fetches a key for a given id and actor
713 * @param string $actor
715 * @return array with actor url and public key
718 private static function fetchKey(string $id, string $actor): array
720 $url = (strpos($id, '#') ? substr($id, 0, strpos($id, '#')) : $id);
722 $profile = APContact::getByURL($url);
723 if (!empty($profile)) {
724 Logger::info('Taking key from id', ['id' => $id]);
725 return ['url' => $url, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']];
726 } elseif ($url != $actor) {
727 $profile = APContact::getByURL($actor);
728 if (!empty($profile)) {
729 Logger::info('Taking key from actor', ['actor' => $actor]);
730 return ['url' => $actor, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']];
734 Logger::notice('Key could not be fetched', ['url' => $url, 'actor' => $actor]);