Version 5 supported

Access control

Within your controllers you should declare and restrict what people can see and do to ensure that users cannot run actions on the website they shouldn't be able to.

Allowed actions

Any action you define on a controller must be defined in a $allowed_actions configuration array. This prevents users from directly calling methods that they shouldn't.

If the permission check fails, Silverstripe CMS will return a 403 Forbidden HTTP status.

namespace App\Control;

use SilverStripe\Control\Controller;

class MyController extends Controller
{
    private static $allowed_actions = [
        // someaction can be accessed by anyone, any time
        'someaction',

        // So can otheraction
        'otheraction' => true,

        // restrictedaction can only be people with ADMIN privilege
        'restrictedaction' => 'ADMIN',

        // restricted to uses that have the 'CMS_ACCESS_CMSMain' access
        'cmsrestrictedaction' => 'CMS_ACCESS_CMSMain',

        // complexaction can only be accessed if $this->canComplexAction() returns true.
        'complexaction' => '->canComplexAction',

        // complexactioncheck can only be accessed if $this->canComplexAction("MyRestrictedAction", false, 42) is true.
        'complexactioncheck' => '->canComplexAction("MyRestrictedAction", false, 42)',
    ];

    // ...
}

If you want to add access checks in a subclass for an action which is declared in a parent class, and the parent class doesn't declare an access check for that action, your subclass will have to redeclare the action method.

The declaration of the method can be as simple as:

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;

class MyController extends Controller
{
    // ...

    public function someAction(HTTPRequest $request)
    {
        return parent::someAction($request);
    }
}

An action named "index" is allowed by default, unless allowed_actions is defined as an empty array, or the action is specifically restricted.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;

class MyController extends Controller
{
    public function index(HTTPRequest $request)
    {
        // allowed without being defined in $allowed_actions
    }
}

$allowed_actions can be defined on Extension classes applying to the controller:

Vendor\Module\Control\SomeModuleController:
  extensions:
    - 'App\Extension\MyExtension'
namespace App\Extension;

use SilverStripe\Core\Extension;

class MyExtension extends Extension
{
    private static $allowed_actions = [
        'myCustomAction',
    ];

    public function myCustomAction()
    {
        // ...
    }
}

Only public methods can be made accessible.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;

class MyController extends Controller
{
    // ...

    private static $allowed_actions = [
        'secure',
        // secureaction won't work as it's protected.
    ];

    public function secure(HTTPRequest $request)
    {
        // ...
    }

    protected function secureaction()
    {
        // ...
    }
}

If a method on a parent class is overwritten, access control for it has to be redefined as well.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;

class MyController extends Controller
{
    // ...

    private static $allowed_actions = [
        'action',
    ];

    public function action(HTTPRequest $request)
    {
        // ...
    }
}
namespace App\Control;

use SilverStripe\Control\HTTPRequest;

class MyChildController extends MyController
{
    // ...

    private static $allowed_actions = [
        // required as we are redefining the action
        'action',
    ];

    public function action(HTTPRequest $request)
    {
        // ...
    }
}

Forms

Form action methods should not be included in $allowed_actions. However, the form method should be included as an allowed_action.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Forms\Form;

class MyController extends Controller
{
    // ...

    private static $allowed_actions = [
        // use the Form method, not the action
        'contactForm',
    ];

    public function contactForm()
    {
        return Form::create(/* ... */);
    }

    public function doContactForm($data, $form)
    {
        // ...
    }
}

See the forms section for more information about handling routing for forms and their actions.

Action level checks

Each method responding to a URL can also implement custom permission checks, e.g. to handle responses conditionally on the passed request data.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;

class MyController extends Controller
{
    // ...

    private static $allowed_actions = [
        'myAction',
    ];

    public function myaction(HTTPRequest $request)
    {
        if (!$request->getVar('apikey')) {
            return $this->httpError(403, 'No API key provided');
        }

        return 'valid';
    }
}

This is recommended as an addition to access checks defined in $allowed_actions, in order to handle more complex checks, rather than a replacement.

Controller level checks

After checking for allowed_actions, each controller invokes its init() method, which is typically used to set up common state. If an init() method returns a HTTPResponse with either a 3xx or 4xx HTTP status code, it'll abort execution. This behavior can be used to implement permission checks.

init() is called regardless of the action that will ultimately handle the request, and executes before the action does.

namespace App\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Security\Permission;

class MyController extends Controller
{
    // ...

    public function init()
    {
        parent::init();

        // Only allow administrators to perform ANY action (including index) on this controller via HTTP requests
        if (!Permission::check('ADMIN')) {
            return $this->httpError(403);
        }
    }
}

Related documentation

API documentation

Edit on Github