Graviton\SecurityBundle\Authentication\Strategies\SameSubnetStrategy

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

18.18%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setSubnetIp()	0	4	1
A	stopPropagation()	0	4	1
A	getRoles()	0	4	1
A	apply()	0	12	3
A	determineName()	0	8	2

<?php
/**
 * strategy for validating auth through the ip address.
 */

namespace Graviton\SecurityBundle\Authentication\Strategies;

use Graviton\SecurityBundle\Entities\SecurityUser;
use Symfony\Component\HttpFoundation\IpUtils;
use Symfony\Component\HttpFoundation\Request;

/**
 * Class SameSubnetStrategy
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class SameSubnetStrategy extends AbstractHttpStrategy
{
    /** @var String */
    protected $subnet;

    /** @var String */
    protected $headerField;

    /** @var bool pass through by default */
    protected $stopPropagation = false;

    /**
     * @param String $subnet      Subnet to be checked (e.g. 10.2.0.0/24)
     * @param String $headerField Http header field to be searched for the 'username'
     */
    public function __construct($subnet, $headerField = 'x-graviton-authentication')
    {
        $this->subnet= $subnet;
        $this->headerField = $headerField;
    }

    /**
     * Ip subnet check
     * @param string $subnet IpAddress
     * @return void
     */
    public function setSubnetIp($subnet)
    {
        $this->subnet = $subnet;
    }

    /**
     * Applies the defined strategy on the provided request.
     *
     * @param Request $request request to handle
     *
     * @return string

Should the return type not be string|array? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function apply(Request $request)
    {
        if (IpUtils::checkIp($request->getClientIp(), $this->subnet)) {
            $name = $this->determineName($request);

The expression $this->determineName($request); of type string|array adds the type array to the return on line 63 which is incompatible with the return type declared by the interface Graviton\SecurityBundle\Authentication\Strategies\StrategyInterface::apply of type string.

            if (!empty($name)) {
                $this->stopPropagation = true;
                return $name;
            }
        }

        throw new \InvalidArgumentException('Provided request information are not valid.');
    }

    /**
     * Decider to stop other strategies running after from being considered.
     *
     * @return boolean
     */
    public function stopPropagation()
    {
        return $this->stopPropagation;
    }

    /**
     * Provides the list of registered roles.
     *
     * @return Role[]
     */
    public function getRoles()
    {
        return [SecurityUser::ROLE_USER, SecurityUser::ROLE_SUBNET];
    }

    /**
     * Finds the username either from a http header filed or returns a default.
     *
     * @param Request $request Current http request
     *
     * @return string

Should the return type not be string|array? Also, consider making the array more specific, something like array<String>, or String[].

     */
    private function determineName(Request $request)
    {
        if ($request->headers->has($this->headerField)) {
            return $request->headers->get($this->headerField);
        }

        return '';
    }
}