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 send
271 * @param string $target The URL of the inbox
272 * @param integer $uid User id of the sender
274 * @return ICanHandleHttpResponses
275 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
277 public static function post(array $data, string $target, int $uid): ICanHandleHttpResponses
279 $owner = User::getOwnerDataById($uid);
285 $content = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
287 // Header data that is about to be signed.
288 $host = parse_url($target, PHP_URL_HOST);
289 $path = parse_url($target, PHP_URL_PATH);
290 $digest = 'SHA-256=' . base64_encode(hash('sha256', $content, true));
291 $content_length = strlen($content);
292 $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
296 'Content-Length' => $content_length,
301 $signed_data = "(request-target): post " . $path . "\ndate: ". $date . "\ncontent-length: " . $content_length . "\ndigest: " . $digest . "\nhost: " . $host;
303 $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
305 $headers['Signature'] = 'keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date content-length digest host",signature="' . $signature . '"';
307 $headers['Content-Type'] = 'application/activity+json';
309 $postResult = DI::httpClient()->post($target, $content, $headers, DI::config()->get('system', 'curl_timeout'));
310 $return_code = $postResult->getReturnCode();
312 Logger::info('Transmit to ' . $target . ' returned ' . $return_code);
314 self::setInboxStatus($target, ($return_code >= 200) && ($return_code <= 299));
320 * Transmit given data to a target for a user
322 * @param array $data Data that is about to be send
323 * @param string $target The URL of the inbox
324 * @param integer $uid User id of the sender
326 * @return boolean Was the transmission successful?
327 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
329 public static function transmit(array $data, string $target, int $uid): bool
331 $postResult = self::post($data, $target, $uid);
332 $return_code = $postResult->getReturnCode();
334 return ($return_code >= 200) && ($return_code <= 299);
338 * Set the delivery status for a given inbox
340 * @param string $url The URL of the inbox
341 * @param boolean $success Transmission status
342 * @param boolean $shared The inbox is a shared inbox
344 static public function setInboxStatus(string $url, bool $success, bool $shared = false)
346 $now = DateTimeFormat::utcNow();
348 $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
349 if (!DBA::isResult($status)) {
350 DBA::insert('inbox-status', ['url' => $url, 'uri-id' => ItemURI::getIdByURI($url), 'created' => $now, 'shared' => $shared], Database::INSERT_IGNORE);
351 $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
355 $fields = ['success' => $now];
357 $fields = ['failure' => $now];
360 if ($status['failure'] > DBA::NULL_DATETIME) {
361 $new_previous_stamp = strtotime($status['failure']);
362 $old_previous_stamp = strtotime($status['previous']);
364 // Only set "previous" with at least one day difference.
365 // We use this to assure to not accidentally archive too soon.
366 if (($new_previous_stamp - $old_previous_stamp) >= 86400) {
367 $fields['previous'] = $status['failure'];
372 if ($status['success'] <= DBA::NULL_DATETIME) {
373 $stamp1 = strtotime($status['created']);
375 $stamp1 = strtotime($status['success']);
378 $stamp2 = strtotime($now);
379 $previous_stamp = strtotime($status['previous']);
381 // Archive the inbox when there had been failures for five days.
382 // Additionally ensure that at least one previous attempt has to be in between.
383 if ((($stamp2 - $stamp1) >= 86400 * 5) && ($previous_stamp > $stamp1)) {
384 $fields['archive'] = true;
387 $fields['archive'] = false;
390 if (empty($status['uri-id'])) {
391 $fields['uri-id'] = ItemURI::getIdByURI($url);
394 DBA::update('inbox-status', $fields, ['url' => $url]);
398 * Fetches JSON data for a user
400 * @param string $request request url
401 * @param integer $uid User id of the requester
403 * @return array JSON array
404 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
406 public static function fetch(string $request, int $uid): array
408 $curlResult = self::fetchRaw($request, $uid);
410 if (empty($curlResult)) {
414 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
418 $content = json_decode($curlResult->getBody(), true);
419 if (empty($content) || !is_array($content)) {
427 * Fetches raw data for a user
429 * @param string $request request url
430 * @param integer $uid User id of the requester
431 * @param boolean $binary TRUE if asked to return binary results (file download) (default is "false")
432 * @param array $opts (optional parameters) assoziative array with:
433 * 'accept_content' => supply Accept: header with 'accept_content' as the value
434 * 'timeout' => int Timeout in seconds, default system config value or 60 seconds
435 * 'nobody' => only return the header
436 * 'cookiejar' => path to cookie jar file
438 * @return \Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses CurlResult
439 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
441 public static function fetchRaw(string $request, int $uid = 0, array $opts = [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::JSON_AS]])
446 $owner = User::getOwnerDataById($uid);
451 $owner = User::getSystemAccount();
457 if (!empty($owner['uprvkey'])) {
458 // Header data that is about to be signed.
459 $host = parse_url($request, PHP_URL_HOST);
460 $path = parse_url($request, PHP_URL_PATH);
461 $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
463 $header['Date'] = $date;
464 $header['Host'] = $host;
466 $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host;
468 $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
470 $header['Signature'] = 'keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"';
474 $curl_opts[HttpClientOptions::HEADERS] = $header;
476 if (!empty($opts['nobody'])) {
477 $curlResult = DI::httpClient()->head($request, $curl_opts);
479 $curlResult = DI::httpClient()->get($request, HttpClientAccept::JSON_AS, $curl_opts);
481 $return_code = $curlResult->getReturnCode();
483 Logger::info('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code);
489 * Fetch the apcontact entry of the keyId in the given header
491 * @param array $http_headers
493 * @return array APContact entry
495 public static function getKeyIdContact(array $http_headers): array
497 if (empty($http_headers['HTTP_SIGNATURE'])) {
498 Logger::debug('No HTTP_SIGNATURE header', ['header' => $http_headers]);
502 $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
504 if (empty($sig_block['keyId'])) {
505 Logger::debug('No keyId', ['sig_block' => $sig_block]);
509 $url = (strpos($sig_block['keyId'], '#') ? substr($sig_block['keyId'], 0, strpos($sig_block['keyId'], '#')) : $sig_block['keyId']);
510 return APContact::getByURL($url);
514 * Gets a signer from a given HTTP request
516 * @param string $content
517 * @param array $http_headers
519 * @return string|null|false Signer
520 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
522 public static function getSigner(string $content, array $http_headers)
524 if (empty($http_headers['HTTP_SIGNATURE'])) {
525 Logger::debug('No HTTP_SIGNATURE header');
529 if (!empty($content)) {
530 $object = json_decode($content, true);
531 if (empty($object)) {
532 Logger::info('No object');
536 $actor = JsonLD::fetchElement($object, 'actor', 'id') ?? '';
542 $headers['(request-target)'] = strtolower(DI::args()->getMethod()) . ' ' . parse_url($http_headers['REQUEST_URI'], PHP_URL_PATH);
544 // First take every header
545 foreach ($http_headers as $k => $v) {
546 $field = str_replace('_', '-', strtolower($k));
547 $headers[$field] = $v;
550 // Now add every http header
551 foreach ($http_headers as $k => $v) {
552 if (strpos($k, 'HTTP_') === 0) {
553 $field = str_replace('_', '-', strtolower(substr($k, 5)));
554 $headers[$field] = $v;
558 $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
560 // Add fields from the signature block to the header. See issue 8845
561 if (!empty($sig_block['created']) && empty($headers['(created)'])) {
562 $headers['(created)'] = $sig_block['created'];
565 if (!empty($sig_block['expires']) && empty($headers['(expires)'])) {
566 $headers['(expires)'] = $sig_block['expires'];
569 if (empty($sig_block) || empty($sig_block['headers']) || empty($sig_block['keyId'])) {
570 Logger::info('No headers or keyId');
575 foreach ($sig_block['headers'] as $h) {
576 if (array_key_exists($h, $headers)) {
577 $signed_data .= $h . ': ' . $headers[$h] . "\n";
579 Logger::info('Requested header field not found', ['field' => $h, 'header' => $headers]);
582 $signed_data = rtrim($signed_data, "\n");
584 if (empty($signed_data)) {
585 Logger::info('Signed data is empty');
591 // Wildcard value where signing algorithm should be derived from keyId
592 // @see https://tools.ietf.org/html/draft-ietf-httpbis-message-signatures-00#section-4.1
593 // Defaulting to SHA256 as it seems to be the prevalent implementation
594 // @see https://arewehs2019yet.vpzom.click
595 if ($sig_block['algorithm'] === 'hs2019') {
596 $algorithm = 'sha256';
599 if ($sig_block['algorithm'] === 'rsa-sha256') {
600 $algorithm = 'sha256';
603 if ($sig_block['algorithm'] === 'rsa-sha512') {
604 $algorithm = 'sha512';
607 if (empty($algorithm)) {
608 Logger::info('No alagorithm');
612 $key = self::fetchKey($sig_block['keyId'], $actor);
614 Logger::info('Empty key');
618 if (!empty($key['url']) && !empty($key['type']) && ($key['type'] == 'Tombstone')) {
619 Logger::info('Actor is a tombstone', ['key' => $key]);
621 if (!Contact::isLocal($key['url'])) {
622 // We now delete everything that we possibly knew from this actor
623 Contact::deleteContactByUrl($key['url']);
628 if (empty($key['pubkey'])) {
629 Logger::info('Empty pubkey');
633 if (!Crypto::rsaVerify($signed_data, $sig_block['signature'], $key['pubkey'], $algorithm)) {
634 Logger::info('Verification failed', ['signed_data' => $signed_data, 'algorithm' => $algorithm, 'header' => $sig_block['headers'], 'http_headers' => $http_headers]);
638 $hasGoodSignedContent = false;
640 // Check the digest when it is part of the signed data
641 if (!empty($content) && in_array('digest', $sig_block['headers'])) {
642 $digest = explode('=', $headers['digest'], 2);
643 if ($digest[0] === 'SHA-256') {
646 if ($digest[0] === 'SHA-512') {
650 /// @todo add all hashes from the rfc
652 if (!empty($hashalg) && base64_encode(hash($hashalg, $content, true)) != $digest[1]) {
653 Logger::info('Digest does not match');
657 $hasGoodSignedContent = true;
660 if (in_array('date', $sig_block['headers']) && !empty($headers['date'])) {
661 $created = strtotime($headers['date']);
662 } elseif (in_array('(created)', $sig_block['headers']) && !empty($sig_block['created'])) {
663 $created = $sig_block['created'];
668 if (in_array('(expires)', $sig_block['headers']) && !empty($sig_block['expires'])) {
669 $expired = min($sig_block['expires'], $created + 300);
671 $expired = $created + 300;
674 // Check if the signed date field is in an acceptable range
675 if (!empty($created)) {
678 // Calculate with a grace period of 60 seconds to avoid slight time differences between the servers
679 if (($created - 60) > $current) {
680 Logger::notice('Signature created in the future', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
684 if ($current > $expired) {
685 Logger::notice('Signature expired', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
689 Logger::debug('Valid creation date', ['created' => date(DateTimeFormat::MYSQL, $created), 'expired' => date(DateTimeFormat::MYSQL, $expired), 'current' => date(DateTimeFormat::MYSQL, $current)]);
690 $hasGoodSignedContent = true;
693 // Check the content-length when it is part of the signed data
694 if (in_array('content-length', $sig_block['headers'])) {
695 if (strlen($content) != $headers['content-length']) {
696 Logger::info('Content length does not match');
701 // Ensure that the authentication had been done with some content
702 // Without this check someone could authenticate with fakeable data
703 if (!$hasGoodSignedContent) {
704 Logger::info('No good signed content');
712 * fetches a key for a given id and actor
715 * @param string $actor
717 * @return array with actor url and public key
720 private static function fetchKey(string $id, string $actor): array
722 $url = (strpos($id, '#') ? substr($id, 0, strpos($id, '#')) : $id);
724 $profile = APContact::getByURL($url);
725 if (!empty($profile)) {
726 Logger::info('Taking key from id', ['id' => $id]);
727 return ['url' => $url, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']];
728 } elseif ($url != $actor) {
729 $profile = APContact::getByURL($actor);
730 if (!empty($profile)) {
731 Logger::info('Taking key from actor', ['actor' => $actor]);
732 return ['url' => $actor, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']];
736 Logger::notice('Key could not be fetched', ['url' => $url, 'actor' => $actor]);