API Reference ex_fpe v#0.1.0

Copy Markdown View Source

Modules

Format-preserving encryption (FPE) for Elixir.

Raised by ExFPE.new!/3 when a context cannot be built — an invalid key, mode, radix, or alphabet.

Handles alphabets made up of digits 0 to 9 and letters a to z, in that order, with all letters of equal casing, encompassing radixes from 2 and up to 36.

Handles custom alphabets — those other than the ones supported by ExFPE.Codec.Builtin.

The FF1 format-preserving encryption mode.

The FF3-1 format-preserving encryption mode.

FFX definitions.

Raised by ExFPE.encrypt!/3 and ExFPE.decrypt!/3 when the tweak or the input numerical string is invalid.

Raised by a use ExFPE module's generated functions when its context is not running — usually because it is missing from the supervision tree, or the application is stopped.