X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FHTTPSignature.php;h=32785a60aac5b913826ef9568b5b530ee53b03db;hb=c1e8dbdbae47e79d6c9b82f4183182b0b533fb6a;hp=234d896078a6b1710df1885348ad25fdece2e610;hpb=406b46b63531bb45d73eda3badc7ba657c1ab8c0;p=friendica.git diff --git a/src/Util/HTTPSignature.php b/src/Util/HTTPSignature.php index 234d896078..cede21b3c4 100644 --- a/src/Util/HTTPSignature.php +++ b/src/Util/HTTPSignature.php @@ -1,19 +1,36 @@ . + * */ + namespace Friendica\Util; -use Friendica\BaseObject; -use Friendica\Core\Config; +use Friendica\Core\Logger; +use Friendica\Database\Database; use Friendica\Database\DBA; -use Friendica\Model\User; +use Friendica\DI; use Friendica\Model\APContact; -use Friendica\Protocol\ActivityPub; +use Friendica\Model\Contact; +use Friendica\Model\User; /** - * @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 * @@ -27,11 +44,12 @@ class HTTPSignature { // See draft-cavage-http-signatures-08 /** - * @brief Verifies a magic request + * Verifies a magic request * * @param $key * * @return array with verification data + * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ public static function verifyMagic($key) { @@ -59,7 +77,7 @@ class HTTPSignature $sig_block = self::parseSigheader($headers['authorization']); if (!$sig_block) { - logger('no signature provided.'); + Logger::log('no signature provided.'); return $result; } @@ -89,7 +107,7 @@ class HTTPSignature $key = $key($sig_block['keyId']); } - logger('Got keyID ' . $sig_block['keyId']); + Logger::log('Got keyID ' . $sig_block['keyId'], Logger::DEBUG); if (!$key) { return $result; @@ -97,7 +115,7 @@ class HTTPSignature $x = Crypto::rsaVerify($signed_data, $sig_block['signature'], $key, $algorithm); - logger('verified: ' . $x, LOGGER_DEBUG); + Logger::log('verified: ' . $x, Logger::DEBUG); if (!$x) { return $result; @@ -111,8 +129,6 @@ class HTTPSignature } /** - * @brief - * * @param array $head * @param string $prvkey * @param string $keyid (optional, default 'Key') @@ -145,8 +161,6 @@ class HTTPSignature } /** - * @brief - * * @param array $head * @param string $prvkey * @param string $alg (optional) default 'sha256' @@ -178,88 +192,67 @@ class HTTPSignature } /** - * @brief - * * @param string $header - * @return array associate array with + * @return array associative array with * - \e string \b keyID + * - \e string \b created + * - \e string \b expires * - \e string \b algorithm * - \e array \b headers * - \e string \b signature + * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ public static function parseSigheader($header) { - $ret = []; - $matches = []; + // Remove obsolete folds + $header = preg_replace('/\n\s+/', ' ', $header); - // if the header is encrypted, decrypt with (default) site private key and continue - if (preg_match('/iv="(.*?)"/ism', $header, $matches)) { - $header = self::decryptSigheader($header); - } + $token = "[!#$%&'*+.^_`|~0-9A-Za-z-]"; - if (preg_match('/keyId="(.*?)"/ism', $header, $matches)) { - $ret['keyId'] = $matches[1]; - } + $quotedString = '"(?:\\\\.|[^"\\\\])*"'; - if (preg_match('/algorithm="(.*?)"/ism', $header, $matches)) { - $ret['algorithm'] = $matches[1]; - } + $regex = "/($token+)=($quotedString|$token+)/ism"; - if (preg_match('/headers="(.*?)"/ism', $header, $matches)) { - $ret['headers'] = explode(' ', $matches[1]); - } + $matches = []; + preg_match_all($regex, $header, $matches, PREG_SET_ORDER); - if (preg_match('/signature="(.*?)"/ism', $header, $matches)) { - $ret['signature'] = base64_decode(preg_replace('/\s+/', '', $matches[1])); + $headers = []; + foreach ($matches as $match) { + $headers[$match[1]] = trim($match[2] ?: $match[3], '"'); } - if (($ret['signature']) && ($ret['algorithm']) && (!$ret['headers'])) { - $ret['headers'] = ['date']; + // if the header is encrypted, decrypt with (default) site private key and continue + if (!empty($headers['iv'])) { + $header = self::decryptSigheader($headers, DI::config()->get('system', 'prvkey')); + return self::parseSigheader($header); + } + + $return = [ + 'keyId' => $headers['keyId'] ?? '', + 'algorithm' => $headers['algorithm'] ?? 'rsa-sha256', + 'created' => $headers['created'] ?? null, + 'expires' => $headers['expires'] ?? null, + 'headers' => explode(' ', $headers['headers'] ?? ''), + 'signature' => base64_decode(preg_replace('/\s+/', '', $headers['signature'] ?? '')), + ]; + + if (!empty($return['signature']) && !empty($return['algorithm']) && empty($return['headers'])) { + $return['headers'] = ['date']; } - return $ret; + return $return; } /** - * @brief - * - * @param string $header - * @param string $prvkey (optional), if not set use site private key - * - * @return array|string associative array, empty string if failue - * - \e string \b iv - * - \e string \b key - * - \e string \b alg - * - \e string \b data + * @param array $headers Signature headers + * @param string $prvkey The site private key + * @return string Decrypted signature string + * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - private static function decryptSigheader($header, $prvkey = null) + private static function decryptSigheader(array $headers, string $prvkey) { - $iv = $key = $alg = $data = null; - - if (!$prvkey) { - $prvkey = Config::get('system', 'prvkey'); - } - - $matches = []; - - if (preg_match('/iv="(.*?)"/ism', $header, $matches)) { - $iv = $matches[1]; - } - - if (preg_match('/key="(.*?)"/ism', $header, $matches)) { - $key = $matches[1]; - } - - if (preg_match('/alg="(.*?)"/ism', $header, $matches)) { - $alg = $matches[1]; - } - - if (preg_match('/data="(.*?)"/ism', $header, $matches)) { - $data = $matches[1]; - } - - if ($iv && $key && $alg && $data) { - return Crypto::unencapsulate(['iv' => $iv, 'key' => $key, 'alg' => $alg, 'data' => $data], $prvkey); + if (!empty($headers['iv']) && !empty($headers['key']) && !empty($headers['data'])) { + return Crypto::unencapsulate($headers, $prvkey); } return ''; @@ -270,11 +263,14 @@ 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 + * @param integer $uid User id of the sender * - * @param $data - * @param $target - * @param $uid + * @return boolean Was the transmission successful? + * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ public static function transmit($data, $target, $uid) { @@ -291,43 +287,208 @@ class HTTPSignature $path = parse_url($target, PHP_URL_PATH); $digest = 'SHA-256=' . base64_encode(hash('sha256', $content, true)); $content_length = strlen($content); + $date = DateTimeFormat::utcNow(DateTimeFormat::HTTP); - $headers = ['Content-Length: ' . $content_length, 'Digest: ' . $digest, 'Host: ' . $host]; + $headers = ['Date: ' . $date, 'Content-Length: ' . $content_length, 'Digest: ' . $digest, 'Host: ' . $host]; - $signed_data = "(request-target): post " . $path . "\ncontent-length: " . $content_length . "\ndigest: " . $digest . "\nhost: " . $host; + $signed_data = "(request-target): post " . $path . "\ndate: ". $date . "\ncontent-length: " . $content_length . "\ndigest: " . $digest . "\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) content-length digest host",signature="' . $signature . '"'; + $headers[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date content-length digest host",signature="' . $signature . '"'; $headers[] = 'Content-Type: application/activity+json'; - Network::post($target, $content, $headers); - $return_code = BaseObject::getApp()->get_curl_code(); + $postResult = DI::httpRequest()->post($target, $content, $headers); + $return_code = $postResult->getReturnCode(); + + Logger::log('Transmit to ' . $target . ' returned ' . $return_code, Logger::DEBUG); + + $success = ($return_code >= 200) && ($return_code <= 299); + + self::setInboxStatus($target, $success); + + return $success; + } + + /** + * Set the delivery status for a given inbox + * + * @param string $url The URL of the inbox + * @param boolean $success Transmission status + * @param boolean $shared The inbox is a shared inbox + */ + static public function setInboxStatus($url, $success, $shared = false) + { + $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); + $status = DBA::selectFirst('inbox-status', [], ['url' => $url]); + } + + if ($success) { + $fields = ['success' => $now]; + } else { + $fields = ['failure' => $now]; + } + + if ($status['failure'] > DBA::NULL_DATETIME) { + $new_previous_stamp = strtotime($status['failure']); + $old_previous_stamp = strtotime($status['previous']); + + // 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']; + } + } + + if (!$success) { + if ($status['success'] <= DBA::NULL_DATETIME) { + $stamp1 = strtotime($status['created']); + } else { + $stamp1 = strtotime($status['success']); + } + + $stamp2 = strtotime($now); + $previous_stamp = strtotime($status['previous']); + + // 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; + } + + DBA::update('inbox-status', $fields, ['url' => $url]); + } + + /** + * 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) + { + $curlResult = self::fetchRaw($request, $uid); + + 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; + } + + return $content; + } + + /** + * 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 + * '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, $opts = ['accept_content' => 'application/activity+json, application/ld+json']) + { + $header = []; + + if (!empty($uid)) { + $owner = User::getOwnerDataById($uid); + if (!$owner) { + return; + } + } else { + $owner = User::getSystemAccount(); + if (!$owner) { + return; + } + } + + if (!empty($owner['uprvkey'])) { + // 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); + + $header = ['Date: ' . $date, 'Host: ' . $host]; + + $signed_data = "(request-target): get " . $path . "\ndate: ". $date . "\nhost: " . $host; + + $signature = base64_encode(Crypto::rsaSign($signed_data, $owner['uprvkey'], 'sha256')); - logger('Transmit to ' . $target . ' returned ' . $return_code); + $header[] = 'Signature: keyId="' . $owner['url'] . '#main-key' . '",algorithm="rsa-sha256",headers="(request-target) date host",signature="' . $signature . '"'; + } + + if (!empty($opts['accept_content'])) { + $header[] = 'Accept: ' . $opts['accept_content']; + } + + $curl_opts = $opts; + $curl_opts['header'] = $header; + + if (!empty($opts['nobody'])) { + $curlResult = DI::httpRequest()->head($request, $curl_opts); + } else { + $curlResult = DI::httpRequest()->get($request, $curl_opts); + } + $return_code = $curlResult->getReturnCode(); + + Logger::log('Fetched for user ' . $uid . ' from ' . $request . ' returned ' . $return_code, Logger::DEBUG); + + return $curlResult; } /** - * @brief Gets a signer from a given HTTP request + * Gets a signer from a given HTTP request * * @param $content * @param $http_headers * - * @return signer string + * @return string Signer + * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ public static function getSigner($content, $http_headers) { - $object = json_decode($content, true); - - if (empty($object)) { + if (empty($http_headers['HTTP_SIGNATURE'])) { return false; } - $actor = JsonLD::fetchElement($object, 'actor', 'id'); + if (!empty($content)) { + $object = json_decode($content, true); + if (empty($object)) { + return false; + } + + $actor = JsonLD::fetchElement($object, 'actor', 'id'); + } else { + $actor = ''; + } $headers = []; - $headers['(request-target)'] = strtolower($http_headers['REQUEST_METHOD']) . ' ' . $http_headers['REQUEST_URI']; + $headers['(request-target)'] = strtolower($http_headers['REQUEST_METHOD']) . ' ' . parse_url($http_headers['REQUEST_URI'], PHP_URL_PATH); // First take every header foreach ($http_headers as $k => $v) { @@ -363,6 +524,14 @@ class HTTPSignature $algorithm = null; + // Wildcard value where signing algorithm should be derived from keyId + // @see https://tools.ietf.org/html/draft-ietf-httpbis-message-signatures-00#section-4.1 + // Defaulting to SHA256 as it seems to be the prevalent implementation + // @see https://arewehs2019yet.vpzom.click + if ($sig_block['algorithm'] === 'hs2019') { + $algorithm = 'sha256'; + } + if ($sig_block['algorithm'] === 'rsa-sha256') { $algorithm = 'sha256'; } @@ -376,17 +545,30 @@ class HTTPSignature } $key = self::fetchKey($sig_block['keyId'], $actor); - if (empty($key)) { return false; } + if (!empty($key['url']) && !empty($key['type']) && ($key['type'] == 'Tombstone')) { + Logger::info('Actor is a tombstone', ['key' => $key]); + + // We now delete everything that we possibly knew from this actor + Contact::deleteContactByUrl($key['url']); + return false; + } + + if (empty($key['pubkey'])) { + return false; + } + if (!Crypto::rsaVerify($signed_data, $sig_block['signature'], $key['pubkey'], $algorithm)) { 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'; @@ -400,6 +582,18 @@ 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 + if (in_array('date', $sig_block['headers'])) { + $diff = abs(strtotime($headers['date']) - time()); + if ($diff > 300) { + 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 @@ -409,16 +603,23 @@ 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 * * @return array with actor url and public key + * @throws \Exception */ private static function fetchKey($id, $actor) { @@ -426,13 +627,13 @@ class HTTPSignature $profile = APContact::getByURL($url); if (!empty($profile)) { - logger('Taking key from id ' . $id, LOGGER_DEBUG); - return ['url' => $url, 'pubkey' => $profile['pubkey']]; + Logger::log('Taking key from id ' . $id, Logger::DEBUG); + return ['url' => $url, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']]; } elseif ($url != $actor) { $profile = APContact::getByURL($actor); if (!empty($profile)) { - logger('Taking key from actor ' . $actor, LOGGER_DEBUG); - return ['url' => $actor, 'pubkey' => $profile['pubkey']]; + Logger::log('Taking key from actor ' . $actor, Logger::DEBUG); + return ['url' => $actor, 'pubkey' => $profile['pubkey'], 'type' => $profile['type']]; } }