Skip to content
Bcrypt password hashing for Elixir
Branch: master
Clone or download

README.md

Bcrypt

Hex.pm Version Build Status

Bcrypt password hashing library for Elixir.

Bcrypt is a well-tested password-based key derivation function that can be configured to remain slow and resistant to brute-force attacks even as computational power increases.

Changes in version 2

In version 2.0, bcrypt_elixir has been updated to implement the Comeonin and Comeonin.PasswordHash behaviours.

It now has the following two additional convenience functions:

  • add_hash/2
    • same as Comeonin.Bcrypt.add_hash in Comeonin version 4
    • hashes a password and returns a map with the password hash
  • check_pass/3
    • same as Comeonin.Bcrypt.check_pass in Comeonin version 4
    • takes a user struct and password as input and verifies the password

Installation

  1. Add bcrypt_elixir to the deps section of your mix.exs file:

If you are using Erlang >20:

def deps do
  [
    {:bcrypt_elixir, "~> 2.0"}
  ]
end

If you are using Erlang 19 or below:

def deps do
  [
    {:bcrypt_elixir, "~> 0.12"}
  ]
end
  1. Make sure you have a C compiler installed. See the Comeonin wiki for details.

  2. Optional: during tests (and tests only), you may want to reduce the number of rounds so it does not slow down your test suite. If you have a config/test.exs, you should add:

config :bcrypt_elixir, :log_rounds, 4

Comeonin wiki

See the Comeonin wiki for more information on the following topics:

Contributing

There are many ways you can contribute to the development of this library, including:

Donations

First of all, I would like to emphasize that this software is offered free of charge. However, if you find it useful, and you would like to buy me a cup of coffee, you can do so at paypal.

Documentation

http://hexdocs.pm/bcrypt_elixir

License

BSD. For full details, please read the LICENSE file.

You can’t perform that action at this time.