Crypto.RLWE.Challenges.Common

Utility functions for handling exceptions and creating file paths.

Documentation

type ChallengeID = Int32

type InstanceID = Int32

type InstDRBG = GenBuffered CtrDRBG

type T = CT

Concrete Tensor type used to generate and verify instances.

data ChallengeU

Holds an (untyped) proto-buf Ring-LWE/LWR challenge.

Constructors

CU !Challenge ![InstanceU]

data InstanceU

Holds an (untyped) proto-buf Ring-LWE/LWR instance.

Constructors

IC

Fields

• secret :: !Secret
• instc :: !InstanceCont

ID

Fields

• secret :: !Secret
• instd :: !InstanceDisc

IR

Fields

• secret :: !Secret
• instr :: !InstanceRLWR

type Zq q = ZqBasic q Int64

Concrete type used to generate and verify instances

type RRq q = RRq q Double

Concrete type used to generate and verify instances

challengeList :: MonadIO m => FilePath -> m [String]

Yield a list of challenge names by getting all directory contents and filtering on all directories whose names start with "chall".

checkFileExists :: (MonadIO m, MonadError String m) => FilePath -> m ()

Do nothing if the file exists, otherwise throw an exception in the monad.

parseBeaconAddr :: MonadError String m => Challenge -> m BeaconAddr

Parse the beacon time/offset used to reveal a challenge from a proto-buf stream.

suppressedSecretID :: InstanceID -> Record -> Int32 -> InstanceID

Yield the ID of the suppressed secret for a challenge, given a beacon record and a byte offset.

Directory Structure

challengeFilesDir :: FilePath -> String -> FilePath

The root directory for challenges and their instances.

challFilePath :: FilePath -> String -> FilePath

The name for a challenge file is some string with a .challenge extension.

instFilePath :: FilePath -> String -> InstanceID -> FilePath

The name for an instance file is some string followed by a hex ID with a .instance extension.

secretFilePath :: FilePath -> String -> InstanceID -> FilePath

The name for a secret file is some string followed by a hex ID with the .secret extension.

beaconFilePath :: FilePath -> BeaconEpoch -> FilePath

The name of a beacon XML file.

certFilePath :: FilePath -> FilePath

The filename for the NIST X509 certificate.

instIDString :: InstanceID -> String

Hex representation of the instance ID.

Functions for easy exceptions.

throwErrorIf :: MonadError String m => Bool -> String -> m ()

Throw an error if the condition is True.

throwErrorUnless :: MonadError String m => Bool -> String -> m ()

Throw an error if the condition is False.

maybeThrowError :: MonadError String m => Maybe a -> String -> m a

Throw an error if the input is Nothing.

printPassFailGeneric

Arguments

:: MonadIO m

=> Color

Color to print failure message.

-> String

String to print if computation succeeds.

-> String

String to print if computation fails.

-> ExceptT String m a

Computation to test.

-> m (Maybe a)

Pretty printing of error messages.

printPassFail :: MonadIO m => String -> String -> ExceptT String m a -> m (Maybe a)

Specialized version of printPassFailGeneric that fails in red.

printPassWarn :: MonadIO m => String -> String -> ExceptT String m a -> m (Maybe a)

Specialized version of printPassFailGeneric that fails in yellow.

printANSI :: MonadIO m => Color -> String -> m ()

Print the input string in the specified color.