Skip to content

Latest commit

 

History

History
92 lines (71 loc) · 3.2 KB

README.md

File metadata and controls

92 lines (71 loc) · 3.2 KB
Raw

Build Status

mruby-argon2

The password hash Argon2, winner of PHC for mruby

Installation

add this to your build_config.rb

  conf.gem mgem: 'mruby-argon2'

Installation Notes

This packages libargon2 with mruby, so if you link mruby against your app you already have all symbols for argon2. The argon2.h file is inside the mruby/build/mrbgems/mruby-argon2/include folder

Examples

Example with default options

out = Argon2.hash("a very long password")

if (Argon2.verify(out[:encoded], "a very long password"))
  puts "entrance granted"
end

Optional arguments

Argon2.hash has the following optional arguments:

salt: String # The salt to use, at least 8 characters, if you don't know what this is it's better left to the default value (default = 16 random bytes)

The secret parameter, which is used for keyed hashing. This allows a secret key to be input at hashing time (from some external location) and be folded into the value of the hash. This means that even if your salts and hashes are compromized, an attacker cannot brute-force to find the password without the key.

The ad parameter, which is used to fold any additional data into the hash value. Functionally, this behaves almost exactly like the secret or salt parameters; the ad parameter is folding into the value of the hash. However, this parameter is used for different data. The salt should be a random string stored alongside your password. The secret should be a random key only usable at hashing time. The ad is for any other data.

t_cost: Integer # Sets the number of iterations to N (default = 3)

m_cost: Integer # Sets the memory usage of N KiB (default = 2 << 12)

parallelism: Integer # Sets parallelism to N threads (default = 1)

hashlen: Integer # Sets hash output length to N bytes (default = 32)

type: Integer # You can choose between Argon2::I, Argon2::D or Argon2::ID (default = Argon2::I)

version: Integer # 0x10 or 0x13 (default = 0x13)

To find out more about them take a look at https://github.com/P-H-C/phc-winner-argon2

Example with optional arguments

out = Argon2.hash("a very long password", secret: "a very secure secret")

if Argon2.verify(out[:encoded], "a very long password", secret: "a very secure secret")
  puts "entrance granted"
end

Output values of Argon2.hash

Argon2.hash returns a ruby hash with the following fields

{
  salt: # the salt
  t_cost: # the number of itarations
  m_cost: # the memory usage
  parallelism: # the threads used
  type: # the Argon2 type, as a Number
  version: # the version number
  hash: # the raw hash calculated
  encoded: # the encoded String, suiteable for password Storage and verification
}

Notes for default arguments

The default arguments can change over time, they are taken from the command like argon2 utility.