germania-kg/base64-coder

Converts a selector and token pair to base64 forth and back.

1.4.0 2023-01-03 13:08 UTC

Requires

• php: ^7.4|^8.0
• psr/log: ^1.0|^2.0|^3.0

Requires (Dev)

• ircmaxell/random-lib: ^1.0
• monolog/monolog: ^1.0|^2.0|^3.0
• php-coveralls/php-coveralls: ^2.0
• phpspec/prophecy: ^1.16
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^8.0|^9.0
• pimple/pimple: ^3.2

Suggests

• pimple/pimple: This package provides a ServiceProvider for the famous Pimple Dependency Injection Container.

MIT

• Carsten Witt

• base64
• encode
• decode
• RandomLib
• random_compat

README

Converts a selector and token pair to base64 forth and back.

Installation with Composer

$ composer require germania-kg/base64-coder

Usage

Instantiation

<?php
use Germania\Base64Coder\Base64Coder;
use Germania\Base64Coder\Exceptions\EncodingException;
use Germania\Base64Coder\Exceptions\DecodingException;

// Optional:
$logger    = new Monolog;
$separator = "::" // Default;

// Setup
$coder = new Base64Coder( $separator, $logger );
$coder = new Base64Coder( $separator );
$coder = new Base64Coder;

Encoding selector and token

<?php
$selector = "user_john";
$token    = "somerandomvalue";

try {
	$encoded = $coder->encode( $selector, $token);
	// Result is something like
	// "RGllcyBpc3ftvZ::GllcmVuZGVyIFN0cmluZw=="
} 
catch (EncodingException $e) {
	// PHP's base64_encode had returned FALSE
}

Decoding encoded selector and token pair

<?php
$encoded_value = 'RGllcyBpc3ftvZ::GllcmVuZGVyIFN0cmluZw==';

try {
	$decoded = $cookie_coder->decode( $encoded_value );

	// Result object:
	echo $decoded->selector; // "user_john"
	echo $decoded->token;    // "somerandomvalue"
	
catch (DecodingException $e) {
	// PHP's base64_decode had returned FALSE
}

Exceptions

<?php
use Germania\Base64Coder\Exceptions\CoderExceptionInterface;

class EncodingException implements CoderExceptionInterface {}
class DecodingException implements CoderExceptionInterface {}

Pimple Service Provider

<?php
use Germania\Base64Coder\Providers\PimpleServiceProvider;
use Germania\Base64Coder\EncoderCallable;
use Germania\Base64Coder\DecoderCallable;
use Germania\Base64Coder\Base64Coder;
use Psr\Log\LoggerInterface;

// have your Pimple DIC ready, and optionally a PSR3 Logger:
$sp = new PimpleServiceProvider;
$custom_separator = "::";
$sp = new PimpleServiceProvider($separator, $psr3_logger);

$sp->register( $dic );

// Grab your services;
// See also above examaples.
$base64coder = $dic[Base64Coder::class];

$encoder = $dic['Cookie.Encryptor']; // Deprecated
$encoder = $dic[EncoderCallable::class];
$encoded_string = $encoder("selector", "token");

$decoder = $dic['Cookie.Decryptor']; // Deprecated
$decoder = $dic[DecoderCallable::class];
$decoded_obj = $decoder( $encoded_string );

echo $decoded_obj->selector;
echo $decoded_obj->token;

Issues

See issues list.

Development

$ git clone https://github.com/GermaniaKG/Base64Coder.git
$ cd Base64Coder
$ composer install

Unit tests

Either copy phpunit.xml.dist to phpunit.xml and adapt to your needs, or leave as is. Run PhpUnit test or composer scripts like this:

$ composer test
# or
$ vendor/bin/phpunit