cemerick.friend.credentials — clj-commons/friend 0.3.193

bcrypt-credential-fn clj

(bcrypt-credential-fn load-credentials-fn {:keys [username password]})

A bcrypt credentials function intended to be used with cemerick.friend/authenticate or individual authentication workflows. You must supply a function of one argument that will look up stored user credentials given a username/id. e.g.:

(authenticate {:credential-fn (partial bcrypt-credential-fn load-user-record) :other :config ...} ring-handler-to-be-secured)

The credentials map returned by the provided function will only be returned if the provided (cleartext, user-supplied) password matches the hashed password in the credentials map.

The password in the credentials map will be looked up using a :password key by default; if the credentials-loading function will return a credentials map that stores the hashed password under a different key, it must specify that alternative key via a :cemerick.friend.credentials/password-key slot in the map's metadata. So, if a credentials map looks like:

{:username "joe" :app.foo/passphrase "bcrypt hash"}

...then the hash will be verified correctly as long as the credentials map contains a [:cemerick.friend.credentials/password-key :app.foo/passphrase] entry.

bcrypt-verify clj

(bcrypt-verify password hash)

Returns true if the plaintext [password] corresponds to [hash], the result of previously hashing that password.

hash-bcrypt clj

(hash-bcrypt password & {:keys [work-factor]})

Hashes a given plaintext password using bcrypt and an optional :work-factor (defaults to 10 as of this writing). Should be used to hash passwords included in stored user credentials that are to be later verified using bcrypt-credential-fn.