Network.TLS.Client

the Client module contains the necessary calls to create a connecting TLS socket aka. a client socket.

Documentation

data TLSClientParams

Constructors

TLSClientParams

Fields

cpConnectVersion :: Version

client version we're sending by default

cpAllowedVersions :: [Version]

allowed versions from the server

cpSession :: Maybe [Word8]

session for this connection

cpCiphers :: [Cipher]

all ciphers for this connection

cpCertificate :: Maybe Certificate

an optional client certificate

cpCallbacks :: TLSClientCallbacks

user callbacks

Instances

Show TLSClientParams

data TLSClientCallbacks

Constructors

TLSClientCallbacks

Fields

cbCertificates :: Maybe ([Certificate] -> IO Bool)

optional callback to verify certificates

Instances

Show TLSClientCallbacks

data TLSStateClient

Instances

Show TLSStateClient

Monad m => MonadState TLSStateClient (TLSClient m)

newtype TLSClient m a

Constructors

TLSClient

Fields

runTLSC :: StateT TLSStateClient m a

Instances

MonadTrans TLSClient

Monad m => MonadState TLSStateClient (TLSClient m)

Monad m => Monad (TLSClient m)

(Functor m, Monad m) => Functor (TLSClient m)

Monad m => MonadTLSState (TLSClient m)

runTLSClient :: TLSClient m a -> TLSClientParams -> SRandomGen -> m (a, TLSStateClient)

low level packet sending receiving.

recvPacket :: Handle -> TLSClient IO (Either TLSError [Packet])

receive a single TLS packet or on error a TLSError

sendPacket :: Handle -> Packet -> TLSClient IO ()

send a single TLS packet

API, warning probably subject to change

connect :: Handle -> TLSClient IO ()

connect through a handle as a new TLS connection.

sendData :: Handle -> ByteString -> TLSClient IO ()

sendData sends a bunch of data

recvData :: Handle -> TLSClient IO ByteString

recvData get data out of Data packet, and automatically try to renegociate if - a Handshake HelloRequest is received

close :: Handle -> TLSClient IO ()

close a TLS connection. - note that it doesn't close the handle, but just signal we're going to close - the connection to the other side