Data.Text.Encoding.Base64.URL

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

Documentation

encodeBase64 :: Text -> Text

Encode a Text value in Base64url with padding.

See: RFC-4648 section 5

decodeBase64 :: Text -> Either Text Text

Decode a padded 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 of incorrect size, use decodeBase64Unpadded.

See: RFC-4648 section 4

encodeBase64Unpadded :: Text -> Text

Encode a Text 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

decodeBase64Unpadded :: Text -> Either Text Text

Decode an unpadded Base64url encoded Text value

See: RFC-4648 section 4

decodeBase64Lenient :: Text -> Text

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

isBase64Url :: Text -> Bool

Tell whether a Text value is Base64url-encoded.

isValidBase64Url :: Text -> Bool

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