JWSVerifier::checkPayload() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - web-token/jwt-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 6560de...8483ce )

by Florent

created 2017-11-15 20:32 UTC

JWSVerifier::checkPayload() B

↳ Parent: JWSVerifier

Complexity

Conditions	5
Paths	3

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	5
nc	3
nop	2

<?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\Signature;

use Base64Url\Base64Url;
use Jose\Component\Core\AlgorithmManager;
use Jose\Component\Core\JWK;
use Jose\Component\Core\JWKSet;
use Jose\Component\Core\Util\KeyChecker;
use Jose\Component\Signature\Algorithm\SignatureAlgorithm;

/**
 * Class able to load JWS and verify signatures and headers.
 */
final class JWSVerifier
{
    /**
     * @var AlgorithmManager
     */
    private $signatureAlgorithmManager;

    /**
     * JWSVerifier constructor.
     *
     * @param AlgorithmManager $signatureAlgorithmManager
     */
    public function __construct(AlgorithmManager $signatureAlgorithmManager)
    {
        $this->signatureAlgorithmManager = $signatureAlgorithmManager;
    }

    /**
     * @return AlgorithmManager
     */
    public function getSignatureAlgorithmManager(): AlgorithmManager
    {
        return $this->signatureAlgorithmManager;
    }

    /**
     * @param JWS         $jws
     * @param JWK         $jwk
     * @param null|string $detachedPayload
     *
     * @return int If the JWS has been verified, an integer that represents the ID of the signature is set
     */
    public function verifyWithKey(JWS $jws, JWK $jwk, ?string $detachedPayload = null): int
    {
        $jwkset = JWKSet::createFromKeys([$jwk]);

        return $this->verifyWithKeySet($jws, $jwkset, $detachedPayload);
    }

    /**
     * Verify the signature of the input.
     * The input must be a valid JWS. This method is usually called after the "load" method.
     *
     * @param JWS         $jws             A JWS object
     * @param JWKSet      $jwkset          The signature will be verified using keys in the key set
     * @param null|string $detachedPayload If not null, the value must be the detached payload encoded in Base64 URL safe. If the input contains a payload, throws an exception.
     *
     * @return int If the JWS has been verified, an integer that represents the ID of the signature is set
     */
    public function verifyWithKeySet(JWS $jws, JWKSet $jwkset, ?string $detachedPayload = null): int
    {
        $this->checkJWKSet($jwkset);
        $this->checkSignatures($jws);
        $this->checkPayload($jws, $detachedPayload);

        $nbSignatures = $jws->countSignatures();

        for ($i = 0; $i < $nbSignatures; ++$i) {
            $signature = $jws->getSignature($i);
            if (true === $this->verifySignature($jws, $jwkset, $signature, $detachedPayload)) {
                return $i;
            }
        }

        throw new \InvalidArgumentException('Unable to verify the JWS.');
    }

    /**
     * @param JWS         $jws
     * @param JWKSet      $jwkset
     * @param Signature   $signature
     * @param null|string $detachedPayload
     *
     * @return bool
     */
    private function verifySignature(JWS $jws, JWKSet $jwkset, Signature $signature, ?string $detachedPayload = null): bool
    {
        $input = $this->getInputToVerify($jws, $signature, $detachedPayload);
        foreach ($jwkset->all() as $jwk) {
            $algorithm = $this->getAlgorithm($signature);

            try {
                KeyChecker::checkKeyUsage($jwk, 'verification');
                KeyChecker::checkKeyAlgorithm($jwk, $algorithm->name());
                if (!in_array($jwk->get('kty'), $algorithm->allowedKeyTypes())) {
                    throw new \InvalidArgumentException('Wrong key type.');
                }
                if (true === $algorithm->verify($jwk, $input, $signature->getSignature())) {
                    return true;
                }
            } catch (\Exception $e) {
                //We do nothing, we continue with other keys
                continue;
            }
        }

        return false;
    }

    /**
     * @param JWS         $jws
     * @param Signature   $signature
     * @param string|null $detachedPayload
     *
     * @return string
     */
    private function getInputToVerify(JWS $jws, Signature $signature, ?string $detachedPayload): string
    {
        $encodedProtectedHeaders = $signature->getEncodedProtectedHeaders();
        if (!$signature->hasProtectedHeader('b64') || true === $signature->getProtectedHeader('b64')) {
            if (null !== $jws->getEncodedPayload()) {
                return sprintf('%s.%s', $encodedProtectedHeaders, $jws->getEncodedPayload());
            }

            $payload = empty($jws->getPayload()) ? $detachedPayload : $jws->getPayload();

            return sprintf('%s.%s', $encodedProtectedHeaders, Base64Url::encode($payload));
        }

        $payload = empty($jws->getPayload()) ? $detachedPayload : $jws->getPayload();

        return sprintf('%s.%s', $encodedProtectedHeaders, $payload);
    }

    /**
     * @param JWS $jws
     */
    private function checkSignatures(JWS $jws)
    {
        if (0 === $jws->countSignatures()) {
            throw new \InvalidArgumentException('The JWS does not contain any signature.');
        }
    }

    /**
     * @param JWKSet $jwkset
     */
    private function checkJWKSet(JWKSet $jwkset)
    {
        if (0 === count($jwkset)) {
            throw new \InvalidArgumentException('There is no key in the key set.');
        }
    }

    /**
     * @param JWS         $jws
     * @param null|string $detachedPayload
     */
    private function checkPayload(JWS $jws, ?string $detachedPayload = null)
    {
        if (null !== $detachedPayload && !empty($jws->getPayload())) {
            throw new \InvalidArgumentException('A detached payload is set, but the JWS already has a payload.');
        }
        if (empty($jws->getPayload()) && null === $detachedPayload) {
            throw new \InvalidArgumentException('The JWS has a detached payload, but no payload is provided.');
        }
    }

    /**
     * @param Signature $signature
     *
     * @return SignatureAlgorithm
     */
    private function getAlgorithm(Signature $signature): SignatureAlgorithm
    {
        $completeHeaders = array_merge($signature->getProtectedHeaders(), $signature->getHeaders());
        if (!array_key_exists('alg', $completeHeaders)) {
            throw new \InvalidArgumentException('No "alg" parameter set in the header.');
        }

        $algorithm = $this->signatureAlgorithmManager->get($completeHeaders['alg']);
        if (!$algorithm instanceof SignatureAlgorithm) {
            throw new \InvalidArgumentException(sprintf('The algorithm "%s" is not supported or is not a signature algorithm.', $completeHeaders['alg']));
        }

        return $algorithm;
    }
}


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\Signature;
15
16			use Base64Url\Base64Url;
17			use Jose\Component\Core\AlgorithmManager;
18			use Jose\Component\Core\JWK;
19			use Jose\Component\Core\JWKSet;
20			use Jose\Component\Core\Util\KeyChecker;
21			use Jose\Component\Signature\Algorithm\SignatureAlgorithm;
22
23			/**
24			* Class able to load JWS and verify signatures and headers.
25			*/
26			final class JWSVerifier
27			{
28			/**
29			* @var AlgorithmManager
30			*/
31			private $signatureAlgorithmManager;
32
33			/**
34			* JWSVerifier constructor.
35			*
36			* @param AlgorithmManager $signatureAlgorithmManager
37			*/
38			public function __construct(AlgorithmManager $signatureAlgorithmManager)
39			{
40			$this->signatureAlgorithmManager = $signatureAlgorithmManager;
41			}
42
43			/**
44			* @return AlgorithmManager
45			*/
46			public function getSignatureAlgorithmManager(): AlgorithmManager
47			{
48			return $this->signatureAlgorithmManager;
49			}
50
51			/**
52			* @param JWS $jws
53			* @param JWK $jwk
54			* @param null\|string $detachedPayload
55			*
56			* @return int If the JWS has been verified, an integer that represents the ID of the signature is set
57			*/
58			public function verifyWithKey(JWS $jws, JWK $jwk, ?string $detachedPayload = null): int
59			{
60			$jwkset = JWKSet::createFromKeys([$jwk]);
61
62			return $this->verifyWithKeySet($jws, $jwkset, $detachedPayload);
63			}
64
65			/**
66			* Verify the signature of the input.
67			* The input must be a valid JWS. This method is usually called after the "load" method.
68			*
69			* @param JWS $jws A JWS object
70			* @param JWKSet $jwkset The signature will be verified using keys in the key set
71			* @param null\|string $detachedPayload If not null, the value must be the detached payload encoded in Base64 URL safe. If the input contains a payload, throws an exception.
72			*
73			* @return int If the JWS has been verified, an integer that represents the ID of the signature is set
74			*/
75			public function verifyWithKeySet(JWS $jws, JWKSet $jwkset, ?string $detachedPayload = null): int
76			{
77			$this->checkJWKSet($jwkset);
78			$this->checkSignatures($jws);
79			$this->checkPayload($jws, $detachedPayload);
80
81			$nbSignatures = $jws->countSignatures();
82
83			for ($i = 0; $i < $nbSignatures; ++$i) {
84			$signature = $jws->getSignature($i);
85			if (true === $this->verifySignature($jws, $jwkset, $signature, $detachedPayload)) {
86			return $i;
87			}
88			}
89
90			throw new \InvalidArgumentException('Unable to verify the JWS.');
91			}
92
93			/**
94			* @param JWS $jws
95			* @param JWKSet $jwkset
96			* @param Signature $signature
97			* @param null\|string $detachedPayload
98			*
99			* @return bool
100			*/
101			private function verifySignature(JWS $jws, JWKSet $jwkset, Signature $signature, ?string $detachedPayload = null): bool
102			{
103			$input = $this->getInputToVerify($jws, $signature, $detachedPayload);
104			foreach ($jwkset->all() as $jwk) {
105			$algorithm = $this->getAlgorithm($signature);
106
107			try {
108			KeyChecker::checkKeyUsage($jwk, 'verification');
109			KeyChecker::checkKeyAlgorithm($jwk, $algorithm->name());
110			if (!in_array($jwk->get('kty'), $algorithm->allowedKeyTypes())) {
111			throw new \InvalidArgumentException('Wrong key type.');
112			}
113			if (true === $algorithm->verify($jwk, $input, $signature->getSignature())) {
114			return true;
115			}
116			} catch (\Exception $e) {
117			//We do nothing, we continue with other keys
118			continue;
119			}
120			}
121
122			return false;
123			}
124
125			/**
126			* @param JWS $jws
127			* @param Signature $signature
128			* @param string\|null $detachedPayload
129			*
130			* @return string
131			*/
132			private function getInputToVerify(JWS $jws, Signature $signature, ?string $detachedPayload): string
133			{
134			$encodedProtectedHeaders = $signature->getEncodedProtectedHeaders();
135			if (!$signature->hasProtectedHeader('b64') \|\| true === $signature->getProtectedHeader('b64')) {
136			if (null !== $jws->getEncodedPayload()) {
137			return sprintf('%s.%s', $encodedProtectedHeaders, $jws->getEncodedPayload());
138			}
139
140			$payload = empty($jws->getPayload()) ? $detachedPayload : $jws->getPayload();
141
142			return sprintf('%s.%s', $encodedProtectedHeaders, Base64Url::encode($payload));
143			}
144
145			$payload = empty($jws->getPayload()) ? $detachedPayload : $jws->getPayload();
146
147			return sprintf('%s.%s', $encodedProtectedHeaders, $payload);
148			}
149
150			/**
151			* @param JWS $jws
152			*/
153			private function checkSignatures(JWS $jws)
154			{
155			if (0 === $jws->countSignatures()) {
156			throw new \InvalidArgumentException('The JWS does not contain any signature.');
157			}
158			}
159
160			/**
161			* @param JWKSet $jwkset
162			*/
163			private function checkJWKSet(JWKSet $jwkset)
164			{
165			if (0 === count($jwkset)) {
166			throw new \InvalidArgumentException('There is no key in the key set.');
167			}
168			}
169
170			/**
171			* @param JWS $jws
172			* @param null\|string $detachedPayload
173			*/
174			private function checkPayload(JWS $jws, ?string $detachedPayload = null)
175			{
176			if (null !== $detachedPayload && !empty($jws->getPayload())) {
177			throw new \InvalidArgumentException('A detached payload is set, but the JWS already has a payload.');
178			}
179			if (empty($jws->getPayload()) && null === $detachedPayload) {
180			throw new \InvalidArgumentException('The JWS has a detached payload, but no payload is provided.');
181			}
182			}
183
184			/**
185			* @param Signature $signature
186			*
187			* @return SignatureAlgorithm
188			*/
189			private function getAlgorithm(Signature $signature): SignatureAlgorithm
190			{
191			$completeHeaders = array_merge($signature->getProtectedHeaders(), $signature->getHeaders());
192			if (!array_key_exists('alg', $completeHeaders)) {
193			throw new \InvalidArgumentException('No "alg" parameter set in the header.');
194			}
195
196			$algorithm = $this->signatureAlgorithmManager->get($completeHeaders['alg']);
197			if (!$algorithm instanceof SignatureAlgorithm) {
198			throw new \InvalidArgumentException(sprintf('The algorithm "%s" is not supported or is not a signature algorithm.', $completeHeaders['alg']));
199			}
200
201			return $algorithm;
202			}
203			}
204

web-token / jwt-framework

Push — master ( 6560de...8483ce )

JWSVerifier::checkPayload() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like