| Portability | unknown |
|---|---|
| Stability | experimental |
| Maintainer | Vincent Hanquez <vincent@snarc.org> |
| Safe Haskell | Safe-Infered |
Network.TLS
Contents
Description
- data TLSParams = TLSParams {
- pConnectVersion :: Version
- pAllowedVersions :: [Version]
- pCiphers :: [Cipher]
- pCompressions :: [Compression]
- pWantClientCert :: Bool
- pUseSecureRenegotiation :: Bool
- pUseSession :: Bool
- pCertificates :: [(X509, Maybe PrivateKey)]
- pLogging :: TLSLogging
- onHandshake :: Measurement -> IO Bool
- onCertificatesRecv :: [X509] -> IO TLSCertificateUsage
- onSessionResumption :: SessionID -> IO (Maybe SessionData)
- onSessionEstablished :: SessionID -> SessionData -> IO ()
- onSessionInvalidated :: SessionID -> IO ()
- sessionResumeWith :: Maybe (SessionID, SessionData)
- data TLSLogging = TLSLogging {
- loggingPacketSent :: String -> IO ()
- loggingPacketRecv :: String -> IO ()
- loggingIOSent :: ByteString -> IO ()
- loggingIORecv :: Header -> ByteString -> IO ()
- data TLSCertificateUsage
- data TLSCertificateRejectReason
- defaultParams :: TLSParams
- defaultLogging :: TLSLogging
- data TLSCtx a
- ctxConnection :: TLSCtx a -> a
- client :: (MonadIO m, CryptoRandomGen g) => TLSParams -> g -> Handle -> m (TLSCtx Handle)
- server :: (MonadIO m, CryptoRandomGen g) => TLSParams -> g -> Handle -> m (TLSCtx Handle)
- bye :: MonadIO m => TLSCtx c -> m ()
- handshake :: MonadIO m => TLSCtx c -> m ()
- sendData :: MonadIO m => TLSCtx c -> ByteString -> m ()
- recvData :: MonadIO m => TLSCtx c -> m ByteString
- recvData' :: MonadIO m => TLSCtx c -> m ByteString
- data PrivateKey = PrivRSA PrivateKey
- class CompressionC a where
- compressionCID :: a -> Word8
- compressionCDeflate :: a -> ByteString -> (a, ByteString)
- compressionCInflate :: a -> ByteString -> (a, ByteString)
- data Compression = forall a . CompressionC a => Compression a
- nullCompression :: Compression
- data Cipher = Cipher {
- cipherID :: Word16
- cipherName :: String
- cipherHash :: Hash
- cipherBulk :: Bulk
- cipherKeyExchange :: CipherKeyExchangeType
- cipherMinVer :: Maybe Version
- data Bulk = Bulk {
- bulkName :: String
- bulkKeySize :: Int
- bulkIVSize :: Int
- bulkBlockSize :: Int
- bulkF :: BulkFunctions
- data Version
- data TLSError
- = Error_Misc String
- | Error_Protocol (String, Bool, AlertDescription)
- | Error_Certificate String
- | Error_HandshakePolicy String
- | Error_Random String
- | Error_EOF
- | Error_Packet String
- | Error_Packet_Size_Mismatch (Int, Int)
- | Error_Packet_unexpected String String
- | Error_Packet_Parsing String
- | Error_Internal_Packet_ByteProcessed Int Int Int
- | Error_Unknown_Version Word8 Word8
- | Error_Unknown_Type String
- data HandshakeFailed = HandshakeFailed TLSError
- data ConnectionNotEstablished = ConnectionNotEstablished
Context configuration
data TLSParams
Constructors
| TLSParams | |
Fields
| |
data TLSLogging
Constructors
| TLSLogging | |
Fields
| |
data TLSCertificateUsage
Certificate Usage callback possible returns values.
Constructors
| CertificateUsageAccept | usage of certificate accepted |
| CertificateUsageReject TLSCertificateRejectReason | usage of certificate rejected |
Instances
data TLSCertificateRejectReason
Certificate and Chain rejection reason
Context object
data TLSCtx a
A TLS Context is a handle augmented by tls specific state and parameters
ctxConnection :: TLSCtx a -> a
return the connection object associated with this context
Creating a context
Arguments
| :: (MonadIO m, CryptoRandomGen g) | |
| => TLSParams | parameters to use for this context |
| -> g | random number generator associated with the context |
| -> Handle | handle to use |
| -> m (TLSCtx Handle) |
Create a new Client context with a configuration, a RNG, and a Handle.
It reconfigures the handle's BufferMode to NoBuffering.
server :: (MonadIO m, CryptoRandomGen g) => TLSParams -> g -> Handle -> m (TLSCtx Handle)
Create a new Server context with a configuration, a RNG, and a Handle.
It reconfigures the handle's BufferMode to NoBuffering.
Initialisation and Termination of context
bye :: MonadIO m => TLSCtx c -> m ()
notify the context that this side wants to close connection. this is important that it is called before closing the handle, otherwise the session might not be resumable (for version < TLS1.2).
this doesn't actually close the handle
handshake :: MonadIO m => TLSCtx c -> m ()
Handshake for a new TLS connection This is to be called at the beginning of a connection, and during renegotiation
High level API
sendData :: MonadIO m => TLSCtx c -> ByteString -> m ()
sendData sends a bunch of data. It will automatically chunk data to acceptable packet size
recvData :: MonadIO m => TLSCtx c -> m ByteString
recvData get data out of Data packet, and automatically renegotiate if a Handshake ClientHello is received
recvData' :: MonadIO m => TLSCtx c -> m ByteString
Crypto Key
Compressions & Predefined compressions
class CompressionC a where
supported compression algorithms need to be part of this class
Methods
compressionCID :: a -> Word8
compressionCDeflate :: a -> ByteString -> (a, ByteString)
compressionCInflate :: a -> ByteString -> (a, ByteString)
Instances
| CompressionC NullCompression |
data Compression
every compression need to be wrapped in this, to fit in structure
Constructors
| forall a . CompressionC a => Compression a |
Instances
nullCompression :: Compression
default null compression
Ciphers & Predefined ciphers
data Cipher
Cipher algorithm
Constructors
| Cipher | |
Fields
| |
data Bulk
Constructors
| Bulk | |
Fields
| |
Versions
data Version
Versions known to TLS
SSL2 is just defined, but this version is and will not be supported.
Errors
data TLSError
TLSError that might be returned through the TLS stack
Constructors
| Error_Misc String | mainly for instance of Error |
| Error_Protocol (String, Bool, AlertDescription) | |
| Error_Certificate String | |
| Error_HandshakePolicy String | handshake policy failed. |
| Error_Random String | |
| Error_EOF | |
| Error_Packet String | |
| Error_Packet_Size_Mismatch (Int, Int) | |
| Error_Packet_unexpected String String | |
| Error_Packet_Parsing String | |
| Error_Internal_Packet_ByteProcessed Int Int Int | |
| Error_Unknown_Version Word8 Word8 | |
| Error_Unknown_Type String |
Exceptions
data HandshakeFailed
Constructors
| HandshakeFailed TLSError |