Lua C binding for the Argon2 password hashing function. Compatible with Lua 5.x and LuaJIT.
For LuaJIT or ngx_lua/OpenResty usage, consider the FFI implementation of this binding: lua-argon2-ffi.
The Argon2 shared library must be compiled and available in your system.
Compatibility:
- Version
1.xof this module is compatible with Argon220151206. - Version
2.xof this module is compatible with Argon220160406to20161029. - Version
3.xof this module is compatible with Argon220161029and above.
See the CI builds for the status of the currently supported versions.
This binding can be installed via Luarocks:
$ luarocks install argon2 ARGON2_INCDIR="..." ARGON2_LIBDIR="..."
ARGON2_INCDIR must contain the argon2.h header file, and ARGON2_LIBDIR
must contain the compiled shared library for your platform.
Or by using the Makefile (use the provided variables to point it to your Lua and Argon2 installations):
$ make
Using the Makefile will compile argon2.so which must be placed somewhere in
your LUA_CPATH.
This binding's documentation is available at http://thibaultcha.github.io/lua-argon2/.
The Argon2 password hashing function documentation is available at https://github.com/P-H-C/phc-winner-argon2.
Hash a password to an encoded string:
local argon2 = require "argon2"
--- Prototype
-- local encoded, err = argon2.hash_encoded(pwd, salt, opts)
--- Argon2i
local encoded = assert(argon2.hash_encoded("password", "somesalt"))
-- encoded is "$argon2i$v=19$m=4096,t=3,p=1$c29tZXNhbHQ$iWh06vD8Fy27wf9npn6FXWiCX4K6pW6Ue1Bnzz07Z8A"
--- Argon2d
local encoded = assert(argon2.hash_encoded("password", "somesalt", {
variant = argon2.variants.argon2_d
}))
-- encoded is "$argon2d$v=19$m=4096,t=3,p=1$c29tZXNhbHQ$2+JCoQtY/2x5F0VB9pEVP3xBNguWP1T25Ui0PtZuk8o"
--- Argon2id
local encoded = assert(argon2.hash_encoded("password", "somesalt", {
variant = argon2.variants.argon2_id
}))
-- encoded is "$argon2id$v=19$m=4096,t=3,p=1$c29tZXNhbHQ$qLml5cbqFAO6YxVHhrSBHP0UWdxrIxkNcM8aMX3blzU"
-- Hashing options
local encoded = assert(argon2.hash_encoded("password", "somesalt", {
t_cost = 4,
m_cost = math.pow(2, 16), -- 65536 KiB
parallelism = 2
}))
-- encoded is "$argon2i$v=19$m=65536,t=4,p=2$c29tZXNhbHQ$n6x5DKNWV8BOeKemQJRk7BU3hcaCVomtn9TCyEA0inM"
-- Changing the default options (those arguments are the current defaults)
argon2.t_cost(3)
argon2.m_cost(4096)
argon2.parallelism(1)
argon2.hash_len(32)
argon2.variant(argon2.variants.argon2_i)Verify a password against an encoded string:
local argon2 = require "argon2"
--- Prototype
-- local ok, err = argon2.decrypt(hash, plain)
local encoded = assert(argon2.hash_encoded("password", "somesalt"))
-- encoded: argon2i encoded hash
local ok, err = argon2.verify(encoded, "password")
if err then
error("could not verify: " .. err)
end
if not ok then
error("The password does not match the supplied hash")
endWork licensed under the MIT License. Please check P-H-C/phc-winner-argon2 for the license over Argon2 and the reference implementation.