{- Convenience wrapper around cryptonite's hashing. - - Copyright 2013-2024 Joey Hess - - License: BSD-2-clause -} {-# LANGUAGE BangPatterns, PackageImports #-} {-# LANGUAGE RankNTypes #-} {-# LANGUAGE CPP #-} module Utility.Hash ( sha1, sha1_context, sha1s, sha2_224, sha2_224_context, sha2_256, sha2_256_context, sha2_384, sha2_384_context, sha2_512, sha2_512_context, sha3_224, sha3_224_context, sha3_256, sha3_256_context, sha3_384, sha3_384_context, sha3_512, sha3_512_context, skein256, skein256_context, skein512, skein512_context, blake2s_160, blake2s_160_context, blake2s_224, blake2s_224_context, blake2s_256, blake2s_256_context, blake2sp_224, blake2sp_224_context, blake2sp_256, blake2sp_256_context, blake2b_160, blake2b_160_context, blake2b_224, blake2b_224_context, blake2b_256, blake2b_256_context, blake2b_384, blake2b_384_context, blake2b_512, blake2b_512_context, blake2bp_512, blake2bp_512_context, md5, md5_context, md5s, hashUpdate, hashFinalize, Digest, HashAlgorithm, Context, props_hashes_stable, Mac(..), calcMac, props_macs_stable, IncrementalHasher(..), mkIncrementalHasher, IncrementalVerifier(..), mkIncrementalVerifier, ) where import qualified Data.ByteString as S import qualified Data.ByteString.Lazy as L import qualified Data.Text as T import qualified Data.Text.Encoding as T import Data.IORef #ifdef WITH_CRYPTON import "crypton" Crypto.MAC.HMAC hiding (Context) import "crypton" Crypto.Hash #else import "cryptonite" Crypto.MAC.HMAC hiding (Context) import "cryptonite" Crypto.Hash #endif sha1 :: L.ByteString -> Digest SHA1 sha1 = hashlazy sha1_context :: Context SHA1 sha1_context = hashInit sha1s :: S.ByteString -> Digest SHA1 sha1s = hash sha2_224 :: L.ByteString -> Digest SHA224 sha2_224 = hashlazy sha2_224_context :: Context SHA224 sha2_224_context = hashInit sha2_256 :: L.ByteString -> Digest SHA256 sha2_256 = hashlazy sha2_256_context :: Context SHA256 sha2_256_context = hashInit sha2_384 :: L.ByteString -> Digest SHA384 sha2_384 = hashlazy sha2_384_context :: Context SHA384 sha2_384_context = hashInit sha2_512 :: L.ByteString -> Digest SHA512 sha2_512 = hashlazy sha2_512_context :: Context SHA512 sha2_512_context = hashInit sha3_224 :: L.ByteString -> Digest SHA3_224 sha3_224 = hashlazy sha3_224_context :: Context SHA3_224 sha3_224_context = hashInit sha3_256 :: L.ByteString -> Digest SHA3_256 sha3_256 = hashlazy sha3_256_context :: Context SHA3_256 sha3_256_context = hashInit sha3_384 :: L.ByteString -> Digest SHA3_384 sha3_384 = hashlazy sha3_384_context :: Context SHA3_384 sha3_384_context = hashInit sha3_512 :: L.ByteString -> Digest SHA3_512 sha3_512 = hashlazy sha3_512_context :: Context SHA3_512 sha3_512_context = hashInit skein256 :: L.ByteString -> Digest Skein256_256 skein256 = hashlazy skein256_context :: Context Skein256_256 skein256_context = hashInit skein512 :: L.ByteString -> Digest Skein512_512 skein512 = hashlazy skein512_context :: Context Skein512_512 skein512_context = hashInit blake2s_160 :: L.ByteString -> Digest Blake2s_160 blake2s_160 = hashlazy blake2s_160_context :: Context Blake2s_160 blake2s_160_context = hashInit blake2s_224 :: L.ByteString -> Digest Blake2s_224 blake2s_224 = hashlazy blake2s_224_context :: Context Blake2s_224 blake2s_224_context = hashInit blake2s_256 :: L.ByteString -> Digest Blake2s_256 blake2s_256 = hashlazy blake2s_256_context :: Context Blake2s_256 blake2s_256_context = hashInit blake2sp_224 :: L.ByteString -> Digest Blake2sp_224 blake2sp_224 = hashlazy blake2sp_224_context :: Context Blake2sp_224 blake2sp_224_context = hashInit blake2sp_256 :: L.ByteString -> Digest Blake2sp_256 blake2sp_256 = hashlazy blake2sp_256_context :: Context Blake2sp_256 blake2sp_256_context = hashInit blake2b_160 :: L.ByteString -> Digest Blake2b_160 blake2b_160 = hashlazy blake2b_160_context :: Context Blake2b_160 blake2b_160_context = hashInit blake2b_224 :: L.ByteString -> Digest Blake2b_224 blake2b_224 = hashlazy blake2b_224_context :: Context Blake2b_224 blake2b_224_context = hashInit blake2b_256 :: L.ByteString -> Digest Blake2b_256 blake2b_256 = hashlazy blake2b_256_context :: Context Blake2b_256 blake2b_256_context = hashInit blake2b_384 :: L.ByteString -> Digest Blake2b_384 blake2b_384 = hashlazy blake2b_384_context :: Context Blake2b_384 blake2b_384_context = hashInit blake2b_512 :: L.ByteString -> Digest Blake2b_512 blake2b_512 = hashlazy blake2b_512_context :: Context Blake2b_512 blake2b_512_context = hashInit blake2bp_512 :: L.ByteString -> Digest Blake2bp_512 blake2bp_512 = hashlazy blake2bp_512_context :: Context Blake2bp_512 blake2bp_512_context = hashInit md5 :: L.ByteString -> Digest MD5 md5 = hashlazy md5_context :: Context MD5 md5_context = hashInit md5s :: S.ByteString -> Digest MD5 md5s = hash {- Check that all the hashes continue to hash the same. -} props_hashes_stable :: [(String, Bool)] props_hashes_stable = map (\(desc, hasher, result) -> (desc ++ " stable", hasher foo == result)) [ ("sha1", show . sha1, "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33") , ("sha2_224", show . sha2_224, "0808f64e60d58979fcb676c96ec938270dea42445aeefcd3a4e6f8db") , ("sha2_256", show . sha2_256, "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae") , ("sha2_384", show . sha2_384, "98c11ffdfdd540676b1a137cb1a22b2a70350c9a44171d6b1180c6be5cbb2ee3f79d532c8a1dd9ef2e8e08e752a3babb") , ("sha2_512", show . sha2_512, "f7fbba6e0636f890e56fbbf3283e524c6fa3204ae298382d624741d0dc6638326e282c41be5e4254d8820772c5518a2c5a8c0c7f7eda19594a7eb539453e1ed7") , ("skein256", show . skein256, "a04efd9a0aeed6ede40fe5ce0d9361ae7b7d88b524aa19917b9315f1ecf00d33") , ("skein512", show . skein512, "fd8956898113510180aa4658e6c0ac85bd74fb47f4a4ba264a6b705d7a8e8526756e75aecda12cff4f1aca1a4c2830fbf57f458012a66b2b15a3dd7d251690a7") , ("sha3_224", show . sha3_224, "f4f6779e153c391bbd29c95e72b0708e39d9166c7cea51d1f10ef58a") , ("sha3_256", show . sha3_256, "76d3bc41c9f588f7fcd0d5bf4718f8f84b1c41b20882703100b9eb9413807c01") , ("sha3_384", show . sha3_384, "665551928d13b7d84ee02734502b018d896a0fb87eed5adb4c87ba91bbd6489410e11b0fbcc06ed7d0ebad559e5d3bb5") , ("sha3_512", show . sha3_512, "4bca2b137edc580fe50a88983ef860ebaca36c857b1f492839d6d7392452a63c82cbebc68e3b70a2a1480b4bb5d437a7cba6ecf9d89f9ff3ccd14cd6146ea7e7") , ("blake2s_160", show . blake2s_160, "52fb63154f958a5c56864597273ea759e52c6f00") , ("blake2s_224", show . blake2s_224, "9466668503ac415d87b8e1dfd7f348ab273ac1d5e4f774fced5fdb55") , ("blake2s_256", show . blake2s_256, "08d6cad88075de8f192db097573d0e829411cd91eb6ec65e8fc16c017edfdb74") , ("blake2sp_224", show . blake2sp_224, "8492d356fbac99f046f55e114301f7596649cb590e5b083d1a19dcdb") , ("blake2sp_256", show . blake2sp_256, "050dc5786037ea72cb9ed9d0324afcab03c97ec02e8c47368fc5dfb4cf49d8c9") , ("blake2b_160", show . blake2b_160, "983ceba2afea8694cc933336b27b907f90c53a88") , ("blake2b_224", show . blake2b_224, "853986b3fe231d795261b4fb530e1a9188db41e460ec4ca59aafef78") , ("blake2b_256", show . blake2b_256, "b8fe9f7f6255a6fa08f668ab632a8d081ad87983c77cd274e48ce450f0b349fd") , ("blake2b_384", show . blake2b_384, "e629ee880953d32c8877e479e3b4cb0a4c9d5805e2b34c675b5a5863c4ad7d64bb2a9b8257fac9d82d289b3d39eb9cc2") , ("blake2b_512", show . blake2b_512, "ca002330e69d3e6b84a46a56a6533fd79d51d97a3bb7cad6c2ff43b354185d6dc1e723fb3db4ae0737e120378424c714bb982d9dc5bbd7a0ab318240ddd18f8d") , ("blake2bp_512", show . blake2bp_512, "8ca9ccee7946afcb686fe7556628b5ba1bf9a691da37ca58cd049354d99f37042c007427e5f219b9ab5063707ec6823872dee413ee014b4d02f2ebb6abb5f643") , ("md5", show . md5, "acbd18db4cc2f85cedef654fccc4a4d8") ] where foo = L.fromChunks [T.encodeUtf8 $ T.pack "foo"] data Mac = HmacSha1 | HmacSha224 | HmacSha256 | HmacSha384 | HmacSha512 deriving (Eq) calcMac :: (forall a. Digest a -> t) -- ^ applied to MAC'ed message -> Mac -- ^ MAC -> S.ByteString -- ^ secret key -> S.ByteString -- ^ message -> t calcMac f mac = case mac of HmacSha1 -> use SHA1 HmacSha224 -> use SHA224 HmacSha256 -> use SHA256 HmacSha384 -> use SHA384 HmacSha512 -> use SHA512 where use alg k m = f (hmacGetDigest (hmacWitnessAlg alg k m)) hmacWitnessAlg :: HashAlgorithm a => a -> S.ByteString -> S.ByteString -> HMAC a hmacWitnessAlg _ = hmac -- Check that all the MACs continue to produce the same. props_macs_stable :: [(String, Bool)] props_macs_stable = map (\(desc, mac, result) -> (desc ++ " stable", calcMac show mac key msg == result)) [ ("HmacSha1", HmacSha1, "46b4ec586117154dacd49d664e5d63fdc88efb51") , ("HmacSha224", HmacSha224, "4c1f774863acb63b7f6e9daa9b5c543fa0d5eccf61e3ffc3698eacdd") , ("HmacSha256", HmacSha256, "f9320baf0249169e73850cd6156ded0106e2bb6ad8cab01b7bbbebe6d1065317") , ("HmacSha384", HmacSha384, "3d10d391bee2364df2c55cf605759373e1b5a4ca9355d8f3fe42970471eca2e422a79271a0e857a69923839015877fc6") , ("HmacSha512", HmacSha512, "114682914c5d017dfe59fdc804118b56a3a652a0b8870759cf9e792ed7426b08197076bf7d01640b1b0684df79e4b67e37485669e8ce98dbab60445f0db94fce") ] where key = T.encodeUtf8 $ T.pack "foo" msg = T.encodeUtf8 $ T.pack "bar" data IncrementalHasher = IncrementalHasher { updateIncrementalHasher :: S.ByteString -> IO () -- ^ Called repeatedly on each piece of the content. , finalizeIncrementalHasher :: IO (Maybe String) -- ^ Called once the full content has been sent, returns -- the hash. (Nothing if unableIncremental was called.) , unableIncrementalHasher :: IO () -- ^ Call if the incremental hashing is unable to be done. , positionIncrementalHasher :: IO (Maybe Integer) -- ^ Returns the number of bytes that have been fed to this -- incremental hasher so far. (Nothing if unableIncremental was -- called.) , descIncrementalHasher :: String } mkIncrementalHasher :: HashAlgorithm h => Context h -> String -> IO IncrementalHasher mkIncrementalHasher ctx desc = do v <- newIORef (Just (ctx, 0)) return $ IncrementalHasher { updateIncrementalHasher = \b -> modifyIORef' v $ \case (Just (ctx', n)) -> let !ctx'' = hashUpdate ctx' b !n' = n + fromIntegral (S.length b) in (Just (ctx'', n')) Nothing -> Nothing , finalizeIncrementalHasher = readIORef v >>= \case (Just (ctx', _)) -> do let digest = hashFinalize ctx' return $ Just $ show digest Nothing -> return Nothing , unableIncrementalHasher = writeIORef v Nothing , positionIncrementalHasher = readIORef v >>= \case Just (_, n) -> return (Just n) Nothing -> return Nothing , descIncrementalHasher = desc } data IncrementalVerifier = IncrementalVerifier { updateIncrementalVerifier :: S.ByteString -> IO () , finalizeIncrementalVerifier :: IO (Maybe Bool) , unableIncrementalVerifier :: IO () , positionIncrementalVerifier :: IO (Maybe Integer) , descIncrementalVerifier :: String } mkIncrementalVerifier :: HashAlgorithm h => Context h -> String -> (String -> Bool) -> IO IncrementalVerifier mkIncrementalVerifier ctx desc samechecksum = do hasher <- mkIncrementalHasher ctx desc return $ IncrementalVerifier { updateIncrementalVerifier = updateIncrementalHasher hasher , finalizeIncrementalVerifier = maybe Nothing (Just . samechecksum) <$> finalizeIncrementalHasher hasher , unableIncrementalVerifier = unableIncrementalHasher hasher , positionIncrementalVerifier = positionIncrementalHasher hasher , descIncrementalVerifier = descIncrementalHasher hasher }