drupal7_password_hash v0.2.0 Drupal7PasswordHash View Source
Elixir implementation of drupal 7 compatible password hashing.
NOTE
The hashes are like drupal 7 hashes except they are prepended with the
string $drupal7
.
Link to this section Summary
Functions
Hashes a password, using hash_pwd_salt/2
, and returns the password hash in a map.
Checks the password, using verify_pass/2
, by comparing the hash with
the password hash found in a user struct, or map.
Hashes a password with a randomly generated salt.
Runs the password hash function, but always returns false.
Verifies a password by hashing the password and comparing the hashed value with a stored hash.
Link to this section Functions
Hashes a password, using hash_pwd_salt/2
, and returns the password hash in a map.
This is a convenience function that is especially useful when used with Ecto changesets.
Options
In addition to the :hash_key
option show below, this function also takes
options that are then passed on to the hash_pwd_salt/2
function in this
module.
See the documentation for hash_pwd_salt/2
for further details.
:hash_key
- the password hash identifier- the default is
:password_hash
- the default is
Example with Ecto
The put_pass_hash
function below is an example of how you can use
add_hash
to add the password hash to the Ecto changeset.
defp put_pass_hash(%Ecto.Changeset{valid?: true, changes:
%{password: password}} = changeset) do
change(changeset, add_hash(password))
end
defp put_pass_hash(changeset), do: changeset
This function will return a changeset with %{password_hash: password_hash}
added to the changes
map.
Checks the password, using verify_pass/2
, by comparing the hash with
the password hash found in a user struct, or map.
This is a convenience function that takes a user struct, or map, as input and seemlessly handles the cases where no user is found.
Options
:hash_key
- the password hash identifier- this does not need to be set if the key is
:password_hash
or:encrypted_password
- this does not need to be set if the key is
:hide_user
- run theno_user_verify/1
function if no user is found- the default is true
Example
The following is an example of using this function to verify a user's password:
def verify_user(%{"password" => password} = params) do
params
|> Accounts.get_by()
|> check_pass(password)
end
The Accounts.get_by
function in this example takes the user parameters
(for example, email and password) as input and returns a user struct or nil.
Hashes a password with a randomly generated salt.
Only the SHA512 ("$S$") variant is supported.
Options
:log_rounds
- number of log rounds- the default is 15 (32768 rounds)
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.
Options
This function should be called with the same options as those used by
hash_pwd_salt/2
.
Hiding usernames
In addition to keeping passwords secret, hiding the precise username can help make online attacks more difficult. An attacker would then have to guess a username / password combination, rather than just a password, to gain access.
This does not mean that the username should be kept completely secret. Adding a short numerical suffix to a user's name, for example, would be sufficient to increase the attacker's work considerably.
If you are implementing a policy of hiding usernames, it is important to make sure that the username is not revealed by any other part of your application.
Verifies a password by hashing the password and comparing the hashed value with a stored hash.
The SHA512 ("$S$") variant as well as both MD5 ("$H$", "$P$") variants are supported. The MD5 variants are untested, though.