Init project

Author: Iurii Bogdanov

.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+.idea
+vendor/
+composer.lock
+phpunit.xml
+.phpunit.result.cache
+/.phpunit
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PHP82Migration' => true,
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
+        '@PHPUnit100Migration:risky' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'strict_param' => true,
+    ])
+    ->setFinder(PhpCsFixer\Finder::create()->in(__DIR__))
+    ->setCacheFile('.php-cs-fixer.cache')
+;

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Iurii Bogdanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,116 @@
+# PHP Base64 (encode/decode) Library
+
+[![Latest Stable Version](http://poser.pugx.org/yurijbogdanov/base64/v)](https://packagist.org/packages/yurijbogdanov/base64)
+[![Total Downloads](http://poser.pugx.org/yurijbogdanov/base64/downloads)](https://packagist.org/packages/yurijbogdanov/base64)
+[![License](http://poser.pugx.org/yurijbogdanov/base64/license)](https://packagist.org/packages/yurijbogdanov/base64)
+[![PHP Version Require](http://poser.pugx.org/yurijbogdanov/base64/require/php)](https://packagist.org/packages/yurijbogdanov/base64)
+
+
+## Installation
+```terminal
+composer require yurijbogdanov/base64
+```
+
+
+## Usage
+Encode:
+```terminal
+$content = 'hello WoRld 123 ~~~';
+$encodedContent = Base64::encode($content); // aGVsbG8gV29SbGQgMTIzIH5+fg==
+```
+
+Encode with variant:
+```terminal
+$content = 'hello WoRld 123 ~~~';
+$encodedContent = Base64::encode($content, Base64::BASE64_VARIANT_ORIGINAL); // aGVsbG8gV29SbGQgMTIzIH5+fg==
+$encodedContent = Base64::encode($content, Base64::BASE64_VARIANT_ORIGINAL_NO_PADDING); // aGVsbG8gV29SbGQgMTIzIH5+fg
+$encodedContent = Base64::encode($content, Base64::BASE64_VARIANT_URLSAFE); // aGVsbG8gV29SbGQgMTIzIH5-fg==
+$encodedContent = Base64::encode($content, Base64::BASE64_VARIANT_URLSAFE_NO_PADDING); // aGVsbG8gV29SbGQgMTIzIH5-fg
+```
+
+Encode urlsafe (Syntactic sugar for "Base64::encode($content, Base64::BASE64_VARIANT_URLSAFE_NO_PADDING)"):
+```terminal
+$content = 'hello WoRld 123 ~~~';
+$encodedContent = Base64::encodeUrlsafe($content); // aGVsbG8gV29SbGQgMTIzIH5-fg
+```
+
+Decode:
+```terminal
+$content = 'aGVsbG8gV29SbGQgMTIzIH5+fg==';
+$decodedContent = Base64::decode($content); // hello WoRld 123 ~~~
+```
+
+Decode with variant:
+```terminal
+$decodedContent = Base64::decode("aGVsbG8gV29SbGQgMTIzIH5+fg==", Base64::BASE64_VARIANT_ORIGINAL); // hello WoRld 123 ~~~
+$decodedContent = Base64::decode("aGVsbG8gV29SbGQgMTIzIH5+fg", Base64::BASE64_VARIANT_ORIGINAL_NO_PADDING); // hello WoRld 123 ~~~
+$decodedContent = Base64::decode("aGVsbG8gV29SbGQgMTIzIH5-fg==", Base64::BASE64_VARIANT_URLSAFE); // hello WoRld 123 ~~~
+$decodedContent = Base64::decode("aGVsbG8gV29SbGQgMTIzIH5-fg", Base64::BASE64_VARIANT_URLSAFE_NO_PADDING); // hello WoRld 123 ~~~
+```
+
+Decode urlsafe (Syntactic sugar for "Base64::decode($content, Base64::BASE64_VARIANT_URLSAFE_NO_PADDING)"):
+```terminal
+$content = 'aGVsbG8gV29SbGQgMTIzIH5-fg';
+$decodedContent = Base64::decode($content); // hello WoRld 123 ~~~
+```
+
+
+## Usage via Terminal
+List of commands:
+```terminal
+bin/base64
+```
+
+Encode:
+```terminal
+bin/base64 encode [CONTENT]
+bin/base64 encode "hello WoRld 123 ~~~"
+# Output: aGVsbG8gV29SbGQgMTIzIH5+fg==
+```
+
+Encode with variant:
+```terminal
+bin/base64 encode_with_variant [CONTENT] [VARIANT]
+bin/base64 encode_with_variant "hello WoRld 123 ~~~" 1
+# Output: aGVsbG8gV29SbGQgMTIzIH5+fg==
+bin/base64 encode_with_variant "hello WoRld 123 ~~~" 2
+# Output: aGVsbG8gV29SbGQgMTIzIH5+fg
+bin/base64 encode_with_variant "hello WoRld 123 ~~~" 4
+# Output: aGVsbG8gV29SbGQgMTIzIH5-fg==
+bin/base64 encode_with_variant "hello WoRld 123 ~~~" 8
+# Output: aGVsbG8gV29SbGQgMTIzIH5-fg
+```
+
+Encode urlsafe (Syntactic sugar for "bin/base64 encode_with_variant [CONTENT] 8"):
+```terminal
+bin/base64 encode_urlsafe [CONTENT]
+bin/base64 encode_urlsafe "hello WoRld 123 ~~~"
+# Output: aGVsbG8gV29SbGQgMTIzIH5-fg
+```
+
+Decode:
+```terminal
+bin/base64 decode [CONTENT]
+bin/base64 decode aGVsbG8gV29SbGQgMTIzIH5+fg==
+# Output: hello WoRld 123 ~~~
+```
+
+Decode with variant:
+```terminal
+bin/base64 decode_with_variant [CONTENT] [VARIANT]
+bin/base64 decode_with_variant aGVsbG8gV29SbGQgMTIzIH5+fg== 1
+# Output: hello WoRld 123 ~~~
+bin/base64 decode_with_variant aGVsbG8gV29SbGQgMTIzIH5+fg 2
+# Output: hello WoRld 123 ~~~
+bin/base64 decode_with_variant aGVsbG8gV29SbGQgMTIzIH5-fg== 4
+# Output: hello WoRld 123 ~~~
+bin/base64 decode_with_variant aGVsbG8gV29SbGQgMTIzIH5-fg 8
+# Output: hello WoRld 123 ~~~
+```
+
+Decode urlsafe (Syntactic sugar for "bin/base64 decode_with_variant [CONTENT] 8"):
+```terminal
+bin/base64 decode_urlsafe [CONTENT]
+bin/base64 decode_urlsafe aGVsbG8gV29SbGQgMTIzIH5-fg
+# Output: hello WoRld 123 ~~~
+```

bin/base64

@@ -0,0 +1,47 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+if ('cli' !== \PHP_SAPI) {
+    exit(1);
+}
+
+require dirname(__DIR__).'/vendor/autoload.php';
+
+use YB\Base64\Base64;
+
+$command = (string) ($argv[1] ?? '');
+$content = $argv[2] ?? null;
+$variant = $argv[3] ?? null;
+
+if (null !== $variant) {
+    $variant = (int) $variant;
+}
+
+try {
+    echo match ($command) {
+        '' => <<<'TEXT'
+Available commands:
+    encode [CONTENT]
+    decode [CONTENT]
+    encode_with_variant [CONTENT] [VARIANT]
+    decode_with_variant [CONTENT] [VARIANT]
+    encode_urlsafe [CONTENT]
+    decode_urlsafe [CONTENT]
+TEXT,
+        'encode' => Base64::encode($content),
+        'decode' => Base64::decode($content),
+        'encode_with_variant' => Base64::encode($content, $variant),
+        'decode_with_variant' => Base64::decode($content, $variant),
+        'encode_urlsafe' => Base64::encodeUrlsafe($content),
+        'decode_urlsafe' => Base64::decodeUrlsafe($content),
+        default => sprintf('Command "%s" not found', $command),
+    };
+} catch (\Throwable $e) {
+    echo sprintf('Error occurred: %s', $e->getMessage()), "\n";
+
+    exit(1);
+}
+
+echo "\n";

composer.json

@@ -0,0 +1,45 @@
+{
+    "name": "yurijbogdanov/base64",
+    "type": "library",
+    "description": "PHP Base64 (encode/decode) Library",
+    "keywords": ["php", "base64", "encode", "decode", "url-safe", "urlsafe-base64", "base64-encode", "base64-decode"],
+    "homepage": "https://github.com/yurijbogdanov/base64",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Iurii Bogdanov",
+            "email": "bogdanovyurij@gmail.com"
+        }
+    ],
+    "require": {
+        "php": ">=8.0"
+    },
+    "require-dev": {
+        "roave/security-advisories": "dev-latest",
+        "phpunit/phpunit": "^10",
+        "phpstan/phpstan": "^1",
+        "friendsofphp/php-cs-fixer": "^3"
+    },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "autoload": {
+        "psr-4": {
+            "YB\\Base64\\": "src/"
+        },
+        "exclude-from-classmap": [
+            "/Tests/"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "YB\\Base64\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": [
+            "php vendor/bin/php-cs-fixer fix --dry-run --allow-risky=yes --using-cache=no --diff -vv",
+            "php vendor/bin/phpstan analyse -vv",
+            "php vendor/bin/phpunit --no-coverage"
+        ]
+    }
+}

phpstan.neon.dist

@@ -0,0 +1,6 @@
+parameters:
+    level: max
+    paths: [ src, tests ]
+    excludePaths: [ tests/bootstrap.php ]
+    checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false

phpunit.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php" failOnRisky="true" failOnWarning="true">
+  <php>
+    <ini name="error_reporting" value="-1"/>
+  </php>
+  <testsuites>
+    <testsuite name="Crypto Library Test Suite">
+      <directory>./Tests/</directory>
+    </testsuite>
+  </testsuites>
+  <coverage/>
+  <source>
+    <include>
+      <directory>./</directory>
+    </include>
+    <exclude>
+      <directory>./Tests</directory>
+      <directory>./vendor</directory>
+    </exclude>
+  </source>
+</phpunit>

src/Base64.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace YB\Base64;
+
+final class Base64 implements Base64Interface
+{
+    /**
+     * BASE64_VARIANT_ORIGINAL for standard (A-Za-z0-9/\+) Base64 encoding.
+     * BASE64_VARIANT_ORIGINAL_NO_PADDING for standard (A-Za-z0-9/\+) Base64 encoding, without = padding characters.
+     * BASE64_VARIANT_URLSAFE for URL-safe (A-Za-z0-9\-_) Base64 encoding.
+     * BASE64_VARIANT_URLSAFE_NO_PADDING for URL-safe (A-Za-z0-9\-_) Base64 encoding, without = padding characters.
+     */
+    public const BASE64_VARIANT_ORIGINAL = 1;
+    public const BASE64_VARIANT_ORIGINAL_NO_PADDING = 2;
+    public const BASE64_VARIANT_URLSAFE = 4;
+    public const BASE64_VARIANT_URLSAFE_NO_PADDING = 8;
+    public const BASE64_VARIANTS = [
+        self::BASE64_VARIANT_ORIGINAL,
+        self::BASE64_VARIANT_ORIGINAL_NO_PADDING,
+        self::BASE64_VARIANT_URLSAFE,
+        self::BASE64_VARIANT_URLSAFE_NO_PADDING,
+    ];
+
+    public static function encode(string $content, int $variant = null): string
+    {
+        if (null === $variant) {
+            $variant = self::BASE64_VARIANT_ORIGINAL;
+        }
+
+        if (!\in_array($variant, self::BASE64_VARIANTS, true)) {
+            throw new Exception\UnsupportedVariantException(sprintf('Unsupported variant: %d', $variant));
+        }
+
+        $content = base64_encode($content);
+
+        if ($variant & (self::BASE64_VARIANT_URLSAFE | self::BASE64_VARIANT_URLSAFE_NO_PADDING)) {
+            $content = strtr($content, '+/', '-_');
+        }
+
+        if ($variant & (self::BASE64_VARIANT_ORIGINAL_NO_PADDING | self::BASE64_VARIANT_URLSAFE_NO_PADDING)) {
+            $content = str_replace('=', '', $content);
+        }
+
+        return $content;
+    }
+
+    public static function decode(string $content, int $variant = null): string
+    {
+        if (null === $variant) {
+            $variant = self::BASE64_VARIANT_ORIGINAL;
+        }
+
+        if (!\in_array($variant, self::BASE64_VARIANTS, true)) {
+            throw new Exception\UnsupportedVariantException(sprintf('Unsupported variant: %d', $variant));
+        }
+
+        if ($variant & (self::BASE64_VARIANT_URLSAFE | self::BASE64_VARIANT_URLSAFE_NO_PADDING)) {
+            $content = strtr($content, '-_', '+/');
+        }
+
+        if ($variant & (self::BASE64_VARIANT_ORIGINAL_NO_PADDING | self::BASE64_VARIANT_URLSAFE_NO_PADDING)) {
+            $remainder = \strlen($content) % 4;
+            if ($remainder) {
+                $content .= str_repeat('=', 4 - $remainder);
+            }
+        }
+
+        $content = base64_decode($content, true);
+        if (false === $content) {
+            throw new Exception\DecodeFailedException('Cannot decode content');
+        }
+
+        return $content;
+    }
+
+    public static function encodeUrlsafe(string $content): string
+    {
+        return self::encode($content, self::BASE64_VARIANT_URLSAFE_NO_PADDING);
+    }
+
+    public static function decodeUrlsafe(string $content): string
+    {
+        return self::decode($content, self::BASE64_VARIANT_URLSAFE_NO_PADDING);
+    }
+}