| @@ -1,15 +1,15 @@ | ||
| 1 | 1 | <?php |
| 2 | -/** | |
| 3 | - * Server REST-Class file. | |
| 4 | - * | |
| 5 | - * @package Activitypub | |
| 6 | - */ | |
| 2 | +namespace Activitypub\Rest; | |
| 7 | 3 | |
| 8 | -namespace Activitypub\Rest; | |
| 4 | +use stdClass; | |
| 5 | +use WP_Error; | |
| 6 | +use WP_REST_Response; | |
| 7 | +use Activitypub\Signature; | |
| 8 | +use Activitypub\Model\Application; | |
| 9 | 9 | |
| 10 | 10 | /** |
| 11 | - * ActivityPub Server REST-Class. | |
| 11 | + * ActivityPub Server REST-Class | |
| 12 | 12 | * |
| 13 | 13 | * @author Django Doucet |
| 14 | 14 | * |
| 15 | 15 | * @see https://www.w3.org/TR/activitypub/#security-verification |
| @@ -15,224 +15,165 @@ | ||
| 15 | 15 | * @see https://www.w3.org/TR/activitypub/#security-verification |
| 16 | 16 | */ |
| 17 | 17 | class Server { |
| 18 | 18 | /** |
| 19 | - * Initialize the class, registering WordPress hooks. | |
| 19 | + * Initialize the class, registering WordPress hooks | |
| 20 | 20 | */ |
| 21 | 21 | public static function init() { |
| 22 | - \add_filter( 'rest_request_before_callbacks', array( self::class, 'validate_requests' ), 9, 3 ); | |
| 23 | - \add_filter( 'rest_request_parameter_order', array( self::class, 'request_parameter_order' ), 10, 2 ); | |
| 22 | + self::register_routes(); | |
| 24 | 23 | |
| 25 | - \add_filter( 'rest_post_dispatch', array( self::class, 'filter_output' ), 10, 3 ); | |
| 26 | - \add_filter( 'rest_post_dispatch', array( self::class, 'add_cors_headers' ), 10, 3 ); | |
| 27 | - \add_filter( 'rest_allowed_cors_headers', array( self::class, 'allow_cors_headers' ), 10, 2 ); | |
| 24 | + \add_filter( 'rest_request_before_callbacks', array( self::class, 'validate_activitypub_requests' ), 9, 3 ); | |
| 25 | + \add_filter( 'rest_request_before_callbacks', array( self::class, 'authorize_activitypub_requests' ), 10, 3 ); | |
| 28 | 26 | } |
| 29 | 27 | |
| 30 | 28 | /** |
| 31 | - * Callback function to validate incoming ActivityPub requests | |
| 32 | - * | |
| 33 | - * @param \WP_REST_Response|\WP_HTTP_Response|\WP_Error|mixed $response Result to send to the client. | |
| 34 | - * Usually a WP_REST_Response or WP_Error. | |
| 35 | - * @param array $handler Route handler used for the request. | |
| 36 | - * @param \WP_REST_Request $request Request used to generate the response. | |
| 37 | - * | |
| 38 | - * @return mixed|\WP_Error The response, error, or modified response. | |
| 29 | + * Register routes | |
| 39 | 30 | */ |
| 40 | - public static function validate_requests( $response, $handler, $request ) { | |
| 41 | - if ( 'HEAD' === $request->get_method() ) { | |
| 42 | - return $response; | |
| 43 | - } | |
| 44 | - | |
| 45 | - $route = $request->get_route(); | |
| 46 | - | |
| 47 | - if ( | |
| 48 | - \is_wp_error( $response ) || | |
| 49 | - ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) | |
| 50 | - ) { | |
| 51 | - return $response; | |
| 52 | - } | |
| 53 | - | |
| 54 | - $params = $request->get_json_params(); | |
| 55 | - | |
| 56 | - // Type is required for ActivityPub requests, so it fail later in the process. | |
| 57 | - if ( ! isset( $params['type'] ) ) { | |
| 58 | - return $response; | |
| 59 | - } | |
| 60 | - | |
| 61 | - if ( | |
| 62 | - ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS && | |
| 63 | - in_array( $params['type'], array( 'Create', 'Like', 'Announce' ), true ) | |
| 64 | - ) { | |
| 65 | - return new \WP_Error( | |
| 66 | - 'activitypub_server_does_not_accept_incoming_interactions', | |
| 67 | - \__( 'This server does not accept incoming interactions.', 'activitypub' ), | |
| 68 | - // We have to use a 2XX status code here, because otherwise the response will be | |
| 69 | - // treated as an error and Mastodon might block this WordPress instance. | |
| 70 | - array( 'status' => 202 ) | |
| 71 | - ); | |
| 72 | - } | |
| 73 | - | |
| 74 | - return $response; | |
| 31 | + public static function register_routes() { | |
| 32 | + \register_rest_route( | |
| 33 | + ACTIVITYPUB_REST_NAMESPACE, | |
| 34 | + '/application', | |
| 35 | + array( | |
| 36 | + array( | |
| 37 | + 'methods' => \WP_REST_Server::READABLE, | |
| 38 | + 'callback' => array( self::class, 'application_actor' ), | |
| 39 | + 'permission_callback' => '__return_true', | |
| 40 | + ), | |
| 41 | + ) | |
| 42 | + ); | |
| 75 | 43 | } |
| 76 | 44 | |
| 77 | 45 | /** |
| 78 | - * Modify the parameter priority order for a REST API request. | |
| 46 | + * Render Application actor profile | |
| 79 | 47 | * |
| 80 | - * @param string[] $order Array of types to check, in order of priority. | |
| 81 | - * @param \WP_REST_Request $request The request object. | |
| 82 | - * | |
| 83 | - * @return string[] The modified order of types to check. | |
| 48 | + * @return WP_REST_Response The JSON profile of the Application Actor. | |
| 84 | 49 | */ |
| 85 | - public static function request_parameter_order( $order, $request ) { | |
| 86 | - $route = $request->get_route(); | |
| 50 | + public static function application_actor() { | |
| 51 | + $user = new Application(); | |
| 87 | 52 | |
| 88 | - // Check if it is an activitypub request and exclude webfinger and nodeinfo endpoints. | |
| 89 | - if ( ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) ) { | |
| 90 | - return $order; | |
| 91 | - } | |
| 53 | + $json = $user->to_array(); | |
| 92 | 54 | |
| 93 | - $method = $request->get_method(); | |
| 55 | + $rest_response = new WP_REST_Response( $json, 200 ); | |
| 56 | + $rest_response->header( 'Content-Type', 'application/activity+json; charset=' . get_option( 'blog_charset' ) ); | |
| 94 | 57 | |
| 95 | - if ( \WP_REST_Server::CREATABLE !== $method ) { | |
| 96 | - return $order; | |
| 97 | - } | |
| 98 | - | |
| 99 | - return array( | |
| 100 | - 'JSON', | |
| 101 | - 'POST', | |
| 102 | - 'URL', | |
| 103 | - 'defaults', | |
| 104 | - ); | |
| 58 | + return $rest_response; | |
| 105 | 59 | } |
| 106 | 60 | |
| 107 | 61 | /** |
| 108 | - * Filters the REST API response to properly handle the ActivityPub error formatting. | |
| 62 | + * Callback function to authorize each api requests | |
| 109 | 63 | * |
| 110 | - * @see https://codeberg.org/fediverse/fep/src/branch/main/fep/c180/fep-c180.md | |
| 64 | + * @see WP_REST_Request | |
| 111 | 65 | * |
| 112 | - * @param \WP_HTTP_Response $response Result to send to the client. Usually a `WP_REST_Response`. | |
| 113 | - * @param \WP_REST_Server $server Server instance. | |
| 114 | - * @param \WP_REST_Request $request Request used to generate the response. | |
| 66 | + * @see https://www.w3.org/wiki/SocialCG/ActivityPub/Primer/Authentication_Authorization#Authorized_fetch | |
| 67 | + * @see https://swicg.github.io/activitypub-http-signature/#authorized-fetch | |
| 115 | 68 | * |
| 116 | - * @return \WP_HTTP_Response The filtered response. | |
| 69 | + * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. | |
| 70 | + * Usually a WP_REST_Response or WP_Error. | |
| 71 | + * @param array $handler Route handler used for the request. | |
| 72 | + * @param WP_REST_Request $request Request used to generate the response. | |
| 73 | + * | |
| 74 | + * @return mixed|WP_Error The response, error, or modified response. | |
| 117 | 75 | */ |
| 118 | - public static function filter_output( $response, $server, $request ) { | |
| 119 | - $route = $request->get_route(); | |
| 120 | - | |
| 121 | - // Check if it is an activitypub request and exclude webfinger and nodeinfo endpoints. | |
| 122 | - if ( ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) ) { | |
| 76 | + public static function authorize_activitypub_requests( $response, $handler, $request ) { | |
| 77 | + if ( 'HEAD' === $request->get_method() ) { | |
| 123 | 78 | return $response; |
| 124 | 79 | } |
| 125 | 80 | |
| 126 | - // Exclude OAuth endpoints - they have their own error format per RFC 6749. | |
| 127 | - if ( \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE . '/oauth' ) ) { | |
| 81 | + if ( \is_wp_error( $response ) ) { | |
| 128 | 82 | return $response; |
| 129 | 83 | } |
| 130 | 84 | |
| 131 | - // Only alter responses that return an error status code. | |
| 132 | - if ( $response->get_status() < 400 ) { | |
| 85 | + $route = $request->get_route(); | |
| 86 | + | |
| 87 | + // check if it is an activitypub request and exclude webfinger and nodeinfo endpoints | |
| 88 | + if ( | |
| 89 | + ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) || | |
| 90 | + \str_starts_with( $route, '/' . \trailingslashit( ACTIVITYPUB_REST_NAMESPACE ) . 'webfinger' ) || | |
| 91 | + \str_starts_with( $route, '/' . \trailingslashit( ACTIVITYPUB_REST_NAMESPACE ) . 'nodeinfo' ) || | |
| 92 | + \str_starts_with( $route, '/' . \trailingslashit( ACTIVITYPUB_REST_NAMESPACE ) . 'application' ) | |
| 93 | + ) { | |
| 133 | 94 | return $response; |
| 134 | 95 | } |
| 135 | 96 | |
| 136 | - $data = $response->get_data(); | |
| 97 | + /** | |
| 98 | + * Filter to defer signature verification | |
| 99 | + * | |
| 100 | + * Skip signature verification for debugging purposes or to reduce load for | |
| 101 | + * certain Activity-Types, like "Delete". | |
| 102 | + * | |
| 103 | + * @param bool $defer Whether to defer signature verification. | |
| 104 | + * @param WP_REST_Request $request The request used to generate the response. | |
| 105 | + * | |
| 106 | + * @return bool Whether to defer signature verification. | |
| 107 | + */ | |
| 108 | + $defer = \apply_filters( 'activitypub_defer_signature_verification', false, $request ); | |
| 137 | 109 | |
| 138 | - // Ensure that `$data` was already converted to a response. | |
| 139 | - if ( \is_wp_error( $data ) ) { | |
| 140 | - $response = \rest_convert_error_to_response( $data ); | |
| 141 | - $data = $response->get_data(); | |
| 110 | + if ( $defer ) { | |
| 111 | + return $response; | |
| 142 | 112 | } |
| 143 | 113 | |
| 144 | - $error = array( | |
| 145 | - 'type' => 'about:blank', | |
| 146 | - 'title' => $data['code'] ?? '', | |
| 147 | - 'detail' => $data['message'] ?? '', | |
| 148 | - 'status' => $response->get_status(), | |
| 114 | + if ( | |
| 115 | + // POST-Requests are always signed | |
| 116 | + 'GET' !== $request->get_method() || | |
| 117 | + // GET-Requests only require a signature in secure mode | |
| 118 | + ( 'GET' === $request->get_method() && ACTIVITYPUB_AUTHORIZED_FETCH ) | |
| 119 | + ) { | |
| 120 | + $verified_request = Signature::verify_http_signature( $request ); | |
| 121 | + if ( \is_wp_error( $verified_request ) ) { | |
| 122 | + return new WP_Error( | |
| 123 | + 'activitypub_signature_verification', | |
| 124 | + $verified_request->get_error_message(), | |
| 125 | + array( 'status' => 401 ) | |
| 126 | + ); | |
| 127 | + } | |
| 128 | + } | |
| 149 | 129 | |
| 150 | - /* | |
| 151 | - * Provides the unstructured error data. | |
| 152 | - * | |
| 153 | - * @see https://nodeinfo.diaspora.software/schema.html#metadata. | |
| 154 | - */ | |
| 155 | - 'metadata' => $data, | |
| 156 | - ); | |
| 157 | - | |
| 158 | - $response->set_data( $error ); | |
| 159 | - | |
| 160 | 130 | return $response; |
| 161 | 131 | } |
| 162 | 132 | |
| 163 | 133 | /** |
| 164 | - * Add CORS headers to ActivityPub REST responses. | |
| 134 | + * Callback function to validate incoming ActivityPub requests | |
| 165 | 135 | * |
| 166 | - * @param \WP_REST_Response $response The REST response. | |
| 167 | - * @param \WP_REST_Server $server The REST server instance. | |
| 168 | - * @param \WP_REST_Request $request The request object. | |
| 136 | + * @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client. | |
| 137 | + * Usually a WP_REST_Response or WP_Error. | |
| 138 | + * @param array $handler Route handler used for the request. | |
| 139 | + * @param WP_REST_Request $request Request used to generate the response. | |
| 169 | 140 | * |
| 170 | - * @return \WP_REST_Response The modified response. | |
| 141 | + * @return mixed|WP_Error The response, error, or modified response. | |
| 171 | 142 | */ |
| 172 | - public static function add_cors_headers( $response, $server, $request ) { | |
| 173 | - $route = $request->get_route(); | |
| 174 | - $namespace = '/' . ACTIVITYPUB_REST_NAMESPACE; | |
| 175 | - | |
| 176 | - // Only add CORS to ActivityPub endpoints, except the interactive OAuth authorize endpoint. | |
| 177 | - if ( ! \str_starts_with( $route, $namespace ) || \str_starts_with( $route, $namespace . '/oauth/authorize' ) ) { | |
| 143 | + public static function validate_activitypub_requests( $response, $handler, $request ) { | |
| 144 | + if ( 'HEAD' === $request->get_method() ) { | |
| 178 | 145 | return $response; |
| 179 | 146 | } |
| 180 | 147 | |
| 181 | - /* | |
| 182 | - * ActivityPub data is meant to be publicly readable by federation peers | |
| 183 | - * and browser-side clients. We do not enable credentialed cross-origin | |
| 184 | - * access: cookie auth would still be rejected by WordPress core's | |
| 185 | - * REST nonce check, and OAuth Bearer tokens travel in the | |
| 186 | - * Authorization header — which is permitted via Allow-Headers and | |
| 187 | - * does not require Allow-Credentials. | |
| 188 | - * | |
| 189 | - * Allow-Headers is contributed by core (which already lists `X-WP-Nonce`, | |
| 190 | - * `Authorization`, `Content-Type`, `Content-Disposition`, and `Content-MD5`) | |
| 191 | - * and extended for ActivityPub via the `rest_allowed_cors_headers` filter | |
| 192 | - * in self::allow_cors_headers(). | |
| 193 | - */ | |
| 194 | - $response->header( 'Access-Control-Allow-Origin', '*' ); | |
| 195 | - $response->header( 'Access-Control-Allow-Methods', 'GET, POST, OPTIONS' ); | |
| 148 | + $route = $request->get_route(); | |
| 196 | 149 | |
| 197 | - return $response; | |
| 198 | - } | |
| 150 | + if ( | |
| 151 | + \is_wp_error( $response ) || | |
| 152 | + ! \str_starts_with( $route, '/' . ACTIVITYPUB_REST_NAMESPACE ) | |
| 153 | + ) { | |
| 154 | + return $response; | |
| 155 | + } | |
| 199 | 156 | |
| 200 | - /** | |
| 201 | - * Extend the CORS Allow-Headers list for ActivityPub REST endpoints. | |
| 202 | - * | |
| 203 | - * Adds the headers ActivityPub clients need on top of WordPress core's | |
| 204 | - * defaults: `Accept` for content negotiation and `Last-Event-ID` for | |
| 205 | - * Server-Sent Events resume. | |
| 206 | - * | |
| 207 | - * @since 8.3.0 | |
| 208 | - * | |
| 209 | - * @param string[] $allow_headers Headers core currently permits in CORS requests. | |
| 210 | - * @param \WP_REST_Request $request The current REST request. | |
| 211 | - * | |
| 212 | - * @return string[] The (possibly extended) list of allowed headers. | |
| 213 | - */ | |
| 214 | - public static function allow_cors_headers( $allow_headers, $request ) { | |
| 215 | - $route = $request->get_route(); | |
| 216 | - $namespace = '/' . ACTIVITYPUB_REST_NAMESPACE; | |
| 157 | + $params = $request->get_json_params(); | |
| 217 | 158 | |
| 218 | - if ( ! \str_starts_with( $route, $namespace ) || \str_starts_with( $route, $namespace . '/oauth/authorize' ) ) { | |
| 219 | - return $allow_headers; | |
| 159 | + // Type is required for ActivityPub requests, so it fail later in the process | |
| 160 | + if ( ! isset( $params['type'] ) ) { | |
| 161 | + return $response; | |
| 220 | 162 | } |
| 221 | 163 | |
| 222 | - return \array_values( \array_unique( \array_merge( (array) $allow_headers, array( 'Accept', 'Last-Event-ID' ) ) ) ); | |
| 223 | - } | |
| 164 | + if ( | |
| 165 | + ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS && | |
| 166 | + in_array( $params['type'], array( 'Create', 'Like', 'Announce' ), true ) | |
| 167 | + ) { | |
| 168 | + return new WP_Error( | |
| 169 | + 'activitypub_server_does_not_accept_incoming_interactions', | |
| 170 | + \__( 'This server does not accept incoming interactions.', 'activitypub' ), | |
| 171 | + // We have to use a 2XX status code here, because otherwise the response will be | |
| 172 | + // treated as an error and Mastodon might block this WordPress instance. | |
| 173 | + array( 'status' => 202 ) | |
| 174 | + ); | |
| 175 | + } | |
| 224 | 176 | |
| 225 | - /** | |
| 226 | - * Send CORS headers directly via header(). | |
| 227 | - * | |
| 228 | - * Use this for endpoints that bypass the REST response flow | |
| 229 | - * (e.g. SSE streams that call exit() instead of returning a WP_REST_Response). | |
| 230 | - * | |
| 231 | - * @since 8.1.0 | |
| 232 | - */ | |
| 233 | - public static function send_cors_headers() { | |
| 234 | - \header( 'Access-Control-Allow-Origin: *' ); | |
| 235 | - \header( 'Access-Control-Allow-Methods: GET, POST, OPTIONS' ); | |
| 236 | - \header( 'Access-Control-Allow-Headers: Authorization, X-WP-Nonce, Content-Disposition, Content-MD5, Content-Type, Accept, Last-Event-ID' ); | |
| 177 | + return $response; | |
| 237 | 178 | } |
| 238 | 179 | } |
