]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/HTTPSignature.php
Merge pull request #8277 from MrPetovan/task/8251-use-about-for-pdesc
[friendica.git] / src / Util / HTTPSignature.php
index a3a73ce1366ddfab6d2e516d62b9e8de01e89a34..e4d2e93ff0ac9bf09587768722602a45689682d2 100644 (file)
@@ -1,17 +1,34 @@
 <?php
-
 /**
- * @file src/Util/HTTPSignature.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Util;
 
-use Friendica\Core\Config;
+use Friendica\Database\DBA;
 use Friendica\Core\Logger;
+use Friendica\DI;
 use Friendica\Model\User;
 use Friendica\Model\APContact;
 
 /**
- * @brief Implements HTTP Signatures per draft-cavage-http-signatures-07.
+ * Implements HTTP Signatures per draft-cavage-http-signatures-07.
  *
  * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/Zotlabs/Web/HTTPSig.php
  *
@@ -25,7 +42,7 @@ class HTTPSignature
 {
        // See draft-cavage-http-signatures-08
        /**
-        * @brief Verifies a magic request
+        * Verifies a magic request
         *
         * @param $key
         *
@@ -110,8 +127,6 @@ class HTTPSignature
        }
 
        /**
-        * @brief
-        *
         * @param array   $head
         * @param string  $prvkey
         * @param string  $keyid (optional, default 'Key')
@@ -144,8 +159,6 @@ class HTTPSignature
        }
 
        /**
-        * @brief
-        *
         * @param array  $head
         * @param string $prvkey
         * @param string $alg (optional) default 'sha256'
@@ -177,8 +190,6 @@ class HTTPSignature
        }
 
        /**
-        * @brief
-        *
         * @param string $header
         * @return array associate array with
         *   - \e string \b keyID
@@ -223,8 +234,6 @@ class HTTPSignature
        }
 
        /**
-        * @brief
-        *
         * @param string $header
         * @param string $prvkey (optional), if not set use site private key
         *
@@ -240,7 +249,7 @@ class HTTPSignature
                $iv = $key = $alg = $data = null;
 
                if (!$prvkey) {
-                       $prvkey = Config::get('system', 'prvkey');
+                       $prvkey = DI::config()->get('system', 'prvkey');
                }
 
                $matches = [];
@@ -273,7 +282,7 @@ class HTTPSignature
         */
 
        /**
-        * @brief Transmit given data to a target for a user
+        * Transmit given data to a target for a user
         *
         * @param array   $data   Data that is about to be send
         * @param string  $target The URL of the inbox
@@ -314,52 +323,91 @@ class HTTPSignature
 
                Logger::log('Transmit to ' . $target . ' returned ' . $return_code, Logger::DEBUG);
 
-               return ($return_code >= 200) && ($return_code <= 299);
+               $success = ($return_code >= 200) && ($return_code <= 299);
+
+               self::setInboxStatus($target, $success);
+
+               return $success;
        }
 
        /**
-        * @brief Fetches JSON data for a user
-        *
-        * @param string  $request request url
-        * @param integer $uid     User id of the requester
+        * Set the delivery status for a given inbox
         *
-        * @return array JSON array
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @param string  $url     The URL of the inbox
+        * @param boolean $success Transmission status
         */
-       public static function fetch($request, $uid)
+       static private function setInboxStatus($url, $success)
        {
-               $owner = User::getOwnerDataById($uid);
+               $now = DateTimeFormat::utcNow();
 
-               if (!$owner) {
-                       return;
+               $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
+               if (!DBA::isResult($status)) {
+                       DBA::insert('inbox-status', ['url' => $url, 'created' => $now]);
+                       $status = DBA::selectFirst('inbox-status', [], ['url' => $url]);
                }
 
-               // Header data that is about to be signed.
-               $host = parse_url($request, PHP_URL_HOST);
-               $path = parse_url($request, PHP_URL_PATH);
-               $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
+               if ($success) {
+                       $fields = ['success' => $now];
+               } else {
+                       $fields = ['failure' => $now];
+               }
 
-               $headers = ['Date: ' . $date, 'Host: ' . $host];
+               if ($status['failure'] > DBA::NULL_DATETIME) {
+                       $new_previous_stamp = strtotime($status['failure']);
+                       $old_previous_stamp = strtotime($status['previous']);
 
-               $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host;
+                       // Only set "previous" with at least one day difference.
+                       // We use this to assure to not accidentally archive too soon.
+                       if (($new_previous_stamp - $old_previous_stamp) >= 86400) {
+                               $fields['previous'] = $status['failure'];
+                       }
+               }
 
-               $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
+               if (!$success) {
+                       if ($status['success'] <= DBA::NULL_DATETIME) {
+                               $stamp1 = strtotime($status['created']);
+                       } else {
+                               $stamp1 = strtotime($status['success']);
+                       }
 
-               $headers[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"';
+                       $stamp2 = strtotime($now);
+                       $previous_stamp = strtotime($status['previous']);
 
-               $headers[] = 'Accept: application/activity+json, application/ld+json';
+                       // Archive the inbox when there had been failures for five days.
+                       // Additionally ensure that at least one previous attempt has to be in between.
+                       if ((($stamp2 - $stamp1) >= 86400 * 5) && ($previous_stamp > $stamp1)) {
+                               $fields['archive'] = true;
+                       }
+               } else {
+                       $fields['archive'] = false;
+               }
 
-               $curlResult = Network::curl($request, false, $redirects, ['header' => $headers]);
-               $return_code = $curlResult->getReturnCode();
+               DBA::update('inbox-status', $fields, ['url' => $url]);
+       }
 
-               Logger::log('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code, Logger::DEBUG);
+       /**
+        * Fetches JSON data for a user
+        *
+        * @param string  $request request url
+        * @param integer $uid     User id of the requester
+        *
+        * @return array JSON array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       public static function fetch($request, $uid)
+       {
+               $opts = ['accept_content' => 'application/activity+json, application/ld+json'];
+               $curlResult = self::fetchRaw($request, $uid, false, $opts);
+
+               if (empty($curlResult)) {
+                       return false;
+               }
 
                if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
                        return false;
                }
 
                $content = json_decode($curlResult->getBody(), true);
-
                if (empty($content) || !is_array($content)) {
                        return false;
                }
@@ -368,7 +416,63 @@ class HTTPSignature
        }
 
        /**
-        * @brief Gets a signer from a given HTTP request
+        * Fetches raw data for a user
+        *
+        * @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:
+        *                         'accept_content' => supply Accept: header with 'accept_content' as the value
+        *                         'timeout' => int Timeout in seconds, default system config value or 60 seconds
+        *                         'http_auth' => username:password
+        *                         'novalidate' => do not validate SSL certs, default is to validate using our CA list
+        *                         'nobody' => only return the header
+        *                         'cookiejar' => path to cookie jar file
+        *
+        * @return object CurlResult
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       public static function fetchRaw($request, $uid = 0, $binary = false, $opts = [])
+       {
+               if (!empty($uid)) {
+                       $owner = User::getOwnerDataById($uid);
+                       if (!$owner) {
+                               return;
+                       }
+
+                       // Header data that is about to be signed.
+                       $host = parse_url($request, PHP_URL_HOST);
+                       $path = parse_url($request, PHP_URL_PATH);
+                       $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP);
+
+                       $headers = ['Date: ' . $date, 'Host: ' . $host];
+
+                       $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host;
+
+                       $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256'));
+
+                       $headers[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"';
+               } else {
+                       $headers = [];
+               }
+
+               if (!empty($opts['accept_content'])) {
+                       $headers[] = 'Accept: ' . $opts['accept_content'];
+               }
+
+               $curl_opts = $opts;
+               $curl_opts['header'] = $headers;
+
+               $curlResult = Network::curl($request, false, $curl_opts);
+               $return_code = $curlResult->getReturnCode();
+
+               Logger::log('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code, Logger::DEBUG);
+
+               return $curlResult;
+       }
+
+       /**
+        * Gets a signer from a given HTTP request
         *
         * @param $content
         * @param $http_headers
@@ -452,8 +556,10 @@ class HTTPSignature
                        return false;
                }
 
+               $hasGoodSignedContent = false;
+
                // Check the digest when it is part of the signed data
-               if (in_array('digest', $sig_block['headers'])) {
+               if (!empty($content) && in_array('digest', $sig_block['headers'])) {
                        $digest = explode('=', $headers['digest'], 2);
                        if ($digest[0] === 'SHA-256') {
                                $hashalg = 'sha256';
@@ -467,6 +573,8 @@ class HTTPSignature
                        if (!empty($hashalg) && base64_encode(hash($hashalg, $content, true)) != $digest[1]) {
                                return false;
                        }
+
+                       $hasGoodSignedContent = true;
                }
 
                //  Check if the signed date field is in an acceptable range
@@ -476,6 +584,7 @@ class HTTPSignature
                                Logger::log("Header date '" . $headers['date'] . "' is with " . $diff . " seconds out of the 300 second frame. The signature is invalid.");
                                return false;
                        }
+                       $hasGoodSignedContent = true;
                }
 
                // Check the content-length when it is part of the signed data
@@ -485,11 +594,17 @@ class HTTPSignature
                        }
                }
 
+               // Ensure that the authentication had been done with some content
+               // Without this check someone could authenticate with fakeable data
+               if (!$hasGoodSignedContent) {
+                       return false;
+               }
+
                return $key['url'];
        }
 
        /**
-        * @brief fetches a key for a given id and actor
+        * fetches a key for a given id and actor
         *
         * @param $id
         * @param $actor