HeaderCheckerManager::checkHeaders() - Code Metrics - Inspection of "Better JKU/X5U support" - Spomky-Labs/jose - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — v7 ( 69552d...3dace9 )

by Florent

created 2017-10-04 19:37 UTC

HeaderCheckerManager::checkHeaders() D

↳ Parent: HeaderCheckerManager

Complexity

Conditions	10
Paths	26

Size

Total Lines	34
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	4.8196
c	0
b	0
f	0
cc	10
eloc	24
nc	26
nop	2

How to fix Complexity

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 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\JWTInterface;
use Jose\Component\Encryption\JWE;
use Jose\Component\Signature\JWS;

/**
 * Class HeaderCheckerManager.
 */
final class HeaderCheckerManager
{
    /**
     * @var HeaderCheckerInterface[]
     */
    private $checkers = [];

    /**
     * HeaderCheckerManager constructor.
     *
     * @param HeaderCheckerInterface[] $checkers
     */
    private function __construct(array $checkers)
    {
        foreach ($checkers as $checker) {
            $this->add($checker);
        }
    }

    /**
     * @param HeaderCheckerInterface[] $checkers
     *
     * @return HeaderCheckerManager
     */
    public static function create(array $checkers): HeaderCheckerManager
    {
        return new self($checkers);
    }

    /**
     * @param HeaderCheckerInterface $checker
     *
     * @return HeaderCheckerManager
     */
    private function add(HeaderCheckerInterface $checker): HeaderCheckerManager
    {
        $header = $checker->supportedHeader();
        if (array_key_exists($header, $this->checkers)) {
            throw new \InvalidArgumentException(sprintf('The header checker "%s" is already supported.', $header));
        }

        $this->checkers[$header] = $checker;

        return $this;
    }

    /**
     * @param JWTInterface $jwt
     * @param int          $component
     */
    public function check(JWTInterface $jwt, int $component)
    {
        switch (true) {
            case $jwt instanceof JWS:
                $this->checkJWS($jwt, $component);

                break;
            case $jwt instanceof JWE:
                $this->checkJWE($jwt, $component);

                break;
            default:
                throw new \InvalidArgumentException('Unsupported argument');
        }
    }

    /**
     * @param JWS $jws
     * @param int $signature
     */
    public function checkJWS(JWS $jws, int $signature)
    {
        if ($signature > $jws->countSignatures()) {
            throw new \InvalidArgumentException('Unknown signature index.');
        }
        $protected = $jws->getSignature($signature)->getProtectedHeaders();
        $headers = $jws->getSignature($signature)->getHeaders();
        $this->checkDuplicatedHeaderParameters($protected, $headers);
        $this->checkHeaders($protected, $headers);
    }

    /**
     * @param JWE $jwe
     * @param int $recipient
     */
    public function checkJWE(JWE $jwe, int $recipient)
    {
        if ($recipient > $jwe->countRecipients()) {
            throw new \InvalidArgumentException('Unknown recipient index.');
        }
        $protected = $jwe->getSharedProtectedHeaders();
        $headers = $jwe->getSharedHeaders();
        $recipient = $jwe->getRecipient($recipient)->getHeaders();
        $this->checkDuplicatedHeaderParameters($protected, $headers);
        $this->checkDuplicatedHeaderParameters($protected, $recipient);
        $this->checkDuplicatedHeaderParameters($headers, $recipient);
        $unprotected = array_merge(
            $headers,
            $recipient
        );
        $this->checkHeaders($protected, $unprotected);
    }

    /**
     * @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 array $protected
     * @param array $headers
     */
    private function checkHeaders(array $protected, array $headers)
    {
        $checkedHeaders = [];
        foreach ($this->checkers as $header => $checker) {
            if ($checker->protectedHeaderOnly()) {
                if (array_key_exists($header, $protected)) {
                    $checker->checkHeader($protected[$header]);
                    $checkedHeaders[] = $header;
                } else {
                    throw new \InvalidArgumentException(sprintf('The header "%s" must be protected.', $header));
                }
            } else {
                if (array_key_exists($header, $protected)) {
                    $checker->checkHeader($protected[$header]);
                    $checkedHeaders[] = $header;
                } elseif (array_key_exists($header, $headers)) {
                    $checker->checkHeader($headers[$header]);
                    $checkedHeaders[] = $header;
                }
            }
        }

        if (array_key_exists('crit', $protected)) {
            if (!is_array($protected['crit'])) {
                throw new \InvalidArgumentException('The header "crit" mus be a list of header parameters.');
            }
            $diff = array_diff($protected['crit'], $checkedHeaders);
            if (!empty($diff)) {
                throw new \InvalidArgumentException(sprintf('One or more headers are marked as critical, but they are missing or have not been checked: %s.', implode(', ', array_values($diff))));
            }
        } elseif (array_key_exists('crit', $headers)) {
            throw new \InvalidArgumentException('The header parameter "crit" must be protected.');
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2017 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\JWTInterface;
17			use Jose\Component\Encryption\JWE;
18			use Jose\Component\Signature\JWS;
19
20			/**
21			* Class HeaderCheckerManager.
22			*/
23			final class HeaderCheckerManager
24			{
25			/**
26			* @var HeaderCheckerInterface[]
27			*/
28			private $checkers = [];
29
30			/**
31			* HeaderCheckerManager constructor.
32			*
33			* @param HeaderCheckerInterface[] $checkers
34			*/
35			private function __construct(array $checkers)
36			{
37			foreach ($checkers as $checker) {
38			$this->add($checker);
39			}
40			}
41
42			/**
43			* @param HeaderCheckerInterface[] $checkers
44			*
45			* @return HeaderCheckerManager
46			*/
47			public static function create(array $checkers): HeaderCheckerManager
48			{
49			return new self($checkers);
50			}
51
52			/**
53			* @param HeaderCheckerInterface $checker
54			*
55			* @return HeaderCheckerManager
56			*/
57			private function add(HeaderCheckerInterface $checker): HeaderCheckerManager
58			{
59			$header = $checker->supportedHeader();
60			if (array_key_exists($header, $this->checkers)) {
61			throw new \InvalidArgumentException(sprintf('The header checker "%s" is already supported.', $header));
62			}
63
64			$this->checkers[$header] = $checker;
65
66			return $this;
67			}
68
69			/**
70			* @param JWTInterface $jwt
71			* @param int $component
72			*/
73			public function check(JWTInterface $jwt, int $component)
74			{
75			switch (true) {
76			case $jwt instanceof JWS:
77			$this->checkJWS($jwt, $component);
78
79			break;
80			case $jwt instanceof JWE:
81			$this->checkJWE($jwt, $component);
82
83			break;
84			default:
85			throw new \InvalidArgumentException('Unsupported argument');
86			}
87			}
88
89			/**
90			* @param JWS $jws
91			* @param int $signature
92			*/
93			public function checkJWS(JWS $jws, int $signature)
94			{
95			if ($signature > $jws->countSignatures()) {
96			throw new \InvalidArgumentException('Unknown signature index.');
97			}
98			$protected = $jws->getSignature($signature)->getProtectedHeaders();
99			$headers = $jws->getSignature($signature)->getHeaders();
100			$this->checkDuplicatedHeaderParameters($protected, $headers);
101			$this->checkHeaders($protected, $headers);
102			}
103
104			/**
105			* @param JWE $jwe
106			* @param int $recipient
107			*/
108			public function checkJWE(JWE $jwe, int $recipient)
109			{
110			if ($recipient > $jwe->countRecipients()) {
111			throw new \InvalidArgumentException('Unknown recipient index.');
112			}
113			$protected = $jwe->getSharedProtectedHeaders();
114			$headers = $jwe->getSharedHeaders();
115			$recipient = $jwe->getRecipient($recipient)->getHeaders();
116			$this->checkDuplicatedHeaderParameters($protected, $headers);
117			$this->checkDuplicatedHeaderParameters($protected, $recipient);
118			$this->checkDuplicatedHeaderParameters($headers, $recipient);
119			$unprotected = array_merge(
120			$headers,
121			$recipient
122			);
123			$this->checkHeaders($protected, $unprotected);
124			}
125
126			/**
127			* @param array $header1
128			* @param array $header2
129			*/
130			private function checkDuplicatedHeaderParameters(array $header1, array $header2)
131			{
132			$inter = array_intersect_key($header1, $header2);
133			if (!empty($inter)) {
134			throw new \InvalidArgumentException(sprintf('The header contains duplicated entries: %s.', implode(', ', array_keys($inter))));
135			}
136			}
137
138			/**
139			* @param array $protected
140			* @param array $headers
141			*/
142			private function checkHeaders(array $protected, array $headers)
143			{
144			$checkedHeaders = [];
145			foreach ($this->checkers as $header => $checker) {
146			if ($checker->protectedHeaderOnly()) {
147			if (array_key_exists($header, $protected)) {
148			$checker->checkHeader($protected[$header]);
149			$checkedHeaders[] = $header;
150			} else {
151			throw new \InvalidArgumentException(sprintf('The header "%s" must be protected.', $header));
152			}
153			} else {
154			if (array_key_exists($header, $protected)) {
155			$checker->checkHeader($protected[$header]);
156			$checkedHeaders[] = $header;
157			} elseif (array_key_exists($header, $headers)) {
158			$checker->checkHeader($headers[$header]);
159			$checkedHeaders[] = $header;
160			}
161			}
162			}
163
164			if (array_key_exists('crit', $protected)) {
165			if (!is_array($protected['crit'])) {
166			throw new \InvalidArgumentException('The header "crit" mus be a list of header parameters.');
167			}
168			$diff = array_diff($protected['crit'], $checkedHeaders);
169			if (!empty($diff)) {
170			throw new \InvalidArgumentException(sprintf('One or more headers are marked as critical, but they are missing or have not been checked: %s.', implode(', ', array_values($diff))));
171			}
172			} elseif (array_key_exists('crit', $headers)) {
173			throw new \InvalidArgumentException('The header parameter "crit" must be protected.');
174			}
175			}
176			}
177

Spomky-Labs / jose

Push — v7 ( 69552d...3dace9 )

HeaderCheckerManager::checkHeaders() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like