Network.TLS.Internal · tls-2.1.6

newtypenewtype Group

#

Constructors

Group Word16

Instances5Eq, Show, Generic, Serialise, Rep

Eq GroupDefined in tls-2.1.6 · Network.TLS.Crypto.Types
Show GroupDefined in tls-2.1.6 · Network.TLS.Crypto.Types
Generic GroupDefined in tls-2.1.6 · Network.TLS.Crypto.Types
Serialise GroupDefined in tls-2.1.6 · Network.TLS.Crypto.Types
type Rep Group = D1 ('MetaData "Group" "Network.TLS.Crypto.Types" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'True) (C1 ('MetaCons "Group" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in tls-2.1.6 · Network.TLS.Crypto.Types

patternpattern P256 :: Group

#

patternpattern P384 :: Group

#

patternpattern P521 :: Group

#

patternpattern X25519 :: Group

#

patternpattern X448 :: Group

#

patternpattern FFDHE2048 :: Group

#

patternpattern FFDHE3072 :: Group

#

patternpattern FFDHE4096 :: Group

#

patternpattern FFDHE6144 :: Group

#

patternpattern FFDHE8192 :: Group

#

datadata MaxFragmentEnum

#

MaxFragment512 MaxFragment1024 MaxFragment2048 MaxFragment4096

Instances2Eq, Show

Eq MaxFragmentEnumDefined in tls-2.1.6 · Network.TLS.Extension
Show MaxFragmentEnumDefined in tls-2.1.6 · Network.TLS.Extension

classclass Extension a where

#

Extension class to transform bytes to and from a high level Extension type.

Methods

extensionID :: a -> ExtensionID
extensionDecode :: MessageType -> ByteString -> Maybe a
extensionEncode :: a -> ByteString

Instances19Extension, …

Extension ApplicationLayerProtocolNegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Extension CertificateAuthoritiesDefined in tls-2.1.6 · Network.TLS.Extension
Extension CookieDefined in tls-2.1.6 · Network.TLS.Extension
Extension EarlyDataIndicationDefined in tls-2.1.6 · Network.TLS.Extension
Extension EcPointFormatsSupportedDefined in tls-2.1.6 · Network.TLS.Extension
Extension ExtendedMainSecretDefined in tls-2.1.6 · Network.TLS.Extension
Extension HeartBeatDefined in tls-2.1.6 · Network.TLS.Extension
Extension KeyShareDefined in tls-2.1.6 · Network.TLS.Extension
Extension MaxFragmentLengthDefined in tls-2.1.6 · Network.TLS.Extension
Extension PostHandshakeAuthDefined in tls-2.1.6 · Network.TLS.Extension
Extension PreSharedKeyDefined in tls-2.1.6 · Network.TLS.Extension
Extension PskKeyExchangeModesDefined in tls-2.1.6 · Network.TLS.Extension
Extension SecureRenegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Extension ServerNameDefined in tls-2.1.6 · Network.TLS.Extension
Extension SessionTicketDefined in tls-2.1.6 · Network.TLS.Extension
Extension SignatureAlgorithmsDefined in tls-2.1.6 · Network.TLS.Extension
Extension SignatureAlgorithmsCertDefined in tls-2.1.6 · Network.TLS.Extension
Extension SupportedGroupsDefined in tls-2.1.6 · Network.TLS.Extension
Extension SupportedVersionsDefined in tls-2.1.6 · Network.TLS.Extension

datadata ExtensionRaw

#

The raw content of a TLS extension.

Constructors

ExtensionRaw ExtensionID ByteString

Instances2Eq, Show

Eq ExtensionRawDefined in tls-2.1.6 · Network.TLS.Extension
Show ExtensionRawDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype ExtensionID

#

Identifier of a TLS extension. http://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.txt

Constructors

ExtensionID
- fromExtensionID :: Word16

Instances2Eq, Show

Eq ExtensionIDDefined in tls-2.1.6 · Network.TLS.Extension
Show ExtensionIDDefined in tls-2.1.6 · Network.TLS.Extension

patternpattern EID_QuicTransportParameters :: ExtensionID

#

patternpattern EID_ServerName :: ExtensionID

#

patternpattern EID_MaxFragmentLength :: ExtensionID

#

patternpattern EID_ClientCertificateUrl :: ExtensionID

#

patternpattern EID_TrustedCAKeys :: ExtensionID

#

patternpattern EID_TruncatedHMAC :: ExtensionID

#

patternpattern EID_StatusRequest :: ExtensionID

#

patternpattern EID_UserMapping :: ExtensionID

#

patternpattern EID_ClientAuthz :: ExtensionID

#

patternpattern EID_ServerAuthz :: ExtensionID

#

patternpattern EID_CertType :: ExtensionID

#

patternpattern EID_SupportedGroups :: ExtensionID

#

patternpattern EID_EcPointFormats :: ExtensionID

#

patternpattern EID_SRP :: ExtensionID

#

patternpattern EID_SignatureAlgorithms :: ExtensionID

#

patternpattern EID_SRTP :: ExtensionID

#

patternpattern EID_Heartbeat :: ExtensionID

#

patternpattern EID_ApplicationLayerProtocolNegotiation :: ExtensionID

#

patternpattern EID_StatusRequestv2 :: ExtensionID

#

patternpattern EID_SignedCertificateTimestamp :: ExtensionID

#

patternpattern EID_ClientCertificateType :: ExtensionID

#

patternpattern EID_ServerCertificateType :: ExtensionID

#

patternpattern EID_Padding :: ExtensionID

#

patternpattern EID_EncryptThenMAC :: ExtensionID

#

patternpattern EID_ExtendedMainSecret :: ExtensionID

#

patternpattern EID_SessionTicket :: ExtensionID

#

patternpattern EID_PreSharedKey :: ExtensionID

#

patternpattern EID_EarlyData :: ExtensionID

#

patternpattern EID_SupportedVersions :: ExtensionID

#

patternpattern EID_Cookie :: ExtensionID

#

patternpattern EID_PskKeyExchangeModes :: ExtensionID

#

patternpattern EID_CertificateAuthorities :: ExtensionID

#

patternpattern EID_OidFilters :: ExtensionID

#

patternpattern EID_PostHandshakeAuth :: ExtensionID

#

patternpattern EID_SignatureAlgorithmsCert :: ExtensionID

#

patternpattern EID_KeyShare :: ExtensionID

#

patternpattern EID_SecureRenegotiation :: ExtensionID

#

valuedefinedExtensions :: [ExtensionID]

#

valuesupportedExtensions :: [ExtensionID]

#

all supported extensions by the implementation

valuetoExtensionRaw :: Extension e => e -> ExtensionRaw

#

valueextensionLookup :: ExtensionID -> [ExtensionRaw] -> Maybe ByteString

#

valuelookupAndDecode

:: Extension e
=> ExtensionID
-> MessageType
-> [ExtensionRaw]
-> a
-> e -> a
-> a

#

valuelookupAndDecodeAndDo

:: Extension a
=> ExtensionID
-> MessageType
-> [ExtensionRaw]
-> IO b
-> a -> IO b
-> IO b

#

datadata ServerNameType

#

Constructors

ServerNameHostName HostName
ServerNameOther (Word8, ByteString)

Instances2Eq, Show

Eq ServerNameTypeDefined in tls-2.1.6 · Network.TLS.Extension
Show ServerNameTypeDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype ServerName

#

Server Name extension including the name type and the associated name. the associated name decoding is dependant of its name type. name type = 0 : hostname

Constructors

ServerName [ServerNameType]

Instances3Eq, Show, Extension

Eq ServerNameDefined in tls-2.1.6 · Network.TLS.Extension
Show ServerNameDefined in tls-2.1.6 · Network.TLS.Extension
Extension ServerNameDefined in tls-2.1.6 · Network.TLS.Extension

datadata MaxFragmentLength

#

Max fragment extension with length from 512 bytes to 4096 bytes

RFC 6066 defines: If a server receives a maximum fragment length negotiation request for a value other than the allowed values, it MUST abort the handshake with an "illegal_parameter" alert.

So, if a server receives MaxFragmentLengthOther, it must send the alert.

Constructors

MaxFragmentLength MaxFragmentEnum
MaxFragmentLengthOther Word8

Instances3Eq, Show, Extension

Eq MaxFragmentLengthDefined in tls-2.1.6 · Network.TLS.Extension
Show MaxFragmentLengthDefined in tls-2.1.6 · Network.TLS.Extension
Extension MaxFragmentLengthDefined in tls-2.1.6 · Network.TLS.Extension

datadata SecureRenegotiation

#

Secure Renegotiation

Constructors

SecureRenegotiation ByteString ByteString

Instances3Eq, Show, Extension

Eq SecureRenegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Show SecureRenegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Extension SecureRenegotiationDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype ApplicationLayerProtocolNegotiation

#

Application Layer Protocol Negotiation (ALPN)

Constructors

ApplicationLayerProtocolNegotiation [ByteString]

Instances3Eq, Show, Extension

Eq ApplicationLayerProtocolNegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Show ApplicationLayerProtocolNegotiationDefined in tls-2.1.6 · Network.TLS.Extension
Extension ApplicationLayerProtocolNegotiationDefined in tls-2.1.6 · Network.TLS.Extension

datadata ExtendedMainSecret

#

Extended Main Secret

ExtendedMainSecret

Instances3Eq, Show, Extension

Eq ExtendedMainSecretDefined in tls-2.1.6 · Network.TLS.Extension
Show ExtendedMainSecretDefined in tls-2.1.6 · Network.TLS.Extension
Extension ExtendedMainSecretDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype SupportedGroups

#

Constructors

SupportedGroups [Group]

Instances3Eq, Show, Extension

Eq SupportedGroupsDefined in tls-2.1.6 · Network.TLS.Extension
Show SupportedGroupsDefined in tls-2.1.6 · Network.TLS.Extension
Extension SupportedGroupsDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype EcPointFormatsSupported

#

Constructors

EcPointFormatsSupported [EcPointFormat]

Instances3Eq, Show, Extension

Eq EcPointFormatsSupportedDefined in tls-2.1.6 · Network.TLS.Extension
Show EcPointFormatsSupportedDefined in tls-2.1.6 · Network.TLS.Extension
Extension EcPointFormatsSupportedDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype EcPointFormat

#

Constructors

EcPointFormat
- fromEcPointFormat :: Word8

Instances2Eq, Show

Eq EcPointFormatDefined in tls-2.1.6 · Network.TLS.Extension
Show EcPointFormatDefined in tls-2.1.6 · Network.TLS.Extension

patternpattern EcPointFormat_Uncompressed :: EcPointFormat

#

patternpattern EcPointFormat_AnsiX962_compressed_prime :: EcPointFormat

#

patternpattern EcPointFormat_AnsiX962_compressed_char2 :: EcPointFormat

#

newtypenewtype SessionTicket

#

Constructors

SessionTicket Ticket

Instances3Eq, Show, Extension

Eq SessionTicketDefined in tls-2.1.6 · Network.TLS.Extension
Show SessionTicketDefined in tls-2.1.6 · Network.TLS.Extension
Extension SessionTicketDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype HeartBeat

#

Constructors

HeartBeat HeartBeatMode

Instances3Eq, Show, Extension

Eq HeartBeatDefined in tls-2.1.6 · Network.TLS.Extension
Show HeartBeatDefined in tls-2.1.6 · Network.TLS.Extension
Extension HeartBeatDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype HeartBeatMode

#

Constructors

HeartBeatMode
- fromHeartBeatMode :: Word8

Instances2Eq, Show

Eq HeartBeatModeDefined in tls-2.1.6 · Network.TLS.Extension
Show HeartBeatModeDefined in tls-2.1.6 · Network.TLS.Extension

patternpattern HeartBeat_PeerAllowedToSend :: HeartBeatMode

#

patternpattern HeartBeat_PeerNotAllowedToSend :: HeartBeatMode

#

newtypenewtype SignatureAlgorithms

#

Constructors

SignatureAlgorithms [HashAndSignatureAlgorithm]

Instances3Eq, Show, Extension

Eq SignatureAlgorithmsDefined in tls-2.1.6 · Network.TLS.Extension
Show SignatureAlgorithmsDefined in tls-2.1.6 · Network.TLS.Extension
Extension SignatureAlgorithmsDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype SignatureAlgorithmsCert

#

Constructors

SignatureAlgorithmsCert [HashAndSignatureAlgorithm]

Instances3Eq, Show, Extension

Eq SignatureAlgorithmsCertDefined in tls-2.1.6 · Network.TLS.Extension
Show SignatureAlgorithmsCertDefined in tls-2.1.6 · Network.TLS.Extension
Extension SignatureAlgorithmsCertDefined in tls-2.1.6 · Network.TLS.Extension

datadata SupportedVersions

#

Constructors

SupportedVersionsClientHello [Version]
SupportedVersionsServerHello Version

Instances3Eq, Show, Extension

Eq SupportedVersionsDefined in tls-2.1.6 · Network.TLS.Extension
Show SupportedVersionsDefined in tls-2.1.6 · Network.TLS.Extension
Extension SupportedVersionsDefined in tls-2.1.6 · Network.TLS.Extension

datadata KeyShare

#

Constructors

KeyShareClientHello [KeyShareEntry]
KeyShareServerHello KeyShareEntry
KeyShareHRR Group

Instances3Eq, Show, Extension

Eq KeyShareDefined in tls-2.1.6 · Network.TLS.Extension
Show KeyShareDefined in tls-2.1.6 · Network.TLS.Extension
Extension KeyShareDefined in tls-2.1.6 · Network.TLS.Extension

datadata KeyShareEntry

#

Constructors

KeyShareEntry
- keyShareEntryGroup :: Group
- keyShareEntryKeyExchange :: ByteString

Instances2Eq, Show

Eq KeyShareEntryDefined in tls-2.1.6 · Network.TLS.Extension
Show KeyShareEntryDefined in tls-2.1.6 · Network.TLS.Extension

datadata MessageType

#

MsgTClientHello MsgTServerHello MsgTHelloRetryRequest MsgTEncryptedExtensions MsgTNewSessionTicket MsgTCertificateRequest

Instances2Eq, Show

Eq MessageTypeDefined in tls-2.1.6 · Network.TLS.Extension
Show MessageTypeDefined in tls-2.1.6 · Network.TLS.Extension

datadata PostHandshakeAuth

#

PostHandshakeAuth

Instances3Eq, Show, Extension

Eq PostHandshakeAuthDefined in tls-2.1.6 · Network.TLS.Extension
Show PostHandshakeAuthDefined in tls-2.1.6 · Network.TLS.Extension
Extension PostHandshakeAuthDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype PskKexMode

#

Constructors

PskKexMode
- fromPskKexMode :: Word8

Instances2Eq, Show

Eq PskKexModeDefined in tls-2.1.6 · Network.TLS.Extension
Show PskKexModeDefined in tls-2.1.6 · Network.TLS.Extension

patternpattern PSK_KE :: PskKexMode

#

patternpattern PSK_DHE_KE :: PskKexMode

#

newtypenewtype PskKeyExchangeModes

#

Constructors

PskKeyExchangeModes [PskKexMode]

Instances3Eq, Show, Extension

Eq PskKeyExchangeModesDefined in tls-2.1.6 · Network.TLS.Extension
Show PskKeyExchangeModesDefined in tls-2.1.6 · Network.TLS.Extension
Extension PskKeyExchangeModesDefined in tls-2.1.6 · Network.TLS.Extension

datadata PskIdentity

#

Constructors

PskIdentity ByteString Word32

Instances2Eq, Show

Eq PskIdentityDefined in tls-2.1.6 · Network.TLS.Extension
Show PskIdentityDefined in tls-2.1.6 · Network.TLS.Extension

datadata PreSharedKey

#

Constructors

PreSharedKeyClientHello [PskIdentity] [ByteString]
PreSharedKeyServerHello Int

Instances3Eq, Show, Extension

Eq PreSharedKeyDefined in tls-2.1.6 · Network.TLS.Extension
Show PreSharedKeyDefined in tls-2.1.6 · Network.TLS.Extension
Extension PreSharedKeyDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype EarlyDataIndication

#

Constructors

EarlyDataIndication (Maybe Word32)

Instances3Eq, Show, Extension

Eq EarlyDataIndicationDefined in tls-2.1.6 · Network.TLS.Extension
Show EarlyDataIndicationDefined in tls-2.1.6 · Network.TLS.Extension
Extension EarlyDataIndicationDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype Cookie

#

Constructors

Cookie ByteString

newtypenewtype CertificateAuthorities

#

Constructors

CertificateAuthorities [DistinguishedName]

Instances3Eq, Show, Extension

Eq CertificateAuthoritiesDefined in tls-2.1.6 · Network.TLS.Extension
Show CertificateAuthoritiesDefined in tls-2.1.6 · Network.TLS.Extension
Extension CertificateAuthoritiesDefined in tls-2.1.6 · Network.TLS.Extension

valuegetSession :: Get Session

#

valuegetBinaryVersion :: Get Version

#

valuegetDNames :: Get [DistinguishedName]

#

Decode a list CA distinguished names

valuegetSignatureHashAlgorithm :: Get HashAndSignatureAlgorithm

#

valueputBinaryVersion :: Version -> Put

#

valueputDNames :: [DistinguishedName] -> Put

#

Encode a list of distinguished names.

valueputSignatureHashAlgorithm :: HashAndSignatureAlgorithm -> Put

#

valuegetExtensions :: Int -> Get [ExtensionRaw]

#

valueencodeSignedDHParams

:: ServerDHParams
-> ClientRandom
-> ServerRandom
-> ByteString

#

valueencodeSignedECDHParams

:: ServerECDHParams
-> ClientRandom
-> ServerRandom
-> ByteString

#

datadata CurrentParams

#

Constructors

CurrentParams
- cParamsVersion :: Version
  current protocol version
- cParamsKeyXchgType :: Maybe CipherKeyExchangeType
  current key exchange type

Instances2Eq, Show

Eq CurrentParamsDefined in tls-2.1.6 · Network.TLS.Packet
Show CurrentParamsDefined in tls-2.1.6 · Network.TLS.Packet

valuedecodeHeader :: ByteString -> Either TLSError Header

#

valueencodeHeader :: Header -> ByteString

#

valuedecodeAlert :: Get (AlertLevel, AlertDescription)

#

valuedecodeAlerts

:: ByteString
-> Either TLSError [(AlertLevel, AlertDescription)]

#

valueencodeAlerts :: [(AlertLevel, AlertDescription)] -> ByteString

#

valuedecodeHandshakeRecord :: ByteString -> GetResult (HandshakeType, ByteString)

#

valuedecodeHandshake

:: CurrentParams
-> HandshakeType
-> ByteString
-> Either TLSError Handshake

#

valueencodeHandshake :: Handshake -> ByteString

#

valueencodeCertificate :: CertificateChain -> ByteString

#

valuedecodeChangeCipherSpec :: ByteString -> Either TLSError ()

#

valueencodeChangeCipherSpec :: ByteString

#

valuedecodePreMainSecret :: ByteString -> Either TLSError (Version, ByteString)

#

valueencodePreMainSecret :: Version -> ByteString -> ByteString

#

valuedecodeReallyServerKeyXchgAlgorithmData

:: Version
-> CipherKeyExchangeType
-> ByteString
-> Either TLSError ServerKeyXchgAlgorithmData

#

in certain cases, we haven't manage to decode ServerKeyExchange properly, because the decoding was too eager and the cipher wasn't been set yet. we keep the Server Key Exchange in it unparsed format, and this function is able to really decode the server key xchange if it's unparsed.

valuegenerateMainSecret

:: ByteArrayAccess preMain
=> Version
-> Cipher
-> preMain
-> ClientRandom
-> ServerRandom
-> ByteString

#

valuegenerateExtendedMainSecret

:: ByteArrayAccess preMain
=> Version
-> Cipher
-> preMain
-> ByteString
-> ByteString

#

valuegenerateKeyBlock

:: Version
-> Cipher
-> ClientRandom
-> ServerRandom
-> ByteString
-> Int
-> ByteString

#

valuegenerateClientFinished

:: Version
-> Cipher
-> ByteString
-> HashCtx
-> ByteString

#

valuegenerateServerFinished

:: Version
-> Cipher
-> ByteString
-> HashCtx
-> ByteString

#

valuegetClientRandom32 :: Get ClientRandom

#

valueputClientRandom32 :: ClientRandom -> Put

#

valuegetServerRandom32 :: Get ServerRandom

#

valueputServerRandom32 :: ServerRandom -> Put

#

valueputExtension :: ExtensionRaw -> Put

#

valueputSession :: Session -> Put

#

valuegetHandshakeType :: Get HandshakeType

#

valueencodeHandshake13 :: Handshake13 -> ByteString

#

valuedecodeHandshakeRecord13

:: ByteString
-> GetResult (HandshakeType, ByteString)

#

valuedecodeHandshake13

:: HandshakeType
-> ByteString
-> Either TLSError Handshake13

#

valuedecodeHandshakes13 :: MonadError TLSError m => ByteString -> m [Handshake13]

#

valueencodeCertificate13

:: CertReqContext
-> CertificateChain
-> [[ExtensionRaw]]
-> ByteString

#

valueprocessPacket :: Context -> Record Plaintext -> IO (Either TLSError Packet)

#

valueprocessPacket13

:: Context
-> Record Plaintext
-> IO (Either TLSError Packet13)

#

valueencodePacket12

:: Monoid bytes
=> Context
-> RecordLayer bytes
-> Packet
-> IO (Either TLSError bytes)

#

encodePacket transform a packet into marshalled data related to current state and updating state on the go

valueencodePacket13

:: Monoid bytes
=> Context
-> RecordLayer bytes
-> Packet13
-> IO (Either TLSError bytes)

#

valueupdateHandshake12 :: Context -> Handshake -> IO ByteString

#

valueupdateHandshake13 :: Context -> Handshake13 -> IO ByteString

#

typetype SessionID = ByteString

#

A session ID

datadata SessionData

#

Session data to resume

Constructors

SessionData
- sessionVersion :: Version
- sessionCipher :: CipherID
- sessionCompression :: CompressionID
- sessionClientSNI :: Maybe HostName
- sessionSecret :: ByteString
- sessionGroup :: Maybe Group
- sessionTicketInfo :: Maybe TLS13TicketInfo
- sessionALPN :: Maybe ByteString
- sessionMaxEarlyDataSize :: Int
- sessionFlags :: [SessionFlag]

Instances5Eq, Show, Generic, Serialise, Rep

Eq SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Show SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Generic SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Serialise SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
type Rep SessionData = D1 ('MetaData "SessionData" "Network.TLS.Types.Session" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'False) (C1 ('MetaCons "SessionData" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sessionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Version) :*: S1 ('MetaSel ('Just "sessionCipher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 CipherID)) :*: (S1 ('MetaSel ('Just "sessionCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 CompressionID) :*: (S1 ('MetaSel ('Just "sessionClientSNI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostName)) :*: S1 ('MetaSel ('Just "sessionSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))) :*: ((S1 ('MetaSel ('Just "sessionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "sessionTicketInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TLS13TicketInfo))) :*: (S1 ('MetaSel ('Just "sessionALPN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: (S1 ('MetaSel ('Just "sessionMaxEarlyDataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "sessionFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SessionFlag]))))))Defined in tls-2.1.6 · Network.TLS.Types.Session

newtypenewtype Version

#

Versions known to TLS

Constructors

Version Word16

Instances6Eq, Ord, Show, Generic, Serialise, Rep

Eq VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Ord VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Show VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Generic VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Serialise VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
type Rep Version = D1 ('MetaData "Version" "Network.TLS.Types.Version" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'True) (C1 ('MetaCons "Version" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in tls-2.1.6 · Network.TLS.Types.Version

patternpattern TLS12 :: Version

#

patternpattern TLS13 :: Version

#

patternpattern SSL2 :: Version

#

patternpattern SSL3 :: Version

#

patternpattern TLS10 :: Version

#

patternpattern TLS11 :: Version

#

typetype HashAndSignatureAlgorithm = (HashAlgorithm, SignatureAlgorithm)

#

valuesupportedSignatureSchemes :: [HashAndSignatureAlgorithm]

#

newtypenewtype HashAlgorithm

#

Constructors

HashAlgorithm
- fromHashAlgorithm :: Word8

Instances2Eq, Show

Eq HashAlgorithmDefined in tls-2.1.6 · Network.TLS.HashAndSignature
Show HashAlgorithmDefined in tls-2.1.6 · Network.TLS.HashAndSignature

patternpattern HashNone :: HashAlgorithm

#

patternpattern HashMD5 :: HashAlgorithm

#

patternpattern HashSHA1 :: HashAlgorithm

#

patternpattern HashSHA224 :: HashAlgorithm

#

patternpattern HashSHA256 :: HashAlgorithm

#

patternpattern HashSHA384 :: HashAlgorithm

#

patternpattern HashSHA512 :: HashAlgorithm

#

patternpattern HashIntrinsic :: HashAlgorithm

#

newtypenewtype SignatureAlgorithm

#

Constructors

SignatureAlgorithm
- fromSignatureAlgorithm :: Word8

Instances2Eq, Show

Eq SignatureAlgorithmDefined in tls-2.1.6 · Network.TLS.HashAndSignature
Show SignatureAlgorithmDefined in tls-2.1.6 · Network.TLS.HashAndSignature

patternpattern SignatureAnonymous :: SignatureAlgorithm

#

patternpattern SignatureRSA :: SignatureAlgorithm

#

patternpattern SignatureDSA :: SignatureAlgorithm

#

patternpattern SignatureECDSA :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA256 :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA384 :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA512 :: SignatureAlgorithm

#

patternpattern SignatureEd25519 :: SignatureAlgorithm

#

patternpattern SignatureEd448 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA256 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA384 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA512 :: SignatureAlgorithm

#

newtypenewtype CertificateType

#

Some of the IANA registered code points for CertificateType are not currently supported by the library. Nor should they be, they're are either unwise, obsolete or both. There's no point in conveying these to the user in the client certificate request callback. The request callback will be filtered to exclude unsupported values. If the user cannot find a certificate for a supported code point, we'll go ahead without a client certificate and hope for the best, unless the user's callback decides to throw an exception.

Constructors

CertificateType
- fromCertificateType :: Word8

Instances3Eq, Ord, Show

Eq CertificateTypeDefined in tls-2.1.6 · Network.TLS.Struct
Ord CertificateTypeDefined in tls-2.1.6 · Network.TLS.Struct
Show CertificateTypeDefined in tls-2.1.6 · Network.TLS.Struct

patternpattern CertificateType_RSA_Sign :: CertificateType

#

TLS10 and up, RFC5246

patternpattern CertificateType_DSA_Sign :: CertificateType

#

TLS10 and up, RFC5246

patternpattern CertificateType_ECDSA_Sign :: CertificateType

#

TLS10 and up, RFC8422

patternpattern CertificateType_Ed25519_Sign :: CertificateType

#

patternpattern CertificateType_Ed448_Sign :: CertificateType

#

newtypenewtype ClientRandom

#

Constructors

ClientRandom
- unClientRandom :: ByteString

Instances2Eq, Show

Eq ClientRandomDefined in tls-2.1.6 · Network.TLS.Struct
Show ClientRandomDefined in tls-2.1.6 · Network.TLS.Struct

newtypenewtype ServerRandom

#

Constructors

ServerRandom
- unServerRandom :: ByteString

Instances2Eq, Show

Eq ServerRandomDefined in tls-2.1.6 · Network.TLS.Struct
Show ServerRandomDefined in tls-2.1.6 · Network.TLS.Struct

datadata Handshake

#

Constructors

ClientHello Version ClientRandom [CompressionID] CH
ServerHello Version ServerRandom Session CipherId CompressionID [ExtensionRaw]
Certificate TLSCertificateChain
HelloRequest
ServerHelloDone
ClientKeyXchg ClientKeyXchgAlgorithmData
ServerKeyXchg ServerKeyXchgAlgorithmData
CertRequest [CertificateType] [HashAndSignatureAlgorithm] [DistinguishedName]
CertVerify DigitallySigned
Finished VerifyData
NewSessionTicket Second Ticket

Instances2Eq, Show

Eq HandshakeDefined in tls-2.1.6 · Network.TLS.Struct
Show HandshakeDefined in tls-2.1.6 · Network.TLS.Struct

datadata Packet

#

Constructors

Handshake [Handshake]
Alert [(AlertLevel, AlertDescription)]
ChangeCipherSpec
AppData ByteString

Instances2Eq, Show

Eq PacketDefined in tls-2.1.6 · Network.TLS.Struct
Show PacketDefined in tls-2.1.6 · Network.TLS.Struct

datadata Header

#

Constructors

Header ProtocolType Version Word16

newtypenewtype ProtocolType

#

Constructors

ProtocolType
- fromProtocolType :: Word8

Instances2Eq, Show

Eq ProtocolTypeDefined in tls-2.1.6 · Network.TLS.Struct
Show ProtocolTypeDefined in tls-2.1.6 · Network.TLS.Struct

patternpattern ProtocolType_ChangeCipherSpec :: ProtocolType

#

patternpattern ProtocolType_Alert :: ProtocolType

#

patternpattern ProtocolType_Handshake :: ProtocolType

#

patternpattern ProtocolType_AppData :: ProtocolType

#

datadata TLSError

#

TLSError that might be returned through the TLS stack.

Prior to version 1.8.0, this type had an Exception instance. In version 1.8.0, this instance was removed, and functions in this library now only throw TLSException.

Constructors

Error_Misc String
mainly for instance of Error
Error_Protocol String AlertDescription
A fatal error condition was encountered at a low level. The elements of the tuple give (freeform text description, structured error description).
Error_Protocol_Warning String AlertDescription
A non-fatal error condition was encountered at a low level at a low level. The elements of the tuple give (freeform text description, structured error description).
Error_Certificate String
Error_HandshakePolicy String
handshake policy failed.
Error_EOF
Error_Packet String
Error_Packet_unexpected String String
Error_Packet_Parsing String
Error_TCP_Terminate

Instances4Eq, Show, MonadError

Eq TLSErrorDefined in tls-2.1.6 · Network.TLS.Error
Show TLSErrorDefined in tls-2.1.6 · Network.TLS.Error
MonadError TLSError RecordMDefined in tls-2.1.6 · Network.TLS.Record.State
MonadError TLSError TLSStDefined in tls-2.1.6 · Network.TLS.State

newtypenewtype AlertDescription

#

Constructors

AlertDescription
- fromAlertDescription :: Word8

Instances2Eq, Show

Eq AlertDescriptionDefined in tls-2.1.6 · Network.TLS.Error
Show AlertDescriptionDefined in tls-2.1.6 · Network.TLS.Error

patternpattern CloseNotify :: AlertDescription

#

patternpattern UnexpectedMessage :: AlertDescription

#

patternpattern BadRecordMac :: AlertDescription

#

patternpattern DecryptionFailed :: AlertDescription

#

patternpattern RecordOverflow :: AlertDescription

#

patternpattern DecompressionFailure :: AlertDescription

#

patternpattern HandshakeFailure :: AlertDescription

#

patternpattern BadCertificate :: AlertDescription

#

patternpattern UnsupportedCertificate :: AlertDescription

#

patternpattern CertificateRevoked :: AlertDescription

#

patternpattern CertificateExpired :: AlertDescription

#

patternpattern CertificateUnknown :: AlertDescription

#

patternpattern IllegalParameter :: AlertDescription

#

patternpattern UnknownCa :: AlertDescription

#

patternpattern AccessDenied :: AlertDescription

#

patternpattern DecodeError :: AlertDescription

#

patternpattern DecryptError :: AlertDescription

#

patternpattern ExportRestriction :: AlertDescription

#

patternpattern ProtocolVersion :: AlertDescription

#

patternpattern InsufficientSecurity :: AlertDescription

#

patternpattern InternalError :: AlertDescription

#

patternpattern InappropriateFallback :: AlertDescription

#

patternpattern UserCanceled :: AlertDescription

#

patternpattern NoRenegotiation :: AlertDescription

#

patternpattern MissingExtension :: AlertDescription

#

patternpattern UnsupportedExtension :: AlertDescription

#

patternpattern CertificateUnobtainable :: AlertDescription

#

patternpattern UnrecognizedName :: AlertDescription

#

patternpattern BadCertificateStatusResponse :: AlertDescription

#

patternpattern BadCertificateHashValue :: AlertDescription

#

patternpattern UnknownPskIdentity :: AlertDescription

#

patternpattern CertificateRequired :: AlertDescription

#

patternpattern NoApplicationProtocol :: AlertDescription

#

datadata TLSException

#

TLS Exceptions. Some of the data constructors indicate incorrect use of the library, and the documentation for those data constructors calls this out. The others wrap TLSError with some kind of context to explain when the exception occurred.

Constructors

Terminated Bool String TLSError
Early termination exception with the reason and the error associated
HandshakeFailed TLSError
Handshake failed for the reason attached.
PostHandshake TLSError
Failure occurred while sending or receiving data after the TLS handshake succeeded.
Uncontextualized TLSError
Lifts a TLSError into TLSException without provided any context around when the error happened.
ConnectionNotEstablished
Usage error when the connection has not been established and the user is trying to send or receive data. Indicates that this library has been used incorrectly.
MissingHandshake
Expected that a TLS handshake had already taken place, but no TLS handshake had occurred. Indicates that this library has been used incorrectly.

Instances3Eq, Show, Exception

Eq TLSExceptionDefined in tls-2.1.6 · Network.TLS.Error
Show TLSExceptionDefined in tls-2.1.6 · Network.TLS.Error
Exception TLSExceptionDefined in tls-2.1.6 · Network.TLS.Error

newtypenewtype Session

#

Constructors

Session (Maybe SessionID)

Instances2Eq, Show

Eq SessionDefined in tls-2.1.6 · Network.TLS.Struct
Show SessionDefined in tls-2.1.6 · Network.TLS.Struct

datadata ExtensionRaw

#

The raw content of a TLS extension.

Constructors

ExtensionRaw ExtensionID ByteString

Instances2Eq, Show

Eq ExtensionRawDefined in tls-2.1.6 · Network.TLS.Extension
Show ExtensionRawDefined in tls-2.1.6 · Network.TLS.Extension

newtypenewtype ExtensionID

#

Identifier of a TLS extension. http://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.txt

Constructors

ExtensionID
- fromExtensionID :: Word16

Instances2Eq, Show

Eq ExtensionIDDefined in tls-2.1.6 · Network.TLS.Extension
Show ExtensionIDDefined in tls-2.1.6 · Network.TLS.Extension

datadata CipherData

#

Constructors

CipherData
- cipherDataContent :: ByteString
- cipherDataMAC :: Maybe ByteString
- cipherDataPadding :: Maybe (ByteString, Int)

Instances2Eq, Show

Eq CipherDataDefined in tls-2.1.6 · Network.TLS.Struct
Show CipherDataDefined in tls-2.1.6 · Network.TLS.Struct

valuelastSupportedCertificateType :: CertificateType

#

Last supported certificate type, no 'CertificateType that compares greater than this one (based on the Ord instance, not on the wire code point) will be reported to the application via the client certificate request callback.

datadata DigitallySigned

#

Constructors

DigitallySigned HashAndSignatureAlgorithm Signature

Instances2Eq, Show

Eq DigitallySignedDefined in tls-2.1.6 · Network.TLS.Struct
Show DigitallySignedDefined in tls-2.1.6 · Network.TLS.Struct

typetype Signature = ByteString

#

newtypenewtype DistinguishedName

#

A list of OID and strings.

Instances6Eq, Ord, Show, Semigroup, Monoid, ASN1Object

Eq DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName
Ord DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName
Show DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName
Semigroup DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName
Monoid DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName
ASN1Object DistinguishedNameDefined in crypton-x509-1.7.7 · Data.X509.DistinguishedName

datadata ServerDHParams

#

Constructors

ServerDHParams
- serverDHParams_p :: BigNum
- serverDHParams_g :: BigNum
- serverDHParams_y :: BigNum

Instances2Eq, Show

Eq ServerDHParamsDefined in tls-2.1.6 · Network.TLS.Struct
Show ServerDHParamsDefined in tls-2.1.6 · Network.TLS.Struct

valueserverDHParamsToParams :: ServerDHParams -> DHParams

#

valueserverDHParamsToPublic :: ServerDHParams -> DHPublic

#

valueserverDHParamsFrom :: DHParams -> DHPublic -> ServerDHParams

#

datadata ServerECDHParams

#

Constructors

ServerECDHParams Group GroupPublic

Instances2Eq, Show

Eq ServerECDHParamsDefined in tls-2.1.6 · Network.TLS.Struct
Show ServerECDHParamsDefined in tls-2.1.6 · Network.TLS.Struct

datadata ServerRSAParams

#

Constructors

ServerRSAParams
- rsa_modulus :: Integer
- rsa_exponent :: Integer

Instances2Eq, Show

Eq ServerRSAParamsDefined in tls-2.1.6 · Network.TLS.Struct
Show ServerRSAParamsDefined in tls-2.1.6 · Network.TLS.Struct

datadata ServerKeyXchgAlgorithmData

#

Constructors

SKX_DH_Anon ServerDHParams
SKX_DHE_DSA ServerDHParams DigitallySigned
SKX_DHE_RSA ServerDHParams DigitallySigned
SKX_ECDHE_RSA ServerECDHParams DigitallySigned
SKX_ECDHE_ECDSA ServerECDHParams DigitallySigned
SKX_RSA (Maybe ServerRSAParams)
SKX_DH_DSA (Maybe ServerDSAParams)
SKX_DH_RSA (Maybe ServerRSAParams)
SKX_Unparsed ByteString
SKX_Unknown ByteString

Instances2Eq, Show

Eq ServerKeyXchgAlgorithmDataDefined in tls-2.1.6 · Network.TLS.Struct
Show ServerKeyXchgAlgorithmDataDefined in tls-2.1.6 · Network.TLS.Struct

datadata ClientKeyXchgAlgorithmData

#

Constructors

CKX_RSA ByteString
CKX_DH DHPublic
CKX_ECDH ByteString

Instances2Eq, Show

Eq ClientKeyXchgAlgorithmDataDefined in tls-2.1.6 · Network.TLS.Struct
Show ClientKeyXchgAlgorithmDataDefined in tls-2.1.6 · Network.TLS.Struct

typetype FinishedData = ByteString

#

Deprecated. use VerifyData

newtypenewtype VerifyData

#

Constructors

VerifyData ByteString

Instances2Eq, Show

Eq VerifyDataDefined in tls-2.1.6 · Network.TLS.Struct
Show VerifyDataDefined in tls-2.1.6 · Network.TLS.Struct

newtypenewtype AlertLevel

#

Constructors

AlertLevel
- fromAlertLevel :: Word8

Instances2Eq, Show

Eq AlertLevelDefined in tls-2.1.6 · Network.TLS.Error
Show AlertLevelDefined in tls-2.1.6 · Network.TLS.Error

patternpattern AlertLevel_Warning :: AlertLevel

#

patternpattern AlertLevel_Fatal :: AlertLevel

#

newtypenewtype HandshakeType

#

Constructors

HandshakeType
- fromHandshakeType :: Word8

Instances2Eq, Show

Eq HandshakeTypeDefined in tls-2.1.6 · Network.TLS.Struct
Show HandshakeTypeDefined in tls-2.1.6 · Network.TLS.Struct

patternpattern HandshakeType_HelloRequest :: HandshakeType

#

patternpattern HandshakeType_ClientHello :: HandshakeType

#

patternpattern HandshakeType_ServerHello :: HandshakeType

#

patternpattern HandshakeType_NewSessionTicket :: HandshakeType

#

patternpattern HandshakeType_EndOfEarlyData :: HandshakeType

#

patternpattern HandshakeType_EncryptedExtensions :: HandshakeType

#

patternpattern HandshakeType_Certificate :: HandshakeType

#

patternpattern HandshakeType_ServerKeyXchg :: HandshakeType

#

patternpattern HandshakeType_CertRequest :: HandshakeType

#

patternpattern HandshakeType_ServerHelloDone :: HandshakeType

#

patternpattern HandshakeType_CertVerify :: HandshakeType

#

patternpattern HandshakeType_ClientKeyXchg :: HandshakeType

#

patternpattern HandshakeType_Finished :: HandshakeType

#

patternpattern HandshakeType_KeyUpdate :: HandshakeType

#

newtypenewtype TLSCertificateChain

#

Constructors

TLSCertificateChain CertificateChain

Instances2Eq, Show

Eq TLSCertificateChainDefined in tls-2.1.6 · Network.TLS.Struct
Show TLSCertificateChainDefined in tls-2.1.6 · Network.TLS.Struct

datadata CH

#

Constructors

CH
- chSession :: Session
- chCiphers :: [CipherId]
- chExtensions :: [ExtensionRaw]

Instances2Eq, Show

Eq CHDefined in tls-2.1.6 · Network.TLS.Struct
Show CHDefined in tls-2.1.6 · Network.TLS.Struct

valuepacketType :: Packet -> ProtocolType

#

valuetypeOfHandshake :: Handshake -> HandshakeType

#

datadata Handshake13

#

Constructors

ServerHello13 ServerRandom Session CipherId [ExtensionRaw]
NewSessionTicket13 Second Word32 TicketNonce SessionIDorTicket [ExtensionRaw]
EndOfEarlyData13
EncryptedExtensions13 [ExtensionRaw]
CertRequest13 CertReqContext [ExtensionRaw]
Certificate13 CertReqContext TLSCertificateChain [[ExtensionRaw]]
CertVerify13 DigitallySigned
Finished13 VerifyData
KeyUpdate13 KeyUpdate

Instances2Eq, Show

Eq Handshake13Defined in tls-2.1.6 · Network.TLS.Struct13
Show Handshake13Defined in tls-2.1.6 · Network.TLS.Struct13

datadata Packet13

#

Constructors

Handshake13 [Handshake13]
Alert13 [(AlertLevel, AlertDescription)]
ChangeCipherSpec13
AppData13 ByteString

Instances2Eq, Show

Eq Packet13Defined in tls-2.1.6 · Network.TLS.Struct13
Show Packet13Defined in tls-2.1.6 · Network.TLS.Struct13

valuetypeOfHandshake13 :: Handshake13 -> HandshakeType

#

valuecontentType :: Packet13 -> ProtocolType

#

datadata KeyUpdate

#

UpdateNotRequested UpdateRequested

Instances2Eq, Show

Eq KeyUpdateDefined in tls-2.1.6 · Network.TLS.Struct13
Show KeyUpdateDefined in tls-2.1.6 · Network.TLS.Struct13

typetype CertReqContext = ByteString

#

Certificate request context for TLS 1.3.

typetype SessionID = ByteString

#

A session ID

typetype SessionIDorTicket = ByteString

#

Identity

typetype Ticket = ByteString

#

Encrypted session ticket (encrypt(encode SessionData)).

datadata SessionData

#

Session data to resume

Constructors

SessionData
- sessionVersion :: Version
- sessionCipher :: CipherID
- sessionCompression :: CompressionID
- sessionClientSNI :: Maybe HostName
- sessionSecret :: ByteString
- sessionGroup :: Maybe Group
- sessionTicketInfo :: Maybe TLS13TicketInfo
- sessionALPN :: Maybe ByteString
- sessionMaxEarlyDataSize :: Int
- sessionFlags :: [SessionFlag]

Instances5Eq, Show, Generic, Serialise, Rep

Eq SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Show SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Generic SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
Serialise SessionDataDefined in tls-2.1.6 · Network.TLS.Types.Session
type Rep SessionData = D1 ('MetaData "SessionData" "Network.TLS.Types.Session" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'False) (C1 ('MetaCons "SessionData" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sessionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Version) :*: S1 ('MetaSel ('Just "sessionCipher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 CipherID)) :*: (S1 ('MetaSel ('Just "sessionCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 CompressionID) :*: (S1 ('MetaSel ('Just "sessionClientSNI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostName)) :*: S1 ('MetaSel ('Just "sessionSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))) :*: ((S1 ('MetaSel ('Just "sessionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "sessionTicketInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TLS13TicketInfo))) :*: (S1 ('MetaSel ('Just "sessionALPN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: (S1 ('MetaSel ('Just "sessionMaxEarlyDataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "sessionFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SessionFlag]))))))Defined in tls-2.1.6 · Network.TLS.Types.Session

datadata SessionFlag

#

Some session flags

Constructors

SessionEMS
Session created with Extended Main Secret

Instances6Enum, Eq, Show, Generic, Serialise, Rep

Enum SessionFlagDefined in tls-2.1.6 · Network.TLS.Types.Session
Eq SessionFlagDefined in tls-2.1.6 · Network.TLS.Types.Session
Show SessionFlagDefined in tls-2.1.6 · Network.TLS.Types.Session
Generic SessionFlagDefined in tls-2.1.6 · Network.TLS.Types.Session
Serialise SessionFlagDefined in tls-2.1.6 · Network.TLS.Types.Session
type Rep SessionFlag = D1 ('MetaData "SessionFlag" "Network.TLS.Types.Session" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'False) (C1 ('MetaCons "SessionEMS" 'PrefixI 'False) U1)Defined in tls-2.1.6 · Network.TLS.Types.Session

datadata TLS13TicketInfo

#

Constructors

TLS13TicketInfo
- lifetime :: Second
- ageAdd :: Second
- txrxTime :: Millisecond
- estimatedRTT :: Maybe Millisecond

Instances5Eq, Show, Generic, Serialise, Rep

Eq TLS13TicketInfoDefined in tls-2.1.6 · Network.TLS.Types.Session
Show TLS13TicketInfoDefined in tls-2.1.6 · Network.TLS.Types.Session
Generic TLS13TicketInfoDefined in tls-2.1.6 · Network.TLS.Types.Session
Serialise TLS13TicketInfoDefined in tls-2.1.6 · Network.TLS.Types.Session
type Rep TLS13TicketInfo = D1 ('MetaData "TLS13TicketInfo" "Network.TLS.Types.Session" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'False) (C1 ('MetaCons "TLS13TicketInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lifetime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Second) :*: S1 ('MetaSel ('Just "ageAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Second)) :*: (S1 ('MetaSel ('Just "txrxTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Millisecond) :*: S1 ('MetaSel ('Just "estimatedRTT") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Millisecond)))))Defined in tls-2.1.6 · Network.TLS.Types.Session

valueis0RTTPossible :: SessionData -> Bool

#

newtypenewtype Version

#

Versions known to TLS

Constructors

Version Word16

Instances6Eq, Ord, Show, Generic, Serialise, Rep

Eq VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Ord VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Show VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Generic VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
Serialise VersionDefined in tls-2.1.6 · Network.TLS.Types.Version
type Rep Version = D1 ('MetaData "Version" "Network.TLS.Types.Version" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'True) (C1 ('MetaCons "Version" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in tls-2.1.6 · Network.TLS.Types.Version

patternpattern TLS12 :: Version

#

patternpattern TLS13 :: Version

#

patternpattern SSL2 :: Version

#

patternpattern SSL3 :: Version

#

patternpattern TLS10 :: Version

#

patternpattern TLS11 :: Version

#

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 CompressionID = Word8

#

Compression identification

datadata Cipher

#

Cipher algorithm

Constructors

Cipher
- cipherID :: CipherID
- cipherName :: String
- cipherHash :: Hash
- cipherBulk :: Bulk
- cipherKeyExchange :: CipherKeyExchangeType
- cipherMinVer :: Maybe Version
- cipherPRFHash :: Maybe Hash

Instances2Eq, Show

Eq CipherDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Show CipherDefined in tls-2.1.6 · Network.TLS.Types.Cipher

datadata CipherKeyExchangeType

#

CipherKeyExchange_RSA CipherKeyExchange_DH_Anon CipherKeyExchange_DHE_RSA CipherKeyExchange_ECDHE_RSA CipherKeyExchange_DHE_DSA CipherKeyExchange_DH_DSA CipherKeyExchange_DH_RSA CipherKeyExchange_ECDH_ECDSA CipherKeyExchange_ECDH_RSA CipherKeyExchange_ECDHE_ECDSA CipherKeyExchange_TLS13

Instances2Eq, Show

Eq CipherKeyExchangeTypeDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Show CipherKeyExchangeTypeDefined in tls-2.1.6 · Network.TLS.Types.Cipher

datadata Bulk

#

Constructors

Bulk
- bulkName :: String
- bulkKeySize :: Int
- bulkIVSize :: Int
- bulkExplicitIV :: Int
- bulkAuthTagLen :: Int
- bulkBlockSize :: Int
- bulkF :: BulkFunctions

Instances2Eq, Show

Eq BulkDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Show BulkDefined in tls-2.1.6 · Network.TLS.Types.Cipher

datadata BulkFunctions

#

Constructors

BulkBlockF (BulkDirection -> BulkKey -> BulkBlock)
BulkStreamF (BulkDirection -> BulkKey -> BulkStream)
BulkAeadF (BulkDirection -> BulkKey -> BulkAEAD)

datadata BulkDirection

#

BulkEncrypt BulkDecrypt

Instances2Eq, Show

Eq BulkDirectionDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Show BulkDirectionDefined in tls-2.1.6 · Network.TLS.Types.Cipher

newtypenewtype BulkStream

#

Constructors

BulkStream (ByteString -> (ByteString, BulkStream))

typetype BulkBlock = BulkIV -> ByteString -> (ByteString, BulkIV)

#

typetype BulkAEAD = BulkNonce -> ByteString -> BulkAdditionalData -> (ByteString, AuthTag)

#

typetype CipherID = Word16

#

Cipher identification

typetype BulkKey = ByteString

#

typetype BulkIV = ByteString

#

typetype BulkNonce = ByteString

#

typetype BulkAdditionalData = ByteString

#

datadata EarlySecret

#

Phantom type indicating early traffic secret.

Instances2HasCryptLevel, LogLabel

HasCryptLevel EarlySecretDefined in tls-2.1.6 · Network.TLS.Record.State
LogLabel (ClientTrafficSecret EarlySecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key

datadata HandshakeSecret

#

Phantom type indicating handshake traffic secrets.

Instances3HasCryptLevel, LogLabel

HasCryptLevel HandshakeSecretDefined in tls-2.1.6 · Network.TLS.Record.State
LogLabel (ClientTrafficSecret HandshakeSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
LogLabel (ServerTrafficSecret HandshakeSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key

datadata ApplicationSecret

#

Phantom type indicating application traffic secrets.

Instances3HasCryptLevel, LogLabel

HasCryptLevel ApplicationSecretDefined in tls-2.1.6 · Network.TLS.Record.State
LogLabel (ClientTrafficSecret ApplicationSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
LogLabel (ServerTrafficSecret ApplicationSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key

typetype TrafficSecrets a = (ClientTrafficSecret a, ServerTrafficSecret a)

#

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

newtypenewtype ServerTrafficSecret a

#

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

Constructors

ServerTrafficSecret ByteString

Instances4Show, LogLabel, TrafficSecret

Show (ServerTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Types.Secret
LogLabel (ServerTrafficSecret ApplicationSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
LogLabel (ServerTrafficSecret HandshakeSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
HasCryptLevel a => TrafficSecret (ServerTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Handshake.State13

newtypenewtype ClientTrafficSecret a

#

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

Constructors

ClientTrafficSecret ByteString

Instances5Show, LogLabel, TrafficSecret

Show (ClientTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Types.Secret
LogLabel (ClientTrafficSecret ApplicationSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
LogLabel (ClientTrafficSecret EarlySecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
LogLabel (ClientTrafficSecret HandshakeSecret)Defined in tls-2.1.6 · Network.TLS.Handshake.Key
HasCryptLevel a => TrafficSecret (ClientTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Handshake.State13

newtypenewtype AnyTrafficSecret a

#

Constructors

AnyTrafficSecret ByteString

Instances2Show, TrafficSecret

Show (AnyTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Types.Secret
HasCryptLevel a => TrafficSecret (AnyTrafficSecret a)Defined in tls-2.1.6 · Network.TLS.Handshake.State13

datadata Role

#

Role

ClientRole ServerRole

Instances2Eq, Show

Eq RoleDefined in tls-2.1.6 · Network.TLS.Types
Show RoleDefined in tls-2.1.6 · Network.TLS.Types

newtypenewtype CipherId

#

Constructors

CipherId
- fromCipherId :: Word16

Instances10Enum, Eq, Integral, Num, Ord, Read, …

Enum CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Eq CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Integral CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Num CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Ord CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Read CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Real CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Show CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
Generic CipherIdDefined in tls-2.1.6 · Network.TLS.Types.Cipher
type Rep CipherId = D1 ('MetaData "CipherId" "Network.TLS.Types.Cipher" "tls-2.1.6-3TrFPbgFIalLKNEHCldmNu" 'True) (C1 ('MetaCons "CipherId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCipherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in tls-2.1.6 · Network.TLS.Types.Cipher

valueinvertRole :: Role -> Role

#

datadata Direction

#

Direction

Tx Rx

Instances2Eq, Show

Eq DirectionDefined in tls-2.1.6 · Network.TLS.Types
Show DirectionDefined in tls-2.1.6 · Network.TLS.Types

newtypenewtype BigNum

#

Constructors

BigNum ByteString

Instances2Eq, Show

Eq BigNumDefined in tls-2.1.6 · Network.TLS.Types
Show BigNumDefined in tls-2.1.6 · Network.TLS.Types

valuebigNumToInteger :: BigNum -> Integer

#

valuebigNumFromInteger :: Integer -> BigNum

#

datadata ResumptionSecret

#

newtypenewtype BaseSecret a

#

Constructors

BaseSecret ByteString

Instances1Show

Show (BaseSecret a)Defined in tls-2.1.6 · Network.TLS.Types.Secret

datadata SecretTriple a

#

Constructors

SecretTriple
- triBase :: BaseSecret a
- triClient :: ClientTrafficSecret a
- triServer :: ServerTrafficSecret a

Instances1Show

Show (SecretTriple a)Defined in tls-2.1.6 · Network.TLS.Types.Secret

datadata SecretPair a

#

Constructors

SecretPair
- pairBase :: BaseSecret a
- pairClient :: ClientTrafficSecret a

newtypenewtype MainSecret

#

Constructors

MainSecret ByteString

Instances2Show, LogLabel

Show MainSecretDefined in tls-2.1.6 · Network.TLS.Types.Secret
LogLabel MainSecretDefined in tls-2.1.6 · Network.TLS.Handshake.Key

valueglobalCipherDict :: IORef [Cipher]

#

valueisTicket :: SessionIDorTicket -> Bool

#

valuetoSessionID :: Ticket -> SessionID

#

typetype Second = Word32

#

typetype Millisecond = Word64

#

typetype GetContinuation a = ByteString -> GetResult a

#

newtypenewtype Get a

#

The Get monad is an Exception and State monad.

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Functor GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
MonadFail GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Applicative GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
Alternative GetDefined in cereal-0.5.8.3 · Data.Serialize.Get
MonadPlus GetDefined in cereal-0.5.8.3 · Data.Serialize.Get

datadata GetResult a

#

Constructors

GotError TLSError
GotPartial (GetContinuation a)
GotSuccess a
GotSuccessRemaining a ByteString

valuerunGet :: String -> Get a -> ByteString -> GetResult a

#

valuerunGetErr :: String -> Get a -> ByteString -> Either TLSError a

#

valuerunGetMaybe :: Get a -> ByteString -> Maybe a

#

valuetryGet :: Get a -> ByteString -> Maybe a

#

valueremaining :: Get Int

#

Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed.

WARNING: when run with runGetPartial, remaining will only return the number of bytes that are remaining in the current input.

valuegetWord8 :: Get Word8

#

Read a Word8 from the monad state

valuegetWords8 :: Get [Word8]

#

valuegetWord16 :: Get Word16

#

valuegetWords16 :: Get [Word16]

#

valuegetWord24 :: Get Int

#

valuegetWord32 :: Get Word32

#

valuegetWord64 :: Get Word64

#

valuegetBytes :: Int -> Get ByteString

#

Pull n bytes from the input, as a strict ByteString.

valuegetOpaque8 :: Get ByteString

#

valuegetOpaque16 :: Get ByteString

#

valuegetOpaque24 :: Get ByteString

#

valuegetInteger16 :: Get Integer

#

valuegetBigNum16 :: Get BigNum

#

valuegetList :: Int -> Get (Int, a) -> Get [a]

#

valueprocessBytes :: Int -> Get a -> Get a

#

valueisEmpty :: Get Bool

#

Test whether all input has been consumed.

WARNING: when run with runGetPartial, isEmpty will only tell you if you're at the end of the current chunk.

typetype Put = PutM ()

#

Put merely lifts Builder into a Writer monad, applied to ().

valuerunPut :: Put -> ByteString

#

Run the Put monad with a serialiser

valueputWord8 :: Putter Word8

#

Efficiently write a byte into the output buffer

valueputWords8 :: [Word8] -> Put

#

valueputWord16 :: Word16 -> Put

#

valueputWords16 :: [Word16] -> Put

#

valueputWord24 :: Int -> Put

#

valueputWord32 :: Word32 -> Put

#

valueputWord64 :: Word64 -> Put

#

valueputBytes :: ByteString -> Put

#

valueputOpaque8 :: ByteString -> Put

#

valueputOpaque16 :: ByteString -> Put

#

valueputOpaque24 :: ByteString -> Put

#

valueputInteger16 :: Integer -> Put

#

valueputBigNum16 :: BigNum -> Put

#

valueencodeWord16 :: Word16 -> ByteString

#

valueencodeWord32 :: Word32 -> ByteString

#

valueencodeWord64 :: Word64 -> ByteString

#

valuesendPacket12 :: Context -> Packet -> IO ()

#

Send one packet to the context

valuerecvPacket12 :: Context -> IO (Either TLSError Packet)

#

receive one packet from the context that contains 1 or many messages (many only in case of handshake). if will returns a TLSError if the packet is unexpected or malformed

valuemakeCipherShowPretty :: IO ()

#