293 lines
9.7 KiB
PHP
293 lines
9.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the Sonata Project package.
|
|
*
|
|
* (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Sonata\GoogleAuthenticator;
|
|
|
|
/**
|
|
* FixedBitNotation.
|
|
*
|
|
* The FixedBitNotation class is for binary to text conversion. It
|
|
* can handle many encoding schemes, formally defined or not, that
|
|
* use a fixed number of bits to encode each character.
|
|
*
|
|
* @author Andre DeMarre
|
|
*/
|
|
final class FixedBitNotation
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $chars;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $bitsPerCharacter;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $radix;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $rightPadFinalBits;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $padFinalGroup;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $padCharacter;
|
|
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private $charmap;
|
|
|
|
/**
|
|
* @param int $bitsPerCharacter Bits to use for each encoded character
|
|
* @param string $chars Base character alphabet
|
|
* @param bool $rightPadFinalBits How to encode last character
|
|
* @param bool $padFinalGroup Add padding to end of encoded output
|
|
* @param string $padCharacter Character to use for padding
|
|
*/
|
|
public function __construct(int $bitsPerCharacter, ?string $chars = null, bool $rightPadFinalBits = false, bool $padFinalGroup = false, string $padCharacter = '=')
|
|
{
|
|
// Ensure validity of $chars
|
|
if (!\is_string($chars) || ($charLength = \strlen($chars)) < 2) {
|
|
$chars =
|
|
'0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-,';
|
|
$charLength = 64;
|
|
}
|
|
|
|
// Ensure validity of $bitsPerCharacter
|
|
if ($bitsPerCharacter < 1) {
|
|
// $bitsPerCharacter must be at least 1
|
|
$bitsPerCharacter = 1;
|
|
$radix = 2;
|
|
} elseif ($charLength < 1 << $bitsPerCharacter) {
|
|
// Character length of $chars is too small for $bitsPerCharacter
|
|
// Set $bitsPerCharacter to greatest acceptable value
|
|
$bitsPerCharacter = 1;
|
|
$radix = 2;
|
|
|
|
while ($charLength >= ($radix <<= 1) && $bitsPerCharacter < 8) {
|
|
++$bitsPerCharacter;
|
|
}
|
|
|
|
$radix >>= 1;
|
|
} elseif ($bitsPerCharacter > 8) {
|
|
// $bitsPerCharacter must not be greater than 8
|
|
$bitsPerCharacter = 8;
|
|
$radix = 256;
|
|
} else {
|
|
$radix = 1 << $bitsPerCharacter;
|
|
}
|
|
|
|
$this->chars = $chars;
|
|
$this->bitsPerCharacter = $bitsPerCharacter;
|
|
$this->radix = $radix;
|
|
$this->rightPadFinalBits = $rightPadFinalBits;
|
|
$this->padFinalGroup = $padFinalGroup;
|
|
$this->padCharacter = $padCharacter[0];
|
|
}
|
|
|
|
/**
|
|
* Encode a string.
|
|
*
|
|
* @param string $rawString Binary data to encode
|
|
*/
|
|
public function encode($rawString): string
|
|
{
|
|
// Unpack string into an array of bytes
|
|
$bytes = unpack('C*', $rawString);
|
|
$byteCount = \count($bytes);
|
|
|
|
$encodedString = '';
|
|
$byte = array_shift($bytes);
|
|
$bitsRead = 0;
|
|
|
|
$chars = $this->chars;
|
|
$bitsPerCharacter = $this->bitsPerCharacter;
|
|
$rightPadFinalBits = $this->rightPadFinalBits;
|
|
$padFinalGroup = $this->padFinalGroup;
|
|
$padCharacter = $this->padCharacter;
|
|
|
|
// Generate encoded output;
|
|
// each loop produces one encoded character
|
|
for ($c = 0; $c < $byteCount * 8 / $bitsPerCharacter; ++$c) {
|
|
// Get the bits needed for this encoded character
|
|
if ($bitsRead + $bitsPerCharacter > 8) {
|
|
// Not enough bits remain in this byte for the current
|
|
// character
|
|
// Save the remaining bits before getting the next byte
|
|
$oldBitCount = 8 - $bitsRead;
|
|
$oldBits = $byte ^ ($byte >> $oldBitCount << $oldBitCount);
|
|
$newBitCount = $bitsPerCharacter - $oldBitCount;
|
|
|
|
if (!$bytes) {
|
|
// Last bits; match final character and exit loop
|
|
if ($rightPadFinalBits) {
|
|
$oldBits <<= $newBitCount;
|
|
}
|
|
$encodedString .= $chars[$oldBits];
|
|
|
|
if ($padFinalGroup) {
|
|
// Array of the lowest common multiples of
|
|
// $bitsPerCharacter and 8, divided by 8
|
|
$lcmMap = [1 => 1, 2 => 1, 3 => 3, 4 => 1, 5 => 5, 6 => 3, 7 => 7, 8 => 1];
|
|
$bytesPerGroup = $lcmMap[$bitsPerCharacter];
|
|
$pads = (int) ($bytesPerGroup * 8 / $bitsPerCharacter
|
|
- ceil((\strlen($rawString) % $bytesPerGroup)
|
|
* 8 / $bitsPerCharacter));
|
|
$encodedString .= str_repeat($padCharacter[0], $pads);
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
// Get next byte
|
|
$byte = array_shift($bytes);
|
|
$bitsRead = 0;
|
|
} else {
|
|
$oldBitCount = 0;
|
|
$newBitCount = $bitsPerCharacter;
|
|
}
|
|
|
|
// Read only the needed bits from this byte
|
|
$bits = $byte >> 8 - ($bitsRead + $newBitCount);
|
|
$bits ^= $bits >> $newBitCount << $newBitCount;
|
|
$bitsRead += $newBitCount;
|
|
|
|
if ($oldBitCount) {
|
|
// Bits come from seperate bytes, add $oldBits to $bits
|
|
$bits = ($oldBits << $newBitCount) | $bits;
|
|
}
|
|
|
|
$encodedString .= $chars[$bits];
|
|
}
|
|
|
|
return $encodedString;
|
|
}
|
|
|
|
/**
|
|
* Decode a string.
|
|
*
|
|
* @param string $encodedString Data to decode
|
|
* @param bool $caseSensitive
|
|
* @param bool $strict Returns null if $encodedString contains
|
|
* an undecodable character
|
|
*/
|
|
public function decode($encodedString, $caseSensitive = true, $strict = false): string
|
|
{
|
|
if (!$encodedString || !\is_string($encodedString)) {
|
|
// Empty string, nothing to decode
|
|
return '';
|
|
}
|
|
|
|
$chars = $this->chars;
|
|
$bitsPerCharacter = $this->bitsPerCharacter;
|
|
$radix = $this->radix;
|
|
$rightPadFinalBits = $this->rightPadFinalBits;
|
|
$padCharacter = $this->padCharacter;
|
|
|
|
// Get index of encoded characters
|
|
if ($this->charmap) {
|
|
$charmap = $this->charmap;
|
|
} else {
|
|
$charmap = [];
|
|
|
|
for ($i = 0; $i < $radix; ++$i) {
|
|
$charmap[$chars[$i]] = $i;
|
|
}
|
|
|
|
$this->charmap = $charmap;
|
|
}
|
|
|
|
// The last encoded character is $encodedString[$lastNotatedIndex]
|
|
$lastNotatedIndex = \strlen($encodedString) - 1;
|
|
|
|
// Remove trailing padding characters
|
|
while ($encodedString[$lastNotatedIndex] === $padCharacter[0]) {
|
|
$encodedString = substr($encodedString, 0, $lastNotatedIndex);
|
|
--$lastNotatedIndex;
|
|
}
|
|
|
|
$rawString = '';
|
|
$byte = 0;
|
|
$bitsWritten = 0;
|
|
|
|
// Convert each encoded character to a series of unencoded bits
|
|
for ($c = 0; $c <= $lastNotatedIndex; ++$c) {
|
|
if (!isset($charmap[$encodedString[$c]]) && !$caseSensitive) {
|
|
// Encoded character was not found; try other case
|
|
if (isset($charmap[$cUpper = strtoupper($encodedString[$c])])) {
|
|
$charmap[$encodedString[$c]] = $charmap[$cUpper];
|
|
} elseif (isset($charmap[$cLower = strtolower($encodedString[$c])])) {
|
|
$charmap[$encodedString[$c]] = $charmap[$cLower];
|
|
}
|
|
}
|
|
|
|
if (isset($charmap[$encodedString[$c]])) {
|
|
$bitsNeeded = 8 - $bitsWritten;
|
|
$unusedBitCount = $bitsPerCharacter - $bitsNeeded;
|
|
|
|
// Get the new bits ready
|
|
if ($bitsNeeded > $bitsPerCharacter) {
|
|
// New bits aren't enough to complete a byte; shift them
|
|
// left into position
|
|
$newBits = $charmap[$encodedString[$c]] << $bitsNeeded
|
|
- $bitsPerCharacter;
|
|
$bitsWritten += $bitsPerCharacter;
|
|
} elseif ($c !== $lastNotatedIndex || $rightPadFinalBits) {
|
|
// Zero or more too many bits to complete a byte;
|
|
// shift right
|
|
$newBits = $charmap[$encodedString[$c]] >> $unusedBitCount;
|
|
$bitsWritten = 8; //$bitsWritten += $bitsNeeded;
|
|
} else {
|
|
// Final bits don't need to be shifted
|
|
$newBits = $charmap[$encodedString[$c]];
|
|
$bitsWritten = 8;
|
|
}
|
|
|
|
$byte |= $newBits;
|
|
|
|
if (8 === $bitsWritten || $c === $lastNotatedIndex) {
|
|
// Byte is ready to be written
|
|
$rawString .= pack('C', $byte);
|
|
|
|
if ($c !== $lastNotatedIndex) {
|
|
// Start the next byte
|
|
$bitsWritten = $unusedBitCount;
|
|
$byte = ($charmap[$encodedString[$c]]
|
|
^ ($newBits << $unusedBitCount)) << 8 - $bitsWritten;
|
|
}
|
|
}
|
|
} elseif ($strict) {
|
|
// Unable to decode character; abort
|
|
return null;
|
|
}
|
|
}
|
|
|
|
return $rawString;
|
|
}
|
|
}
|
|
|
|
// NEXT_MAJOR: Remove class alias
|
|
class_alias('Sonata\GoogleAuthenticator\FixedBitNotation', 'Google\Authenticator\FixedBitNotation', false);
|