REST module security

There are three levels of control when REST requests are issued:

• URI access
• JCR access
• Command-level access

Permissions to issue REST requests are controlled using Magnolia's standard role-based security mechanism.

URI access security

URI security is checked by the URISecurityFilter. The filter checks whether the role(s) of the requesting user allow to the user to request a given path with given method.

URI permissions are granted by Access Lists (ACL). An ACL grants access to a path for Get or Get & Post.

• Get – Grants the HTTP method GET for a given URI.
• Get & Post – Grants the HTTP methods GET, PUT, POST and DELETE for a given URI.

URI access is checked for every endpoint.

JCR access security

JCR access security is a feature of the JCR standard (defined by JCR JSR-170 and JSR-283). JCR access is granted per workspace on path level. It can grant Read-only or Read/Write permission.

When using endpoints dealing with JCR repositories (nodes and properties to read and write, delivery to read only) the user must have an appropriate role that provides JCR permissions for the given method.

JCR access security is checked on every endpoint dealing which reads or writes JCR data.

Role-based security for commands

Command level security access is the lowest level of access you can configure by role for REST endpoints. 

Commands are custom actions executed at pre-defined trigger points. Magnolia uses commands to activate content, send email, flush the cache, take backups, import and export data, and to do many other tasks. Commands can perform duties within the system or connect to external resources.

Role-based access to specific commands can be configured in the rest-services module: /modules/rest-services/rest-endpoints/commands/enabledCommands/ 

Security for endpoints

Endpoints always require URI access, they may also require JCR access or a specific role defined defined at a command level.

When you request a REST URL, URI security is checked first:

• If the URI security check fails, the request is redirected to the login page by default.
• If the the URI security check is passed, the request is delegated to the endpoint in question.

If the endpoint concerns JCR access, JCR access security is checked too:

• If the user is not granted access to the requested node, the endpoint returns the HTTP response code 401, 403, 404 or 500 depending on the case.
• If JCR security access is granted, the endpoint returns the HTTP response code 200 and a response body if appropriate.

If the endpoint triggers commands, the command definition grants access via specifically defined roles defined per command:

REST roles

The REST module installs four default roles with the following permissions:

• rest-admin – The REST administrator role grants GET/POST permissions to all Magnolia's REST APIs.
• rest-editor – The REST editor role grants GET/POST permissions to REST services APIs (nodes, properties), for a limited set of workspaces.
• rest-anonymous – The REST anonymous consumer role grants GET permissions to Magnolia's content delivery REST API.
• rest-backup – The REST backup role grants permission to execute the backup command from a running Magnolia instance.

rest-admin

Web access

Configured access

rest-editor

Web access

rest-anonymous

Web access

rest-backup

Web access

Configured access

The superuser account has the rest-admin role by default so you can use superuser to test your requests. However, for production use, you should create a custom REST role. The anonymous role is specifically denied access to the REST endpoints.

Custom REST roles

Magnolia recommends you create custom REST roles granting specific access for specific use cases.TODO:

DOCU-1199 - Getting issue details... STATUS

To be further specified into

• rest roles used on the public instance - mainly to grant to anonymous user
• rest roles for the author context for specific apps and whatnot ...

Enabling commands (optional)

Commands are custom actions executed at pre-defined trigger points. Magnolia uses commands to activate content, send email, flush the cache, take backups, import and export data, and to do many other tasks. Commands can perform duties within the system or connect to external resources.

To enable the use of commands through REST:

1. Open the security app and grant the rest-admin role a permission to issue requests to the commands endpoint.  Permission to the endpoint is denied by default. Add a new rule.
   
2. Whitelist any commands you want to expose to REST. The white list is managed in /modules/rest-services/rest-endpoints/commands/enabledCommands.

Properties: