added predis and eseye back in.
This commit is contained in:
169
vendor/web-token/jwt-checker/HeaderCheckerManager.php
vendored
Normal file
169
vendor/web-token/jwt-checker/HeaderCheckerManager.php
vendored
Normal file
@@ -0,0 +1,169 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2020 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 function array_key_exists;
|
||||
use function count;
|
||||
use InvalidArgumentException;
|
||||
use function is_array;
|
||||
use Jose\Component\Core\JWT;
|
||||
|
||||
class HeaderCheckerManager
|
||||
{
|
||||
/**
|
||||
* @var HeaderChecker[]
|
||||
*/
|
||||
private $checkers = [];
|
||||
|
||||
/**
|
||||
* @var TokenTypeSupport[]
|
||||
*/
|
||||
private $tokenTypes = [];
|
||||
|
||||
/**
|
||||
* HeaderCheckerManager constructor.
|
||||
*
|
||||
* @param HeaderChecker[] $checkers
|
||||
* @param TokenTypeSupport[] $tokenTypes
|
||||
*/
|
||||
public function __construct(array $checkers, array $tokenTypes)
|
||||
{
|
||||
foreach ($checkers as $checker) {
|
||||
$this->add($checker);
|
||||
}
|
||||
foreach ($tokenTypes as $tokenType) {
|
||||
$this->addTokenTypeSupport($tokenType);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns all checkers handled by this manager.
|
||||
*
|
||||
* @return HeaderChecker[]
|
||||
*/
|
||||
public function getCheckers(): array
|
||||
{
|
||||
return $this->checkers;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 string[] $mandatoryHeaderParameters
|
||||
*
|
||||
* @throws InvalidArgumentException if the token format is not valid
|
||||
*/
|
||||
public function check(JWT $jwt, int $index, array $mandatoryHeaderParameters = []): void
|
||||
{
|
||||
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.');
|
||||
}
|
||||
|
||||
private function addTokenTypeSupport(TokenTypeSupport $tokenType): void
|
||||
{
|
||||
$this->tokenTypes[] = $tokenType;
|
||||
}
|
||||
|
||||
private function add(HeaderChecker $checker): void
|
||||
{
|
||||
$header = $checker->supportedHeader();
|
||||
$this->checkers[$header] = $checker;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidArgumentException if the header contains duplicated entries
|
||||
*/
|
||||
private function checkDuplicatedHeaderParameters(array $header1, array $header2): void
|
||||
{
|
||||
$inter = array_intersect_key($header1, $header2);
|
||||
if (0 !== count($inter)) {
|
||||
throw new InvalidArgumentException(sprintf('The header contains duplicated entries: %s.', implode(', ', array_keys($inter))));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $mandatoryHeaderParameters
|
||||
*
|
||||
* @throws MissingMandatoryHeaderParameterException if a mandatory header parameter is missing
|
||||
*/
|
||||
private function checkMandatoryHeaderParameters(array $mandatoryHeaderParameters, array $protected, array $unprotected): void
|
||||
{
|
||||
if (0 === count($mandatoryHeaderParameters)) {
|
||||
return;
|
||||
}
|
||||
$diff = array_keys(array_diff_key(array_flip($mandatoryHeaderParameters), array_merge($protected, $unprotected)));
|
||||
if (0 !== count($diff)) {
|
||||
throw new MissingMandatoryHeaderParameterException(sprintf('The following header parameters are mandatory: %s.', implode(', ', $diff)), $diff);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidHeaderException if a protected header parameter is not in the protected header
|
||||
*/
|
||||
private function checkHeaders(array $protected, array $header): void
|
||||
{
|
||||
$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 header parameter "%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);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidHeaderException if the "crit" parameter is not valid or if a critical header parameter cannot be verified
|
||||
*/
|
||||
private function checkCriticalHeader(array $protected, array $header, array $checkedHeaderParameters): void
|
||||
{
|
||||
if (array_key_exists('crit', $protected)) {
|
||||
if (!is_array($protected['crit'])) {
|
||||
throw new InvalidHeaderException('The header "crit" must be a list of header parameters.', 'crit', $protected['crit']);
|
||||
}
|
||||
$diff = array_diff($protected['crit'], $checkedHeaderParameters);
|
||||
if (0 !== count($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']);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user