Crypto.Noise.Types

This module contains helper functions which can be useful at times.

Types

data ScrubbedBytes :: *

ScrubbedBytes is a memory chunk which have the properties of:

• Being scrubbed after its goes out of scope.
• A Show instance that doesn't actually show any content
• A Eq instance that is constant time

Instances

Eq ScrubbedBytes

Ord ScrubbedBytes

Show ScrubbedBytes

Monoid ScrubbedBytes

ByteArray ScrubbedBytes

ByteArrayAccess ScrubbedBytes

NFData ScrubbedBytes

data NoiseException

Represents exceptions which can occur. DecryptionFailure is thrown if a symmetric decryption operation fails, which is usually the result of an invalid authentication tag. HandshakeStateFailure is thrown if the HandshakeState is improperly initialized for the given handshake type.

If your goal is to detect an invalid PSK, prologue, etc, you'll want to catch DecryptionFailure.

Constructors

DecryptionFailure String

HandshakeStateFailure String

Instances

Show NoiseException

Exception NoiseException

newtype Plaintext

Represents plaintext which can be encrypted.

Constructors

Plaintext ScrubbedBytes

Instances

IsString Plaintext

Functions

convert :: (ByteArrayAccess bin, ByteArray bout) => bin -> bout

Convert a bytearray to another type of bytearray

append :: ByteArray bs => bs -> bs -> bs

append one bytearray to the other

concatSB :: [ScrubbedBytes] -> ScrubbedBytes

Concatenates a list of ScrubbedBytes.

bsToSB :: ByteString -> ScrubbedBytes

Converts a lazy ByteString to ScrubbedBytes.

bsToSB' :: ByteString -> ScrubbedBytes

Strict version of bsToSB.

sbToBS :: ScrubbedBytes -> ByteString

Converts ScrubbedBytes to a lazy ByteString.

sbToBS' :: ScrubbedBytes -> ByteString

Strict version of sbToBS'.

sbEq :: ScrubbedBytes -> ScrubbedBytes -> Bool

Equality operator for ScrubbedBytes.