Crypto.Secretbox.Internal

Internals of crypto_secretbox.

Documentation

type Key a = SizedByteArray CRYPTO_SECRETBOX_KEYBYTES a

Encryption key that can be used for Secretbox.

This type is parametrised by the actual data type that contains bytes. This can be, for example, a ByteString, but, since this is a secret key, it is better to use ScrubbedBytes.

toKey :: ByteArrayAccess ba => ba -> Maybe (Key ba)

Make a Key from an arbitrary byte array.

This function returns Just if and only if the byte array has the right length to be used as a key with a Secretbox.

type Nonce a = SizedByteArray CRYPTO_SECRETBOX_NONCEBYTES a

Nonce that can be used for Secretbox.

This type is parametrised by the actual data type that contains bytes. This can be, for example, a ByteString.

toNonce :: ByteArrayAccess ba => ba -> Maybe (Nonce ba)

Make a Nonce from an arbitrary byte array.

This function returns Just if and only if the byte array has the right length to be used as a nonce with a Secretbox.

create

Arguments

:: (ByteArrayAccess key, ByteArrayAccess nonce, ByteArrayAccess pt, ByteArray ct)

=> Key key

Secret key

-> Nonce nonce

Nonce

-> pt

Plaintext message

-> IO ct

Encrypt a message.

open

Arguments

:: (ByteArrayAccess key, ByteArrayAccess nonce, ByteArray pt, ByteArrayAccess ct)

=> Key key

Secret key

-> Nonce nonce

Nonce

-> ct

Cyphertext

-> IO (Maybe pt)

Decrypt a message.