base64

A modern Base64 library

https://github.com/emilypi/base64

LTS Haskell 22.42:0.4.2.4@rev:4
Stackage Nightly 2024-11-21:1.0@rev:1
Latest on Hackage:1.0@rev:1

See all snapshots base64 appears in

BSD-3-Clause licensed by Emily Pillmore
Maintained by Emily Pillmore, Sofia-m-a <https://github.com/sofia-m-a>
This version can be pinned in stack with:base64-1.0@sha256:ab8084608505f30d6cf7dd790271f927fd8a00956c5e7f5546f5cf56b298022c,2991

Module documentation for 1.0

Used by 5 packages in nightly-2024-11-21(full list with versions):
gemini-exports, hledger-web, hoauth2, mailtrap, password

Base64

Build Status Hackage

Base64 encoding and decodings.

For the companion optics and pattern synonyms, see base64-lens.

Summary

The following types are supported for both std, padded url-safe, and unpadded url-safe alphabets:

  • Data.ByteString
  • Data.ByteString.Lazy
  • Data.ByteString.Short
  • Data.Text
  • Data.Text.Lazy
  • Data.Text.Short

Additionally this library has

  • Better performance than base64-bytestring for encode and decode.
  • Optics for handling more complex structures with Base64 representations via the base64-lens package
  • Checks for both validity and correctness of Base64 and Base64url encodings
  • Rejects non-canonical encodings that do not roundtrip in other base64 libraries like ZE==.

There are no dependencies aside from those bundled with GHC, text-short, and the ghc-byteorder re-export.

Changes

Revision history for base64

1.0.0.0

New epoch time! lots of changes to the API. Please see MIGRATION.md for more info:

  • Add support for GHC 9.x
  • Bumped bounds to more modern dependency set
  • Introduced Base64 newtype, located in Data.Base64.Types, as well as ADT for associated alphabets.
  • Signature for encodeBase64 has changed so that it produces a Base64 wrapped value.
  • decodeBase64 and its URLsafe variants now consume a value of type Base64 and produces a decoded value of the underlying type.
  • The old decodeBase64 and its URLsafe variants is now renamed to decodeBase64Untyped*.
  • Fix for 32-bit systems in which memory barriers were not respected in the encoe loop (see: #56)
  • Optimize encode and decode loops to achieve significant speedup across the board.

Thanks to everyone who contributed (especially @sofia-m-a!).

0.4.2.4

0.4.2.3

  • Tighter length calculations in unpadded base64url #35

0.4.2.2

  • Add NFData, Exception, and Generic instances for Base64Error + @since annotations for new instances. (#28)
  • Doc improvements and add -XTrustworty and -XSafe annotations where needed. (#27)
  • Improve URL canonicity validation and correctness checking (now supports correct checking for unpadded Base64url) (#26)
  • Fixed perf regressions in decode
  • Test coverage is at 98%

0.4.2.1

  • Security fix: reject non-canonical base64 encoded values - (#25)

  • Perf improvements

0.4.2

  • Added support for Data.ByteString.Short, Data.ByteString.Lazy, Data.Text.Short, and Data.Text.Lazy. (#17)
  • Optimize decode algorithm (now beats base64-bytestring in every category!) - (#13)
  • Use decodeLatin1 when decoding to text, so that functions are total - (#13)
  • Added decodeWith* variants and a Base64Error type to handle decoding errors when decoding base64 values - (#13)
  • Improved error reporting: all offsets are now precisely accurate. - (#13)
  • Validations added to head, rejecting invalid corner cases (such as bytestrings of length l == 1 mod 4, which are never correct) - (#16)
  • Added decodeBase64Padded for symmetry - (#13)

0.4.1 – 2020-02-04

  • Optimize loops for 32-bit and 64-bit architectures
  • Restructure project to be more amenable to swapping head/tail/loops
  • Fix module header alignment

0.4.0 – 2020-01-26

  • With this major version release, we remove the redundant encodeBase64Unpadded and decodeBase64Unpadded functions from Base64.hs. This is for two reasons:

    1. There is no reason for them to exist, since all std base64 is expected to be padded (in contrast to base64url)
    2. it was literally redundant with decodeBase64.

  • Use a specialized Bool type to give better visual cues regarding which functions add padding

0.3.1.1 – 2020-01-15

  • Make sure benchmark code builds

0.3.1.0 – 2020-01-08

  • Bug fix for isBase64 and isBase64Url - wrong alphabet was used
  • Added isValidBase64 and isValidBase64Url for alphabet conformity. The isBase64* functions now tell if it’s correct base64 now in the sense that it’s decodable and valid.
  • Dropped Cabal version to 2.0 for backcompat with Stack
  • Better documentation

0.3.0.0 – 2020-01-07

  • After a discussion with lexilambda, we’re making ‘encodeBase64’ be ByteString -> Text by default, offering ByteString -> ByteString as a secondary format.
  • Add decodeBase64Lenient to the API for phadej
  • Fix unpadded decoding bug where garbage was appended to the end of garbage inputs. A cleaner way to do this is to simply encode as Base64 with padding and then strip padding chars until I come up with a workflow specific to unpadded inputs (I used to have this, so I’ll have to dig it up)
  • Added isBase64 and isBase64Url to the API
  • Performance is stable

0.2.0.0 – 2020-01-05

  • After a discussion with phadej, we’re doing away with the flags, and splitting the optics out into their own separate library
  • Removed unnecessary inline pragmas

0.1.0.0 – 2020-01-05

  • Do away with the typeclasses, and just provide prisms + synonyms
  • Continued performance improvements to decoding
  • Corrected benchmarks

0.0.1.0 – 2020-01-03

  • First version. Released on an unsuspecting world.
  • Preliminary release