base64-0.1.0.0: RFC 4648-compliant padded and unpadded base64 and base64url encodings

Copyright(c) 2019 Emily Pillmore
LicenseBSD-style
MaintainerEmily Pillmore <emilypi@cohomolo.gy>
StabilityExperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Data.ByteString.Base64.URL

Description

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

Synopsis

Documentation

encodeBase64 :: ByteString -> ByteString Source #

Encode a ByteString in base64-url with padding.

See: RFC-4648 section 5

decodeBase64 :: ByteString -> Either Text ByteString Source #

Decode a padded base64-url encoded ByteString

See: RFC-4648 section 4

encodeBase64Unpadded :: ByteString -> ByteString Source #

Encode a ByteString in base64-url without padding.

Note: in some circumstances, the use of padding ("=") in base-encoded data is not required or used. If you are absolutely sure the length of your input data is divisible by 3, this function will be the same as encodeBase64 with padding. However, if not, you may see garbage appended to output in the form of "NUL".

Only call unpadded variants when you can make assumptions about the length of your input data.

See: RFC-4648 section 3.2