forked from GNUsocial/gnu-social
		
	Instructions below
To extend an Activity properties do:
public function onActivityPubValidateActivityStreamsTwoData(string $type_name, array &$validators): bool {
    if ($type_name === '{Type}') {
        $validators['attribute'] = myValidator::class;
    }
    return Event::next;
}
The Validator should be of the form:
use ActivityPhp\Type;
use ActivityPhp\Type\Util;
use Plugin\ActivityPub\Util\ModelValidator;
class myValidator extends ModelValidator
{
    /**
     * Validate Attribute's value
     *
     * @param mixed $value from JSON's attribute
     * @param mixed $container A {Type}
     * @return bool
     * @throws Exception
     */
    public function validate($value, $container): bool
    {
        // Validate that container is a {Type}
        Util::subclassOf($container, Type\Extended\Object\{Type}::class, true);
        return {Validation Result};
To act on received activities do:
public function onActivityPubNew{Type}(&$obj): bool {
To add information to Activities being federated by ActivityPub do:
public function ActivityPubAddActivityStreamsTwoData(string $type_name, &$type): bool {
To implement an ActivityStreams 2.0 representation do:
public function onActivityPubActivityStreamsTwoResponse(string $route, arrray $vars, ?TypeResponse &$response = null): bool {
        if ($route === '{Object route}') {
                $response = ModelResponse::handle($vars[{Object}]);
                return Event::stop;
        }
        return Event::next;
}
		
	
		
			
				
	
	
		
			158 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			158 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| 
 | |
| declare(strict_types=1);
 | |
| 
 | |
| // {{{ License
 | |
| // This file is part of GNU social - https://www.gnu.org/software/social
 | |
| //
 | |
| // GNU social 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.
 | |
| //
 | |
| // GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
 | |
| // }}}
 | |
| 
 | |
| /**
 | |
|  * ActivityPub implementation for GNU social
 | |
|  *
 | |
|  * @package   GNUsocial
 | |
|  * @category  ActivityPub
 | |
|  * @author    Diogo Peralta Cordeiro <@diogo.site>
 | |
|  * @copyright 2018-2019, 2021 Free Software Foundation, Inc http://www.fsf.org
 | |
|  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 | |
|  */
 | |
| 
 | |
| namespace Plugin\ActivityPub\Controller;
 | |
| 
 | |
| use App\Core\Controller;
 | |
| use App\Core\DB\DB;
 | |
| use App\Core\Log;
 | |
| use App\Core\Router\Router;
 | |
| use App\Entity\Actor;
 | |
| use App\Util\Exception\ClientException;
 | |
| use Component\FreeNetwork\Entity\FreeNetworkActorProtocol;
 | |
| use Component\FreeNetwork\Util\Discovery;
 | |
| use Exception;
 | |
| use Plugin\ActivityPub\Entity\ActivitypubActor;
 | |
| use Plugin\ActivityPub\Entity\ActivitypubRsa;
 | |
| use Plugin\ActivityPub\Util\Explorer;
 | |
| use Plugin\ActivityPub\Util\HTTPSignature;
 | |
| use Plugin\ActivityPub\Util\Model;
 | |
| use Plugin\ActivityPub\Util\TypeResponse;
 | |
| use function App\Core\I18n\_m;
 | |
| use function is_null;
 | |
| use const PHP_URL_HOST;
 | |
| 
 | |
| /**
 | |
|  * ActivityPub Inbox Handler
 | |
|  *
 | |
|  * @copyright 2018-2019, 2021 Free Software Foundation, Inc http://www.fsf.org
 | |
|  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 | |
|  */
 | |
| class Inbox extends Controller
 | |
| {
 | |
|     /**
 | |
|      * Create an Inbox Handler to receive something from someone.
 | |
|      */
 | |
|     public function handle(?int $gsactor_id = null): TypeResponse
 | |
|     {
 | |
|         $error = fn(string $m): TypeResponse => new TypeResponse(json_encode(['error' => $m]));
 | |
|         $path = Router::url('activitypub_inbox', type: Router::ABSOLUTE_PATH);
 | |
| 
 | |
|         if (!is_null($gsactor_id)) {
 | |
|             try {
 | |
|                 $user = DB::findOneBy('local_user', ['id' => $gsactor_id]);
 | |
|                 $path = Router::url('activitypub_actor_inbox', ['gsactor_id' => $user->getId()], type: Router::ABSOLUTE_PATH);
 | |
|             } catch (Exception $e) {
 | |
|                 throw new ClientException(_m('No such actor.'), 404, $e);
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         Log::debug('ActivityPub Inbox: Received a POST request.');
 | |
|         $body = (string)$this->request->getContent();
 | |
|         $type = Model::jsonToType($body);
 | |
| 
 | |
|         if ($type->has('actor') === false) {
 | |
|             $error('Actor not found in the request.');
 | |
|         }
 | |
| 
 | |
|         try {
 | |
|             $ap_actor = ActivitypubActor::fromUri($type->get('actor'));
 | |
|             $actor = Actor::getById($ap_actor->getActorId());
 | |
|             DB::flush();
 | |
|         } catch (Exception $e) {
 | |
|             $error('Invalid actor.');
 | |
|         }
 | |
| 
 | |
|         $actor_public_key = ActivitypubRsa::getByActor($actor)->getPublicKey();
 | |
| 
 | |
|         $headers = $this->request->headers->all();
 | |
|         // Flattify headers
 | |
|         foreach ($headers as $key => $val) {
 | |
|             $headers[$key] = $val[0];
 | |
|         }
 | |
| 
 | |
|         if (!isset($headers['signature'])) {
 | |
|             Log::debug('ActivityPub Inbox: HTTP Signature: Missing Signature header.');
 | |
|             $error('Missing Signature header.', 400);
 | |
|             // TODO: support other methods beyond HTTP Signatures
 | |
|         }
 | |
| 
 | |
|         // Extract the signature properties
 | |
|         $signatureData = HTTPSignature::parseSignatureHeader($headers['signature']);
 | |
|         Log::debug('ActivityPub Inbox: HTTP Signature Data: ' . print_r($signatureData, true));
 | |
|         if (isset($signatureData['error'])) {
 | |
|             Log::debug('ActivityPub Inbox: HTTP Signature: ' . json_encode($signatureData, JSON_PRETTY_PRINT));
 | |
|             $error(json_encode($signatureData, JSON_PRETTY_PRINT), 400);
 | |
|         }
 | |
| 
 | |
|         list($verified, /*$headers*/) = HTTPSignature::verify($actor_public_key, $signatureData, $headers, $path, $body);
 | |
| 
 | |
|         // If the signature fails verification the first time, update profile as it might have changed public key
 | |
|         if ($verified !== 1) {
 | |
|             try {
 | |
|                 $res = Explorer::get_remote_user_activity($ap_actor->getUri());
 | |
|             } catch (Exception) {
 | |
|                 $error('Invalid remote actor.');
 | |
|             }
 | |
|             try {
 | |
|                 $actor = ActivitypubActor::update_profile($ap_actor, $res);
 | |
|             } catch (Exception) {
 | |
|                 $error('Failed to updated remote actor information.');
 | |
|             }
 | |
| 
 | |
|             [$verified, /*$headers*/] = HTTPSignature::verify($actor_public_key, $signatureData, $headers, $path, $body);
 | |
|         }
 | |
| 
 | |
|         // If it still failed despite profile update
 | |
|         if ($verified !== 1) {
 | |
|             Log::debug('ActivityPub Inbox: HTTP Signature: Invalid signature.');
 | |
|             $error('Invalid signature.');
 | |
|         }
 | |
| 
 | |
|         // HTTP signature checked out, make sure the "actor" of the activity matches that of the signature
 | |
|         Log::debug('ActivityPub Inbox: HTTP Signature: Authorized request. Will now start the inbox handler.');
 | |
| 
 | |
|         // TODO: Check if Actor has authority over payload
 | |
| 
 | |
|         // Store Activity
 | |
|         $ap_act = Model\Activity::fromJson($type, ['source' => 'ActivityPub']);
 | |
|         FreeNetworkActorProtocol::protocolSucceeded(
 | |
|             'activitypub',
 | |
|             $ap_actor->getActorId(),
 | |
|             Discovery::normalize($actor->getNickname() . '@' . parse_url($ap_actor->getInboxUri(), PHP_URL_HOST))
 | |
|         );
 | |
|         DB::flush();
 | |
|         dd($ap_act, $act = $ap_act->getActivity(), $act->getActor(), $act->getObject());
 | |
| 
 | |
|         return new TypeResponse($type, status: 202);
 | |
|     }
 | |
| }
 |