Data.ByteString.Short.Base64.URL

This module contains the combinators implementing the RFC 4648 specification for the Base64url encoding including unpadded and lenient variants

Documentation

encodeBase64 :: ShortByteString -> ShortText

Encode a ShortByteString value as a Base64url Text value with padding.

See: RFC-4648 section 5

encodeBase64Unpadded :: ShortByteString -> ShortText

Encode a ShortByteString value as Base64url Text 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

encodeBase64' :: ShortByteString -> ShortByteString

Encode a ShortByteString as a Base64url ShortByteString value with padding.

See: RFC-4648 section 5

encodeBase64Unpadded' :: ShortByteString -> ShortByteString

Encode a ShortByteString value as 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

decodeBase64 :: ShortByteString -> Either Text ShortByteString

Decode a padded Base64url encoded ShortByteString 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 on unpadded input of incorrect size, use decodeBase64Unpadded.

See: RFC-4648 section 4

decodeBase64Padded :: ShortByteString -> Either Text ShortByteString

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

In general, unless padded Base64url is explicitly required, it is safer to call decodeBase64.

See: RFC-4648 section 4

decodeBase64Unpadded :: ShortByteString -> Either Text ShortByteString

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

In general, unless unpadded Base64url is explicitly required, it is safer to call decodeBase64.

See: RFC-4648 section 4

decodeBase64Lenient :: ShortByteString -> ShortByteString

Leniently decode an unpadded Base64url-encoded ShortByteString. 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.

isBase64Url :: ShortByteString -> Bool

Tell whether a ShortByteString is Base64url-encoded.

isValidBase64Url :: ShortByteString -> Bool

Tell whether a ShortByteString 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 ShortByteString value, use isBase64Url.