Data.Conduit.Network.TLS

Common

type ApplicationStartTLS = GeneralApplicationStartTLS IO ()

type GeneralApplicationStartTLS m a = (AppData, (AppData -> m ()) -> m ()) -> m a

Since: 1.2.2

Server

data TLSConfig

tlsConfigBS

Arguments

:: HostPreference

-> Int

port

-> ByteString

Certificate raw data

-> ByteString

Key file raw data

-> TLSConfig

allow to build a server config directly from raw bytestring data (exact same string as if the certificates were read from the filesystem). this enables to plug another backend to fetch certifcates (other than FS)

tlsConfig

Arguments

:: HostPreference

-> Int

port

-> FilePath

certificate

-> FilePath

key

-> TLSConfig

tlsConfigChainBS

Arguments

:: HostPreference

-> Int

Port

-> ByteString

Certificate raw data

-> [ByteString]

Chain certificate raw data

-> ByteString

Key file raw data

-> TLSConfig

Like tlsConfigBS, but also allow specifying chain certificates.

Since 1.1.1

tlsConfigChain

Arguments

:: HostPreference

-> Int

Port

-> FilePath

Certificate

-> [FilePath]

Chain certificates

-> FilePath

Key

-> TLSConfig

Like tlsConfig, but also allow specifying chain certificates.

Since 1.1.1

tlsHost :: TLSConfig -> HostPreference

tlsPort :: TLSConfig -> Int

tlsNeedLocalAddr :: TLSConfig -> Bool

tlsAppData

Arguments

:: Context

a TLS context

-> SockAddr

remote address

-> Maybe SockAddr

local address

-> AppData

Create an AppData from an existing tls Context value. This is a lower level function, allowing you to create a connection in any way you want.

Sample usage:

import Network.Simple.TCP.TLS

myapp :: Application IO
...
main = do
    cset <- getDefaultClientSettings
    connect cset "host" "port" $
        (\(ctx, addr) -> myapp $ tlsAppData ctx addr Nothing)

Since 1.0.1

runTCPServerTLS :: TLSConfig -> (AppData -> IO ()) -> IO ()

runGeneralTCPServerTLS :: MonadUnliftIO m => TLSConfig -> (AppData -> m ()) -> m ()

Like runTCPServerTLS, but monad can be any instance of MonadUnliftIO.

Note that any changes to the monadic state performed by individual client handlers will be discarded. If you have mutable state you want to share among multiple handlers, you need to use some kind of mutable variables.

Since 1.1.2

runTCPServerStartTLS :: MonadUnliftIO m => TLSConfig -> GeneralApplicationStartTLS m () -> m ()

run a server un-crypted but also pass a call-back to trigger a StartTLS handshake on the underlying connection

Sample usage:

runTCPServerStartTLS serverConfig $ \(appData,startTLS) -> do
  abortTLS <- doSomethingInClear appData
  unless abortTLS $ startTls $ \appDataTls -> do
    doSomethingSSL appDataTls

Client

data TLSClientConfig

Settings type for TLS client connection.

Since 1.0.2

tlsClientConfig

Arguments

:: Int

port

-> ByteString

host

-> TLSClientConfig

Smart constructor for TLSClientConfig.

Since 1.0.2

runTLSClient :: MonadUnliftIO m => TLSClientConfig -> (AppData -> m a) -> m a

Run an application with the given configuration.

Since 1.0.2

runTLSClientStartTLS :: MonadUnliftIO m => TLSClientConfig -> GeneralApplicationStartTLS m a -> m a

Run an application with the given configuration. starting with a clear connection but provide also a call back to trigger a StartTLS handshake on the connection

Since 1.0.2

tlsClientPort :: TLSClientConfig -> Int

Since 1.0.2

tlsClientHost :: TLSClientConfig -> ByteString

Since 1.0.2

tlsClientUseTLS :: TLSClientConfig -> Bool

Default is True. If set to False, will make a non-TLS connection.

Since 1.0.2

tlsClientTLSSettings :: TLSClientConfig -> TLSSettings

TLS settings to use. If not provided, defaults will be provided.

Since 1.0.2

tlsClientSockSettings :: TLSClientConfig -> Maybe SockSettings

Socks configuration; default is Nothing. If absent, Socks will not be used.

Since 1.0.2

tlsClientConnectionContext :: TLSClientConfig -> Maybe ConnectionContext

Connection context. Default is Nothing, which will generate a new context automatically. If you will be making many connections, it's recommended to call initConnectionContext yourself.

Since 1.0.2

Misc

sourceConnection :: MonadIO m => Connection -> ConduitT i ByteString m ()

Read from a Connection.

Since: 1.3.0

sinkConnection :: MonadIO m => Connection -> ConduitT ByteString o m ()

Write to a Connection.

Since: 1.3.0