Copyright	(c) simplex.chat
License	AGPL-3
Maintainer	chat@simplex.chat
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Simplex.Messaging.Crypto

Contents

RSA keys
E2E hybrid encryption scheme
RSA OAEP encryption
RSA PSS signing
AES256 AEAD-GCM scheme
Encoding of RSA keys
SHA256 hash
Cryptography error type

Description

This module provides cryptography implementation for SMP protocols based on cryptonite package.

Synopsis

class PrivateKey k where
- rsaPrivateKey :: k -> PrivateKey
- publicKey :: k -> Maybe PublicKey
newtype SafePrivateKey = SafePrivateKey {
- unPrivateKey :: PrivateKey
}
newtype FullPrivateKey = FullPrivateKey {
- unPrivateKey :: PrivateKey
}
newtype APrivateKey = APrivateKey {
- unPrivateKey :: PrivateKey
}
newtype PublicKey = PublicKey {
- rsaPublicKey :: PublicKey
}
type SafeKeyPair = (PublicKey, SafePrivateKey)
type FullKeyPair = (PublicKey, FullPrivateKey)
newtype KeyHash = KeyHash {
- unKeyHash :: ByteString
}
generateKeyPair :: PrivateKey k => Int -> IO (KeyPair k)
publicKey' :: FullPrivateKey -> PublicKey
publicKeySize :: PublicKey -> Int
validKeySize :: Int -> Bool
safePrivateKey :: (Int, Integer, Integer) -> SafePrivateKey
removePublicKey :: APrivateKey -> APrivateKey
encrypt :: PublicKey -> Int -> ByteString -> ExceptT CryptoError IO ByteString
decrypt :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO ByteString
encryptOAEP :: PublicKey -> ByteString -> ExceptT CryptoError IO ByteString
decryptOAEP :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO ByteString
newtype Signature = Signature {
- unSignature :: ByteString
}
sign :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO Signature
verify :: PublicKey -> Signature -> ByteString -> Bool
newtype Key = Key {
- unKey :: ByteString
}
newtype IV = IV {
- unIV :: ByteString
}
encryptAES :: Key -> IV -> Int -> ByteString -> ExceptT CryptoError IO (AuthTag, ByteString)
decryptAES :: Key -> IV -> ByteString -> AuthTag -> ExceptT CryptoError IO ByteString
authTagSize :: Int
authTagToBS :: AuthTag -> ByteString
bsToAuthTag :: ByteString -> AuthTag
randomAesKey :: IO Key
randomIV :: IO IV
aesKeyP :: Parser Key
ivP :: Parser IV
serializePrivKey :: PrivateKey k => k -> ByteString
serializePubKey :: PublicKey -> ByteString
serializePubKeyUri :: PublicKey -> ByteString
encodePubKey :: PublicKey -> ByteString
publicKeyHash :: PublicKey -> KeyHash
privKeyP :: PrivateKey k => Parser k
pubKeyP :: Parser PublicKey
pubKeyUriP :: Parser PublicKey
binaryPubKeyP :: Parser PublicKey
sha256Hash :: ByteString -> ByteString
data CryptoError
- = RSAEncryptError Error
- | RSADecryptError Error
- | RSASignError Error
- | AESCipherError CryptoError
- | CryptoIVError
- | AESDecryptError
- | CryptoLargeMsgError
- | CryptoHeaderError String

RSA keys

class PrivateKey k where Source #

Type-class used for both private key types: SafePrivateKey and FullPrivateKey.

Minimal complete definition

rsaPrivateKey, _privateKey, mkPrivateKey, publicKey

Methods

rsaPrivateKey :: k -> PrivateKey Source #

publicKey :: k -> Maybe PublicKey Source #

Instances

Instances details

PrivateKey APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: APrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> APrivateKey mkPrivateKey :: PrivateKey -> APrivateKey publicKey :: APrivateKey -> Maybe PublicKey Source #
PrivateKey FullPrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: FullPrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> FullPrivateKey mkPrivateKey :: PrivateKey -> FullPrivateKey publicKey :: FullPrivateKey -> Maybe PublicKey Source #
PrivateKey SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: SafePrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> SafePrivateKey mkPrivateKey :: PrivateKey -> SafePrivateKey publicKey :: SafePrivateKey -> Maybe PublicKey Source #

newtype SafePrivateKey Source #

A newtype of PrivateKey, with PublicKey removed.

It is not possible to recover PublicKey from SafePrivateKey. The constructor of this type is not exported.

Constructors

SafePrivateKey
Fields unPrivateKey :: PrivateKey

Instances

Instances details

Eq SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: SafePrivateKey -> SafePrivateKey -> Bool # (/=) :: SafePrivateKey -> SafePrivateKey -> Bool #
Show SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> SafePrivateKey -> ShowS # show :: SafePrivateKey -> String # showList :: [SafePrivateKey] -> ShowS #
FromField SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromField :: FieldParser SafePrivateKey #
ToField SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods toField :: SafePrivateKey -> SQLData #
PrivateKey SafePrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: SafePrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> SafePrivateKey mkPrivateKey :: PrivateKey -> SafePrivateKey publicKey :: SafePrivateKey -> Maybe PublicKey Source #

newtype FullPrivateKey Source #

A newtype of PrivateKey (with PublicKey inside).

Constructors

FullPrivateKey
Fields unPrivateKey :: PrivateKey

Instances

Instances details

Eq FullPrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: FullPrivateKey -> FullPrivateKey -> Bool # (/=) :: FullPrivateKey -> FullPrivateKey -> Bool #
Show FullPrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> FullPrivateKey -> ShowS # show :: FullPrivateKey -> String # showList :: [FullPrivateKey] -> ShowS #
IsString FullPrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromString :: String -> FullPrivateKey #
PrivateKey FullPrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: FullPrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> FullPrivateKey mkPrivateKey :: PrivateKey -> FullPrivateKey publicKey :: FullPrivateKey -> Maybe PublicKey Source #

newtype APrivateKey Source #

A newtype of PrivateKey (PublicKey may be inside).

Constructors

APrivateKey
Fields unPrivateKey :: PrivateKey

Instances

Instances details

Eq APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: APrivateKey -> APrivateKey -> Bool # (/=) :: APrivateKey -> APrivateKey -> Bool #
Show APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> APrivateKey -> ShowS # show :: APrivateKey -> String # showList :: [APrivateKey] -> ShowS #
FromField APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromField :: FieldParser APrivateKey #
ToField APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods toField :: APrivateKey -> SQLData #
PrivateKey APrivateKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods rsaPrivateKey :: APrivateKey -> PrivateKey Source # _privateKey :: PrivateKey -> APrivateKey mkPrivateKey :: PrivateKey -> APrivateKey publicKey :: APrivateKey -> Maybe PublicKey Source #

newtype PublicKey Source #

A newtype of PublicKey.

Constructors

PublicKey
Fields rsaPublicKey :: PublicKey

Instances

Instances details

Eq PublicKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Show PublicKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
IsString PublicKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromString :: String -> PublicKey #
FromField PublicKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromField :: FieldParser PublicKey #
ToField PublicKey Source #
Instance details Defined in Simplex.Messaging.Crypto Methods toField :: PublicKey -> SQLData #

type SafeKeyPair = (PublicKey, SafePrivateKey) Source #

Tuple of RSA PublicKey and SafePrivateKey.

type FullKeyPair = (PublicKey, FullPrivateKey) Source #

Tuple of RSA PublicKey and FullPrivateKey.

newtype KeyHash Source #

Key hash newtype.

Constructors

KeyHash
Fields unKeyHash :: ByteString

Instances

Instances details

Eq KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: KeyHash -> KeyHash -> Bool # (/=) :: KeyHash -> KeyHash -> Bool #
Ord KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods compare :: KeyHash -> KeyHash -> Ordering # (<) :: KeyHash -> KeyHash -> Bool # (<=) :: KeyHash -> KeyHash -> Bool # (>) :: KeyHash -> KeyHash -> Bool # (>=) :: KeyHash -> KeyHash -> Bool # max :: KeyHash -> KeyHash -> KeyHash # min :: KeyHash -> KeyHash -> KeyHash #
Show KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> KeyHash -> ShowS # show :: KeyHash -> String # showList :: [KeyHash] -> ShowS #
IsString KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromString :: String -> KeyHash #
FromField KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromField :: FieldParser KeyHash #
ToField KeyHash Source #
Instance details Defined in Simplex.Messaging.Crypto Methods toField :: KeyHash -> SQLData #

generateKeyPair :: PrivateKey k => Int -> IO (KeyPair k) Source #

Generate RSA key pair with either SafePrivateKey or FullPrivateKey.

publicKey' :: FullPrivateKey -> PublicKey Source #

publicKeySize :: PublicKey -> Int Source #

validKeySize :: Int -> Bool Source #

safePrivateKey :: (Int, Integer, Integer) -> SafePrivateKey Source #

Construct SafePrivateKey from three numbers - used internally and in the tests.

removePublicKey :: APrivateKey -> APrivateKey Source #

Remove public key exponent from APrivateKey.

E2E hybrid encryption scheme

encrypt :: PublicKey -> Int -> ByteString -> ExceptT CryptoError IO ByteString Source #

E2E encrypt SMP agent messages.

https://github.com/simplex-chat/simplexmq/blob/master/rfcs/2021-01-26-crypto.md#e2e-encryption

decrypt :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO ByteString Source #

E2E decrypt SMP agent messages.

https://github.com/simplex-chat/simplexmq/blob/master/rfcs/2021-01-26-crypto.md#e2e-encryption

RSA OAEP encryption

encryptOAEP :: PublicKey -> ByteString -> ExceptT CryptoError IO ByteString Source #

RSA OAEP encryption.

Used as part of hybrid E2E encryption scheme and for SMP transport handshake.

decryptOAEP :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO ByteString Source #

RSA OAEP decryption.

Used as part of hybrid E2E encryption scheme and for SMP transport handshake.

RSA PSS signing

newtype Signature Source #

RSA signature newtype.

Constructors

Signature
Fields unSignature :: ByteString

Instances

Instances details

Eq Signature Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: Signature -> Signature -> Bool # (/=) :: Signature -> Signature -> Bool #
Show Signature Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> Signature -> ShowS # show :: Signature -> String # showList :: [Signature] -> ShowS #
IsString Signature Source #
Instance details Defined in Simplex.Messaging.Crypto Methods fromString :: String -> Signature #

sign :: PrivateKey k => k -> ByteString -> ExceptT CryptoError IO Signature Source #

RSA PSS message signing.

Used by SMP clients to sign SMP commands and by SMP agents to sign messages.

verify :: PublicKey -> Signature -> ByteString -> Bool Source #

RSA PSS signature verification.

Used by SMP servers to authorize SMP commands and by SMP agents to verify messages.

AES256 AEAD-GCM scheme

newtype Key Source #

AES key newtype.

Constructors

Key
Fields unKey :: ByteString

newtype IV Source #

IV bytes newtype.

Constructors

IV
Fields unIV :: ByteString

encryptAES :: Key -> IV -> Int -> ByteString -> ExceptT CryptoError IO (AuthTag, ByteString) Source #

AEAD-GCM encryption.

Used as part of hybrid E2E encryption scheme and for SMP transport blocks encryption.

decryptAES :: Key -> IV -> ByteString -> AuthTag -> ExceptT CryptoError IO ByteString Source #

AEAD-GCM decryption.

Used as part of hybrid E2E encryption scheme and for SMP transport blocks decryption.

authTagSize :: Int Source #

authTagToBS :: AuthTag -> ByteString Source #

Convert AEAD AuthTag to ByteString.

bsToAuthTag :: ByteString -> AuthTag Source #

Convert ByteString to AEAD AuthTag.

randomAesKey :: IO Key Source #

Random AES256 key.

randomIV :: IO IV Source #

Random IV bytes for AES256 encryption.

aesKeyP :: Parser Key Source #

AES256 key parser.

ivP :: Parser IV Source #

IV bytes parser.

Encoding of RSA keys

serializePrivKey :: PrivateKey k => k -> ByteString Source #

Base-64 PKCS8 encoding of PSA private key.

Not used as part of SMP protocols.

serializePubKey :: PublicKey -> ByteString Source #

Base-64 X509 encoding of RSA public key.

Used as part of SMP queue information (out-of-band message).

serializePubKeyUri :: PublicKey -> ByteString Source #

encodePubKey :: PublicKey -> ByteString Source #

publicKeyHash :: PublicKey -> KeyHash Source #

Digest (hash) of binary X509 encoding of RSA public key.

privKeyP :: PrivateKey k => Parser k Source #

pubKeyP :: Parser PublicKey Source #

pubKeyUriP :: Parser PublicKey Source #

binaryPubKeyP :: Parser PublicKey Source #

SHA256 hash

sha256Hash :: ByteString -> ByteString Source #

SHA256 digest.

Cryptography error type

data CryptoError Source #

Various cryptographic or related errors.

Constructors

RSAEncryptError Error	RSA OAEP encryption error
RSADecryptError Error	RSA OAEP decryption error
RSASignError Error	RSA PSS signature error
AESCipherError CryptoError	AES initialization error
CryptoIVError	IV generation error
AESDecryptError	AES decryption error
CryptoLargeMsgError	message does not fit in SMP block
CryptoHeaderError String	failure parsing RSA-encrypted message header

Instances

Instances details

Eq CryptoError Source #
Instance details Defined in Simplex.Messaging.Crypto Methods (==) :: CryptoError -> CryptoError -> Bool # (/=) :: CryptoError -> CryptoError -> Bool #
Show CryptoError Source #
Instance details Defined in Simplex.Messaging.Crypto Methods showsPrec :: Int -> CryptoError -> ShowS # show :: CryptoError -> String # showList :: [CryptoError] -> ShowS #
Exception CryptoError Source #
Instance details Defined in Simplex.Messaging.Crypto Methods toException :: CryptoError -> SomeException # fromException :: SomeException -> Maybe CryptoError # displayException :: CryptoError -> String #