Crypto.Noise.Cipher

Classes

class Cipher c where

Typeclass for ciphers.

Minimal complete definition

cipherName, cipherEncrypt, cipherDecrypt, cipherZeroNonce, cipherMaxNonce, cipherIncNonce, cipherNonceEq, cipherNonceCmp, cipherBytesToSym, cipherSymToBytes, cipherTextToBytes, cipherBytesToText

Associated Types

data Ciphertext c :: *

Represents encrypted data containing an authentication tag.

data SymmetricKey c :: *

Represents a symmetric key.

data Nonce c :: *

Represents a nonce.

Methods

cipherName :: proxy c -> ScrubbedBytes

Returns the name of the cipher. This is used when generating the handshake name.

cipherEncrypt :: SymmetricKey c -> Nonce c -> AssocData -> Plaintext -> Ciphertext c

Encrypts data.

cipherDecrypt :: SymmetricKey c -> Nonce c -> AssocData -> Ciphertext c -> Maybe Plaintext

Decrypts data, returning Nothing on error (such as when the auth tag is invalid).

cipherRekey :: SymmetricKey c -> SymmetricKey c

Returns a new 32-byte cipher key as a pseudorandom function of k. Defaults to:

cipherEncrypt k maxNonce "" zeros

where maxNonce = 2^64 - 1 and zeros is a sequence of 32 bytes filed with zeros.

cipherZeroNonce :: Nonce c

Returns a Nonce set to zero.

cipherMaxNonce :: Nonce c

Returns the largest possible Nonce (2 ^ 64 - 1).

cipherIncNonce :: Nonce c -> Nonce c

Increments a nonce.

cipherNonceEq :: Nonce c -> Nonce c -> Bool

Tests if two Nonces are equal.

cipherNonceCmp :: Nonce c -> Nonce c -> Ordering

Compares the value of two Nonces.

cipherBytesToSym :: ScrubbedBytes -> SymmetricKey c

Imports a symmetric key. If the input is greater than 32 bytes, it is truncated.

cipherSymToBytes :: SymmetricKey c -> ScrubbedBytes

Exports a symmetric key. Use with care.

cipherTextToBytes :: Ciphertext c -> ScrubbedBytes

Exports a Ciphertext. The authentication tag follows the actual ciphertext.

cipherBytesToText :: ScrubbedBytes -> Ciphertext c

Imports a Ciphertext.

Instances

Cipher AESGCM

Defined in Crypto.Noise.Cipher.AESGCM

Associated Types

data Ciphertext AESGCM :: Type

data SymmetricKey AESGCM :: Type

data Nonce AESGCM :: Type

Methods

cipherName :: proxy AESGCM -> ScrubbedBytes

cipherEncrypt :: SymmetricKey AESGCM -> Nonce AESGCM -> AssocData -> Plaintext -> Ciphertext AESGCM

cipherDecrypt :: SymmetricKey AESGCM -> Nonce AESGCM -> AssocData -> Ciphertext AESGCM -> Maybe Plaintext

cipherRekey :: SymmetricKey AESGCM -> SymmetricKey AESGCM

cipherZeroNonce :: Nonce AESGCM

cipherMaxNonce :: Nonce AESGCM

cipherIncNonce :: Nonce AESGCM -> Nonce AESGCM

cipherNonceEq :: Nonce AESGCM -> Nonce AESGCM -> Bool

cipherNonceCmp :: Nonce AESGCM -> Nonce AESGCM -> Ordering

cipherBytesToSym :: ScrubbedBytes -> SymmetricKey AESGCM

cipherSymToBytes :: SymmetricKey AESGCM -> ScrubbedBytes

cipherTextToBytes :: Ciphertext AESGCM -> ScrubbedBytes

cipherBytesToText :: ScrubbedBytes -> Ciphertext AESGCM

Cipher ChaChaPoly1305

Defined in Crypto.Noise.Cipher.ChaChaPoly1305

Associated Types

data Ciphertext ChaChaPoly1305 :: Type

data SymmetricKey ChaChaPoly1305 :: Type

data Nonce ChaChaPoly1305 :: Type

Methods

cipherName :: proxy ChaChaPoly1305 -> ScrubbedBytes

cipherEncrypt :: SymmetricKey ChaChaPoly1305 -> Nonce ChaChaPoly1305 -> AssocData -> Plaintext -> Ciphertext ChaChaPoly1305

cipherDecrypt :: SymmetricKey ChaChaPoly1305 -> Nonce ChaChaPoly1305 -> AssocData -> Ciphertext ChaChaPoly1305 -> Maybe Plaintext

cipherRekey :: SymmetricKey ChaChaPoly1305 -> SymmetricKey ChaChaPoly1305

cipherZeroNonce :: Nonce ChaChaPoly1305

cipherMaxNonce :: Nonce ChaChaPoly1305

cipherIncNonce :: Nonce ChaChaPoly1305 -> Nonce ChaChaPoly1305

cipherNonceEq :: Nonce ChaChaPoly1305 -> Nonce ChaChaPoly1305 -> Bool

cipherNonceCmp :: Nonce ChaChaPoly1305 -> Nonce ChaChaPoly1305 -> Ordering

cipherBytesToSym :: ScrubbedBytes -> SymmetricKey ChaChaPoly1305

cipherSymToBytes :: SymmetricKey ChaChaPoly1305 -> ScrubbedBytes

cipherTextToBytes :: Ciphertext ChaChaPoly1305 -> ScrubbedBytes

cipherBytesToText :: ScrubbedBytes -> Ciphertext ChaChaPoly1305

Types

type AssocData = ScrubbedBytes

Represents the associated data for AEAD.

type Plaintext = ScrubbedBytes

Represents plaintext data that can be encrypted.