]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/HTTPSignature.php
bump version 2023.12
[friendica.git] / src / Util / HTTPSignature.php
index faad39dde5115c06bcc27c7aef5dcfc14dbe9a53..9e130bc9166b00d86aaa7f0a3df1bcdaaa41e3cb 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
 namespace Friendica\Util;
 
 use Friendica\Core\Logger;
+use Friendica\Core\Protocol;
 use Friendica\Database\Database;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Model\APContact;
 use Friendica\Model\Contact;
+use Friendica\Model\GServer;
+use Friendica\Model\ItemURI;
 use Friendica\Model\User;
-use Friendica\Network\HTTPClient\Client\HttpClient;
+use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
 
 /**
@@ -53,7 +57,7 @@ class HTTPSignature
         * @return array with verification data
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function verifyMagic($key)
+       public static function verifyMagic(string $key): array
        {
                $headers   = null;
                $spoofable = false;
@@ -137,7 +141,7 @@ class HTTPSignature
         *
         * @return array
         */
-       public static function createSig($head, $prvkey, $keyid = 'Key')
+       public static function createSig(array $head, string $prvkey, string $keyid = 'Key'): array
        {
                $return_headers = [];
                if (!empty($head)) {
@@ -164,7 +168,7 @@ class HTTPSignature
         *
         * @return array
         */
-       private static function sign($head, $prvkey, $alg = 'sha256')
+       private static function sign(array $head, string $prvkey, string $alg = 'sha256'): array
        {
                $ret = [];
                $headers = '';
@@ -202,7 +206,7 @@ class HTTPSignature
         *   - \e string \b signature
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function parseSigheader($header)
+       public static function parseSigheader(string $header): array
        {
                // Remove obsolete folds
                $header = preg_replace('/\n\s+/', ' ', $header);
@@ -249,7 +253,7 @@ class HTTPSignature
         * @return string Decrypted signature string
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       private static function decryptSigheader(array $headers, string $prvkey)
+       private static function decryptSigheader(array $headers, string $prvkey): string
        {
                if (!empty($headers['iv']) && !empty($headers['key']) && !empty($headers['data'])) {
                        return Crypto::unencapsulate($headers, $prvkey);
@@ -263,23 +267,16 @@ class HTTPSignature
         */
 
        /**
-        * Transmit given data to a target for a user
+        * Post given data to a target for a user, returns the result class
         *
-        * @param array   $data   Data that is about to be send
-        * @param string  $target The URL of the inbox
-        * @param integer $uid    User id of the sender
+        * @param array  $data   Data that is about to be sent
+        * @param string $target The URL of the inbox
+        * @param array  $owner  Sender owner-view record
         *
-        * @return boolean Was the transmission successful?
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @return ICanHandleHttpResponses
         */
-       public static function transmit($data, $target, $uid)
+       public static function post(array $data, string $target, array $owner): ICanHandleHttpResponses
        {
-               $owner = User::getOwnerDataById($uid);
-
-               if (!$owner) {
-                       return;
-               }
-
                $content = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
 
                // Header data that is about to be signed.
@@ -304,16 +301,31 @@ class HTTPSignature
 
                $headers['Content-Type'] = 'application/activity+json';
 
-               $postResult = DI::httpClient()->post($target, $content, $headers);
+               $postResult = DI::httpClient()->post($target, $content, $headers, DI::config()->get('system', 'curl_timeout'));
                $return_code = $postResult->getReturnCode();
 
                Logger::info('Transmit to ' . $target . ' returned ' . $return_code);
 
-               $success = ($return_code >= 200) && ($return_code <= 299);
+               self::setInboxStatus($target, ($return_code >= 200) && ($return_code <= 299));
 
-               self::setInboxStatus($target, $success);
+               return $postResult;
+       }
 
-               return $success;
+       /**
+        * Transmit given data to a target for a user
+        *
+        * @param array  $data   Data that is about to be sent
+        * @param string $target The URL of the inbox
+        * @param array  $owner  Sender owner-vew record
+        *
+        * @return boolean Was the transmission successful?
+        */
+       public static function transmit(array $data, string $target, array $owner): bool
+       {
+               $postResult = self::post($data, $target, $owner);
+               $return_code = $postResult->getReturnCode();
+
+               return ($return_code >= 200) && ($return_code <= 299);
        }
 
        /**
@@ -322,15 +334,26 @@ class HTTPSignature
         * @param string  $url     The URL of the inbox
         * @param boolean $success Transmission status
         * @param boolean $shared  The inbox is a shared inbox
+        * @param int     $gsid    Server ID
+        * @throws \Exception
         */
-       static public function setInboxStatus($url, $success, $shared = false)
+       static public function setInboxStatus(string $url, bool $success, bool $shared = false, int $gsid = null)
        {
                $now = DateTimeFormat::utcNow();
 
                $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
                if (!DBA::isResult($status)) {
-                       DBA::insert('inbox-status', ['url' => $url, 'created' => $now, 'shared' => $shared], Database::INSERT_IGNORE);
+                       $insertFields = ['url' => $url, 'uri-id' => ItemURI::getIdByURI($url), 'created' => $now, 'shared' => $shared];
+                       if (!empty($gsid)) {
+                               $insertFields['gsid'] = $gsid;
+                       }
+                       DBA::insert('inbox-status', $insertFields, Database::INSERT_IGNORE);
+
                        $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
+                       if (empty($status)) {
+                               Logger::warning('Unable to insert inbox-status row', $insertFields);
+                               return;
+                       }
                }
 
                if ($success) {
@@ -339,6 +362,10 @@ class HTTPSignature
                        $fields = ['failure' => $now];
                }
 
+               if (!empty($gsid)) {
+                       $fields['gsid'] = $gsid;
+               }
+
                if ($status['failure'] > DBA::NULL_DATETIME) {
                        $new_previous_stamp = strtotime($status['failure']);
                        $old_previous_stamp = strtotime($status['previous']);
@@ -369,7 +396,19 @@ class HTTPSignature
                        $fields['archive'] = false;
                }
 
+               if (empty($status['uri-id'])) {
+                       $fields['uri-id'] = ItemURI::getIdByURI($url);
+               }
+
                DBA::update('inbox-status', $fields, ['url' => $url]);
+
+               if (!empty($status['gsid'])) {
+                       if ($success) {
+                               GServer::setReachableById($status['gsid'], Protocol::ACTIVITYPUB);
+                       } elseif ($status['shared']) {
+                               GServer::setFailureById($status['gsid']);
+                       }
+               }
        }
 
        /**
@@ -381,21 +420,27 @@ class HTTPSignature
         * @return array JSON array
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function fetch($request, $uid)
+       public static function fetch(string $request, int $uid = 0): array
        {
-               $curlResult = self::fetchRaw($request, $uid);
+               try {
+                       $curlResult = self::fetchRaw($request, $uid);
+               } catch (\Exception $exception) {
+                       Logger::notice('Error fetching url', ['url' => $request, 'exception' => $exception]);
+                       return [];
+               }
 
                if (empty($curlResult)) {
-                       return false;
+                       return [];
                }
 
                if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
-                       return false;
+                       Logger::debug('Fetching was unsuccessful', ['url' => $request, 'return-code' => $curlResult->getReturnCode(), 'error-number' => $curlResult->getErrorNumber(), 'error' => $curlResult->getError()]);
+                       return [];
                }
 
                $content = json_decode($curlResult->getBody(), true);
                if (empty($content) || !is_array($content)) {
-                       return false;
+                       return [];
                }
 
                return $content;
@@ -407,7 +452,7 @@ class HTTPSignature
         * @param string  $request request url
         * @param integer $uid     User id of the requester
         * @param boolean $binary  TRUE if asked to return binary results (file download) (default is "false")
-        * @param array   $opts    (optional parameters) assoziative array with:
+        * @param array   $opts    (optional parameters) associative array with:
         *                         'accept_content' => supply Accept: header with 'accept_content' as the value
         *                         'timeout' => int Timeout in seconds, default system config value or 60 seconds
         *                         'nobody' => only return the header
@@ -416,7 +461,7 @@ class HTTPSignature
         * @return \Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses CurlResult
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function fetchRaw($request, $uid = 0, $opts = ['accept_content' => [HttpClient::ACCEPT_JSON_AS]])
+       public static function fetchRaw(string $request, int $uid = 0, array $opts = [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::JSON_AS]])
        {
                $header = [];
 
@@ -454,7 +499,7 @@ class HTTPSignature
                if (!empty($opts['nobody'])) {
                        $curlResult = DI::httpClient()->head($request, $curl_opts);
                } else {
-                       $curlResult = DI::httpClient()->get($request, $curl_opts);
+                       $curlResult = DI::httpClient()->get($request, HttpClientAccept::JSON_AS, $curl_opts);
                }
                $return_code = $curlResult->getReturnCode();
 
@@ -463,16 +508,41 @@ class HTTPSignature
                return $curlResult;
        }
 
+       /**
+        * Fetch the apcontact entry of the keyId in the given header
+        *
+        * @param array $http_headers
+        *
+        * @return array APContact entry
+        */
+       public static function getKeyIdContact(array $http_headers): array
+       {
+               if (empty($http_headers['HTTP_SIGNATURE'])) {
+                       Logger::debug('No HTTP_SIGNATURE header', ['header' => $http_headers]);
+                       return [];
+               }
+
+               $sig_block = self::parseSigHeader($http_headers['HTTP_SIGNATURE']);
+
+               if (empty($sig_block['keyId'])) {
+                       Logger::debug('No keyId', ['sig_block' => $sig_block]);
+                       return [];
+               }
+
+               $url = (strpos($sig_block['keyId'], '#') ? substr($sig_block['keyId'], 0, strpos($sig_block['keyId'], '#')) : $sig_block['keyId']);
+               return APContact::getByURL($url);
+       }
+
        /**
         * Gets a signer from a given HTTP request
         *
-        * @param $content
-        * @param $http_headers
+        * @param string $content
+        * @param array $http_headers
         *
-        * @return string Signer
+        * @return string|null|false Signer
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function getSigner($content, $http_headers)
+       public static function getSigner(string $content, array $http_headers)
        {
                if (empty($http_headers['HTTP_SIGNATURE'])) {
                        Logger::debug('No HTTP_SIGNATURE header');
@@ -486,7 +556,7 @@ class HTTPSignature
                                return false;
                        }
 
-                       $actor = JsonLD::fetchElement($object, 'actor', 'id');
+                       $actor = JsonLD::fetchElement($object, 'actor', 'id') ?? '';
                } else {
                        $actor = '';
                }
@@ -558,7 +628,7 @@ class HTTPSignature
                }
 
                if (empty($algorithm)) {
-                       Logger::info('No alagorithm');
+                       Logger::info('No algorithm');
                        return false;
                }
 
@@ -664,13 +734,13 @@ class HTTPSignature
        /**
         * fetches a key for a given id and actor
         *
-        * @param $id
-        * @param $actor
+        * @param string $id
+        * @param string $actor
         *
         * @return array with actor url and public key
         * @throws \Exception
         */
-       private static function fetchKey($id, $actor)
+       private static function fetchKey(string $id, string $actor): array
        {
                $url = (strpos($id, '#') ? substr($id, 0, strpos($id, '#')) : $id);
 
@@ -687,6 +757,6 @@ class HTTPSignature
                }
 
                Logger::notice('Key could not be fetched', ['url' => $url, 'actor' => $actor]);
-               return false;
+               return [];
        }
 }