Safe Haskell	None
Language	Haskell2010

Crypto.RNCryptor.Types

Contents

Type synonyms to make the API more descriptive

Synopsis

data RNCryptorException = InvalidHMACException !ByteString !ByteString
data RNCryptorHeader = RNCryptorHeader {
- rncVersion :: !Word8
- rncOptions :: !Word8
- rncEncryptionSalt :: !EncryptionSalt
- rncHMACSalt :: !HMACSalt
- rncIV :: !IV
}
data RNCryptorContext
newRNCryptorContext :: Password -> RNCryptorHeader -> RNCryptorContext
newRNCryptorHeader :: IO RNCryptorHeader
newRNCryptorHeaderFrom :: EncryptionSalt -> HMACSalt -> IV -> RNCryptorHeader
renderRNCryptorHeader :: RNCryptorHeader -> ByteString
makeHMAC :: ByteString -> Password -> ByteString -> HMAC
blockSize :: Int
type Password = ByteString
type HMAC = ByteString
type Salt = ByteString
type EncryptionKey = ByteString
type EncryptionSalt = Salt
type HMACSalt = Salt
type IV = ByteString

Documentation

data RNCryptorException Source #

Constructors

InvalidHMACException !ByteString !ByteString

HMAC validation failed. First parameter is the untrusted hmac, the second the computed one.

Instances

Eq RNCryptorException Source #
Instance details Defined in Crypto.RNCryptor.Types Methods (==) :: RNCryptorException -> RNCryptorException -> Bool # (/=) :: RNCryptorException -> RNCryptorException -> Bool #
Show RNCryptorException Source #
Instance details Defined in Crypto.RNCryptor.Types Methods showsPrec :: Int -> RNCryptorException -> ShowS # show :: RNCryptorException -> String # showList :: [RNCryptorException] -> ShowS #
Exception RNCryptorException Source #
Instance details Defined in Crypto.RNCryptor.Types Methods toException :: RNCryptorException -> SomeException # fromException :: SomeException -> Maybe RNCryptorException # displayException :: RNCryptorException -> String #

data RNCryptorHeader Source #

Constructors

RNCryptorHeader
Fields rncVersion :: !Word8 Data format version. Currently 3. rncOptions :: !Word8 bit 0 - uses password rncEncryptionSalt :: !EncryptionSalt iff option includes "uses password" rncHMACSalt :: !HMACSalt iff options includes "uses password" rncIV :: !IV The initialisation vector The ciphertext is variable and encrypted in CBC mode

Instances

Show RNCryptorHeader Source #
Instance details Defined in Crypto.RNCryptor.Types Methods showsPrec :: Int -> RNCryptorHeader -> ShowS # show :: RNCryptorHeader -> String # showList :: [RNCryptorHeader] -> ShowS #
Arbitrary RNCryptorHeader Source #
Instance details Defined in Crypto.RNCryptor.Types Methods arbitrary :: Gen RNCryptorHeader # shrink :: RNCryptorHeader -> [RNCryptorHeader] #

data RNCryptorContext Source #

newRNCryptorContext :: Password -> RNCryptorHeader -> RNCryptorContext Source #

newRNCryptorHeader :: IO RNCryptorHeader Source #

Generates a new RNCryptorHeader, suitable for encryption.

newRNCryptorHeaderFrom :: EncryptionSalt -> HMACSalt -> IV -> RNCryptorHeader Source #

renderRNCryptorHeader :: RNCryptorHeader -> ByteString Source #

Concatenates this RNCryptorHeader into a raw sequence of bytes, up to the IV. This means you need to append the ciphertext plus the HMAC to finalise the encrypted file.

makeHMAC :: ByteString -> Password -> ByteString -> HMAC Source #

blockSize :: Int Source #

Type synonyms to make the API more descriptive

type Password = ByteString Source #

type HMAC = ByteString Source #

type Salt = ByteString Source #

type EncryptionKey = ByteString Source #

type EncryptionSalt = Salt Source #

type HMACSalt = Salt Source #

type IV = ByteString Source #