Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thibaultCha/lua-argon2-ffi
LuaJIT FFI binding for the Argon2 password hashing algorithm
https://github.com/thibaultCha/lua-argon2-ffi
argon2 luajit
Last synced: 3 months ago
JSON representation
LuaJIT FFI binding for the Argon2 password hashing algorithm
- Host: GitHub
- URL: https://github.com/thibaultCha/lua-argon2-ffi
- Owner: thibaultcha
- Created: 2016-02-21T07:26:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-11T19:53:46.000Z (over 5 years ago)
- Last Synced: 2024-04-14T20:01:52.470Z (7 months ago)
- Topics: argon2, luajit
- Language: Lua
- Homepage: http://thibaultcha.github.io/lua-argon2/
- Size: 32.2 KB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-resty - lua-argon2-ffi
README
# lua-argon2-ffi
[![Module Version][badge-version-image]][luarocks-argon2-ffi]
[![Build Status][badge-travis-image]][badge-travis-url]
[![Coverage Status][badge-coveralls-image]][badge-coveralls-url]
LuaJIT FFI binding for the [Argon2] password hashing function.
While [lua-argon2] provides a PUC Lua binding through the Lua C API, this
module is a binding for the LuaJIT FFI, especially fit for use in
[ngx_lua]/[OpenResty].
### Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Documentation](#documentation)
- [Example](#example)
- [License](#license)
### Requirements
The [Argon2] shared library must be compiled and available in your system.
Compatibility:
- Version `0.x` of this module is compatible with Argon2
[`20151206`](https://github.com/P-H-C/phc-winner-argon2/releases/tag/20151206)
- Version `1.x` of this module is compatible with Argon2
[`20160406`](https://github.com/P-H-C/phc-winner-argon2/releases/tag/20160406)
and later.
- Version `3.x` of this module is compatible with Argon2
[`20161029`](https://github.com/P-H-C/phc-winner-argon2/releases/tag/20161029)
and later.
See the [CI builds][badge-coveralls-url] for the status of the currently
supported versions.
[Back to TOC](#table-of-contents)
### Installation
This binding can be installed via [Luarocks](https://luarocks.org):
```
$ luarocks install argon2-ffi
```
Or via [opm](https://github.com/openresty/opm):
```
$ opm get thibaultcha/lua-argon2-ffi
```
Or simply by copying the `src/argon2.lua` file in your `LUA_PATH`.
[Back to TOC](#table-of-contents)
### Documentation
**Note**: lua-argon2-ffi uses the same API as [lua-argon2], to the exception of
the default settings capabilities of lua-argon2.
This binding's documentation is available at
.
The Argon2 password hashing function documentation is available at
.
[Back to TOC](#table-of-contents)
### Example
Hash a password to an encoded string:
```lua
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"
```
Verify a password against an encoded string:
```lua
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")
end
```
[Back to TOC](#table-of-contents)
### License
Work licensed under the MIT License. Please check
[P-H-C/phc-winner-argon2][Argon2] for the license over Argon2 and the reference
implementation.
[Back to TOC](#table-of-contents)
[Argon2]: https://github.com/P-H-C/phc-winner-argon2
[lua-argon2]: https://github.com/thibaultCha/lua-argon2
[luarocks-argon2-ffi]: http://luarocks.org/modules/thibaultcha/argon2-ffi
[ngx_lua]: https://github.com/openresty/lua-nginx-module
[OpenResty]: https://openresty.org
[badge-travis-url]: https://travis-ci.org/thibaultcha/lua-argon2-ffi
[badge-travis-image]: https://travis-ci.org/thibaultcha/lua-argon2-ffi.svg?branch=master
[badge-version-image]: https://img.shields.io/badge/version-3.0.1-blue.svg?style=flat
[badge-coveralls-url]: https://coveralls.io/github/thibaultcha/lua-argon2-ffi?branch=master
[badge-coveralls-image]: https://coveralls.io/repos/github/thibaultcha/lua-argon2-ffi/badge.svg?branch=master