. // }}} namespace Component\FreeNetwork; use App\Core\Event; use App\Entity\Activity; use function App\Core\I18n\_m; use App\Core\Log; use App\Core\Modules\Component; use App\Core\Router\RouteLoader; use App\Core\Router\Router; use App\Entity\Actor; use App\Entity\LocalUser; use App\Entity\Note; use App\Util\Common; use App\Util\Exception\ClientException; use App\Util\Exception\NoSuchActorException; use App\Util\Exception\ServerException; use App\Util\Nickname; use Component\FreeNetwork\Controller\HostMeta; use Component\FreeNetwork\Controller\OwnerXrd; use Component\FreeNetwork\Controller\Webfinger; use Component\FreeNetwork\Util\Discovery; use Component\FreeNetwork\Util\WebfingerResource; use Component\FreeNetwork\Util\WebfingerResource\WebfingerResourceActor; use Component\FreeNetwork\Util\WebfingerResource\WebfingerResourceNote; use Exception; use Plugin\ActivityPub\Entity\ActivitypubActivity; use Plugin\ActivityPub\Util\Response\TypeResponse; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\Response; use XML_XRD_Element_Link; use function count; use function in_array; use const PREG_SET_ORDER; /** * Implements WebFinger (RFC7033) for GNU social, as well as Link-based Resource Descriptor Discovery based on RFC6415, * Web Host Metadata ('.well-known/host-meta') resource. * * @package GNUsocial * * @author Mikael Nordfeldth * @author Diogo Peralta Cordeiro */ class FreeNetwork extends Component { public const PLUGIN_VERSION = '0.1.0'; public const OAUTH_ACCESS_TOKEN_REL = 'http://apinamespace.org/oauth/access_token'; public const OAUTH_REQUEST_TOKEN_REL = 'http://apinamespace.org/oauth/request_token'; public const OAUTH_AUTHORIZE_REL = 'http://apinamespace.org/oauth/authorize'; public function onAddRoute(RouteLoader $m): bool { $m->connect('freenetwork_hostmeta', '.well-known/host-meta', [HostMeta::class, 'handle']); $m->connect( 'freenetwork_hostmeta_format', '.well-known/host-meta.:format', [HostMeta::class, 'handle'], ['format' => '(xml|json)'], ); // the resource GET parameter can be anywhere, so don't mention it here $m->connect('freenetwork_webfinger', '.well-known/webfinger', [Webfinger::class, 'handle']); $m->connect( 'freenetwork_webfinger_format', '.well-known/webfinger.:format', [Webfinger::class, 'handle'], ['format' => '(xml|json)'], ); $m->connect('freenetwork_ownerxrd', 'main/ownerxrd', [OwnerXrd::class, 'handle']); return Event::next; } public function onStartGetProfileAcctUri(Actor $profile, &$acct): bool { $wfr = new WebFingerResourceActor($profile); try { $acct = $wfr->reconstructAcct(); } catch (Exception) { return Event::next; } return Event::stop; } public function onEndGetWebFingerResource($resource, ?WebfingerResource &$target = null, array $args = []) { // * Either we didn't find the profile, then we want to make // the $profile variable null for clarity. // * Or we did find it but for a possibly malicious remote // user who might've set their profile URL to a Note URL // which would've caused a sort of DoS unless we continue // our search here by discarding the remote profile. $profile = null; if (Discovery::isAcct($resource)) { $parts = explode('@', mb_substr(urldecode($resource), 5)); // 5 is strlen of 'acct:' if (count($parts) == 2) { [$nick, $domain] = $parts; if ($domain !== $_ENV['SOCIAL_DOMAIN']) { throw new ServerException(_m('Remote profiles not supported via WebFinger yet.')); } $nick = Nickname::normalize(nickname: $nick, check_already_used: false, check_is_allowed: false); $freenetwork_actor = LocalUser::getWithPK(['nickname' => $nick]); if (!($freenetwork_actor instanceof LocalUser)) { throw new NoSuchActorException($nick); } $profile = $freenetwork_actor->getActor(); } } else { try { if (Common::isValidHttpUrl($resource)) { // This means $resource is a valid url $resource_parts = parse_url($resource); // TODO: Use URLMatcher if ($resource_parts['host'] === $_ENV['SOCIAL_DOMAIN']) { // XXX: Common::config('site', 'server')) { $str = $resource_parts['path']; // actor_view_nickname $renick = '/\/@(' . Nickname::DISPLAY_FMT . ')\/?/m'; // actor_view_id $reuri = '/\/actor\/(\d+)\/?/m'; if (preg_match_all($renick, $str, $matches, PREG_SET_ORDER, 0) === 1) { $profile = LocalUser::getWithPK(['nickname' => $matches[0][1]])->getActor(); } elseif (preg_match_all($reuri, $str, $matches, PREG_SET_ORDER, 0) === 1) { $profile = Actor::getById((int) $matches[0][1]); } } } } catch (NoSuchActorException $e) { // not a User, maybe a Note? we'll try that further down... // try { // Log::debug(__METHOD__ . ': Finding User_group URI for WebFinger lookup on resource==' . $resource); // $group = new User_group(); // $group->whereAddIn('uri', array_keys($alt_urls), $group->columnType('uri')); // $group->limit(1); // if ($group->find(true)) { // $profile = $group->getProfile(); // } // unset($group); // } catch (Exception $e) { // Log::error(get_class($e) . ': ' . $e->getMessage()); // throw $e; // } } } if ($profile instanceof Actor) { Log::debug(__METHOD__ . ': Found Profile with ID==' . $profile->getID() . ' for resource==' . $resource); $target = new WebfingerResourceActor($profile); return Event::stop; // We got our target, stop handler execution } $APNote = ActivitypubActivity::getWithPK(['object_uri' => $resource]); if ($APNote instanceof ActivitypubActivity) { $target = new WebfingerResourceNote(Note::getWithPK(['id' => $APNote->getObjectId()])); return Event::stop; // We got our target, stop handler execution } return Event::next; } public function onStartHostMetaLinks(array &$links): bool { foreach (Discovery::supportedMimeTypes() as $type) { $links[] = new XML_XRD_Element_Link( Discovery::LRDD_REL, Router::url(id: 'freenetwork_webfinger', args: [], type: Router::ABSOLUTE_URL) . '?resource={uri}', $type, isTemplate: true, ); } // TODO OAuth connections //$links[] = new XML_XRD_Element_link(self::OAUTH_ACCESS_TOKEN_REL, common_local_url('ApiOAuthAccessToken')); //$links[] = new XML_XRD_Element_link(self::OAUTH_REQUEST_TOKEN_REL, common_local_url('ApiOAuthRequestToken')); //$links[] = new XML_XRD_Element_link(self::OAUTH_AUTHORIZE_REL, common_local_url('ApiOAuthAuthorize')); return Event::next; } /** * Add a link header for LRDD Discovery */ public function onStartShowHTML($action): bool { if ($action instanceof ShowstreamAction) { $resource = $action->getTarget()->getUri(); $url = common_local_url('webfinger') . '?resource=' . urlencode($resource); foreach ([Discovery::JRD_MIMETYPE, Discovery::XRD_MIMETYPE] as $type) { header('Link: <' . $url . '>; rel="' . Discovery::LRDD_REL . '"; type="' . $type . '"', false); } } return Event::next; } public function onStartDiscoveryMethodRegistration(Discovery $disco): bool { $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodWebfinger'); return Event::next; } public function onEndDiscoveryMethodRegistration(Discovery $disco): bool { $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodHostMeta'); $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodLinkHeader'); $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodLinkHtml'); return Event::next; } /** * @throws ClientException * @throws ServerException */ public function onControllerResponseInFormat(string $route, array $accept_header, array $vars, ?TypeResponse &$response = null): bool { if (!in_array($route, ['freenetwork_hostmeta', 'freenetwork_hostmeta_format', 'freenetwork_webfinger', 'freenetwork_webfinger_format', 'freenetwork_ownerxrd'])) { return Event::next; } $mimeType = array_intersect(array_values(Discovery::supportedMimeTypes()), $accept_header); /* * "A WebFinger resource MUST return a JRD as the representation * for the resource if the client requests no other supported * format explicitly via the HTTP "Accept" header. [...] * The WebFinger resource MUST silently ignore any requested * representations that it does not understand and support." * -- RFC 7033 (WebFinger) * http://tools.ietf.org/html/rfc7033 */ $mimeType = count($mimeType) !== 0 ? array_pop($mimeType) : $vars['default_mimetype']; $headers = []; if (Common::config('discovery', 'cors')) { $headers['Access-Control-Allow-Origin'] = '*'; } $headers['Content-Type'] = $mimeType; $response = match ($mimeType) { Discovery::XRD_MIMETYPE => new Response(content: $vars['xrd']->to('xml'), headers: $headers), Discovery::JRD_MIMETYPE, Discovery::JRD_MIMETYPE_OLD => new JsonResponse(data: $vars['xrd']->to('json'), headers: $headers, json: true), }; return Event::stop; } public static function notify(Actor $sender, Activity $activity, array $targets, ?string $reason = null): bool { $protocols = []; Event::handle('AddFreeNetworkProtocol', [&$protocols]); foreach ($protocols as $protocol) { $protocol::freeNetworkDistribute($sender, $activity, $targets, $reason); } return false; } public function onPluginVersion(array &$versions): bool { $versions[] = [ 'name' => 'WebFinger', 'version' => self::PLUGIN_VERSION, 'author' => 'Mikael Nordfeldth', 'homepage' => GNUSOCIAL_ENGINE_URL, // TRANS: Plugin description. 'rawdescription' => _m('WebFinger and LRDD support'), ]; return true; } }