Data.ByteString.Lazy.Base32.Hex

This module contains ByteString-valued combinators for implementing the RFC 4648 specification of the Base32hex encoding format. This includes strictly padded/unpadded decoding variants, as well as internal and external validation for canonicity.

Encoding

encodeBase32 :: ByteString -> Text

Encode a ByteString value as a Base32hex Text value with padding.

See: RFC-4648 section 7

Examples:

>>> encodeBase32 "Sun"
"ADQMS==="

encodeBase32' :: ByteString -> ByteString

Encode a ByteString as a Base32hex ByteString value with padding.

See: RFC-4648 section 7

Examples:

>>> encodeBase32' "Sun"
"ADQMS==="

encodeBase32Unpadded :: ByteString -> Text

Encode a ByteString value as Base32hex Text without padding. Note that for Base32hex, padding is optional. If you call this function, you will simply be encoding as Base32hex and stripping padding chars from the output.

See: RFC-4648 section 7

Examples:

>>> encodeBase32Unpadded "Sun"
"ADQMS"

encodeBase32Unpadded' :: ByteString -> ByteString

Encode a ByteString value as Base32hex without padding. Note that for Base32hex, padding is optional. If you call this function, you will simply be encoding as Base32hex and stripping padding chars from the output.

See: RFC-4648 section 7

Examples:

>>> encodeBase32Unpadded' "Sun"
"ADQMS"

Decoding

decodeBase32 :: ByteString -> Either Text ByteString

Decode an arbitrarily padded Base32hex encoded ByteString value. If its length is not a multiple of 4, then padding chars will be added to fill out the input to a multiple of 4 for safe decoding as Base32hex-encoded values are optionally padded.

See: RFC-4648 section 7

Examples:

>>> decodeBase32 "ADQMS==="
Right "Sun"

>>> decodeBase32 "ADQMS"
Right "Sun"

>>> decodeBase32 "ADQMS==="
Left "Base32-encoded bytestring has invalid padding"

decodeBase32Unpadded :: ByteString -> Either Text ByteString

Decode an unpadded Base32hex-encoded ByteString value. Input strings are required to be unpadded, and will undergo validation prior to decoding to confirm.

In general, unless unpadded Base32hex is explicitly required, it is safer to call decodeBase32.

See: RFC-4648 section 7

Examples:

>>> decodeBase32Unpadded "ADQMS"
Right "Sun"

>>> decodeBase32Unpadded "ADQMS==="
Left "Base32-encoded bytestring has invalid padding"

decodeBase32Padded :: ByteString -> Either Text ByteString

Decode a padded Base32hex-encoded ByteString value. Input strings are required to be correctly padded, and will be validated prior to decoding to confirm.

In general, unless padded Base32hex is explicitly required, it is safer to call decodeBase32.

See: RFC-4648 section 7

Examples:

>>> decodeBase32Padded "ADQMS==="
Right "Sun"

>>> decodeBase32Padded "ADQMS"
Left "Base32-encoded bytestring requires padding"

Validation

isBase32Hex :: ByteString -> Bool

Tell whether a ByteString is Base32hex-encoded.

Examples:

>>> isBase32Hex "ADQMS"
True

>>> isBase32Hex "ADQMS==="
True

>>> isBase32Hex "ADQMS=="
False

isValidBase32Hex :: ByteString -> Bool

Tell whether a ByteString is a valid Base32hex format.

This will not tell you whether or not this is a correct Base32hex representation, only that it conforms to the correct shape. To check whether it is a true Base32hex encoded ByteString value, use isBase32Hex.

Examples:

>>> isValidBase32Hex "ADQMS"
True

>>> isValidBase32Hex "ADQMS="
False

>>> isValidBase32Hex "ADQMS%"
False