Network.TLS.QUIC

Experimental API to run the TLS handshake establishing a QUIC connection.

On the northbound API:

• QUIC starts a TLS client or server thread with tlsQUICClient or tlsQUICServer.

TLS invokes QUIC callbacks to use the QUIC transport

• TLS uses quicSend and quicRecv to send and receive handshake message fragments.
• TLS calls quicInstallKeys to provide to QUIC the traffic secrets it should use for encryption/decryption.
• TLS calls quicNotifyExtensions to notify to QUIC the transport parameters exchanged through the handshake protocol.
• TLS calls quicDone when the handshake is done.

Handshakers

tlsQUICClient :: ClientParams -> QUICCallbacks -> IO ()

Start a TLS handshake thread for a QUIC client. The client will use the specified TLS parameters and call the provided callback functions to send and receive handshake data.

tlsQUICServer :: ServerParams -> QUICCallbacks -> IO ()

Start a TLS handshake thread for a QUIC server. The server will use the specified TLS parameters and call the provided callback functions to send and receive handshake data.

Callback

data QUICCallbacks

Callbacks implemented by QUIC and to be called by TLS at specific points during the handshake. TLS may invoke them from external threads but calls are not concurrent. Only a single callback function is called at a given point in time.

Constructors

QUICCallbacks

Fields

• quicSend :: [(CryptLevel, ByteString)] -> IO ()

  Called by TLS so that QUIC sends one or more handshake fragments. The content transiting on this API is the plaintext of the fragments and QUIC responsability is to encrypt this payload with the key material given for the specified level and an appropriate encryption scheme.

  The size of the fragments may exceed QUIC datagram limits so QUIC may break them into smaller fragments.

  The handshake protocol sometimes combines content at two levels in a single flight. The TLS library does its best to provide this in the same quicSend call and with a multi-valued argument. QUIC can then decide how to transmit this optimally.

• quicRecv :: CryptLevel -> IO (Either TLSError ByteString)

  Called by TLS to receive from QUIC the next plaintext handshake fragment. The argument specifies with which encryption level the fragment should be decrypted.

  QUIC may return partial fragments to TLS. TLS will then call quicRecv again as long as necessary. Note however that fragments must be returned in the correct sequence, i.e. the order the TLS peer emitted them.

  The function may return an error to TLS if end of stream is reached or if a protocol error has been received, believing the handshake cannot proceed any longer. If the TLS handshake protocol cannot recover from this error, the failure condition will be reported back to QUIC through the control interface.

• quicInstallKeys :: Context -> KeyScheduleEvent -> IO ()

  Called by TLS when new encryption material is ready to be used in the handshake. The next quicSend or quicRecv may now use the associated encryption level (although the previous level is also possible: directions Send/Recv do not change at the same time).

• quicNotifyExtensions :: Context -> [ExtensionRaw] -> IO ()

  Called by TLS when QUIC-specific extensions have been received from the peer.

• quicDone :: Context -> IO ()

  Called when handshake is done. tlsQUICServer is finished after calling this hook. tlsQUICClient calls recvData after calling this hook to wait for new session tickets.

data CryptLevel

TLS encryption level.

Constructors

CryptInitial

Unprotected traffic

CryptMasterSecret

Protected with master secret (TLS < 1.3)

CryptEarlySecret

Protected with early traffic secret (TLS 1.3)

CryptHandshakeSecret

Protected with handshake traffic secret (TLS 1.3)

CryptApplicationSecret

Protected with application traffic secret (TLS 1.3)

Instances

Eq CryptLevel

Defined in Network.TLS.Record.State

Methods

(==) :: CryptLevel -> CryptLevel -> Bool

(/=) :: CryptLevel -> CryptLevel -> Bool

Show CryptLevel

Defined in Network.TLS.Record.State

Methods

showsPrec :: Int -> CryptLevel -> ShowS

show :: CryptLevel -> String

showList :: [CryptLevel] -> ShowS

data KeyScheduleEvent

Argument given to quicInstallKeys when encryption material is available.

Constructors

InstallEarlyKeys (Maybe EarlySecretInfo)

Key material and parameters for traffic at 0-RTT level

InstallHandshakeKeys HandshakeSecretInfo

Key material and parameters for traffic at handshake level

InstallApplicationKeys ApplicationSecretInfo

Key material and parameters for traffic at application level

Secrets

data EarlySecretInfo

Handshake information generated for traffic at 0-RTT level.

Constructors

EarlySecretInfo Cipher (ClientTrafficSecret EarlySecret)

Instances

Show EarlySecretInfo

Defined in Network.TLS.Handshake.Control

Methods

showsPrec :: Int -> EarlySecretInfo -> ShowS

show :: EarlySecretInfo -> String

showList :: [EarlySecretInfo] -> ShowS

data HandshakeSecretInfo

Handshake information generated for traffic at handshake level.

Constructors

HandshakeSecretInfo Cipher (TrafficSecrets HandshakeSecret)

Instances

Show HandshakeSecretInfo

Defined in Network.TLS.Handshake.Control

Methods

showsPrec :: Int -> HandshakeSecretInfo -> ShowS

show :: HandshakeSecretInfo -> String

showList :: [HandshakeSecretInfo] -> ShowS

newtype ApplicationSecretInfo

Handshake information generated for traffic at application level.

Constructors

ApplicationSecretInfo (TrafficSecrets ApplicationSecret)

Instances

Show ApplicationSecretInfo

Defined in Network.TLS.Handshake.Control

Methods

showsPrec :: Int -> ApplicationSecretInfo -> ShowS

show :: ApplicationSecretInfo -> String

showList :: [ApplicationSecretInfo] -> ShowS

data EarlySecret

Phantom type indicating early traffic secret.

data HandshakeSecret

Phantom type indicating handshake traffic secrets.

data ApplicationSecret

Phantom type indicating application traffic secrets.

type TrafficSecrets a = (ClientTrafficSecret a, ServerTrafficSecret a)

Hold both client and server traffic secrets at the same step.

newtype ServerTrafficSecret a

A server traffic secret, typed with a parameter indicating a step in the TLS key schedule.

Constructors

ServerTrafficSecret ByteString

Instances

Show (ServerTrafficSecret a)

Defined in Network.TLS.Types

Methods

showsPrec :: Int -> ServerTrafficSecret a -> ShowS

show :: ServerTrafficSecret a -> String

showList :: [ServerTrafficSecret a] -> ShowS

newtype ClientTrafficSecret a

A client traffic secret, typed with a parameter indicating a step in the TLS key schedule.

Constructors

ClientTrafficSecret ByteString

Instances

Show (ClientTrafficSecret a)

Defined in Network.TLS.Types

Methods

showsPrec :: Int -> ClientTrafficSecret a -> ShowS

show :: ClientTrafficSecret a -> String

showList :: [ClientTrafficSecret a] -> ShowS

Negotiated parameters

type NegotiatedProtocol = ByteString

ID of the application-level protocol negotiated between client and server. See values listed in the IANA registry.

data HandshakeMode13

Type to show which handshake mode is used in TLS 1.3.

Constructors

FullHandshake

Full handshake is used.

HelloRetryRequest

Full handshake is used with hello retry request.

PreSharedKey

Server authentication is skipped.

RTT0

Server authentication is skipped and early data is sent.

Instances

Eq HandshakeMode13

Defined in Network.TLS.Handshake.State

Methods

(==) :: HandshakeMode13 -> HandshakeMode13 -> Bool

(/=) :: HandshakeMode13 -> HandshakeMode13 -> Bool

Show HandshakeMode13

Defined in Network.TLS.Handshake.State

Methods

showsPrec :: Int -> HandshakeMode13 -> ShowS

show :: HandshakeMode13 -> String

showList :: [HandshakeMode13] -> ShowS

Extensions

data ExtensionRaw

The raw content of a TLS extension.

Constructors

ExtensionRaw ExtensionID ByteString

Instances

Eq ExtensionRaw

Defined in Network.TLS.Struct

Methods

(==) :: ExtensionRaw -> ExtensionRaw -> Bool

(/=) :: ExtensionRaw -> ExtensionRaw -> Bool

Show ExtensionRaw

Defined in Network.TLS.Struct

Methods

showsPrec :: Int -> ExtensionRaw -> ShowS

show :: ExtensionRaw -> String

showList :: [ExtensionRaw] -> ShowS

type ExtensionID = Word16

Identifier of a TLS extension.

extensionID_QuicTransportParameters :: ExtensionID

Errors

errorTLS :: String -> IO a

Can be used by callbacks to signal an unexpected condition. This will then generate an "internal_error" alert in the TLS stack.

errorToAlertDescription :: TLSError -> AlertDescription

Return the alert that a TLS endpoint would send to the peer for the specified library error.

errorToAlertMessage :: TLSError -> String

Return the message that a TLS endpoint can add to its local log for the specified library error.

fromAlertDescription :: AlertDescription -> Word8

Encode an alert to the assigned value.

toAlertDescription :: Word8 -> Maybe AlertDescription

Decode an alert from the assigned value.

Hash

hkdfExpandLabel :: Hash -> ByteString -> ByteString -> ByteString -> Int -> ByteString

HKDF-Expand-Label function. Returns output keying material of the specified length from the PRK, customized for a TLS label and context.

hkdfExtract :: Hash -> ByteString -> ByteString -> ByteString

HKDF-Extract function. Returns the pseudorandom key (PRK) from salt and input keying material (IKM).

hashDigestSize :: Hash -> Int

Digest size in bytes.

Constants

quicMaxEarlyDataSize :: Int

Max early data size for QUIC.

Supported

defaultSupported :: Supported