Encode a Text value in Base64url with padding.

See: RFC-4648 section 5

Examples:

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

Encode a Text value in Base64url without padding.

See: RFC-4648 section 3.2

Examples:

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

Decode a Base64url encoded Text value, either padded or unpadded. The correct decoding function is dispatched based on the existence of padding.

For typed values: - If a padded value is required, use decodeBase64Padded - If an unpadded value is required, use decodeBase64Unpadded

See: RFC-4648 section 4

Examples:

>>> decodeBase64 $ assertBase64 @'UrlPadded "PDw_Pj4="
"<<?>>"

>>> decodeBase64 $ assertBase64 @'UrlUnpadded "PDw_Pj4"
"<<?>>"

Decode an untyped Base64url encoded Text 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-encoded values are optionally padded.

For a decoder that fails to decode untyped values of incorrect size: - If a padded value is required, use decodeBase64PaddedUntyped - If an unpadded value is required, use decodeBase64UnpaddedUntyped

See: RFC-4648 section 4

Examples:

>>> decodeBase64Untyped "PDw_Pj4="
Right "<<?>>"

>>> decodeBase64Untyped "PDw_Pj4"
Right "<<?>>"

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

>>> decodeBase64Untyped "PDw-Pg"
Right "<<>>"

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

See: RFC-4648 section 4

Examples:

decodeBase64UntypedWith decodeUtf8'
  :: Text -> Either (Base64Error UnicodeException) Text

Decode an unpadded Base64url encoded Text value.

See: RFC-4648 section 4

Examples:

>>> decodeBase64Unpadded $ assertBase64 @'UrlUnpadded "PDw_Pj4"
"<<?>>"

Decode a unpadded, untyped Base64url-encoded Text 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 decodeBase64PaddedUntyped

See: RFC-4648 section 4

Examples:

>>> decodeBase64UnpaddedUntyped "PDw_Pj4"
Right "<<?>>"

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

>>> decodeBase64UnpaddedUntyped "PDw-Pg"
Right "<<>>"

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

See: RFC-4648 section 4

Example:

decodeBase64UnpaddedUntypedWith decodeUtf8'
  :: ByteString -> Either (Base64Error UnicodeException) Text

Decode a padded Base64url encoded Text value

See: RFC-4648 section 4

Examples:

>>> decodeBase64Padded $ assertBase64 @'UrlPadded "PDw_Pj4="
"<<?>>"

Decode an untyped, padded Base64url encoded Text value

For a decoder that fails on padded input, use decodeBase64UnpaddedUntyped

See: RFC-4648 section 4

Examples:

>>> decodeBase64PaddedUntyped "PDw_Pj4="
Right "<<?>>"

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

See: RFC-4648 section 4

Example:

decodeBase64PaddedWith decodeUtf8'
  :: ByteString -> Either (Base64Error UnicodeException) Text

Leniently decode an untyped Base64url-encoded Text. 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"
"<<?>>"

Parse a canonical, padded Base64url-encoded Text value.

Checks the URL-safe alphabet, length, padding, and unused padding bits. Returns the original encoded value wrapped in Base64, ready for decodeBase64Padded or decodeBase64. Errors match the strict ByteString decodeBase64PaddedUntyped decoder. The input is neither decoded nor normalized in the returned value.

This validates the Base64url encoding, independently of whether the decoded payload is valid UTF-8.

Examples:

>>> parseBase64Padded "PDw_Pj4="
Right "PDw_Pj4="

>>> fmap decodeBase64Padded (parseBase64Padded "PDw_Pj4=")
Right "<<?>>"

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

>>> parseBase64Padded "ZE=="
Left "non-canonical encoding detected at offset: 1"

Since: 2.1

Parse a canonical, unpadded Base64url-encoded Text value.

Checks the URL-safe alphabet, length, padding, and unused padding bits. Returns the original encoded value wrapped in Base64, ready for decodeBase64Unpadded or decodeBase64. Errors match the strict ByteString decodeBase64UnpaddedUntyped decoder. The input is neither decoded nor normalized in the returned value.

This validates the Base64url encoding, independently of whether the decoded payload is valid UTF-8.

Examples:

>>> parseBase64Unpadded "PDw_Pj4"
Right "PDw_Pj4"

>>> fmap decodeBase64Unpadded (parseBase64Unpadded "PDw_Pj4")
Right "<<?>>"

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

>>> parseBase64Unpadded "ZE"
Left "non-canonical encoding detected at offset: 1"

Since: 2.1