Jwt::decode() - Code Metrics - tmilos/jose-jwt - Measure and Improve Code Quality continuously with Scrutinizer

Jwt::decode() B
last analyzed 2018-09-04 10:39 UTC

↳ Parent: Jwt

Complexity

Conditions	8
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	10
nop	3
dl	0
loc	34
rs	8.1315
c	0
b	0
f	0

<?php

/*
 * This file is part of the tmilos/jose-jwt package.
 *
 * (c) Milos Tomic <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Tmilos\JoseJwt;

use Tmilos\JoseJwt\Context\Context;
use Tmilos\JoseJwt\Error\IntegrityException;
use Tmilos\JoseJwt\Error\JoseJwtException;
use Tmilos\JoseJwt\Util\StringUtils;
use Tmilos\JoseJwt\Util\UrlSafeB64Encoder;

class Jwt
{
    private function __construct()
    {
    }

    /**
     * @param Context         $context
     * @param array|object    $payload
     * @param string|resource $key
     * @param string          $jwsAlgorithm
     * @param array           $extraHeaders
     *
     * @return string
     */
    public static function encode(Context $context, $payload, $key, $jwsAlgorithm, $extraHeaders = [])
    {
        $header = array_merge([
            'alg' => '',
            'typ' => 'JWT',
        ], $extraHeaders);

        $hashAlgorithm = $context->jwsAlgorithms()->get($jwsAlgorithm);
        if (null == $hashAlgorithm) {
            throw new JoseJwtException(sprintf('Unknown algorithm "%s"', $jwsAlgorithm));
        }

        $header['alg'] = $jwsAlgorithm;

        $payloadString = StringUtils::payload2string($payload, $context->jsonMapper());

        $signingInput = implode('.', [
            UrlSafeB64Encoder::encode(json_encode($header)),
            UrlSafeB64Encoder::encode($payloadString),
        ]);

        $signature = $hashAlgorithm->sign($signingInput, $key);

        $signature = UrlSafeB64Encoder::encode($signature);

        return $signingInput.'.'.$signature;
    }

    /**
     * @param Context         $context
     * @param string          $token
     * @param string|resource $key
     *
     * @return array
     */
    public static function decode(Context $context, $token, $key)
    {
        if (empty($token) || trim($token) === '') {
            throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
        }

        $parts = explode('.', $token);
        if (count($parts) == 5) {
            return Jwe::decode($context, $token, $key);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $decodedParts = [];
        foreach ($parts as $part) {
            $decodedParts[] = UrlSafeB64Encoder::decode($part);
        }
        $header = json_decode($decodedParts[0], true);
        if (null == $header) {
            throw new JoseJwtException('Invalid header');
        }

        // signed or plain JWT
        $signedInput = $parts[0].'.'.$parts[1];
        $algorithmId = $header['alg'];
        $algorithm = $context->jwsAlgorithms()->get($algorithmId);
        if (null === $algorithm) {
            throw new JoseJwtException(sprintf('Invalid algorithm "%s"', $algorithmId));
        }

        if (false === $algorithm->verify($decodedParts[2], $signedInput, $key)) {

            throw new IntegrityException('Invalid signature');
        }

        return json_decode($decodedParts[1], true);
    }

    /**
     * @param $token
     *
     * @return array
     */
    public static function header($token)

    {
        if (null === $token || trim($token) === '') {
            throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
        }

        $parts = explode('.', $token);
        if (count($parts) != 3 && count($parts) != 5) {
            throw new JoseJwtException('Invalid JWT');
        }

        $header = json_decode(UrlSafeB64Encoder::decode($parts[0]), true);
        if (null == $header) {
            throw new JoseJwtException('Invalid header');
        }

        return $header;
    }

    /**
     * @param $token
     *
     * @return array
     */
    public static function payload($token)

    {
        if (null === $token || trim($token) === '') {
            throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
        }

        $parts = explode('.', $token);
        if (count($parts) != 3) {
            throw new JoseJwtException('Invalid JWT');
        }

        $payload = json_decode(UrlSafeB64Encoder::decode($parts[1]), true);
        if (null == $payload) {
            throw new JoseJwtException('Invalid payload');
        }

        return $payload;
    }
}


1		<?php
2
3		/*
4		* This file is part of the tmilos/jose-jwt package.
5		*
6		* (c) Milos Tomic <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Tmilos\JoseJwt;
13
14		use Tmilos\JoseJwt\Context\Context;
15		use Tmilos\JoseJwt\Error\IntegrityException;
16		use Tmilos\JoseJwt\Error\JoseJwtException;
17		use Tmilos\JoseJwt\Util\StringUtils;
18		use Tmilos\JoseJwt\Util\UrlSafeB64Encoder;
19
20		class Jwt
21		{
22		private function __construct()
23		{
24		}
25
26		/**
27		* @param Context $context
28		* @param array\|object $payload
29		* @param string\|resource $key
30		* @param string $jwsAlgorithm
31		* @param array $extraHeaders
32		*
33		* @return string
34		*/
35		public static function encode(Context $context, $payload, $key, $jwsAlgorithm, $extraHeaders = [])
36		{
37		$header = array_merge([
38		'alg' => '',
39		'typ' => 'JWT',
40		], $extraHeaders);
41
42		$hashAlgorithm = $context->jwsAlgorithms()->get($jwsAlgorithm);
43		if (null == $hashAlgorithm) {
44		throw new JoseJwtException(sprintf('Unknown algorithm "%s"', $jwsAlgorithm));
45		}
46
47		$header['alg'] = $jwsAlgorithm;
48
49		$payloadString = StringUtils::payload2string($payload, $context->jsonMapper());
50
51		$signingInput = implode('.', [
52		UrlSafeB64Encoder::encode(json_encode($header)),
53		UrlSafeB64Encoder::encode($payloadString),
54		]);
55
56		$signature = $hashAlgorithm->sign($signingInput, $key);
		0 ignored issues – show Bug introduced 2017-01-26 09:43 UTC by Report Bug Copy Issue Report It seems like `$key` defined by parameter `$key` on line 35 can also be of type `resource`; however, `Tmilos\JoseJwt\Jws\JwsAlgorithm::sign()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
57		$signature = UrlSafeB64Encoder::encode($signature);
58
59		return $signingInput.'.'.$signature;
60		}
61
62		/**
63		* @param Context $context
64		* @param string $token
65		* @param string\|resource $key
66		*
67		* @return array
68		*/
69		public static function decode(Context $context, $token, $key)
70		{
71		if (empty($token) \|\| trim($token) === '') {
72		throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
73		}
74
75		$parts = explode('.', $token);
76		if (count($parts) == 5) {
77		return Jwe::decode($context, $token, $key);
		0 ignored issues – show Bug Best Practice introduced 2017-01-26 09:43 UTC by Report Bug Copy Issue Report The return type of `return \Tmilos\JoseJwt\J...context, $token, $key);` (`string`) is incompatible with the return type documented by `Tmilos\JoseJwt\Jwt::decode` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
78		}
79
80		$decodedParts = [];
81		foreach ($parts as $part) {
82		$decodedParts[] = UrlSafeB64Encoder::decode($part);
83		}
84		$header = json_decode($decodedParts[0], true);
85		if (null == $header) {
86		throw new JoseJwtException('Invalid header');
87		}
88
89		// signed or plain JWT
90		$signedInput = $parts[0].'.'.$parts[1];
91		$algorithmId = $header['alg'];
92		$algorithm = $context->jwsAlgorithms()->get($algorithmId);
93		if (null === $algorithm) {
94		throw new JoseJwtException(sprintf('Invalid algorithm "%s"', $algorithmId));
95		}
96
97		if (false === $algorithm->verify($decodedParts[2], $signedInput, $key)) {
		0 ignored issues – show Bug introduced 2017-01-26 09:43 UTC by Report Bug Copy Issue Report It seems like `$key` defined by parameter `$key` on line 69 can also be of type `resource`; however, `Tmilos\JoseJwt\Jws\JwsAlgorithm::verify()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
98		throw new IntegrityException('Invalid signature');
99		}
100
101		return json_decode($decodedParts[1], true);
102		}
103
104		/**
105		* @param $token
106		*
107		* @return array
108		*/
109	View Code Duplication	public static function header($token)
		0 ignored issues – show Duplication introduced 2016-01-15 14:05 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		{
111		if (null === $token \|\| trim($token) === '') {
112		throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
113		}
114
115		$parts = explode('.', $token);
116		if (count($parts) != 3 && count($parts) != 5) {
117		throw new JoseJwtException('Invalid JWT');
118		}
119
120		$header = json_decode(UrlSafeB64Encoder::decode($parts[0]), true);
121		if (null == $header) {
122		throw new JoseJwtException('Invalid header');
123		}
124
125		return $header;
126		}
127
128		/**
129		* @param $token
130		*
131		* @return array
132		*/
133	View Code Duplication	public static function payload($token)
		0 ignored issues – show Duplication introduced 2016-01-15 14:05 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
134		{
135		if (null === $token \|\| trim($token) === '') {
136		throw new JoseJwtException('Incoming token expected to be in compact serialization form, but is empty');
137		}
138
139		$parts = explode('.', $token);
140		if (count($parts) != 3) {
141		throw new JoseJwtException('Invalid JWT');
142		}
143
144		$payload = json_decode(UrlSafeB64Encoder::decode($parts[1]), true);
145		if (null == $payload) {
146		throw new JoseJwtException('Invalid payload');
147		}
148
149		return $payload;
150		}
151		}
152

tmilos / jose-jwt

Jwt::decode() B last analyzed 2018-09-04 10:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Jwt::decode() B
last analyzed 2018-09-04 10:39 UTC