Packages

cloak

0.7.0-alpha.1
1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.3 1.0.2 1.0.1 1.0.0 1.0.0-alpha.0 0.9.2 0.9.1 0.9.0 0.8.0 0.7.0 0.7.0-alpha.2 0.7.0-alpha.1 0.6.2 0.6.1 0.6.0 0.5.0 0.4.0 0.3.3 0.3.2 0.3.1 0.2.2 0.2.1 0.2.0 0.1.0 0.1.0-pre

Elixir encryption library

HexDocs

Current section

Files

Jump to
Readme
30 Versions
3 Dependencies
9 Dependants
Files
Activity
cloak lib cloak.ex
Raw

lib/cloak.ex 

defmodule Cloak do

  @moduledoc """

  Cloak makes it easy to encrypt and decrypt database fields using

  [Ecto](http://hexdocs.pm/ecto). It consists of four components:



  - `Cloak.Cipher` - ciphers encrypt and decrypt data using a particular

    encryption algorithm.



  - `Cloak.Vault` - vaults configure and use ciphers. Applications can

    have multiple vaults.



  - `Ecto.Type`s - custom Ecto types that make it easy to use your vault

    to encrypt/decrypt your fields.



  - `Mix.Tasks.Cloak.Migrate` - a task that will great simplify the process

    when you need to rotate your keys.



  ## Guides

  In addition to the API reference and module documentation, Cloak provides

  the following guides:



  ### How To



  - [Install Cloak](install.html)

  - [Encrypt Existing Data](encrypt_existing_data.html)

  - [Rotate Keys](rotate_keys.html)



  ### Upgrading



  - [From **0.6.x** to **0.7.x**](0.6.x_to_0.7.x.html)



  """

end