├── .github
    └── FUNDING.yml
├── LICENSE
├── composer.json
└── src
    ├── Decoder.php
    ├── Encoder.php
    ├── Exception.php
    └── Parser.php


/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: lcobucci
2 | patreon: lcobucci
3 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2014-2015, Luís Otávio Cobucci Oblonczyk
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without
 5 | modification, are permitted provided that the following conditions are met:
 6 | 
 7 | * Redistributions of source code must retain the above copyright notice, this
 8 |   list of conditions and the following disclaimer.
 9 | 
10 | * Redistributions in binary form must reproduce the above copyright notice,
11 |   this list of conditions and the following disclaimer in the documentation
12 |   and/or other materials provided with the distribution.
13 | 
14 | * Neither the name of the {organization} nor the names of its
15 |   contributors may be used to endorse or promote products derived from
16 |   this software without specific prior written permission.
17 | 
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "lcobucci/jose-parsing",
 3 |     "description": "A basic Base64Url and JSON encoding/decoding implementation",
 4 |     "type": "library",
 5 |     "abandoned": true,
 6 |     "authors": [
 7 |         {
 8 |             "name": "Luís Cobucci",
 9 |             "email": "lcobucci@gmail.com",
10 |             "role": "Developer"
11 |         }
12 |     ],
13 |     "keywords": [
14 |         "JOSE",
15 |         "Base64Url"
16 |     ],
17 |     "config": {
18 |         "preferred-install": "dist",
19 |         "sort-packages": true
20 |     },
21 |     "license": [
22 |         "BSD-3-Clause"
23 |     ],
24 |     "require": {
25 |         "php": "^7.4 || ^8.0",
26 |         "ext-json": "*"
27 |     },
28 |     "require-dev": {
29 |         "infection/infection": "^0.16",
30 |         "lcobucci/coding-standard": "^4.0",
31 |         "phpstan/extension-installer": "^1.0",
32 |         "phpstan/phpstan": "^0.12",
33 |         "phpstan/phpstan-deprecation-rules": "^0.12",
34 |         "phpstan/phpstan-phpunit": "^0.12",
35 |         "phpstan/phpstan-strict-rules": "^0.12",
36 |         "phpunit/phpunit": "^9.2"
37 |     },
38 |     "autoload": {
39 |         "psr-4": {
40 |             "Lcobucci\\Jose\\Parsing\\": "src"
41 |         }
42 |     },
43 |     "autoload-dev": {
44 |         "psr-4": {
45 |             "Lcobucci\\Jose\\Parsing\\": ["test"]
46 |         }
47 |     },
48 |     "extra": {
49 |         "branch-alias": {
50 |             "dev-master": "3.0-dev"
51 |         }
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/src/Decoder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Lcobucci\Jose\Parsing;
 5 | 
 6 | /**
 7 |  * A utilitarian class that decodes data according with JOSE specifications
 8 |  */
 9 | interface Decoder
10 | {
11 |     /**
12 |      * Decodes from JSON, validating the errors
13 |      *
14 |      * @return mixed
15 |      *
16 |      * @throws Exception When something goes wrong while decoding.
17 |      */
18 |     public function jsonDecode(string $json);
19 | 
20 |     /**
21 |      * Decodes from Base64URL
22 |      *
23 |      * @link http://tools.ietf.org/html/rfc4648#section-5
24 |      */
25 |     public function base64UrlDecode(string $data): string;
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Encoder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Lcobucci\Jose\Parsing;
 5 | 
 6 | /**
 7 |  * A utilitarian class that encodes data according with JOSE specifications
 8 |  */
 9 | interface Encoder
10 | {
11 |     /**
12 |      * Encodes to JSON, validating the errors
13 |      *
14 |      * @param mixed $data
15 |      *
16 |      * @throws Exception When something goes wrong while encoding.
17 |      */
18 |     public function jsonEncode($data): string;
19 | 
20 |     /**
21 |      * Encodes to base64url
22 |      *
23 |      * @link http://tools.ietf.org/html/rfc4648#section-5
24 |      */
25 |     public function base64UrlEncode(string $data): string;
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Lcobucci\Jose\Parsing;
 5 | 
 6 | use RuntimeException;
 7 | 
 8 | /**
 9 |  * An exception to be used when encoding or decoding
10 |  */
11 | final class Exception extends RuntimeException
12 | {
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Parser.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | declare(strict_types=1);
 3 | 
 4 | namespace Lcobucci\Jose\Parsing;
 5 | 
 6 | use JsonException;
 7 | use function base64_decode;
 8 | use function base64_encode;
 9 | use function is_string;
10 | use function json_decode;
11 | use function json_encode;
12 | use function str_repeat;
13 | use function str_replace;
14 | use function strlen;
15 | use function strtr;
16 | use const JSON_THROW_ON_ERROR;
17 | use const JSON_UNESCAPED_SLASHES;
18 | use const JSON_UNESCAPED_UNICODE;
19 | 
20 | /**
21 |  * A utilitarian class that encodes and decodes data according with JOSE specifications
22 |  */
23 | final class Parser implements Encoder, Decoder
24 | {
25 |     private const JSON_DEFAULT_DEPTH    = 512;
26 |     private const BASE64_PADDING_LENGTH = 4;
27 | 
28 |     /**
29 |      * {@inheritdoc}
30 |      */
31 |     public function jsonEncode($data): string
32 |     {
33 |         try {
34 |             return json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR);
35 |         } catch (JsonException $exception) {
36 |             throw new Exception('Error while encoding to JSON', 0, $exception);
37 |         }
38 |     }
39 | 
40 |     /**
41 |      * {@inheritdoc}
42 |      */
43 |     public function jsonDecode(string $json)
44 |     {
45 |         try {
46 |             return json_decode($json, true, self::JSON_DEFAULT_DEPTH, JSON_THROW_ON_ERROR);
47 |         } catch (JsonException $exception) {
48 |             throw new Exception('Error while decoding to JSON', 0, $exception);
49 |         }
50 |     }
51 | 
52 |     public function base64UrlEncode(string $data): string
53 |     {
54 |         return str_replace('=', '', strtr(base64_encode($data), '+/', '-_'));
55 |     }
56 | 
57 |     public function base64UrlDecode(string $data): string
58 |     {
59 |         $remainder = strlen($data) % self::BASE64_PADDING_LENGTH;
60 | 
61 |         if ($remainder !== 0) {
62 |             $data .= str_repeat('=', self::BASE64_PADDING_LENGTH - $remainder);
63 |         }
64 | 
65 |         $decodedContent = base64_decode(strtr($data, '-_', '+/'), true);
66 | 
67 |         if (! is_string($decodedContent)) {
68 |             throw new Exception('Error while decoding from Base64: invalid characters used');
69 |         }
70 | 
71 |         return $decodedContent;
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------