├── .editorconfig
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── composer.lock
├── src
    ├── Base64.php
    └── Throwable
    │   ├── DecodingError.php
    │   ├── EncodingError.php
    │   ├── Error.php
    │   └── Exception.php
└── tests
    └── index.php


/.editorconfig:
--------------------------------------------------------------------------------
 1 | # editorconfig.org
 2 | root = true
 3 | 
 4 | [*]
 5 | charset = utf-8
 6 | indent_style = tab
 7 | trim_trailing_whitespace = true
 8 | end_of_line = lf
 9 | insert_final_newline = true
10 | 
11 | [*.md]
12 | indent_style = space
13 | indent_size = 4
14 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # IntelliJ
2 | .idea/
3 | 
4 | # Composer
5 | vendor/
6 | composer.phar
7 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) delight.im (https://www.delight.im/)
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PHP-Base64
 2 | 
 3 | Simple and convenient Base64 encoding and decoding for PHP
 4 | 
 5 | ## Requirements
 6 | 
 7 |  * PHP 5.3.0+
 8 | 
 9 | ## Installation
10 | 
11 |  1. Include the library via Composer [[?]](https://github.com/delight-im/Knowledge/blob/master/Composer%20(PHP).md):
12 | 
13 |     ```
14 |     $ composer require delight-im/base64
15 |     ```
16 | 
17 |  1. Include the Composer autoloader:
18 | 
19 |     ```php
20 |     require __DIR__ . '/vendor/autoload.php';
21 |     ```
22 | 
23 | ## Usage
24 | 
25 | ### Standard
26 | 
27 |  * Encoding data
28 | 
29 |    ```php
30 |    \Delight\Base64\Base64::encode('Gallia est omnis divisa in partes tres');
31 |    // string(52) "R2FsbGlhIGVzdCBvbW5pcyBkaXZpc2EgaW4gcGFydGVzIHRyZXM="
32 |    ```
33 | 
34 |  * Decoding data
35 | 
36 |    ```php
37 |    \Delight\Base64\Base64::decode('R2FsbGlhIGVzdCBvbW5pcyBkaXZpc2EgaW4gcGFydGVzIHRyZXM=');
38 |    // string(38) "Gallia est omnis divisa in partes tres"
39 |    ```
40 | 
41 | ### URL-safe
42 | 
43 |  * Encoding data
44 | 
45 |    ```php
46 |    \Delight\Base64\Base64::encodeUrlSafe('πάντα χωρεῖ καὶ οὐδὲν μένει …');
47 |    // string(80) "z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg~~"
48 |    ```
49 | 
50 |  * Decoding data
51 | 
52 |    ```php
53 |    \Delight\Base64\Base64::decodeUrlSafe('z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg~~');
54 |    // string(58) "πάντα χωρεῖ καὶ οὐδὲν μένει …"
55 |    ```
56 | 
57 | ### URL-safe without padding
58 | 
59 |  * Encoding data
60 | 
61 |    ```php
62 |    \Delight\Base64\Base64::encodeUrlSafeWithoutPadding('πάντα χωρεῖ καὶ οὐδὲν μένει …');
63 |    // string(78) "z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg"
64 |    ```
65 | 
66 |  * Decoding data
67 | 
68 |    ```php
69 |    \Delight\Base64\Base64::decodeUrlSafeWithoutPadding('z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg');
70 |    // string(58) "πάντα χωρεῖ καὶ οὐδὲν μένει …"
71 |    ```
72 | 
73 | ## Specifications
74 | 
75 |  * [RFC 4648](https://tools.ietf.org/html/rfc4648)
76 |  * [RFC 3548](https://tools.ietf.org/html/rfc3548)
77 |  * [RFC 2045](https://tools.ietf.org/html/rfc2045)
78 |  * [RFC 1421](https://tools.ietf.org/html/rfc1421)
79 |  * [RFC 7515](https://tools.ietf.org/html/rfc7515)
80 | 
81 | ## Contributing
82 | 
83 | All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed.
84 | 
85 | ## License
86 | 
87 | This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).
88 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"name": "delight-im/base64",
 3 | 	"description": "Simple and convenient Base64 encoding and decoding for PHP",
 4 | 	"require": {
 5 | 		"php": ">=5.3.0"
 6 | 	},
 7 | 	"type": "library",
 8 | 	"keywords": [ "base64", "base-64", "encode", "decode", "encoding", "decoding", "url-safe", "url" ],
 9 | 	"homepage": "https://github.com/delight-im/PHP-Base64",
10 | 	"license": "MIT",
11 | 	"autoload": {
12 | 		"psr-4": {
13 | 			"Delight\\Base64\\": "src/"
14 | 		}
15 | 	}
16 | }
17 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
 1 | {
 2 |     "_readme": [
 3 |         "This file locks the dependencies of your project to a known state",
 4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
 5 |         "This file is @generated automatically"
 6 |     ],
 7 |     "content-hash": "d69f90769e62bab4c7f053c4a3030138",
 8 |     "packages": [],
 9 |     "packages-dev": [],
10 |     "aliases": [],
11 |     "minimum-stability": "stable",
12 |     "stability-flags": [],
13 |     "prefer-stable": false,
14 |     "prefer-lowest": false,
15 |     "platform": {
16 |         "php": ">=5.3.0"
17 |     },
18 |     "platform-dev": []
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Base64.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
  5 |  * Copyright (c) delight.im (https://www.delight.im/)
  6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
  7 |  */
  8 | 
  9 | namespace Delight\Base64;
 10 | 
 11 | use Delight\Base64\Throwable\DecodingError;
 12 | use Delight\Base64\Throwable\EncodingError;
 13 | 
 14 | /** Utilities for encoding and decoding data using Base64 and variants thereof */
 15 | final class Base64 {
 16 | 
 17 | 	/**
 18 | 	 * The last three characters from the alphabet of the standard implementation
 19 | 	 *
 20 | 	 * @var string
 21 | 	 */
 22 | 	const LAST_THREE_STANDARD = '+/=';
 23 | 
 24 | 	/**
 25 | 	 * The last three characters from the alphabet of the URL-safe implementation
 26 | 	 *
 27 | 	 * @var string
 28 | 	 */
 29 | 	const LAST_THREE_URL_SAFE = '-_~';
 30 | 
 31 | 	/**
 32 | 	 * Encodes the supplied data to Base64
 33 | 	 *
 34 | 	 * @param mixed $data
 35 | 	 * @return string
 36 | 	 * @throws EncodingError if the input has been invalid
 37 | 	 */
 38 | 	public static function encode($data) {
 39 | 		$encoded = \base64_encode($data);
 40 | 
 41 | 		if ($encoded === false) {
 42 | 			throw new EncodingError();
 43 | 		}
 44 | 
 45 | 		return $encoded;
 46 | 	}
 47 | 
 48 | 	/**
 49 | 	 * Decodes the supplied data from Base64
 50 | 	 *
 51 | 	 * @param string $data
 52 | 	 * @return mixed
 53 | 	 * @throws DecodingError if the input has been invalid
 54 | 	 */
 55 | 	public static function decode($data) {
 56 | 		$decoded = \base64_decode($data, true);
 57 | 
 58 | 		if ($decoded === false) {
 59 | 			throw new DecodingError();
 60 | 		}
 61 | 
 62 | 		return $decoded;
 63 | 	}
 64 | 
 65 | 	/**
 66 | 	 * Encodes the supplied data to a URL-safe variant of Base64
 67 | 	 *
 68 | 	 * @param mixed $data
 69 | 	 * @return string
 70 | 	 * @throws EncodingError if the input has been invalid
 71 | 	 */
 72 | 	public static function encodeUrlSafe($data) {
 73 | 		$encoded = self::encode($data);
 74 | 
 75 | 		return \strtr(
 76 | 			$encoded,
 77 | 			self::LAST_THREE_STANDARD,
 78 | 			self::LAST_THREE_URL_SAFE
 79 | 		);
 80 | 	}
 81 | 
 82 | 	/**
 83 | 	 * Decodes the supplied data from a URL-safe variant of Base64
 84 | 	 *
 85 | 	 * @param string $data
 86 | 	 * @return mixed
 87 | 	 * @throws DecodingError if the input has been invalid
 88 | 	 */
 89 | 	public static function decodeUrlSafe($data) {
 90 | 		$data = \strtr(
 91 | 			$data,
 92 | 			self::LAST_THREE_URL_SAFE,
 93 | 			self::LAST_THREE_STANDARD
 94 | 		);
 95 | 
 96 | 		return self::decode($data);
 97 | 	}
 98 | 
 99 | 	/**
100 | 	 * Encodes the supplied data to a URL-safe variant of Base64 without padding
101 | 	 *
102 | 	 * @param mixed $data
103 | 	 * @return string
104 | 	 * @throws EncodingError if the input has been invalid
105 | 	 */
106 | 	public static function encodeUrlSafeWithoutPadding($data) {
107 | 		$encoded = self::encode($data);
108 | 
109 | 		$encoded = \rtrim(
110 | 			$encoded,
111 | 			\substr(self::LAST_THREE_STANDARD, -1)
112 | 		);
113 | 
114 | 		return \strtr(
115 | 			$encoded,
116 | 			\substr(self::LAST_THREE_STANDARD, 0, -1),
117 | 			\substr(self::LAST_THREE_URL_SAFE, 0, -1)
118 | 		);
119 | 	}
120 | 
121 | 	/**
122 | 	 * Decodes the supplied data from a URL-safe variant of Base64 without padding
123 | 	 *
124 | 	 * @param string $data
125 | 	 * @return mixed
126 | 	 * @throws DecodingError if the input has been invalid
127 | 	 */
128 | 	public static function decodeUrlSafeWithoutPadding($data) {
129 | 		return self::decodeUrlSafe($data);
130 | 	}
131 | 
132 | }
133 | 


--------------------------------------------------------------------------------
/src/Throwable/DecodingError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
 5 |  * Copyright (c) delight.im (https://www.delight.im/)
 6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
 7 |  */
 8 | 
 9 | namespace Delight\Base64\Throwable;
10 | 
11 | /** Error that is thrown when an attempt is being made to decode illegal input */
12 | class DecodingError extends Error {}
13 | 


--------------------------------------------------------------------------------
/src/Throwable/EncodingError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
 5 |  * Copyright (c) delight.im (https://www.delight.im/)
 6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
 7 |  */
 8 | 
 9 | namespace Delight\Base64\Throwable;
10 | 
11 | /** Error that is thrown when an attempt is being made to encode illegal input */
12 | class EncodingError extends Error {}
13 | 


--------------------------------------------------------------------------------
/src/Throwable/Error.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
 5 |  * Copyright (c) delight.im (https://www.delight.im/)
 6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
 7 |  */
 8 | 
 9 | namespace Delight\Base64\Throwable;
10 | 
11 | /** Base class for all (unchecked) errors */
12 | abstract class Error extends \Exception {}
13 | 


--------------------------------------------------------------------------------
/src/Throwable/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
 5 |  * Copyright (c) delight.im (https://www.delight.im/)
 6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
 7 |  */
 8 | 
 9 | namespace Delight\Base64\Throwable;
10 | 
11 | /** Base class for all (checked) exceptions */
12 | abstract class Exception extends \Exception {}
13 | 


--------------------------------------------------------------------------------
/tests/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * PHP-Base64 (https://github.com/delight-im/PHP-Base64)
 5 |  * Copyright (c) delight.im (https://www.delight.im/)
 6 |  * Licensed under the MIT License (https://opensource.org/licenses/MIT)
 7 |  */
 8 | 
 9 | \error_reporting(\E_ALL);
10 | \ini_set('display_errors', 'stdout');
11 | 
12 | \header('Content-Type: text/plain; charset=utf-8');
13 | 
14 | require __DIR__ . '/../vendor/autoload.php';
15 | 
16 | function fail($lineNumber) {
17 | 	exit('Error on line ' . $lineNumber);
18 | }
19 | 
20 | (\Delight\Base64\Base64::encode('Gallia est omnis divisa in partes tres') === 'R2FsbGlhIGVzdCBvbW5pcyBkaXZpc2EgaW4gcGFydGVzIHRyZXM=') or \fail(__LINE__);
21 | (\Delight\Base64\Base64::decode('R2FsbGlhIGVzdCBvbW5pcyBkaXZpc2EgaW4gcGFydGVzIHRyZXM=') === 'Gallia est omnis divisa in partes tres') or \fail(__LINE__);
22 | (\Delight\Base64\Base64::encodeUrlSafe('πάντα χωρεῖ καὶ οὐδὲν μένει …') === 'z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg~~') or \fail(__LINE__);
23 | (\Delight\Base64\Base64::decodeUrlSafe('z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg~~') === 'πάντα χωρεῖ καὶ οὐδὲν μένει …') or \fail(__LINE__);
24 | (\Delight\Base64\Base64::encodeUrlSafeWithoutPadding('πάντα χωρεῖ καὶ οὐδὲν μένει …') === 'z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg') or \fail(__LINE__);
25 | (\Delight\Base64\Base64::decodeUrlSafeWithoutPadding('z4DOrM69z4TOsSDPh8-Jz4HOteG_liDOus6x4b22IM6_4b2QzrThvbLOvSDOvM6tzr3Otc65IOKApg') === 'πάντα χωρεῖ καὶ οὐδὲν μένει …') or \fail(__LINE__);
26 | 
27 | for ($i = 0; $i < 1000; $i++) {
28 | 	$data = \openssl_random_pseudo_bytes(
29 | 		\mt_rand(12, 24)
30 | 	);
31 | 
32 | 	(\Delight\Base64\Base64::decode(\Delight\Base64\Base64::encode($data)) === $data) or \fail(__LINE__);
33 | 	(\Delight\Base64\Base64::decodeUrlSafe(\Delight\Base64\Base64::encodeUrlSafe($data)) === $data) or \fail(__LINE__);
34 | 	(\Delight\Base64\Base64::decodeUrlSafeWithoutPadding(\Delight\Base64\Base64::encodeUrlSafeWithoutPadding($data)) === $data) or \fail(__LINE__);
35 | }
36 | 
37 | echo 'ALL TESTS PASSED' . "\n";
38 | 


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