Modulehttp2-tls-0.4.5Haskell2010

Network.HTTP2.TLS.Client

Running an HTTP/2 client over TLS.

6 types
28 values

Packagehttp2-tls-0.4.5
Exports34
LanguageHaskell2010
LicenceBSD-3-Clause
SourceClient.hs

Runners

7 declarations

valuerun :: Settings -> HostName -> PortNumber -> Client a -> IO a

valuerunH2C :: Settings -> HostName -> PortNumber -> Client a -> IO a

typetype Client a = SendRequest -> Aux -> IO a

Client type.

typetype HostName = String

Either a host name e.g., "haskell.org" or a numeric host address string consisting of a dotted decimal IPv4 address or an IPv6 address e.g., "192.168.0.1".

typetype Authority = String

Authority.

newtypenewtype PortNumber

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

Example6 expressions

>>> 1 :: PortNumber1>>> read "1" :: PortNumber1>>> show (12345 :: PortNumber)"12345">>> 50000 < (51000 :: PortNumber)True>>> 50000 < (52000 :: PortNumber)True>>> 50000 + (10000 :: PortNumber)60000

Instances10Bounded, Enum, Eq, Integral, Num, Ord, …

Bounded PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Enum PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Eq PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Integral PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Num PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Ord PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Read PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Real PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Show PortNumberDefined in network-3.2.8.0 · Network.Socket.Types
Storable PortNumberDefined in network-3.2.8.0 · Network.Socket.Types

valuerunTLS

:: Settings
-> HostName
-> PortNumber
-> ByteString
ALPN
-> (Context -> SockAddr -> SockAddr -> IO a)
-> IO a

Generalized API

datadata ClientConfig

Client configuration

Instances2Eq, Show

Eq ClientConfigDefined in http2-5.3.10 · Network.HTTP2.Client.Run
Show ClientConfigDefined in http2-5.3.10 · Network.HTTP2.Client.Run

valuedefaultClientConfig :: Settings -> Authority -> ClientConfig

valuedefaultAuthority :: HostName -> Authority

Default authority

When we connect to a server, we can distinguish between three names, all of which may be different:

The HostName, used for the DNS lookup to get the server's IP
The HTTP2 :authority pseudo-header
The TLS SNI (Server Name Indicator). This is different from (2) only in exceptional circumstances, see settingsServerNameOverride.

In most cases, however, all three names are identical, and so the default Authority is simply equal to the ServerName.

valuerunWithConfig

:: ClientConfig
-> Settings
-> HostName
-> PortNumber
-> Client a
-> IO a

Running an HTTP/2 client over TLS (over TCP).

valuerunH2CWithConfig

:: ClientConfig
-> Settings
-> HostName
-> PortNumber
-> Client a
-> IO a

Running an HTTP/2 client over TCP.

valuerunTLSWithConfig

:: ClientConfig
-> Settings
-> HostName
-> PortNumber
-> ByteString
ALPN
-> (Context -> SockAddr -> SockAddr -> IO a)
-> IO a

Running a TLS client.

Settings

17 declarations

datadata Settings

valuedefaultSettings :: Settings

Default settings.

valuesettingsKeyLogger :: Settings -> String -> IO ()

Key logger (TLS and H2)

Applications may wish to set this depending on the SSLKEYLOGFILE environment variable.

Default: do nothing.

valuesettingsValidateCert :: Settings -> Bool

Should we validate TLS certificates? (TLS and H2)

Example1 expression

>>> settingsValidateCert defaultSettingsTrue

valuesettingsCAStore :: Settings -> CertificateStore

Certificate store used for validation. (TLS and H2)

Default: mempty.

valuesettingsAddrInfoFlags :: Settings -> [AddrInfoFlag]

Obsoleted.

valuesettingsCacheLimit :: Settings -> Int

How many pushed responses are contained in the cache (H2 and H2c)

Example1 expression

>>> settingsCacheLimits defaultSettings64

valuesettingsConcurrentStreams :: Settings -> Int

The maximum number of incoming streams on the net (H2 and H2c)

Example1 expression

>>> settingsConcurrentStreams defaultSettings64

valuesettingsConnectionWindowSize :: Settings -> Int

The window size of a connection (H2 and H2c)

Example1 expression

>>> settingsConnectionWindowSize defaultSettings1048575

valuesettingsStreamWindowSize :: Settings -> Int

The window size of incoming streams (H2 and H2c)

Example1 expression

>>> settingsStreamWindowSize defaultSettings262144

valuesettingsServerNameOverride :: Settings -> Maybe HostName

Server name override (H2)

By default, the server name (for TLS SNI) is set based on the Network.HTTP2.Client.authority, corresponding to the HTTP2 :authority pseudo-header. In rare circumstances these two values should be different (for example in the case of domain fronting); settingsServerNameOverride can be used to give SNI a different value than :authority.

valuesettingsSessionManager :: Settings -> SessionManager

TLS session manager (H2 and TLS)

Default: noSessionManager

valuesettingsWantSessionResume :: Settings -> Maybe (SessionID, SessionData)

Try to resume a TLS session (H2 and TLS)

Example1 expression

>>> settingsWantSessionResume defaultSettingsNothing

valuesettingsWantSessionResumeList :: Settings -> [(SessionID, SessionData)]

Try to resume a TLS session (H2 and TLS). This takes precedence over settingsWantSessionResume.

Example1 expression

>>> settingsWantSessionResumeList defaultSettings[]

valuesettingsOpenClientSocket :: Settings -> AddrInfo -> IO Socket

Function to initialize the server socket (All)

Default: openClientSocket

valuesettingsUseEarlyData :: Settings -> Bool

Try to use 0-RTT (H2 and TLS)

This is only supported for tls >= 2.0.

Example1 expression

>>> settingsUseEarlyData defaultSettingsFalse

valuesettingsOnServerFinished :: Settings -> Information -> IO ()

Rate limits

valuesettingsPingRateLimit :: Settings -> Int

Maximum number of pings allowed per second (CVE-2019-9512)

Example1 expression

>>> settingsPingRateLimit defaultSettings10

valuesettingsEmptyFrameRateLimit :: Settings -> Int

Maximum number of empty data frames allowed per second (CVE-2019-9518)

Example1 expression

>>> settingsEmptyFrameRateLimit defaultSettings4

valuesettingsSettingsRateLimit :: Settings -> Int

Maximum number of settings frames allowed per second (CVE-2019-9515)

Example1 expression

>>> settingsSettingsRateLimit defaultSettings4

valuesettingsRstRateLimit :: Settings -> Int

Maximum number of reset frames allowed per second (CVE-2023-44487)

Example1 expression

>>> settingsRstRateLimit4