Base32 Class Reference

Class Base32 [A-Z][2-7]. More...

Inheritance diagram for Base32:

Static Public Member Functions
static	decode (#[\SensitiveParameter] string $encodedString, bool $strictPadding=false)
	Decode a Base32-encoded string into raw binary.
static	decode (string $encodedString, bool $strictPadding=false)
	Convert a binary string into a hexadecimal string without cache-timing leaks.
static	decodeNoPadding (#[\SensitiveParameter] string $encodedString, bool $upper=false)
static	decodeUpper (#[\SensitiveParameter] string $src, bool $strictPadding=false)
	Decode an uppercase Base32-encoded string into raw binary.
static	encode (#[\SensitiveParameter] string $binString)
	Encode into Base32 (RFC 4648)
static	encode (string $binString)
	Convert a binary string into a hexadecimal string without cache-timing leaks.
static	encodeUnpadded (#[\SensitiveParameter] string $src)
	Encode into Base32 (RFC 4648)
static	encodeUpper (#[\SensitiveParameter] string $src)
	Encode into uppercase Base32 (RFC 4648)
static	encodeUpperUnpadded (#[\SensitiveParameter] string $src)
	Encode into uppercase Base32 (RFC 4648)

Static Protected Member Functions
static	decode5Bits (int $src)
	Uses bitwise operators instead of table-lookups to turn 5-bit integers into 8-bit integers.
static	decode5BitsUpper (int $src)
	Uses bitwise operators instead of table-lookups to turn 5-bit integers into 8-bit integers.
static	doDecode (#[\SensitiveParameter] string $src, bool $upper=false, bool $strictPadding=false)
	Base32 decoding.
static	doEncode (#[\SensitiveParameter] string $src, bool $upper=false, $pad=true)
	Base32 Encoding.
static	encode5Bits (int $src)
	Uses bitwise operators instead of table-lookups to turn 8-bit integers into 5-bit integers.
static	encode5BitsUpper (int $src)
	Uses bitwise operators instead of table-lookups to turn 8-bit integers into 5-bit integers.

Detailed Description

Class Base32 [A-Z][2-7].

Member Function Documentation

decode() [1/2]

static Base32::decode ( # string $encodedString[\SensitiveParameter], bool $strictPadding = false )

static

Decode a Base32-encoded string into raw binary.

Parameters

string	$encodedString
bool	$strictPadding

Return values

string

decode() [2/2]

static EncoderInterface::decode ( string $encodedString, bool $strictPadding = false )

staticinherited

Convert a binary string into a hexadecimal string without cache-timing leaks.

Parameters

string	$encodedString
bool	$strictPadding	Error on invalid padding

Return values

string

(raw binary)

decode5Bits()

static Base32::decode5Bits ( int $src )

staticprotected

Uses bitwise operators instead of table-lookups to turn 5-bit integers into 8-bit integers.

Parameters

int

$src

Return values

int

decode5BitsUpper()

static Base32::decode5BitsUpper ( int $src )

staticprotected

Uses bitwise operators instead of table-lookups to turn 5-bit integers into 8-bit integers.

Uppercase variant.

Parameters

int

$src

Return values

int

decodeNoPadding()

static Base32::decodeNoPadding ( # string $encodedString[\SensitiveParameter], bool $upper = false )

static

Parameters

string	$encodedString
bool	$upper

Return values

string

decodeUpper()

static Base32::decodeUpper ( # string $src[\SensitiveParameter], bool $strictPadding = false )

static

Decode an uppercase Base32-encoded string into raw binary.

Parameters

string	$src
bool	$strictPadding

Return values

string

doDecode()

static Base32::doDecode ( # string $src[\SensitiveParameter], bool $upper = false, bool $strictPadding = false )

staticprotected

Base32 decoding.

Parameters

string	$src
bool	$upper
bool	$strictPadding

Return values

string

Exceptions

TypeError

doEncode()

static Base32::doEncode ( # string $src[\SensitiveParameter], bool $upper = false, $pad = true )

staticprotected

Base32 Encoding.

Parameters

string	$src
bool	$upper
bool	$pad

Return values

string

Exceptions

TypeError

encode() [1/2]

static Base32::encode ( # string $binString[\SensitiveParameter] )

static

Encode into Base32 (RFC 4648)

Parameters

string

$binString

Return values

string

Exceptions

TypeError

encode() [2/2]

static EncoderInterface::encode ( string $binString )

staticinherited

Convert a binary string into a hexadecimal string without cache-timing leaks.

Parameters

string

$binString

(raw binary)

Return values

string

encode5Bits()

static Base32::encode5Bits ( int $src )

staticprotected

Uses bitwise operators instead of table-lookups to turn 8-bit integers into 5-bit integers.

Parameters

int

$src

Return values

string

encode5BitsUpper()

static Base32::encode5BitsUpper ( int $src )

staticprotected

Uses bitwise operators instead of table-lookups to turn 8-bit integers into 5-bit integers.

Uppercase variant.

Parameters

int

$src

Return values

string

encodeUnpadded()

static Base32::encodeUnpadded ( # string $src[\SensitiveParameter] )

static

Encode into Base32 (RFC 4648)

Parameters

string

$src

Return values

string

Exceptions

TypeError

encodeUpper()

static Base32::encodeUpper ( # string $src[\SensitiveParameter] )

static

Encode into uppercase Base32 (RFC 4648)

Parameters

string

$src

Return values

string

Exceptions

TypeError

encodeUpperUnpadded()

static Base32::encodeUpperUnpadded ( # string $src[\SensitiveParameter] )

static

Encode into uppercase Base32 (RFC 4648)

Parameters

string

$src

Return values

string

Exceptions

TypeError

---

The documentation for this class was generated from the following file:

• admin/tool/mfa/factor/totp/extlib/ParagonIE/ConstantTime/Base32.php