haskell/cryptonite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[bcrypt] make the haddock comment reflect what happens to the cost value.

Browse Source 
also fix a tpyo
This commit is contained in:
Vincent Hanquez 2016-02-25 07:48:30 +00:00
parent e5748d5edf
commit f362d50d46
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Crypto/KDF/BCrypt.hs
View File

@ -1,7 +1,7 @@
-- | Password encoding and validation using bcrypt. -- | Password encoding and validation using bcrypt.
-- --
-- Example usasge: -- Example usage:
-- --
-- >>> import Crypto.KDF.BCrypt (hashPassword, validatePassword) -- >>> import Crypto.KDF.BCrypt (hashPassword, validatePassword)
-- >>> import qualified Data.ByteString.Char8 as B -- >>> import qualified Data.ByteString.Char8 as B
@ -78,6 +78,8 @@ hashPassword cost password = do
return $ bcrypt cost (salt :: Bytes) password return $ bcrypt cost (salt :: Bytes) password
-- | Create a bcrypt hash for a password with a provided cost value and salt. -- | Create a bcrypt hash for a password with a provided cost value and salt.
--
-- Cost value under 4 will be automatically adjusted back to 10 for safety reason.
bcrypt :: (ByteArray salt, ByteArray password, ByteArray output) bcrypt :: (ByteArray salt, ByteArray password, ByteArray output)
=> Int => Int
-- ^ The cost parameter. Should be between 4 and 31 (inclusive). -- ^ The cost parameter. Should be between 4 and 31 (inclusive).