Sel.PublicKey.Cipher

Introduction

Public-key authenticated encryption allows a sender to encrypt a confidential message specifically for the recipient, using the recipient's public key.

Usage

import qualified Sel.PublicKey.Cipher as Cipher

main = do
  -- We get the sender their pair of keys:
  (senderSecretKey, senderPublicKey) <- newKeyPair
  -- We get the nonce from the other party with the message, or with 'encrypt' and our own message.
  (nonce, encryptedMessage) <- Cipher.encrypt "hello hello" secretKey
  let result = Cipher.decrypt encryptedMessage secretKey nonce
  print result
  -- "Just \"hello hello\""

Key pair generation

newKeyPair :: IO (PublicKey, SecretKey)

Generate a new random secret key.

May throw KeyPairGenerationException if the generation fails.

Since: 0.0.1.0

newtype SecretKey

A secret key of size cryptoBoxSecretKeyBytes.

Since: 0.0.1.0

Constructors

SecretKey (ForeignPtr CUChar)

Instances

Show SecretKey

show secretKey == "[REDACTED]"

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> SecretKey -> ShowS

show :: SecretKey -> String

showList :: [SecretKey] -> ShowS

Eq SecretKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

(==) :: SecretKey -> SecretKey -> Bool

(/=) :: SecretKey -> SecretKey -> Bool

Ord SecretKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

compare :: SecretKey -> SecretKey -> Ordering

(<) :: SecretKey -> SecretKey -> Bool

(<=) :: SecretKey -> SecretKey -> Bool

(>) :: SecretKey -> SecretKey -> Bool

(>=) :: SecretKey -> SecretKey -> Bool

max :: SecretKey -> SecretKey -> SecretKey

min :: SecretKey -> SecretKey -> SecretKey

Display SecretKey

display secretKey == "[REDACTED]"

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

displayBuilder :: SecretKey -> Builder

displayList :: [SecretKey] -> Builder

displayPrec :: Int -> SecretKey -> Builder

unsafeSecretKeyToHexByteString :: SecretKey -> StrictByteString

Convert a SecretKey to a hexadecimal-encoded StrictByteString.

⚠️ Be prudent as to where you store it!

Since: 0.0.1.0

newtype PublicKey

A public key of size cryptoBoxPublicKeyBytes.

Since: 0.0.1.0

Constructors

PublicKey (ForeignPtr CUChar)

Instances

Show PublicKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

Eq PublicKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

(==) :: PublicKey -> PublicKey -> Bool

(/=) :: PublicKey -> PublicKey -> Bool

Ord PublicKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

compare :: PublicKey -> PublicKey -> Ordering

(<) :: PublicKey -> PublicKey -> Bool

(<=) :: PublicKey -> PublicKey -> Bool

(>) :: PublicKey -> PublicKey -> Bool

(>=) :: PublicKey -> PublicKey -> Bool

max :: PublicKey -> PublicKey -> PublicKey

min :: PublicKey -> PublicKey -> PublicKey

Display PublicKey

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

displayBuilder :: PublicKey -> Builder

displayList :: [PublicKey] -> Builder

displayPrec :: Int -> PublicKey -> Builder

publicKeyToHexByteString :: PublicKey -> StrictByteString

Convert a PublicKey to a hexadecimal-encoded StrictByteString.

Since: 0.0.1.0

keyPairFromHexByteStrings

Arguments

:: StrictByteString

Public key

-> StrictByteString

Secret key

-> Either Text (PublicKey, SecretKey)

Create a pair of SecretKey and PublicKey from hexadecimal-encoded StrictByteStrings that you have obtained on your own, usually from the network or disk.

The public and secret keys, once decoded from base16, must respectively be at least of length cryptoBoxPublicKeyBytes and 'cryptoBoxSecretKeyBytes.

Since: 0.0.1.0

Nonce

newtype Nonce

Convert a SecretKey to a hexadecimal-encoded StrictByteString.

⚠️ Be prudent as to where you store it!

A random number that must only be used once per exchanged message. It does not have to be confidential. It is of size cryptoBoxNonceBytes.

Since: 0.0.1.0

Constructors

Nonce (ForeignPtr CUChar)

Instances

Show Nonce

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> Nonce -> ShowS

show :: Nonce -> String

showList :: [Nonce] -> ShowS

Eq Nonce

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

(==) :: Nonce -> Nonce -> Bool

(/=) :: Nonce -> Nonce -> Bool

Ord Nonce

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

compare :: Nonce -> Nonce -> Ordering

(<) :: Nonce -> Nonce -> Bool

(<=) :: Nonce -> Nonce -> Bool

(>) :: Nonce -> Nonce -> Bool

(>=) :: Nonce -> Nonce -> Bool

max :: Nonce -> Nonce -> Nonce

min :: Nonce -> Nonce -> Nonce

Display Nonce

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

displayBuilder :: Nonce -> Builder

displayList :: [Nonce] -> Builder

displayPrec :: Int -> Nonce -> Builder

nonceFromHexByteString :: StrictByteString -> Either Text Nonce

Create a Nonce from a hexadecimal-encoded StrictByteString that you have obtained on your own, usually from the network or disk.

Since: 0.0.1.0

nonceToHexByteString :: Nonce -> StrictByteString

Convert a Nonce to a hexadecimal-encoded StrictByteString.

Since: 0.0.1.0

Cipher text

data CipherText

A ciphertext consisting of an encrypted message and an authentication tag.

Since: 0.0.1.0

Constructors

CipherText

Fields

• messageLength :: CULLong
• cipherTextForeignPtr :: ForeignPtr CUChar

Instances

Show CipherText

⚠️ Be prudent as to what you do with it!

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> CipherText -> ShowS

show :: CipherText -> String

showList :: [CipherText] -> ShowS

Eq CipherText

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

(==) :: CipherText -> CipherText -> Bool

(/=) :: CipherText -> CipherText -> Bool

Ord CipherText

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

compare :: CipherText -> CipherText -> Ordering

(<) :: CipherText -> CipherText -> Bool

(<=) :: CipherText -> CipherText -> Bool

(>) :: CipherText -> CipherText -> Bool

(>=) :: CipherText -> CipherText -> Bool

max :: CipherText -> CipherText -> CipherText

min :: CipherText -> CipherText -> CipherText

Display CipherText

⚠️ Be prudent as to what you do with it!

Since: 0.0.1.0

Defined in Sel.PublicKey.Cipher

Methods

displayBuilder :: CipherText -> Builder

displayList :: [CipherText] -> Builder

displayPrec :: Int -> CipherText -> Builder

cipherTextFromHexByteString :: StrictByteString -> Either Text CipherText

Create a CipherText from a binary StrictByteString that you have obtained on your own, usually from the network or disk. It must be a valid cipherText built from the concatenation of the encrypted message and the authentication tag.

The input cipher text, once decoded from base16, must be at least of length cryptoBoxMACBytes.

Since: 0.0.1.0

cipherTextToHexText :: CipherText -> Text

Convert a CipherText to a hexadecimal-encoded Text.

⚠️ Be prudent as to where you store it!

Since: 0.0.1.0

cipherTextToHexByteString :: CipherText -> StrictByteString

Convert a CipherText to a hexadecimal-encoded StrictByteString.

⚠️ Be prudent as to where you store it!

Since: 0.0.1.0

cipherTextToBinary :: CipherText -> StrictByteString

Convert a CipherText to a binary StrictByteString.

⚠️ Be prudent as to where you store it!

Since: 0.0.1.0

Encryption and Decryption

encrypt

Arguments

:: StrictByteString

Message to encrypt.

-> PublicKey

Public key of the recipient

-> SecretKey

Secret key of the sender

-> IO (Nonce, CipherText)

Create an authenticated CipherText from a message, a SecretKey, and a one-time cryptographic Nonce that must never be re-used with the same secret key to encrypt another message.

Since: 0.0.1.0

decrypt

Arguments

:: CipherText

Encrypted message you want to decrypt.

-> PublicKey

Public key of the sender.

-> SecretKey

Secret key of the recipient.

-> Nonce

Nonce used for encrypting the original message.

-> Maybe StrictByteString

Decrypt a CipherText and authenticated message with the shared secret key and the one-time cryptographic nonce.

Since: 0.0.1.0

Errors

data KeyPairGenerationException

Exception thrown upon error during the generation of the key pair by newKeyPair.

Since: 0.0.1.0

Constructors

KeyPairGenerationException

Instances

Exception KeyPairGenerationException

Defined in Sel.PublicKey.Cipher

Methods

toException :: KeyPairGenerationException -> SomeException

fromException :: SomeException -> Maybe KeyPairGenerationException

displayException :: KeyPairGenerationException -> String

Show KeyPairGenerationException

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> KeyPairGenerationException -> ShowS

show :: KeyPairGenerationException -> String

showList :: [KeyPairGenerationException] -> ShowS

Eq KeyPairGenerationException

Defined in Sel.PublicKey.Cipher

Methods

(==) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

(/=) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

Ord KeyPairGenerationException

Defined in Sel.PublicKey.Cipher

Methods

compare :: KeyPairGenerationException -> KeyPairGenerationException -> Ordering

(<) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

(<=) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

(>) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

(>=) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool

max :: KeyPairGenerationException -> KeyPairGenerationException -> KeyPairGenerationException

min :: KeyPairGenerationException -> KeyPairGenerationException -> KeyPairGenerationException

data EncryptionError

Exception thrown upon error during the encryption of the message by encrypt.

Since: 0.0.1.0

Constructors

EncryptionError

Instances

Exception EncryptionError

Defined in Sel.PublicKey.Cipher

Methods

toException :: EncryptionError -> SomeException

fromException :: SomeException -> Maybe EncryptionError

displayException :: EncryptionError -> String

Show EncryptionError

Defined in Sel.PublicKey.Cipher

Methods

showsPrec :: Int -> EncryptionError -> ShowS

show :: EncryptionError -> String

showList :: [EncryptionError] -> ShowS

Eq EncryptionError

Defined in Sel.PublicKey.Cipher

Methods

(==) :: EncryptionError -> EncryptionError -> Bool

(/=) :: EncryptionError -> EncryptionError -> Bool

Ord EncryptionError

Defined in Sel.PublicKey.Cipher

Methods

compare :: EncryptionError -> EncryptionError -> Ordering

(<) :: EncryptionError -> EncryptionError -> Bool

(<=) :: EncryptionError -> EncryptionError -> Bool

(>) :: EncryptionError -> EncryptionError -> Bool

(>=) :: EncryptionError -> EncryptionError -> Bool

max :: EncryptionError -> EncryptionError -> EncryptionError

min :: EncryptionError -> EncryptionError -> EncryptionError