3 * @copyright Copyright (C) 2010-2023, 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\Module\OStatus;
25 use Friendica\Core\L10n;
26 use Friendica\Core\Protocol;
27 use Friendica\Database\Database;
28 use Friendica\Model\GServer;
29 use Friendica\Model\Post;
30 use Friendica\Module\Response;
31 use Friendica\Protocol\ActivityNamespace;
32 use Friendica\Protocol\OStatus;
33 use Friendica\Util\Crypto;
34 use Friendica\Util\Network;
35 use Friendica\Network\HTTPException;
36 use Friendica\Protocol\Salmon as SalmonProtocol;
37 use Friendica\Util\Profiler;
38 use Friendica\Util\Strings;
39 use Psr\Log\LoggerInterface;
42 * Technical endpoint for the Salmon protocol
44 class Salmon extends \Friendica\BaseModule
49 public function __construct(Database $database, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
51 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
53 $this->database = $database;
57 * @param array $request
59 * @throws HTTPException\AcceptedException
60 * @throws HTTPException\BadRequestException
61 * @throws HTTPException\InternalServerErrorException
62 * @throws HTTPException\OKException
63 * @throws \ImagickException
65 protected function post(array $request = [])
67 $xml = Network::postdata();
68 $this->logger->debug('Got request data.', ['request' => $request]);
70 $nickname = $this->parameters['nickname'] ?? '';
71 if (empty($nickname)) {
72 throw new HTTPException\BadRequestException('nickname parameter is mandatory');
75 $this->logger->debug('New Salmon', ['nickname' => $nickname, 'xml' => $xml]);
77 $importer = $this->database->selectFirst('user', [], ['nickname' => $nickname, 'account_expired' => false, 'account_removed' => false]);
78 if (!$this->database->isResult($importer)) {
79 throw new HTTPException\InternalServerErrorException();
83 $dom = simplexml_load_string($xml, 'SimpleXMLElement', 0, ActivityNamespace::SALMON_ME);
87 // figure out where in the DOM tree our data is hiding
88 if (!empty($dom->provenance->data)) {
89 $base = $dom->provenance;
90 } elseif (!empty($dom->env->data)) {
92 } elseif (!empty($dom->data)) {
97 $this->logger->notice('unable to locate salmon data in xml');
98 throw new HTTPException\BadRequestException();
101 // Stash the signature away for now. We have to find their key or it won't be good for anything.
102 $signature = Strings::base64UrlDecode($base->sig);
106 // strip whitespace so our data element will return to one big base64 blob
107 $data = str_replace([" ", "\t", "\r", "\n"], ["", "", "", ""], $base->data);
109 // stash away some other stuff for later
111 $type = $base->data[0]->attributes()->type[0];
112 $keyhash = $base->sig[0]->attributes()->keyhash[0] ?? '';
113 $encoding = $base->encoding;
116 // Salmon magic signatures have evolved and there is no way of knowing ahead of time which
117 // flavour we have. We'll try and verify it regardless.
119 $stnet_signed_data = $data;
121 $signed_data = $data . '.' . Strings::base64UrlEncode($type) . '.' . Strings::base64UrlEncode($encoding) . '.' . Strings::base64UrlEncode($alg);
123 $compliant_format = str_replace('=', '', $signed_data);
127 $data = Strings::base64UrlDecode($data);
129 $author = OStatus::salmonAuthor($data, $importer);
130 $author_link = $author["author-link"];
132 $this->logger->notice('Could not retrieve author URI.');
133 throw new HTTPException\BadRequestException();
136 // Once we have the author URI, go to the web and try to find their public key
138 $this->logger->notice('Fetching key for ' . $author_link);
140 $key = SalmonProtocol::getKey($author_link, $keyhash);
143 $this->logger->notice('Could not retrieve author key.');
144 throw new HTTPException\BadRequestException();
147 $this->logger->info('Key details', ['info' => $key]);
149 $pubkey = SalmonProtocol::magicKeyToPem($key);
151 // We should have everything we need now. Let's see if it verifies.
153 // Try GNU Social format
154 $verify = Crypto::rsaVerify($signed_data, $signature, $pubkey);
158 $this->logger->notice('Message did not verify using protocol. Trying compliant format.');
159 $verify = Crypto::rsaVerify($compliant_format, $signature, $pubkey);
164 $this->logger->notice('Message did not verify using padding. Trying old statusnet format.');
165 $verify = Crypto::rsaVerify($stnet_signed_data, $signature, $pubkey);
170 $this->logger->notice('Message did not verify. Discarding.');
171 throw new HTTPException\BadRequestException();
174 $this->logger->notice('Message verified with mode ' . $mode);
179 * If we reached this point, the message is good. Now let's figure out if the author is allowed to send us stuff.
183 $contact = $this->database->selectFirst(
188 AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)
190 Protocol::OSTATUS, Protocol::DFRN,
191 Strings::normaliseLink($author_link), $author_link, Strings::normaliseLink($author_link),
196 if (!empty($contact['gsid'])) {
197 GServer::setProtocol($contact['gsid'], Post\DeliveryData::OSTATUS);
200 // Have we ignored the person?
201 // If so we can not accept this post.
203 if (!empty($contact['blocked'])) {
204 $this->logger->notice('Ignoring this author.');
205 throw new HTTPException\AcceptedException();
208 // Placeholder for hub discovery.
211 $contact = $contact ?: [];
213 OStatus::import($data, $importer, $contact, $hub);
215 throw new HTTPException\OKException();