HeaderCheckerManager::checkMandatoryHeaderParameters() - Code Metrics - Inspection of "Merge branch 'v1.1'" - web-token/jwt-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7ad838...d2ad41 )

by Florent

created 2018-03-13 12:47 UTC

checkMandatoryHeaderParameters() A

↳ Parent: HeaderCheckerManager

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	3
nop	3

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Component\Checker;

use Jose\Component\Core\JWT;

class HeaderCheckerManager
{
    /**
     * @var HeaderChecker[]
     */
    private $checkers = [];

    /**
     * @var TokenTypeSupport[]
     */
    private $tokenTypes = [];

    /**
     * HeaderCheckerManager constructor.
     *
     * @param HeaderChecker[]    $checkers
     * @param TokenTypeSupport[] $tokenTypes
     */
    private function __construct(array $checkers, array $tokenTypes)
    {
        foreach ($checkers as $checker) {
            $this->add($checker);
        }
        foreach ($tokenTypes as $tokenType) {
            $this->addTokenTypeSupport($tokenType);
        }
    }

    /**
     * This method creates the HeaderCheckerManager.
     * The first argument is a list of header parameter checkers objects.
     * The second argument is a list of token type support objects.
     * It is recommended to support only one token type per manager.
     *
     * @param HeaderChecker[]    $checkers
     * @param TokenTypeSupport[] $tokenTypes
     *
     * @return HeaderCheckerManager
     */
    public static function create(array $checkers, array $tokenTypes): self
    {
        return new self($checkers, $tokenTypes);
    }

    /**
     * This method returns all checkers handled by this manager.
     *
     * @return HeaderChecker[]
     */
    public function getCheckers(): array
    {
        return $this->checkers;
    }

    /**
     * @param TokenTypeSupport $tokenType
     *
     * @return HeaderCheckerManager
     */
    private function addTokenTypeSupport(TokenTypeSupport $tokenType): self
    {
        $this->tokenTypes[] = $tokenType;

        return $this;
    }

    /**
     * @param HeaderChecker $checker
     *
     * @return HeaderCheckerManager
     */
    private function add(HeaderChecker $checker): self
    {
        $header = $checker->supportedHeader();
        $this->checkers[$header] = $checker;

        return $this;
    }

    /**
     * This method checks all the header parameters passed as argument.
     * All header parameters are checked against the header parameter checkers.
     * If one fails, the InvalidHeaderException is thrown.
     *
     * @param JWT      $jwt
     * @param int      $index
     * @param string[] $mandatoryHeaderParameters
     *
     * @throws InvalidHeaderException
     * @throws MissingMandatoryHeaderParameterException
     */
    public function check(JWT $jwt, int $index, array $mandatoryHeaderParameters = [])
    {
        foreach ($this->tokenTypes as $tokenType) {
            if ($tokenType->supports($jwt)) {
                $protected = [];
                $unprotected = [];
                $tokenType->retrieveTokenHeaders($jwt, $index, $protected, $unprotected);
                $this->checkDuplicatedHeaderParameters($protected, $unprotected);
                $this->checkMandatoryHeaderParameters($mandatoryHeaderParameters, $protected, $unprotected);
                $this->checkHeaders($protected, $unprotected);

                return;
            }
        }

        throw new \InvalidArgumentException('Unsupported token type.');
    }

    /**
     * @param array $header1
     * @param array $header2
     */
    private function checkDuplicatedHeaderParameters(array $header1, array $header2)
    {
        $inter = array_intersect_key($header1, $header2);
        if (!empty($inter)) {
            throw new \InvalidArgumentException(sprintf('The header contains duplicated entries: %s.', implode(', ', array_keys($inter))));
        }
    }

    /**
     * @param string[] $mandatoryHeaderParameters
     * @param array    $protected
     * @param array    $unprotected
     *
     * @throws MissingMandatoryHeaderParameterException
     */
    private function checkMandatoryHeaderParameters(array $mandatoryHeaderParameters, array $protected, array $unprotected)
    {
        if (empty($mandatoryHeaderParameters)) {
            return;
        }
        $diff = array_keys(array_diff_key(array_flip($mandatoryHeaderParameters), array_merge($protected, $unprotected)));

        if (!empty($diff)) {
            throw new MissingMandatoryHeaderParameterException(sprintf('The following header parameters are mandatory: %s.', implode(', ', $diff)), $diff);
        }
    }

    /**
     * @param array $protected
     * @param array $header
     *
     * @throws InvalidHeaderException
     */
    private function checkHeaders(array $protected, array $header)
    {
        $checkedHeaderParameters = [];
        foreach ($this->checkers as $headerParameter => $checker) {
            if ($checker->protectedHeaderOnly()) {
                if (array_key_exists($headerParameter, $protected)) {
                    $checker->checkHeader($protected[$headerParameter]);
                    $checkedHeaderParameters[] = $headerParameter;
                } elseif (array_key_exists($headerParameter, $header)) {
                    throw new InvalidHeaderException(sprintf('The headerParameter "%s" must be protected.', $headerParameter), $headerParameter, $header[$headerParameter]);
                }
            } else {
                if (array_key_exists($headerParameter, $protected)) {
                    $checker->checkHeader($protected[$headerParameter]);
                    $checkedHeaderParameters[] = $headerParameter;
                } elseif (array_key_exists($headerParameter, $header)) {
                    $checker->checkHeader($header[$headerParameter]);
                    $checkedHeaderParameters[] = $headerParameter;
                }
            }
        }
        $this->checkCriticalHeader($protected, $header, $checkedHeaderParameters);
    }

    /**
     * @param array $protected
     * @param array $header
     * @param array $checkedHeaderParameters
     *
     * @throws InvalidHeaderException
     */
    private function checkCriticalHeader(array $protected, array $header, array $checkedHeaderParameters)
    {
        if (array_key_exists('crit', $protected)) {
            if (!is_array($protected['crit'])) {
                throw new InvalidHeaderException('The header "crit" mus be a list of header parameters.', 'crit', $protected['crit']);
            }
            $diff = array_diff($protected['crit'], $checkedHeaderParameters);
            if (!empty($diff)) {
                throw new InvalidHeaderException(sprintf('One or more header parameters are marked as critical, but they are missing or have not been checked: %s.', implode(', ', array_values($diff))), 'crit', $protected['crit']);
            }
        } elseif (array_key_exists('crit', $header)) {
            throw new InvalidHeaderException('The header parameter "crit" must be protected.', 'crit', $header['crit']);
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2018 Spomky-Labs
9			*
10			* This software may be modified and distributed under the terms
11			* of the MIT license. See the LICENSE file for details.
12			*/
13
14			namespace Jose\Component\Checker;
15
16			use Jose\Component\Core\JWT;
17
18			class HeaderCheckerManager
19			{
20			/**
21			* @var HeaderChecker[]
22			*/
23			private $checkers = [];
24
25			/**
26			* @var TokenTypeSupport[]
27			*/
28			private $tokenTypes = [];
29
30			/**
31			* HeaderCheckerManager constructor.
32			*
33			* @param HeaderChecker[] $checkers
34			* @param TokenTypeSupport[] $tokenTypes
35			*/
36			private function __construct(array $checkers, array $tokenTypes)
37			{
38			foreach ($checkers as $checker) {
39			$this->add($checker);
40			}
41			foreach ($tokenTypes as $tokenType) {
42			$this->addTokenTypeSupport($tokenType);
43			}
44			}
45
46			/**
47			* This method creates the HeaderCheckerManager.
48			* The first argument is a list of header parameter checkers objects.
49			* The second argument is a list of token type support objects.
50			* It is recommended to support only one token type per manager.
51			*
52			* @param HeaderChecker[] $checkers
53			* @param TokenTypeSupport[] $tokenTypes
54			*
55			* @return HeaderCheckerManager
56			*/
57			public static function create(array $checkers, array $tokenTypes): self
58			{
59			return new self($checkers, $tokenTypes);
60			}
61
62			/**
63			* This method returns all checkers handled by this manager.
64			*
65			* @return HeaderChecker[]
66			*/
67			public function getCheckers(): array
68			{
69			return $this->checkers;
70			}
71
72			/**
73			* @param TokenTypeSupport $tokenType
74			*
75			* @return HeaderCheckerManager
76			*/
77			private function addTokenTypeSupport(TokenTypeSupport $tokenType): self
78			{
79			$this->tokenTypes[] = $tokenType;
80
81			return $this;
82			}
83
84			/**
85			* @param HeaderChecker $checker
86			*
87			* @return HeaderCheckerManager
88			*/
89			private function add(HeaderChecker $checker): self
90			{
91			$header = $checker->supportedHeader();
92			$this->checkers[$header] = $checker;
93
94			return $this;
95			}
96
97			/**
98			* This method checks all the header parameters passed as argument.
99			* All header parameters are checked against the header parameter checkers.
100			* If one fails, the InvalidHeaderException is thrown.
101			*
102			* @param JWT $jwt
103			* @param int $index
104			* @param string[] $mandatoryHeaderParameters
105			*
106			* @throws InvalidHeaderException
107			* @throws MissingMandatoryHeaderParameterException
108			*/
109			public function check(JWT $jwt, int $index, array $mandatoryHeaderParameters = [])
110			{
111			foreach ($this->tokenTypes as $tokenType) {
112			if ($tokenType->supports($jwt)) {
113			$protected = [];
114			$unprotected = [];
115			$tokenType->retrieveTokenHeaders($jwt, $index, $protected, $unprotected);
116			$this->checkDuplicatedHeaderParameters($protected, $unprotected);
117			$this->checkMandatoryHeaderParameters($mandatoryHeaderParameters, $protected, $unprotected);
118			$this->checkHeaders($protected, $unprotected);
119
120			return;
121			}
122			}
123
124			throw new \InvalidArgumentException('Unsupported token type.');
125			}
126
127			/**
128			* @param array $header1
129			* @param array $header2
130			*/
131			private function checkDuplicatedHeaderParameters(array $header1, array $header2)
132			{
133			$inter = array_intersect_key($header1, $header2);
134			if (!empty($inter)) {
135			throw new \InvalidArgumentException(sprintf('The header contains duplicated entries: %s.', implode(', ', array_keys($inter))));
136			}
137			}
138
139			/**
140			* @param string[] $mandatoryHeaderParameters
141			* @param array $protected
142			* @param array $unprotected
143			*
144			* @throws MissingMandatoryHeaderParameterException
145			*/
146			private function checkMandatoryHeaderParameters(array $mandatoryHeaderParameters, array $protected, array $unprotected)
147			{
148			if (empty($mandatoryHeaderParameters)) {
149			return;
150			}
151			$diff = array_keys(array_diff_key(array_flip($mandatoryHeaderParameters), array_merge($protected, $unprotected)));
152
153			if (!empty($diff)) {
154			throw new MissingMandatoryHeaderParameterException(sprintf('The following header parameters are mandatory: %s.', implode(', ', $diff)), $diff);
155			}
156			}
157
158			/**
159			* @param array $protected
160			* @param array $header
161			*
162			* @throws InvalidHeaderException
163			*/
164			private function checkHeaders(array $protected, array $header)
165			{
166			$checkedHeaderParameters = [];
167			foreach ($this->checkers as $headerParameter => $checker) {
168			if ($checker->protectedHeaderOnly()) {
169			if (array_key_exists($headerParameter, $protected)) {
170			$checker->checkHeader($protected[$headerParameter]);
171			$checkedHeaderParameters[] = $headerParameter;
172			} elseif (array_key_exists($headerParameter, $header)) {
173			throw new InvalidHeaderException(sprintf('The headerParameter "%s" must be protected.', $headerParameter), $headerParameter, $header[$headerParameter]);
174			}
175			} else {
176			if (array_key_exists($headerParameter, $protected)) {
177			$checker->checkHeader($protected[$headerParameter]);
178			$checkedHeaderParameters[] = $headerParameter;
179			} elseif (array_key_exists($headerParameter, $header)) {
180			$checker->checkHeader($header[$headerParameter]);
181			$checkedHeaderParameters[] = $headerParameter;
182			}
183			}
184			}
185			$this->checkCriticalHeader($protected, $header, $checkedHeaderParameters);
186			}
187
188			/**
189			* @param array $protected
190			* @param array $header
191			* @param array $checkedHeaderParameters
192			*
193			* @throws InvalidHeaderException
194			*/
195			private function checkCriticalHeader(array $protected, array $header, array $checkedHeaderParameters)
196			{
197			if (array_key_exists('crit', $protected)) {
198			if (!is_array($protected['crit'])) {
199			throw new InvalidHeaderException('The header "crit" mus be a list of header parameters.', 'crit', $protected['crit']);
200			}
201			$diff = array_diff($protected['crit'], $checkedHeaderParameters);
202			if (!empty($diff)) {
203			throw new InvalidHeaderException(sprintf('One or more header parameters are marked as critical, but they are missing or have not been checked: %s.', implode(', ', array_values($diff))), 'crit', $protected['crit']);
204			}
205			} elseif (array_key_exists('crit', $header)) {
206			throw new InvalidHeaderException('The header parameter "crit" must be protected.', 'crit', $header['crit']);
207			}
208			}
209			}
210

web-token / jwt-framework

Push — master ( 7ad838...d2ad41 )

checkMandatoryHeaderParameters() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like