Copyright	(C) Hécate Moonlight 2022
License	BSD-3-Clause
Maintainer	The Haskell Cryptography Group
Portability	GHC only
Safe Haskell	Safe-Inferred
Language	Haskell2010

Sel.PublicKey.Seal

Contents

Introduction
Usage
Keys
Operations
Errors

Description

Synopsis

newtype PublicKey = PublicKey (ForeignPtr CUChar)
newtype SecretKey = SecretKey (ForeignPtr CUChar)
newKeyPair :: IO (PublicKey, SecretKey)
seal :: StrictByteString -> PublicKey -> IO CipherText
open :: CipherText -> PublicKey -> SecretKey -> Maybe StrictByteString
data KeyPairGenerationException
data EncryptionError

Introduction

Ephemeral authenticated encryption allows to anonymously send message to a recipient given their public key.

Only the recipient can decrypt these messages using their own secret key. While the recipient can verify the integrity of the message, they cannot verify the identity of the sender.

A message is encrypted using an ephemeral key pair, with the secret key being erased right after the encryption process.

Without knowing the secret key used for a given message, the sender cannot decrypt their own message later. Furthermore, without additional data, a message cannot be correlated with the identity of its sender.

Usage

import qualified Sel.PublicKey.Seal as Seal

main = do
  -- We get the recipient their pair of keys:
(recipientPublicKey, recipientSecretKey) <- newKeyPair
  encryptedMessage <- Seal.encrypt "hello hello" recipientPublicKey
  let result = Seal.open encryptedMessage recipientPublicKey recipientSecretKey
  print result
  -- "Just \"hello hello\""

Keys

newtype PublicKey Source #

A public key of size cryptoBoxPublicKeyBytes.

Since: 0.0.1.0

Constructors

PublicKey (ForeignPtr CUChar)

Instances

Instances details

Show PublicKey Source #	Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
Eq PublicKey Source #	Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Ord PublicKey Source #	Since: 0.0.1.0
Instance details 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 Source #	Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods displayBuilder :: PublicKey -> Builder # displayList :: [PublicKey] -> Builder # displayPrec :: Int -> PublicKey -> Builder #

newtype SecretKey Source #

A secret key of size cryptoBoxSecretKeyBytes.

Since: 0.0.1.0

Constructors

SecretKey (ForeignPtr CUChar)

Instances

Instances details

Show SecretKey Source #	show secretKey == "[REDACTED]" Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods showsPrec :: Int -> SecretKey -> ShowS # show :: SecretKey -> String # showList :: [SecretKey] -> ShowS #
Eq SecretKey Source #	Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #
Ord SecretKey Source #	Since: 0.0.1.0
Instance details 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 Source #	display secretKey == "[REDACTED]" Since: 0.0.1.0
Instance details Defined in Sel.PublicKey.Cipher Methods displayBuilder :: SecretKey -> Builder # displayList :: [SecretKey] -> Builder # displayPrec :: Int -> SecretKey -> Builder #

newKeyPair :: IO (PublicKey, SecretKey) Source #

Generate a new random secret key.

May throw KeyPairGenerationException if the generation fails.

Since: 0.0.1.0

Operations

seal Source #

Arguments

:: StrictByteString	Message to encrypt
-> PublicKey	Public key of the recipient
-> IO CipherText

Encrypt a message with the recipient's public key. A key pair for the sender is generated, and the public key of that pair is attached to the cipher text. The secret key of the sender's pair is automatically destroyed.

Since: 0.0.1.0

open Source #

Arguments

:: CipherText	Cipher to decrypt
-> PublicKey	Public key of the recipient
-> SecretKey	Secret key of the recipient
-> Maybe StrictByteString

Open a sealed message from an unknown sender. You need your public and secret keys.

Since: 0.0.1.0

Errors

data KeyPairGenerationException Source #

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

Since: 0.0.1.0

Instances

Instances details

Exception KeyPairGenerationException Source #
Instance details Defined in Sel.PublicKey.Cipher Methods toException :: KeyPairGenerationException -> SomeException # fromException :: SomeException -> Maybe KeyPairGenerationException # displayException :: KeyPairGenerationException -> String #
Show KeyPairGenerationException Source #
Instance details Defined in Sel.PublicKey.Cipher Methods showsPrec :: Int -> KeyPairGenerationException -> ShowS # show :: KeyPairGenerationException -> String # showList :: [KeyPairGenerationException] -> ShowS #
Eq KeyPairGenerationException Source #
Instance details Defined in Sel.PublicKey.Cipher Methods (==) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool # (/=) :: KeyPairGenerationException -> KeyPairGenerationException -> Bool #
Ord KeyPairGenerationException Source #
Instance details 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 Source #

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

Since: 0.0.1.0

Instances

Instances details

Exception EncryptionError Source #
Instance details Defined in Sel.PublicKey.Cipher Methods toException :: EncryptionError -> SomeException # fromException :: SomeException -> Maybe EncryptionError # displayException :: EncryptionError -> String #
Show EncryptionError Source #
Instance details Defined in Sel.PublicKey.Cipher Methods showsPrec :: Int -> EncryptionError -> ShowS # show :: EncryptionError -> String # showList :: [EncryptionError] -> ShowS #
Eq EncryptionError Source #
Instance details Defined in Sel.PublicKey.Cipher Methods (==) :: EncryptionError -> EncryptionError -> Bool # (/=) :: EncryptionError -> EncryptionError -> Bool #
Ord EncryptionError Source #
Instance details 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 #