Data.Text.Short.Encoding.Base64.URL

This module contains ShortText-valued combinators implementing the RFC 4648 specification for the Base64url encoding format. This includes strictly padded/unpadded and lenient decoding variants, and external + internal validations for canonicity.

Encoding

encodeBase64 :: ShortText -> ShortText

Encode a ShortText value in Base64url with padding.

See: RFC-4648 section 5

Examples:

>>> encodeBase64 "<<?>>"
"PDw_Pj4="

encodeBase64Unpadded :: ShortText -> ShortText

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

See: RFC-4648 section 3.2

Examples:

>>> encodeBase64Unpadded "<<?>>"
"PDw_Pj4"

Decoding

decodeBase64 :: ShortText -> Either Text ShortText

Decode a padded Base64url-encoded ShortText 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 base64url encodings are optionally padded.

For a decoder that fails on unpadded input, use decodeBase64Unpadded.

Note: This function makes sure that decoding is total by deferring to decodeLatin1. This will always round trip for any valid Base64-encoded text value, but it may not round trip for bad inputs. The onus is on the caller to make sure inputs are valid. If unsure, defer to decodeBase64With and pass in a custom decode function.

See: RFC-4648 section 4

Examples:

>>> decodeBase64 "PDw_Pj4="
Right "<<?>>"

>>> decodeBase64 "PDw_Pj4"
Right "<<?>>"

>>> decodeBase64 "PDw-Pg="
Left "Base64-encoded bytestring has invalid padding"

>>> decodeBase64 "PDw-Pg"
Right "<<>>"

decodeBase64With

Arguments

:: (ShortByteString -> Either err ShortText)

convert a bytestring to text (e.g. decodeUtf8')

-> ShortByteString

Input text to decode

-> Either (Base64Error err) ShortText

Attempt to decode a ShortByteString value as Base64url, converting from ByteString to ShortText according to some encoding function. In practice, This is something like decodeUtf8', which may produce an error.

See: RFC-4648 section 4

Examples:

decodeBase64With decodeUtf8'
  :: ShortByteString -> Either (Base64Error UnicodeException) ShortText

decodeBase64Unpadded :: ShortText -> Either Text ShortText

Decode an unpadded Base64url encoded ShortText value.

Note: This function makes sure that decoding is total by deferring to decodeLatin1. This will always round trip for any valid Base64-encoded text value, but it may not round trip for bad inputs. The onus is on the caller to make sure inputs are valid. If unsure, defer to decodeBase64UnpaddedWith and pass in a custom decode function.

See: RFC-4648 section 4

Examples:

>>> decodeBase64Unpadded "PDw_Pj4"
Right "<<?>>"

>>> decodeBase64Unpadded "PDw_Pj4="
Left "Base64-encoded bytestring has invalid padding"

decodeBase64UnpaddedWith

Arguments

:: (ShortByteString -> Either err ShortText)

convert a bytestring to text (e.g. decodeUtf8')

-> ShortByteString

Input text to decode

-> Either (Base64Error err) ShortText

Attempt to decode an unpadded ShortByteString value as Base64url, converting from ShortByteString to ShortText according to some encoding function. In practice, This is something like decodeUtf8', which may produce an error.

See: RFC-4648 section 4

Examples:

decodeBase64UnpaddedWith decodeUtf8'
  :: ShortByteString -> Either (Base64Error UnicodeException) ShortText

decodeBase64Padded :: ShortText -> Either Text ShortText

Decode an padded Base64url encoded ShortText value

Note: This function makes sure that decoding is total by deferring to decodeLatin1. This will always round trip for any valid Base64-encoded text value, but it may not round trip for bad inputs. The onus is on the caller to make sure inputs are valid. If unsure, defer to decodeBase64PaddedWith and pass in a custom decode function.

See: RFC-4648 section 4

Examples:

>>> decodeBase64Padded "PDw_Pj4="
Right "<<?>>"

>>> decodeBase64Padded "PDw_Pj4"
Left "Base64-encoded bytestring requires padding"

decodeBase64PaddedWith

Arguments

:: (ShortByteString -> Either err ShortText)

convert a bytestring to text (e.g. decodeUtf8')

-> ShortByteString

Input text to decode

-> Either (Base64Error err) ShortText

Attempt to decode a padded ShortByteString value as Base64url, converting from ByteString to ShortText according to some encoding function. In practice, This is something like decodeUtf8', which may produce an error.

See: RFC-4648 section 4

Examples:

decodeBase64With decodeUtf8'
  :: ShortByteString -> Either (Base64Error UnicodeException) ShortText

decodeBase64Lenient :: ShortText -> ShortText

Leniently decode an unpadded Base64url-encoded ShortText. This function will not generate parse errors. If input data contains padding chars, then the input will be parsed up until the first pad character.

Note: This is not RFC 4648-compliant.

Examples:

>>> decodeBase64Lenient "PDw_Pj4="
"<<?>>"

>>> decodeBase64Lenient "PDw_%%%$}Pj4"
"<<?>>"

Validation

isBase64Url :: ShortText -> Bool

Tell whether a ShortText value is Base64url-encoded.

Examples:

>>> isBase64Url "PDw_Pj4="
True

>>> isBase64Url "PDw_Pj4"
True

>>> isBase64Url "PDw_Pj"
False

isValidBase64Url :: ShortText -> Bool

Tell whether a ShortText value is a valid Base64url format.

This will not tell you whether or not this is a correct Base64url representation, only that it conforms to the correct shape. To check whether it is a true Base64 encoded ShortText value, use isBase64Url.

Examples:

>>> isValidBase64Url "PDw_Pj4="
True

>>> isValidBase64Url "PDw_Pj"
True

>>> isValidBase64Url "%"
False