<?php
/**
- * @file src/Protocol/Salmon.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @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\Protocol;
+use Friendica\Core\Logger;
+use Friendica\DI;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
use Friendica\Network\Probe;
+use Friendica\Protocol\Salmon\Format\Magic;
use Friendica\Util\Crypto;
-use Friendica\Util\Network;
+use Friendica\Util\Strings;
use Friendica\Util\XML;
+use phpseclib3\Crypt\PublicKeyLoader;
/**
- * @brief Salmon Protocol class
+ * Salmon Protocol class
+ *
* The Salmon Protocol is a message exchange protocol running over HTTP designed to decentralize commentary
* and annotations made against newsfeed articles such as blog posts.
*/
/**
* @param string $uri Uniform Resource Identifier
* @param string $keyhash encoded key
- * @return mixed
+ * @return string Key or empty string on any errors
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getKey($uri, $keyhash)
+ public static function getKey(string $uri, string $keyhash): string
{
$ret = [];
- logger('Fetching salmon key for '.$uri);
+ Logger::info('Fetching salmon key for '.$uri);
$arr = Probe::lrdd($uri);
} else {
$ret[$x] = substr($ret[$x], 5);
}
- } elseif (normalise_link($ret[$x]) == 'http://') {
- $ret[$x] = Network::fetchUrl($ret[$x]);
+ } elseif (Strings::normaliseLink($ret[$x]) == 'http://') {
+ $ret[$x] = DI::httpClient()->fetch($ret[$x], HttpClientAccept::MAGIC_KEY);
+ Logger::debug('Fetched public key', ['url' => $ret[$x]]);
}
}
}
- logger('Key located: ' . print_r($ret, true));
+ Logger::notice('Key located', ['ret' => $ret]);
if (count($ret) == 1) {
- // We only found one one key so we don't care if the hash matches.
- // If it's the wrong key we'll find out soon enough because
- // message verification will fail. This also covers some older
- // software which don't supply a keyhash. As long as they only
- // have one key we'll be right.
-
- return $ret[0];
+ /* We only found one key so we don't care if the hash matches.
+ * If it's the wrong key we'll find out soon enough because
+ * message verification will fail. This also covers some older
+ * software which don't supply a keyhash. As long as they only
+ * have one key we'll be right.
+ */
+ return (string) $ret[0];
} else {
foreach ($ret as $a) {
- $hash = base64url_encode(hash('sha256', $a));
+ $hash = Strings::base64UrlEncode(hash('sha256', $a));
if ($hash == $keyhash) {
return $a;
}
* @param string $url url
* @param string $slap slap
* @return integer
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function slapper($owner, $url, $slap)
+ public static function slapper(array $owner, string $url, string $slap): int
{
// does contact have a salmon endpoint?
- if (! strlen($url)) {
- return;
+ if (!strlen($url)) {
+ return -1;
}
- if (! $owner['sprvkey']) {
- logger(sprintf("user '%s' (%d) does not have a salmon private key. Send failed.",
- $owner['username'], $owner['uid']));
- return;
+ if (!$owner['sprvkey']) {
+ Logger::notice(sprintf("user '%s' (%d) does not have a salmon private key. Send failed.",
+ $owner['name'], $owner['uid']));
+ return -1;
}
- logger('slapper called for '.$url.'. Data: ' . $slap);
+ Logger::info('slapper called for '.$url.'. Data: ' . $slap);
// create a magic envelope
- $data = base64url_encode($slap);
+ $data = Strings::base64UrlEncode($slap);
$data_type = 'application/atom+xml';
$encoding = 'base64url';
$algorithm = 'RSA-SHA256';
- $keyhash = base64url_encode(hash('sha256', self::salmonKey($owner['spubkey'])), true);
+ $keyhash = Strings::base64UrlEncode(hash('sha256', self::salmonKey($owner['spubkey'])), true);
- $precomputed = '.' . base64url_encode($data_type) . '.' . base64url_encode($encoding) . '.' . base64url_encode($algorithm);
+ $precomputed = '.' . Strings::base64UrlEncode($data_type) . '.' . Strings::base64UrlEncode($encoding) . '.' . Strings::base64UrlEncode($algorithm);
// GNU Social format
- $signature = base64url_encode(Crypto::rsaSign($data . $precomputed, $owner['sprvkey']));
+ $signature = Strings::base64UrlEncode(Crypto::rsaSign($data . $precomputed, $owner['sprvkey']));
// Compliant format
- $signature2 = base64url_encode(Crypto::rsaSign(str_replace('=', '', $data . $precomputed), $owner['sprvkey']));
+ $signature2 = Strings::base64UrlEncode(Crypto::rsaSign(str_replace('=', '', $data . $precomputed), $owner['sprvkey']));
// Old Status.net format
- $signature3 = base64url_encode(Crypto::rsaSign($data, $owner['sprvkey']));
+ $signature3 = Strings::base64UrlEncode(Crypto::rsaSign($data, $owner['sprvkey']));
// At first try the non compliant method that works for GNU Social
- $xmldata = ["me:env" => ["me:data" => $data,
- "@attributes" => ["type" => $data_type],
- "me:encoding" => $encoding,
- "me:alg" => $algorithm,
- "me:sig" => $signature,
- "@attributes2" => ["key_id" => $keyhash]]];
+ $xmldata = [
+ 'me:env' => [
+ 'me:data' => $data,
+ '@attributes' => ['type' => $data_type],
+ 'me:encoding' => $encoding,
+ 'me:alg' => $algorithm,
+ 'me:sig' => $signature,
+ '@attributes2' => ['key_id' => $keyhash],
+ ]
+ ];
- $namespaces = ["me" => "http://salmon-protocol.org/ns/magic-env"];
+ $namespaces = ['me' => ActivityNamespace::SALMON_ME];
- $salmon = XML::fromArray($xmldata, $xml, false, $namespaces);
+ $salmon = XML::fromArray($xmldata, $dummy, false, $namespaces);
// slap them
- $postResult = Network::post($url, $salmon, [
- 'Content-type: application/magic-envelope+xml',
- 'Content-length: ' . strlen($salmon)
+ $postResult = DI::httpClient()->post($url, $salmon, [
+ 'Content-type' => 'application/magic-envelope+xml',
+ 'Content-length' => strlen($salmon),
]);
$return_code = $postResult->getReturnCode();
// check for success, e.g. 2xx
if ($return_code > 299) {
- logger('GNU Social salmon failed. Falling back to compliant mode');
+ Logger::notice('GNU Social salmon failed. Falling back to compliant mode');
// Now try the compliant mode that normally isn't used for GNU Social
- $xmldata = ["me:env" => ["me:data" => $data,
- "@attributes" => ["type" => $data_type],
- "me:encoding" => $encoding,
- "me:alg" => $algorithm,
- "me:sig" => $signature2,
- "@attributes2" => ["key_id" => $keyhash]]];
-
- $namespaces = ["me" => "http://salmon-protocol.org/ns/magic-env"];
-
- $salmon = XML::fromArray($xmldata, $xml, false, $namespaces);
+ $xmldata = [
+ 'me:env' => [
+ 'me:data' => $data,
+ '@attributes' => ['type' => $data_type],
+ 'me:encoding' => $encoding,
+ 'me:alg' => $algorithm,
+ 'me:sig' => $signature2,
+ '@attributes2' => ['key_id' => $keyhash]
+ ]
+ ];
+
+ $salmon = XML::fromArray($xmldata, $dummy, false, $namespaces);
// slap them
- $postResult = Network::post($url, $salmon, [
- 'Content-type: application/magic-envelope+xml',
- 'Content-length: ' . strlen($salmon)
+ $postResult = DI::httpClient()->post($url, $salmon, [
+ 'Content-type' => 'application/magic-envelope+xml',
+ 'Content-length' => strlen($salmon),
]);
$return_code = $postResult->getReturnCode();
}
if ($return_code > 299) {
- logger('compliant salmon failed. Falling back to old status.net');
+ Logger::notice('compliant salmon failed. Falling back to old status.net');
// Last try. This will most likely fail as well.
- $xmldata = ["me:env" => ["me:data" => $data,
- "@attributes" => ["type" => $data_type],
- "me:encoding" => $encoding,
- "me:alg" => $algorithm,
- "me:sig" => $signature3,
- "@attributes2" => ["key_id" => $keyhash]]];
-
- $namespaces = ["me" => "http://salmon-protocol.org/ns/magic-env"];
-
- $salmon = XML::fromArray($xmldata, $xml, false, $namespaces);
+ $xmldata = [
+ 'me:env' => [
+ 'me:data' => $data,
+ '@attributes' => ['type' => $data_type],
+ 'me:encoding' => $encoding,
+ 'me:alg' => $algorithm,
+ 'me:sig' => $signature3,
+ '@attributes2' => ['key_id' => $keyhash],
+ ]
+ ];
+
+ $salmon = XML::fromArray($xmldata, $dummy, false, $namespaces);
// slap them
- $postResult = Network::post($url, $salmon, [
- 'Content-type: application/magic-envelope+xml',
- 'Content-length: ' . strlen($salmon)]);
+ $postResult = DI::httpClient()->post($url, $salmon, [
+ 'Content-type' => 'application/magic-envelope+xml',
+ 'Content-length' => strlen($salmon)]);
$return_code = $postResult->getReturnCode();
}
- logger('slapper for '.$url.' returned ' . $return_code);
+ Logger::info('slapper for '.$url.' returned ' . $return_code);
if (! $return_code) {
return -1;
}
- if (($return_code == 503) && (stristr(Network::getCurl()->getHeaders(), 'retry-after'))) {
+ if (($return_code == 503) && $postResult->inHeader('retry-after')) {
return -1;
}
/**
* @param string $pubkey public key
* @return string
+ * @throws \Exception
*/
- public static function salmonKey($pubkey)
+ public static function salmonKey(string $pubkey): string
{
- Crypto::pemToMe($pubkey, $m, $e);
- return 'RSA' . '.' . base64url_encode($m, true) . '.' . base64url_encode($e, true);
+ \phpseclib3\Crypt\RSA::addFileFormat(Magic::class);
+
+ return PublicKeyLoader::load($pubkey)->toString('Magic');
+ }
+
+ /**
+ * @param string $magic Magic key format starting with "RSA."
+ * @return string
+ */
+ public static function magicKeyToPem(string $magic): string
+ {
+ \phpseclib3\Crypt\RSA::addFileFormat(Magic::class);
+
+ return (string) PublicKeyLoader::load($magic);
}
}