|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
/* |
|
6
|
|
|
* The MIT License (MIT) |
|
7
|
|
|
* |
|
8
|
|
|
* Copyright (c) 2014-2019 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 InvalidArgumentException; |
|
17
|
|
|
use Jose\Component\Core\JWT; |
|
18
|
|
|
|
|
19
|
|
|
class HeaderCheckerManager |
|
20
|
|
|
{ |
|
21
|
|
|
/** |
|
22
|
|
|
* @var HeaderChecker[] |
|
23
|
|
|
*/ |
|
24
|
|
|
private $checkers = []; |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* @var TokenTypeSupport[] |
|
28
|
|
|
*/ |
|
29
|
|
|
private $tokenTypes = []; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* HeaderCheckerManager constructor. |
|
33
|
|
|
* |
|
34
|
|
|
* @param HeaderChecker[] $checkers |
|
35
|
|
|
* @param TokenTypeSupport[] $tokenTypes |
|
36
|
|
|
*/ |
|
37
|
|
|
public function __construct(array $checkers, array $tokenTypes) |
|
38
|
|
|
{ |
|
39
|
|
|
foreach ($checkers as $checker) { |
|
40
|
|
|
$this->add($checker); |
|
41
|
|
|
} |
|
42
|
|
|
foreach ($tokenTypes as $tokenType) { |
|
43
|
|
|
$this->addTokenTypeSupport($tokenType); |
|
44
|
|
|
} |
|
45
|
|
|
} |
|
46
|
|
|
|
|
47
|
|
|
/** |
|
48
|
|
|
* This method returns all checkers handled by this manager. |
|
49
|
|
|
* |
|
50
|
|
|
* @return HeaderChecker[] |
|
51
|
|
|
*/ |
|
52
|
|
|
public function getCheckers(): array |
|
53
|
|
|
{ |
|
54
|
|
|
return $this->checkers; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* This method checks all the header parameters passed as argument. |
|
59
|
|
|
* All header parameters are checked against the header parameter checkers. |
|
60
|
|
|
* If one fails, the InvalidHeaderException is thrown. |
|
61
|
|
|
* |
|
62
|
|
|
* @param string[] $mandatoryHeaderParameters |
|
63
|
|
|
* |
|
64
|
|
|
* @throws InvalidArgumentException if the token format is not valid |
|
65
|
|
|
*/ |
|
66
|
|
|
public function check(JWT $jwt, int $index, array $mandatoryHeaderParameters = []): void |
|
67
|
|
|
{ |
|
68
|
|
|
foreach ($this->tokenTypes as $tokenType) { |
|
69
|
|
|
if ($tokenType->supports($jwt)) { |
|
70
|
|
|
$protected = []; |
|
71
|
|
|
$unprotected = []; |
|
72
|
|
|
$tokenType->retrieveTokenHeaders($jwt, $index, $protected, $unprotected); |
|
73
|
|
|
$this->checkDuplicatedHeaderParameters($protected, $unprotected); |
|
74
|
|
|
$this->checkMandatoryHeaderParameters($mandatoryHeaderParameters, $protected, $unprotected); |
|
75
|
|
|
$this->checkHeaders($protected, $unprotected); |
|
76
|
|
|
|
|
77
|
|
|
return; |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
throw new InvalidArgumentException('Unsupported token type.'); |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
private function addTokenTypeSupport(TokenTypeSupport $tokenType): void |
|
85
|
|
|
{ |
|
86
|
|
|
$this->tokenTypes[] = $tokenType; |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
private function add(HeaderChecker $checker): void |
|
90
|
|
|
{ |
|
91
|
|
|
$header = $checker->supportedHeader(); |
|
92
|
|
|
$this->checkers[$header] = $checker; |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
/** |
|
96
|
|
|
* @throws InvalidArgumentException if the header contains duplicated entries |
|
97
|
|
|
*/ |
|
98
|
|
|
private function checkDuplicatedHeaderParameters(array $header1, array $header2): void |
|
99
|
|
|
{ |
|
100
|
|
|
$inter = array_intersect_key($header1, $header2); |
|
101
|
|
|
if (0 !== \count($inter)) { |
|
102
|
|
|
throw new InvalidArgumentException(sprintf('The header contains duplicated entries: %s.', implode(', ', array_keys($inter)))); |
|
103
|
|
|
} |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* @param string[] $mandatoryHeaderParameters |
|
108
|
|
|
* |
|
109
|
|
|
* @throws MissingMandatoryHeaderParameterException if a mandatory header parameter is missing |
|
110
|
|
|
*/ |
|
111
|
|
|
private function checkMandatoryHeaderParameters(array $mandatoryHeaderParameters, array $protected, array $unprotected): void |
|
112
|
|
|
{ |
|
113
|
|
|
if (0 === \count($mandatoryHeaderParameters)) { |
|
114
|
|
|
return; |
|
115
|
|
|
} |
|
116
|
|
|
$diff = array_keys(array_diff_key(array_flip($mandatoryHeaderParameters), array_merge($protected, $unprotected))); |
|
117
|
|
|
if (0 !== \count($diff)) { |
|
118
|
|
|
throw new MissingMandatoryHeaderParameterException(sprintf('The following header parameters are mandatory: %s.', implode(', ', $diff)), $diff); |
|
119
|
|
|
} |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
/** |
|
123
|
|
|
* @throws InvalidHeaderException if a protected header parameter is not in the protected header |
|
124
|
|
|
*/ |
|
125
|
|
|
private function checkHeaders(array $protected, array $header): void |
|
126
|
|
|
{ |
|
127
|
|
|
$checkedHeaderParameters = []; |
|
128
|
|
|
foreach ($this->checkers as $headerParameter => $checker) { |
|
129
|
|
|
if ($checker->protectedHeaderOnly()) { |
|
130
|
|
|
if (\array_key_exists($headerParameter, $protected)) { |
|
131
|
|
|
$checker->checkHeader($protected[$headerParameter]); |
|
132
|
|
|
$checkedHeaderParameters[] = $headerParameter; |
|
133
|
|
|
} elseif (\array_key_exists($headerParameter, $header)) { |
|
134
|
|
|
throw new InvalidHeaderException(sprintf('The header parameter "%s" must be protected.', $headerParameter), $headerParameter, $header[$headerParameter]); |
|
135
|
|
|
} |
|
136
|
|
|
} else { |
|
137
|
|
|
if (\array_key_exists($headerParameter, $protected)) { |
|
138
|
|
|
$checker->checkHeader($protected[$headerParameter]); |
|
139
|
|
|
$checkedHeaderParameters[] = $headerParameter; |
|
140
|
|
|
} elseif (\array_key_exists($headerParameter, $header)) { |
|
141
|
|
|
$checker->checkHeader($header[$headerParameter]); |
|
142
|
|
|
$checkedHeaderParameters[] = $headerParameter; |
|
143
|
|
|
} |
|
144
|
|
|
} |
|
145
|
|
|
} |
|
146
|
|
|
$this->checkCriticalHeader($protected, $header, $checkedHeaderParameters); |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
|
|
/** |
|
150
|
|
|
* @throws InvalidHeaderException if the "crit" parameter is not valid or if a critical header parameter cannot be verified |
|
151
|
|
|
*/ |
|
152
|
|
|
private function checkCriticalHeader(array $protected, array $header, array $checkedHeaderParameters): void |
|
153
|
|
|
{ |
|
154
|
|
|
if (\array_key_exists('crit', $protected)) { |
|
155
|
|
|
if (!\is_array($protected['crit'])) { |
|
156
|
|
|
throw new InvalidHeaderException('The header "crit" must be a list of header parameters.', 'crit', $protected['crit']); |
|
157
|
|
|
} |
|
158
|
|
|
$diff = array_diff($protected['crit'], $checkedHeaderParameters); |
|
159
|
|
|
if (0 !== \count($diff)) { |
|
160
|
|
|
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']); |
|
161
|
|
|
} |
|
162
|
|
|
} elseif (\array_key_exists('crit', $header)) { |
|
163
|
|
|
throw new InvalidHeaderException('The header parameter "crit" must be protected.', 'crit', $header['crit']); |
|
164
|
|
|
} |
|
165
|
|
|
} |
|
166
|
|
|
} |
|
167
|
|
|
|
web-token /
jwt-framework
