View Source Comeonin behaviour (Comeonin v5.5.0)

Defines a behaviour for higher-level password hashing functions.

Summary

Types

opts()
password()
user_struct()

Callbacks

add_hash(password, opts) deprecated
check_pass(user_struct, password, opts) deprecated
no_user_verify(opts)

Runs the password hash function, but always returns false.

Types

Link to this type

opts()

View Source 
@type opts() :: keyword()
Link to this type

password()

View Source 
@type password() :: binary()
Link to this type

user_struct()

View Source 
@type user_struct() :: map() | nil

Callbacks

Link to this callback

add_hash(password, opts)

View Source
This callback is deprecated. This function will be removed in the next major version.. 
@callback add_hash(password(), opts()) :: map()
Link to this callback

check_pass(user_struct, password, opts)

View Source
This callback is deprecated. This function will be removed in the next major version.. 
@callback check_pass(user_struct(), password(), opts()) ::
  {:ok, map()} | {:error, String.t()}
Link to this callback

no_user_verify(opts)

View Source 
@callback no_user_verify(opts()) :: false

Runs the password hash function, but always returns false.

This function is intended to make it more difficult for any potential attacker to find valid usernames by using timing attacks. This function is only useful if it is used as part of a policy of hiding usernames.