Copyright	Copyright © 2022-2024 Lars Kuhtz <lakuhtz@gmail.com>
License	MIT
Maintainer	Lars Kuhtz <lakuhtz@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Hash.Internal

Contents

Validation Tests for SHA1, SHA2, and SHA3 Hash Algorithms
- Response Files for Selected Long And Short Messages Test for Byte-Oriented Implementations
- Response Files for Pseudorandomly Generated Messages (Monte Carlo) Tests
Validation Tests for SHA3-XOFs (Shake) Hash Algorithms
Test Tools
Internal: Embedding Response Files in Haskell Code
Orphan instances

Description

Synopsis

data MsgFile = MsgFile {
- _msgDescription :: !Text
- _msgL :: !Natural
- _msgVectors :: !(Vector MsgVector)
}
data MsgVector = MsgVector {
- _msgLen :: !Natural
- _msgMsg :: !ByteString
- _msgMd :: !ByteString
}
readMsgFile :: FilePath -> IO MsgFile
embedMsgFile :: FilePath -> Code Q MsgFile
data MonteFile = MonteFile {
- _monteDescription :: !Text
- _monteL :: !Natural
- _monteSeed :: !ByteString
- _monteVectors :: !(Vector MonteVector)
}
data MonteVector = MonteVector {
- _monteCount :: !Natural
- _monteMd :: !ByteString
}
readMonteFile :: FilePath -> IO MonteFile
embedMonteFile :: FilePath -> Code Q MonteFile
data ShakeMsgFile = ShakeMsgFile {
- _shakeMsgDescription :: !Text
- _shakeMsgOutputLen :: !Natural
- _shakeMsgVectors :: !(Vector MsgVector)
}
data ShakeMsgVector = ShakeMsgVector {
- _shakeMsgLen :: !Natural
- _shakeMsgMsg :: !ByteString
- _shakeMsgOutput :: !ByteString
}
readShakeMsgFile :: FilePath -> IO ShakeMsgFile
embedShakeMsgFile :: FilePath -> Code Q ShakeMsgFile
data ShakeMonteFile = ShakeMonteFile {
- _shakeMonteDescription :: !Text
- _shakeMonteMinOutputBits :: !Natural
- _shakeMonteMaxOutputBits :: !Natural
- _shakeMonteMsg :: !ByteString
- _shakeMonteVectors :: !(Vector ShakeMonteVector)
}
data ShakeMonteVector = ShakeMonteVector {
- _shakeMonteCount :: !Natural
- _shakeMonteOutputLen :: !Natural
- _shakeMonteOutput :: !ByteString
}
readShakeMonteFile :: FilePath -> IO ShakeMonteFile
embedShakeMonteFile :: FilePath -> Code Q ShakeMonteFile
data ShakeVarOutFile = ShakeVarOutFile {
- _shakeVarOutDescription :: !Text
- _shakeVarOutInputLength :: !Natural
- _shakeVarOutMinOutputBits :: !Natural
- _shakeVarOutMaxOutputBits :: !Natural
- _shakeVarOutVectors :: !(Vector ShakeVarOutVector)
}
data ShakeVarOutVector = ShakeVarOutVector {
- _shakeVarOutCount :: !Natural
- _shakeVarOutOutputLen :: !Natural
- _shakeVarOutMsg :: !ByteString
- _shakeVarOutOutput :: !ByteString
}
readShakeVarOutFile :: FilePath -> IO ShakeVarOutFile
embedShakeVarOutFile :: FilePath -> Code Q ShakeVarOutFile
msgTest :: (ByteString -> ByteString) -> MsgFile -> Bool
msgAssert :: Monad m => (String -> ByteString -> ByteString -> m ()) -> (ByteString -> ByteString) -> MsgFile -> m ()
monteTestInternal :: Natural -> (ByteString -> ByteString) -> MonteFile -> Bool
monteAssertInternal :: Monad m => Natural -> (String -> ByteString -> ByteString -> m ()) -> (ByteString -> ByteString) -> MonteFile -> m ()
embedIO :: Lift a => IO a -> Code Q a

Validation Tests for SHA1, SHA2, and SHA3 Hash Algorithms

Response Files for Selected Long And Short Messages Test for Byte-Oriented Implementations

data MsgFile Source #

Constructors

MsgFile
Fields _msgDescription :: !Text _msgL :: !Natural _msgVectors :: !(Vector MsgVector)

Instances

Instances details

Show MsgFile Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> MsgFile -> ShowS # show :: MsgFile -> String # showList :: [MsgFile] -> ShowS #
Eq MsgFile Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: MsgFile -> MsgFile -> Bool # (/=) :: MsgFile -> MsgFile -> Bool #
Ord MsgFile Source #
Instance details Defined in Test.Hash.Internal Methods compare :: MsgFile -> MsgFile -> Ordering # (<) :: MsgFile -> MsgFile -> Bool # (<=) :: MsgFile -> MsgFile -> Bool # (>) :: MsgFile -> MsgFile -> Bool # (>=) :: MsgFile -> MsgFile -> Bool # max :: MsgFile -> MsgFile -> MsgFile # min :: MsgFile -> MsgFile -> MsgFile #
Lift MsgFile Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => MsgFile -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => MsgFile -> Code m MsgFile #

data MsgVector Source #

Constructors

MsgVector
Fields _msgLen :: !Natural _msgMsg :: !ByteString _msgMd :: !ByteString

Instances

Instances details

Show MsgVector Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> MsgVector -> ShowS # show :: MsgVector -> String # showList :: [MsgVector] -> ShowS #
Eq MsgVector Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: MsgVector -> MsgVector -> Bool # (/=) :: MsgVector -> MsgVector -> Bool #
Ord MsgVector Source #
Instance details Defined in Test.Hash.Internal Methods compare :: MsgVector -> MsgVector -> Ordering # (<) :: MsgVector -> MsgVector -> Bool # (<=) :: MsgVector -> MsgVector -> Bool # (>) :: MsgVector -> MsgVector -> Bool # (>=) :: MsgVector -> MsgVector -> Bool # max :: MsgVector -> MsgVector -> MsgVector # min :: MsgVector -> MsgVector -> MsgVector #
Lift MsgVector Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => MsgVector -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => MsgVector -> Code m MsgVector #

readMsgFile :: FilePath -> IO MsgFile Source #

embedMsgFile :: FilePath -> Code Q MsgFile Source #

Response Files for Pseudorandomly Generated Messages (Monte Carlo) Tests

data MonteFile Source #

Constructors

MonteFile
Fields _monteDescription :: !Text _monteL :: !Natural _monteSeed :: !ByteString _monteVectors :: !(Vector MonteVector)

Instances

Instances details

Show MonteFile Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> MonteFile -> ShowS # show :: MonteFile -> String # showList :: [MonteFile] -> ShowS #
Eq MonteFile Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: MonteFile -> MonteFile -> Bool # (/=) :: MonteFile -> MonteFile -> Bool #
Ord MonteFile Source #
Instance details Defined in Test.Hash.Internal Methods compare :: MonteFile -> MonteFile -> Ordering # (<) :: MonteFile -> MonteFile -> Bool # (<=) :: MonteFile -> MonteFile -> Bool # (>) :: MonteFile -> MonteFile -> Bool # (>=) :: MonteFile -> MonteFile -> Bool # max :: MonteFile -> MonteFile -> MonteFile # min :: MonteFile -> MonteFile -> MonteFile #
Lift MonteFile Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => MonteFile -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => MonteFile -> Code m MonteFile #

data MonteVector Source #

Constructors

MonteVector
Fields _monteCount :: !Natural _monteMd :: !ByteString

Instances

Instances details

Show MonteVector Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> MonteVector -> ShowS # show :: MonteVector -> String # showList :: [MonteVector] -> ShowS #
Eq MonteVector Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: MonteVector -> MonteVector -> Bool # (/=) :: MonteVector -> MonteVector -> Bool #
Ord MonteVector Source #
Instance details Defined in Test.Hash.Internal Methods compare :: MonteVector -> MonteVector -> Ordering # (<) :: MonteVector -> MonteVector -> Bool # (<=) :: MonteVector -> MonteVector -> Bool # (>) :: MonteVector -> MonteVector -> Bool # (>=) :: MonteVector -> MonteVector -> Bool # max :: MonteVector -> MonteVector -> MonteVector # min :: MonteVector -> MonteVector -> MonteVector #
Lift MonteVector Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => MonteVector -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => MonteVector -> Code m MonteVector #

readMonteFile :: FilePath -> IO MonteFile Source #

embedMonteFile :: FilePath -> Code Q MonteFile Source #

Validation Tests for SHA3-XOFs (Shake) Hash Algorithms

Response Files for Selected Long And Short Messages Test for Byte-Oriented Implementations

data ShakeMsgFile Source #

Constructors

ShakeMsgFile
Fields _shakeMsgDescription :: !Text _shakeMsgOutputLen :: !Natural _shakeMsgVectors :: !(Vector MsgVector)

Instances

Instances details

Show ShakeMsgFile Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeMsgFile -> ShowS # show :: ShakeMsgFile -> String # showList :: [ShakeMsgFile] -> ShowS #
Eq ShakeMsgFile Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeMsgFile -> ShakeMsgFile -> Bool # (/=) :: ShakeMsgFile -> ShakeMsgFile -> Bool #
Ord ShakeMsgFile Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeMsgFile -> ShakeMsgFile -> Ordering # (<) :: ShakeMsgFile -> ShakeMsgFile -> Bool # (<=) :: ShakeMsgFile -> ShakeMsgFile -> Bool # (>) :: ShakeMsgFile -> ShakeMsgFile -> Bool # (>=) :: ShakeMsgFile -> ShakeMsgFile -> Bool # max :: ShakeMsgFile -> ShakeMsgFile -> ShakeMsgFile # min :: ShakeMsgFile -> ShakeMsgFile -> ShakeMsgFile #
Lift ShakeMsgFile Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeMsgFile -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeMsgFile -> Code m ShakeMsgFile #

data ShakeMsgVector Source #

Constructors

ShakeMsgVector
Fields _shakeMsgLen :: !Natural _shakeMsgMsg :: !ByteString _shakeMsgOutput :: !ByteString

Instances

Instances details

Show ShakeMsgVector Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeMsgVector -> ShowS # show :: ShakeMsgVector -> String # showList :: [ShakeMsgVector] -> ShowS #
Eq ShakeMsgVector Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeMsgVector -> ShakeMsgVector -> Bool # (/=) :: ShakeMsgVector -> ShakeMsgVector -> Bool #
Ord ShakeMsgVector Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeMsgVector -> ShakeMsgVector -> Ordering # (<) :: ShakeMsgVector -> ShakeMsgVector -> Bool # (<=) :: ShakeMsgVector -> ShakeMsgVector -> Bool # (>) :: ShakeMsgVector -> ShakeMsgVector -> Bool # (>=) :: ShakeMsgVector -> ShakeMsgVector -> Bool # max :: ShakeMsgVector -> ShakeMsgVector -> ShakeMsgVector # min :: ShakeMsgVector -> ShakeMsgVector -> ShakeMsgVector #
Lift ShakeMsgVector Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeMsgVector -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeMsgVector -> Code m ShakeMsgVector #

readShakeMsgFile :: FilePath -> IO ShakeMsgFile Source #

embedShakeMsgFile :: FilePath -> Code Q ShakeMsgFile Source #

Response Files for Pseudorandomly Generated Messages (Monte Carlo) Tests

data ShakeMonteFile Source #

Constructors

ShakeMonteFile
Fields _shakeMonteDescription :: !Text _shakeMonteMinOutputBits :: !Natural _shakeMonteMaxOutputBits :: !Natural _shakeMonteMsg :: !ByteString _shakeMonteVectors :: !(Vector ShakeMonteVector)

Instances

Instances details

Show ShakeMonteFile Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeMonteFile -> ShowS # show :: ShakeMonteFile -> String # showList :: [ShakeMonteFile] -> ShowS #
Eq ShakeMonteFile Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeMonteFile -> ShakeMonteFile -> Bool # (/=) :: ShakeMonteFile -> ShakeMonteFile -> Bool #
Ord ShakeMonteFile Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeMonteFile -> ShakeMonteFile -> Ordering # (<) :: ShakeMonteFile -> ShakeMonteFile -> Bool # (<=) :: ShakeMonteFile -> ShakeMonteFile -> Bool # (>) :: ShakeMonteFile -> ShakeMonteFile -> Bool # (>=) :: ShakeMonteFile -> ShakeMonteFile -> Bool # max :: ShakeMonteFile -> ShakeMonteFile -> ShakeMonteFile # min :: ShakeMonteFile -> ShakeMonteFile -> ShakeMonteFile #
Lift ShakeMonteFile Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeMonteFile -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeMonteFile -> Code m ShakeMonteFile #

data ShakeMonteVector Source #

Constructors

ShakeMonteVector
Fields _shakeMonteCount :: !Natural _shakeMonteOutputLen :: !Natural _shakeMonteOutput :: !ByteString

Instances

Instances details

Show ShakeMonteVector Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeMonteVector -> ShowS # show :: ShakeMonteVector -> String # showList :: [ShakeMonteVector] -> ShowS #
Eq ShakeMonteVector Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeMonteVector -> ShakeMonteVector -> Bool # (/=) :: ShakeMonteVector -> ShakeMonteVector -> Bool #
Ord ShakeMonteVector Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeMonteVector -> ShakeMonteVector -> Ordering # (<) :: ShakeMonteVector -> ShakeMonteVector -> Bool # (<=) :: ShakeMonteVector -> ShakeMonteVector -> Bool # (>) :: ShakeMonteVector -> ShakeMonteVector -> Bool # (>=) :: ShakeMonteVector -> ShakeMonteVector -> Bool # max :: ShakeMonteVector -> ShakeMonteVector -> ShakeMonteVector # min :: ShakeMonteVector -> ShakeMonteVector -> ShakeMonteVector #
Lift ShakeMonteVector Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeMonteVector -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeMonteVector -> Code m ShakeMonteVector #

readShakeMonteFile :: FilePath -> IO ShakeMonteFile Source #

embedShakeMonteFile :: FilePath -> Code Q ShakeMonteFile Source #

Response Files for Variable Output Tests for Byte-Oriented Implementations

data ShakeVarOutFile Source #

Constructors

ShakeVarOutFile
Fields _shakeVarOutDescription :: !Text _shakeVarOutInputLength :: !Natural _shakeVarOutMinOutputBits :: !Natural _shakeVarOutMaxOutputBits :: !Natural _shakeVarOutVectors :: !(Vector ShakeVarOutVector)

Instances

Instances details

Show ShakeVarOutFile Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeVarOutFile -> ShowS # show :: ShakeVarOutFile -> String # showList :: [ShakeVarOutFile] -> ShowS #
Eq ShakeVarOutFile Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool # (/=) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool #
Ord ShakeVarOutFile Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeVarOutFile -> ShakeVarOutFile -> Ordering # (<) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool # (<=) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool # (>) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool # (>=) :: ShakeVarOutFile -> ShakeVarOutFile -> Bool # max :: ShakeVarOutFile -> ShakeVarOutFile -> ShakeVarOutFile # min :: ShakeVarOutFile -> ShakeVarOutFile -> ShakeVarOutFile #
Lift ShakeVarOutFile Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeVarOutFile -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeVarOutFile -> Code m ShakeVarOutFile #

data ShakeVarOutVector Source #

Constructors

ShakeVarOutVector
Fields _shakeVarOutCount :: !Natural _shakeVarOutOutputLen :: !Natural _shakeVarOutMsg :: !ByteString _shakeVarOutOutput :: !ByteString

Instances

Instances details

Show ShakeVarOutVector Source #
Instance details Defined in Test.Hash.Internal Methods showsPrec :: Int -> ShakeVarOutVector -> ShowS # show :: ShakeVarOutVector -> String # showList :: [ShakeVarOutVector] -> ShowS #
Eq ShakeVarOutVector Source #
Instance details Defined in Test.Hash.Internal Methods (==) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool # (/=) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool #
Ord ShakeVarOutVector Source #
Instance details Defined in Test.Hash.Internal Methods compare :: ShakeVarOutVector -> ShakeVarOutVector -> Ordering # (<) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool # (<=) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool # (>) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool # (>=) :: ShakeVarOutVector -> ShakeVarOutVector -> Bool # max :: ShakeVarOutVector -> ShakeVarOutVector -> ShakeVarOutVector # min :: ShakeVarOutVector -> ShakeVarOutVector -> ShakeVarOutVector #
Lift ShakeVarOutVector Source #
Instance details Defined in Test.Hash.Internal Methods lift :: Quote m => ShakeVarOutVector -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ShakeVarOutVector -> Code m ShakeVarOutVector #

readShakeVarOutFile :: FilePath -> IO ShakeVarOutFile Source #

embedShakeVarOutFile :: FilePath -> Code Q ShakeVarOutFile Source #

Test Tools

msgTest :: (ByteString -> ByteString) -> MsgFile -> Bool Source #

Check that all test vectors in a File are satisfied by a given hash implementation.

msgAssert Source #

Arguments

:: Monad m
=> (String -> ByteString -> ByteString -> m ())	Function to assertion Equality. The first argument is a test label, the second argument is the actual value, and the thrid value is the expected value.
-> (ByteString -> ByteString)	Hash function
-> MsgFile
-> m ()

For a given hash implementation, assert the correct result for each test vector in a MsgFile.

The function to assert equality is usually provided by some testing framework.

monteTestInternal :: Natural -> (ByteString -> ByteString) -> MonteFile -> Bool Source #

monteAssertInternal Source #

Arguments

:: Monad m
=> Natural	seed multiplyer
-> (String -> ByteString -> ByteString -> m ())	Function to assertion Equality. The first argument is a test label, the second argument is the actual value, and the thrid value is the expected value.
-> (ByteString -> ByteString)	Hash function
-> MonteFile
-> m ()

Internal: Embedding Response Files in Haskell Code

embedIO :: Lift a => IO a -> Code Q a Source #

Orphan instances

Lift a => Lift (Vector a :: Type) Source #
Instance details Methods lift :: Quote m => Vector a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Vector a -> Code m (Vector a) #