You can install the package via composer:<\/p>\n\n
composer require alleyinteractive\/wp-rest-api-guard\n<\/code><\/pre>\n\n\nRestrict and control access to the REST API.<\/p>\n\n
Usage<\/h3>\n\n
The WordPress REST API is generally very public and can share a good deal of information with the internet anonymously. This plugin aims to make it easier to restrict access to the REST API for your WordPress site.<\/p>\n\n
Out of the box the plugin can:<\/p>\n\n
\n- Disable anonymous access to the REST API.<\/li>\n
- Restrict and control anonymous access to the REST API by namespace, path, etc.<\/li>\n<\/ul>\n\n
Settings Page<\/h3>\n\n
The plugin can be configured via the Settings page (Settings -> REST API Guard<\/code>) or via the relevant filter.<\/p>\n\n<\/p>\n\n
Preventing Access to User Information (wp\/v2\/users<\/code>)<\/h3>\n\nBy default, the plugin will restrict anonymous access to the users endpoint. This can be prevented in the plugin's settings or via code:<\/p>\n\n
add_filter( 'rest_api_guard_allow_user_access', fn () => true );\n<\/code><\/pre>\n\nPreventing Access to Index (\/<\/code>) or Namespace Endpoints (wp\/v2<\/code>)<\/h3>\n\nTo prevent anonymous users from browsing your site and discovering what plugins\/post types are setup, the plugin restricts access to the index (\/<\/code>) and namespace (wp\/v2<\/code>) endpoints. This can be prevented in the plugin's settings or via code:<\/p>\n\n\/\/ Allow index access.\nadd_filter( 'rest_api_guard_allow_index_access', fn () => true );\n\n\/\/ Allow namespace access.\nadd_filter( 'rest_api_guard_allow_namespace_access', fn ( string $namespace ) => true );\n<\/code><\/pre>\n\nRestrict Anonymous Access to the REST API<\/h3>\n\n
The plugin can restrict anonymous access for any request to the REST API in the plugin's settings or via code:<\/p>\n\n
add_filter( 'rest_api_guard_prevent_anonymous_access', fn () => true );\n<\/code><\/pre>\n\nLimit Anonymous Access to Specific Namespaces\/Routes (Allowlist)<\/h3>\n\n
Anonymous users can be granted access only to specific namespaces\/routes. Requests outside of these paths will be denied. This can be configured in the plugin's settings or via code:<\/p>\n\n
add_filter(\n 'rest_api_guard_anonymous_requests_allowlist',\n function ( array $paths, WP_REST_Request $request ): array {\n \/\/ Allow other paths not included here will be denied.\n $paths[] = 'wp\/v2\/post';\n $paths[] = 'custom-namespace\/v1\/public\/*';\n\n return $paths;\n },\n 10,\n 2\n);\n<\/code><\/pre>\n\nRestrict Anonymous Access to Specific Namespaces\/Routes (Denylist)<\/h3>\n\n
Anonymous users can be restricted from specific namespaces\/routes. This acts as\na denylist for specific paths that an anonymous user cannot access. The paths\nsupport regular expressions for matching. The use of the allowlist takes\npriority over this denylist. This can be configured in the plugin's settings or\nvia code:<\/p>\n\n
add_filter(\n 'rest_api_guard_anonymous_requests_denylist',\n function ( array $paths, WP_REST_Request $request ): array {\n $paths[] = 'wp\/v2\/user';\n $paths[] = 'custom-namespace\/v1\/private\/*';\n\n return $paths;\n },\n 10,\n 2\n);\n<\/code><\/pre>\n\nRequire JSON Web Token (JWT) Authentication<\/h3>\n\n
Anonymous users can be required to authenticate via a JSON Web Token (JWT) to\naccess the REST API. Users should pass an Authorization: Bearer <token><\/code> header\nwith their request. This can be configured in the plugin's settings or via code:<\/p>\n\nadd_filter( 'rest_api_guard_authentication_jwt', fn () => true );\n<\/code><\/pre>\n\nOut of the box, the plugin will look for a JWT in the Authorization: Bearer\n<token><\/code> header. The JWT will be expected to have an audience of\n'wordpress-rest-api' and issuer of the site's URL. This can be configured in the\nplugin's settings or via code:<\/p>\n\nadd_filter(\n 'rest_api_guard_jwt_audience',\n function ( string $audience ): string {\n return 'custom-audience';\n }\n);\n\nadd_filter(\n 'rest_api_guard_jwt_issuer',\n function ( string $issuer ): string {\n return 'https:\/\/example.com';\n }\n);\n<\/code><\/pre>\n\nThe JWT's secret will be autogenerated and stored in the database in the\n rest_api_guard_jwt_secret option. The secret can also be changed via code:<\/p>\n\n
add_filter(\n 'rest_api_guard_jwt_secret',\n function ( string $secret ): string {\n return 'my-custom-secret';\n }\n);\n<\/code><\/pre>\n\nAllow JWT Authentication for Authenticated Users<\/h3>\n\n
Authenticated users can be authenticated with the REST API via a JSON Web Token.\nSimilar to the anonymous JWT authentication, users should pass an\n Authorization: Bearer header with their request. This can be\nconfigured in the plugin's settings or via code:<\/p>\n\n
add_filter( 'rest_api_guard_user_authentication_jwt', fn () => true );\n<\/code><\/pre>\n\nGenerating JWTs for Anonymous and Authenticated Users<\/h3>\n\n
JWTs can be generated by calling the\n wp rest-api-guard generate-jwt [--user=] command or using the\n Alley\\WP\\REST_API_Guard\\generate_jwt() method:<\/p>\n\n
$jwt = \\Alley\\WP\\REST_API_Guard\\generate_jwt(\n expiration: 3600, \/\/ Optional. The expiration time in seconds from now.\n user: 1, \/\/ Optional. The user ID to generate the JWT for. Supports `WP_User` or user ID.\n);\n<\/code><\/pre>","raw_excerpt":"Restrict and control access to the REST API.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/163734","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=163734"}],"author":[{"embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/sean212"}],"wp:attachment":[{"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=163734"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=163734"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=163734"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=163734"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=163734"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/hu.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=163734"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}