Network.TLS.Extra

Cipher related definition

cipher suite

ciphersuite_all :: [Cipher]

all encrypted ciphers supported ordered from strong to weak. this choice of ciphersuite should satisfy most normal need

ciphersuite_medium :: [Cipher]

list of medium ciphers.

ciphersuite_strong :: [Cipher]

the strongest ciphers supported.

ciphersuite_unencrypted :: [Cipher]

all unencrypted ciphers, do not use on insecure network.

individual ciphers

cipher_null_null :: Cipher

this is not stricly a usable cipher; it's the initial cipher of a TLS connection

cipher_null_SHA1 :: Cipher

unencrypted cipher using RSA for key exchange and SHA1 for digest

cipher_null_MD5 :: Cipher

unencrypted cipher using RSA for key exchange and MD5 for digest

cipher_RC4_128_MD5 :: Cipher

RC4 cipher, RSA key exchange and MD5 for digest

cipher_RC4_128_SHA1 :: Cipher

RC4 cipher, RSA key exchange and SHA1 for digest

cipher_AES128_SHA1 :: Cipher

AES cipher (128 bit key), RSA key exchange and SHA1 for digest

cipher_AES256_SHA1 :: Cipher

AES cipher (256 bit key), RSA key exchange and SHA1 for digest

cipher_AES128_SHA256 :: Cipher

AES cipher (128 bit key), RSA key exchange and SHA256 for digest

cipher_AES256_SHA256 :: Cipher

AES cipher (256 bit key), RSA key exchange and SHA256 for digest

Certificate helpers

certificateChecks :: [[X509] -> IO TLSCertificateUsage] -> [X509] -> IO TLSCertificateUsage

Returns CertificateUsageAccept if all the checks pass, or the first failure.

certificateVerifyChain :: [X509] -> IO TLSCertificateUsage

verify a certificates chain using the system certificates available.

each certificate of the list is verified against the next certificate, until it can be verified against a system certificate (system certificates are assumed as trusted)

This helper only check that the chain of certificate is valid, which means that each items received are signed by the next one, or by a system certificate. Some extra checks need to be done at the user level so that the certificate chain received make sense in the context.

for example for HTTP, the user should typically verify the certificate subject match the URL of connection.

TODO: verify validity, check revocation list if any, add optional user output to know the rejection reason.

certificateVerifyAgainst :: X509 -> X509 -> IO Bool

verify a certificate against another one. the first certificate need to be signed by the second one for this function to succeed.

certificateSelfSigned :: X509 -> Bool

Is this certificate self signed?

certificateVerifyDomain :: String -> [X509] -> TLSCertificateUsage

Verify that the given certificate chain is application to the given fully qualified host name.

certificateVerifyValidity :: Day -> [X509] -> TLSCertificateUsage

Verify certificate validity period that need to between the bounds of the certificate. TODO: maybe should verify whole chain.

certificateFingerprint :: (ByteString -> ByteString) -> X509 -> ByteString

hash the certificate signing data using the supplied hash function.

Connection helpers

connectionClient :: CryptoRandomGen g => String -> String -> TLSParams -> g -> IO (TLSCtx Handle)

open a TCP client connection to a destination and port description (number or name)

File helpers

fileReadCertificate :: FilePath -> IO X509

read one X509 certificate from a file.

the certificate must be in the usual PEM format with the TRUSTED CERTIFICATE or CERTIFICATE pem name.

If no valid PEM encoded certificate is found in the file this function will raise an error.

fileReadPrivateKey :: FilePath -> IO PrivateKey

read one private key from a file.

the private key must be in the usual PEM format and at the moment only RSA PRIVATE KEY are supported.

If no valid PEM encoded private key is found in the file this function will raise an error.