Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.03 KB

README.md

File metadata and controls

88 lines (62 loc) · 3.03 KB
Raw

Argon2

Build Status Hex Version Hex Docs Total Download License Last Updated

Argon2 password hashing library for Elixir.

Argon2 is the official winner of the Password Hashing Competition, a several year project to identify a successor to Bcrypt / Pbkdf2 / Scrypt password hashing methods.

Installation

  1. Add :argon2_elixir to your list of dependencies in mix.exs:

    def deps do
  [
    {:argon2_elixir, "~> 4.0"}
  ]
end

  2. Optional: during tests (and tests only), you may want to speed up the tests. If you have a config/test.exs, you can add:

    config :argon2_elixir,
  t_cost: 1,
  m_cost: 8

Configuration

Configure argon2_elixir - see the documentation for Argon2.Stats for more details

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:

  • reporting issues
  • improving documentation
  • sharing your experiences with others

Development

$ git clone https://github.com/riverrun/argon2_elixir
$ git submodule update --init --recursive
$ mix do deps.get, compile
$ mix test

Documentation

http://hexdocs.pm/argon2_elixir

Copyright and License

Copyright (c) 2016 David Whitlock

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.