Enjoys\Forms\Rule\Csrf

Complexity

Total Complexity

5

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	check()	0	3	1
A	setMessage()	0	6	2
A	validate()	0	10	2

<?php

/*
 * The MIT License
 *
 * Copyright 2020 Enjoys.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

declare(strict_types=1);

namespace Enjoys\Forms\Rule;

use Enjoys\Forms\Element;
use Enjoys\Forms\Form;
use Enjoys\Forms\Rule\RuleInterface;
use Enjoys\Forms\Rules;

/**
 * Description of Required
 *
 * Csrf element will automatically set the rule(s)
 * and the form itself determines when csrf is needed
 *
 * @author Enjoys
 */
class Csrf extends Rules implements RuleInterface
{

    /**
     * 
     * @param string|null $message
     * @return string|null
     */
    public function setMessage(?string $message = null): ?string
    {
        if (is_null($message)) {
            $message = 'CSRF Attack detected';
        }
        return parent::setMessage($message);
    }

    /**
     * @psalm-suppress UndefinedMethod
     * @param Element $element
     * @return bool
     */
    public function validate(Element $element): bool
    {

        if (!$this->check($this->getRequest()->post(Form::_TOKEN_CSRF_, ''))) {
            $element->setRuleError($this->getMessage());

The method setRuleError() does not exist on Enjoys\Forms\Element. It seems like you code against a sub-type of said class. However, the method does not exist in Enjoys\Forms\Elements\Optgroup or Enjoys\Forms\Elements\Submit or Enjoys\Forms\Elements\Option or Enjoys\Forms\Elements\Button or Enjoys\Forms\Elements\Image or Enjoys\Forms\Elements\Reset or Enjoys\Forms\Elements\Header. Are you sure you never get one of those?

            // throw new \Enjoys\Forms\Exception\ExceptionRule($this->getMessage());
            return false;
        }

        return true;
    }

    /**
     * @psalm-suppress PossiblyNullArgument
     * @param string $value
     * @return bool
     */
    private function check(string $value): bool
    {
        return hash_equals($value, crypt($this->getParam('csrf_key'), $value));
    }
}