CsrfAwareActionTrait.rst

CsrfAwareActionTrait

• Published: 2019-08-27
• Author: Nickolas Burr

Table of Contents

• Related
• Description
• Usage
• Source
• Notes

Related

• :doc:`AuthTrait`
• :doc:`RedirectTrait`

Description

Starting in v2.3.0, Magento provides the CsrfAwareActionInterface [1] interface, which is used to validate requests against CSRF attacks. In most cases, default validation is adequate, so the implementation is identical across the vast majority of controllers.

In the example below, we've created a trait called CsrfAwareActionTrait, which effectively implements CsrfAwareActionInterface with default validation.

Usage

<?php
/**
 * LoginPost.php
 */
declare(strict_types=1);

namespace Vendor\Package\Controller\Entity;

use Magento\Framework\{
    App\Action\Action,
    App\Action\Context,
    App\Action\HttpPostActionInterface,
    App\CsrfAwareActionInterface
};
use Vendor\Package\Component\CsrfAwareActionTrait;

class LoginPost extends Action implements
    CsrfAwareActionInterface,
    HttpPostActionInterface
{
    use CsrfAwareActionTrait;

    /**
     * @param Context $context
     * @return void
     */
    public function __construct(
        Context $context
    ) {
        parent::__construct($context);
    }

    /**
     * @return Redirect
     */
    public function execute()
    {
        ...
    }
}

Source

<?php
/**
 * CsrfAwareActionTrait.php
 */
declare(strict_types=1);

namespace Vendor\Package\Component;

use Magento\Framework\{
    App\RequestInterface,
    App\Request\InvalidRequestException
};

trait CsrfAwareActionTrait
{
    /**
     * @param RequestInterface $request
     * @return InvalidRequestException|null
     */
    public function createCsrfValidationException(
        RequestInterface $request
    ): ?InvalidRequestException
    {
        /** @var Redirect $resultRedirect */
        $resultRedirect = $this->resultRedirectFactory->create();
        $resultRedirect->setPath('*/*/');

        return new InvalidRequestException(
            $resultRedirect,
            [
                __('Invalid Form Key. Please refresh the page.')
            ]
        );
    }

    /**
     * @param RequestInterface $request
     * @return bool|null
     */
    public function validateForCsrf(RequestInterface $request): ?bool
    {
        return null;
    }
}

Notes

[1]	Magento\Framework\App\CsrfAwareActionInterface