Network.TLS.Internal · tls-2.4.9

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

patternpattern FFDHE2048 :: Group

#

patternpattern FFDHE3072 :: Group

#

patternpattern FFDHE4096 :: Group

#

patternpattern FFDHE6144 :: Group

#

patternpattern FFDHE8192 :: Group

#

patternpattern MLKEM1024 :: Group

#

patternpattern MLKEM512 :: Group

#

patternpattern MLKEM768 :: Group

#

patternpattern P256 :: Group

#

patternpattern P256MLKEM768 :: Group

#

patternpattern P384 :: Group

#

patternpattern P384MLKEM1024 :: Group

#

patternpattern P521 :: Group

#

patternpattern X25519 :: Group

#

patternpattern X25519MLKEM768 :: Group

#

patternpattern X448 :: Group

#

newtypenewtype ApplicationLayerProtocolNegotiation

#

Application Layer Protocol Negotiation (ALPN)

Constructors

ApplicationLayerProtocolNegotiation [ByteString]

Instances3Eq, Show, Extension

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

newtypenewtype CertificateAuthorities

#

Constructors

CertificateAuthorities [DistinguishedName]

Instances3Eq, Show, Extension

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

newtypenewtype CertificateCompressionAlgorithm

#

Constructors

CertificateCompressionAlgorithm Word16

Instances2Eq, Show

Eq CertificateCompressionAlgorithmDefined in tls-2.4.9 · Network.TLS.Extension
Show CertificateCompressionAlgorithmDefined in tls-2.4.9 · Network.TLS.Extension

patternpattern CCA_Brotli :: CertificateCompressionAlgorithm

#

patternpattern CCA_Zlib :: CertificateCompressionAlgorithm

#

patternpattern CCA_Zstd :: CertificateCompressionAlgorithm

#

newtypenewtype CompressCertificate

#

Constructors

CompressCertificate [CertificateCompressionAlgorithm]

Instances3Eq, Show, Extension

Eq CompressCertificateDefined in tls-2.4.9 · Network.TLS.Extension
Show CompressCertificateDefined in tls-2.4.9 · Network.TLS.Extension
Extension CompressCertificateDefined in tls-2.4.9 · Network.TLS.Extension

newtypenewtype Cookie

#

Constructors

Cookie ByteString

newtypenewtype EarlyDataIndication

#

Constructors

EarlyDataIndication (Maybe Word32)

Instances3Eq, Show, Extension

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

newtypenewtype EcPointFormat

#

Constructors

EcPointFormat
- fromEcPointFormat :: Word8

Instances2Eq, Show

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

patternpattern EcPointFormat_AnsiX962_compressed_char2 :: EcPointFormat

#

patternpattern EcPointFormat_AnsiX962_compressed_prime :: EcPointFormat

#

patternpattern EcPointFormat_Uncompressed :: EcPointFormat

#

newtypenewtype EcPointFormatsSupported

#

Constructors

EcPointFormatsSupported [EcPointFormat]

Instances3Eq, Show, Extension

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

newtypenewtype EchOuterExtensions

#

Constructors

EchOuterExtensions [ExtensionID]

Instances3Eq, Show, Extension

Eq EchOuterExtensionsDefined in tls-2.4.9 · Network.TLS.Extension
Show EchOuterExtensionsDefined in tls-2.4.9 · Network.TLS.Extension
Extension EchOuterExtensionsDefined in tls-2.4.9 · Network.TLS.Extension

datadata EncryptedClientHello

#

Encrypted Client Hello

Constructors

ECHClientHelloInner
ECHClientHelloOuter
- echCipherSuite :: (KDF_ID, AEAD_ID)
- echConfigId :: ConfigId
- echEnc :: EncodedPublicKey
- echPayload :: ByteString
ECHEncryptedExtensions ECHConfigList
ECHHelloRetryRequest ByteString

Instances3Eq, Show, Extension

Eq EncryptedClientHelloDefined in tls-2.4.9 · Network.TLS.Extension
Show EncryptedClientHelloDefined in tls-2.4.9 · Network.TLS.Extension
Extension EncryptedClientHelloDefined in tls-2.4.9 · Network.TLS.Extension

datadata ExtendedMainSecret

#

Extended Main Secret

ExtendedMainSecret

Instances3Eq, Show, Extension

Eq ExtendedMainSecretDefined in tls-2.4.9 · Network.TLS.Extension
Show ExtendedMainSecretDefined in tls-2.4.9 · Network.TLS.Extension
Extension ExtendedMainSecretDefined in tls-2.4.9 · 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
Decode an extension's body as it appears in the given message.
Nothing covers both ways this can fail to produce a value: a body that does not parse, and a message the extension is not defined in. Both reach the peer the same way, as the decode_error alert that lookupAndDecode and lookupAndDecodeAndDo raise, which is what either case warrants.
So the last clause of an instance is Nothing, never error: the message type is chosen by this library rather than by the peer, so an unhandled one would be our own bug -- and turning our bug into an ErrorCall thrown from pure code, out through the handshake and into the application, is a worse answer than dropping the one connection.
extensionEncode :: a -> ByteString

Instances23Extension, …

Extension ApplicationLayerProtocolNegotiationDefined in tls-2.4.9 · Network.TLS.Extension
Extension CertificateAuthoritiesDefined in tls-2.4.9 · Network.TLS.Extension
Extension CompressCertificateDefined in tls-2.4.9 · Network.TLS.Extension
Extension CookieDefined in tls-2.4.9 · Network.TLS.Extension
Extension EarlyDataIndicationDefined in tls-2.4.9 · Network.TLS.Extension
Extension EcPointFormatsSupportedDefined in tls-2.4.9 · Network.TLS.Extension
Extension EchOuterExtensionsDefined in tls-2.4.9 · Network.TLS.Extension
Extension EncryptedClientHelloDefined in tls-2.4.9 · Network.TLS.Extension
Extension ExtendedMainSecretDefined in tls-2.4.9 · Network.TLS.Extension
Extension HeartBeatDefined in tls-2.4.9 · Network.TLS.Extension
Extension KeyShareDefined in tls-2.4.9 · Network.TLS.Extension
Extension MaxFragmentLengthDefined in tls-2.4.9 · Network.TLS.Extension
Extension PostHandshakeAuthDefined in tls-2.4.9 · Network.TLS.Extension
Extension PreSharedKeyDefined in tls-2.4.9 · Network.TLS.Extension
Extension PskKeyExchangeModesDefined in tls-2.4.9 · Network.TLS.Extension
Extension RecordSizeLimitDefined in tls-2.4.9 · Network.TLS.Extension
Extension SecureRenegotiationDefined in tls-2.4.9 · Network.TLS.Extension
Extension ServerNameDefined in tls-2.4.9 · Network.TLS.Extension
Extension SessionTicketDefined in tls-2.4.9 · Network.TLS.Extension
Extension SignatureAlgorithmsDefined in tls-2.4.9 · Network.TLS.Extension
Extension SignatureAlgorithmsCertDefined in tls-2.4.9 · Network.TLS.Extension
Extension SupportedGroupsDefined in tls-2.4.9 · Network.TLS.Extension
Extension SupportedVersionsDefined in tls-2.4.9 · 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.4.9 · Network.TLS.Extension
Show ExtensionIDDefined in tls-2.4.9 · Network.TLS.Extension

patternpattern EID_ApplicationLayerProtocolNegotiation :: ExtensionID

#

patternpattern EID_CertType :: ExtensionID

#

patternpattern EID_CertificateAuthorities :: ExtensionID

#

patternpattern EID_ClientAuthz :: ExtensionID

#

patternpattern EID_ClientCertificateType :: ExtensionID

#

patternpattern EID_ClientCertificateUrl :: ExtensionID

#

patternpattern EID_CompressCertificate :: ExtensionID

#

patternpattern EID_Cookie :: ExtensionID

#

patternpattern EID_EarlyData :: ExtensionID

#

patternpattern EID_EcPointFormats :: ExtensionID

#

patternpattern EID_EchOuterExtensions :: ExtensionID

#

patternpattern EID_EncryptThenMAC :: ExtensionID

#

patternpattern EID_EncryptedClientHello :: ExtensionID

#

patternpattern EID_ExtendedMainSecret :: ExtensionID

#

patternpattern EID_Heartbeat :: ExtensionID

#

patternpattern EID_KeyShare :: ExtensionID

#

patternpattern EID_MaxFragmentLength :: ExtensionID

#

patternpattern EID_OidFilters :: ExtensionID

#

patternpattern EID_Padding :: ExtensionID

#

patternpattern EID_PostHandshakeAuth :: ExtensionID

#

patternpattern EID_PreSharedKey :: ExtensionID

#

patternpattern EID_PskKeyExchangeModes :: ExtensionID

#

patternpattern EID_QuicTransportParameters :: ExtensionID

#

patternpattern EID_RecordSizeLimit :: ExtensionID

#

patternpattern EID_SRP :: ExtensionID

#

patternpattern EID_SRTP :: ExtensionID

#

patternpattern EID_SecureRenegotiation :: ExtensionID

#

patternpattern EID_ServerAuthz :: ExtensionID

#

patternpattern EID_ServerCertificateType :: ExtensionID

#

patternpattern EID_ServerName :: ExtensionID

#

patternpattern EID_SessionTicket :: ExtensionID

#

patternpattern EID_SignatureAlgorithms :: ExtensionID

#

patternpattern EID_SignatureAlgorithmsCert :: ExtensionID

#

patternpattern EID_SignedCertificateTimestamp :: ExtensionID

#

patternpattern EID_StatusRequest :: ExtensionID

#

patternpattern EID_StatusRequestv2 :: ExtensionID

#

patternpattern EID_SupportedGroups :: ExtensionID

#

patternpattern EID_SupportedVersions :: ExtensionID

#

patternpattern EID_TruncatedHMAC :: ExtensionID

#

patternpattern EID_TrustedCAKeys :: ExtensionID

#

patternpattern EID_UserMapping :: ExtensionID

#

datadata ExtensionRaw

#

The raw content of a TLS extension.

Constructors

ExtensionRaw ExtensionID ByteString

Instances2Eq, Show

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

newtypenewtype HeartBeat

#

Constructors

HeartBeat HeartBeatMode

Instances3Eq, Show, Extension

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

newtypenewtype HeartBeatMode

#

Constructors

HeartBeatMode
- fromHeartBeatMode :: Word8

Instances2Eq, Show

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

patternpattern HeartBeat_PeerAllowedToSend :: HeartBeatMode

#

patternpattern HeartBeat_PeerNotAllowedToSend :: HeartBeatMode

#

datadata KeyShare

#

Constructors

KeyShareClientHello [KeyShareEntry]
KeyShareServerHello KeyShareEntry
KeyShareHRR Group

Instances3Eq, Show, Extension

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

datadata KeyShareEntry

#

Constructors

KeyShareEntry
- keyShareEntryGroup :: Group
- keyShareEntryKeyExchange :: ByteString

Instances2Eq, Show

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

datadata MaxFragmentEnum

#

MaxFragment512 MaxFragment1024 MaxFragment2048 MaxFragment4096

Instances2Eq, Show

Eq MaxFragmentEnumDefined in tls-2.4.9 · Network.TLS.Extension
Show MaxFragmentEnumDefined in tls-2.4.9 · 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.4.9 · Network.TLS.Extension
Show MaxFragmentLengthDefined in tls-2.4.9 · Network.TLS.Extension
Extension MaxFragmentLengthDefined in tls-2.4.9 · Network.TLS.Extension

datadata MessageType

#

MsgTClientHello MsgTServerHello MsgTHelloRetryRequest MsgTEncryptedExtensions MsgTNewSessionTicket MsgTCertificateRequest

Instances4Bounded, Enum, Eq, Show

Bounded MessageTypeDefined in tls-2.4.9 · Network.TLS.Extension
Enum MessageTypeDefined in tls-2.4.9 · Network.TLS.Extension
Eq MessageTypeDefined in tls-2.4.9 · Network.TLS.Extension
Show MessageTypeDefined in tls-2.4.9 · Network.TLS.Extension

datadata PostHandshakeAuth

#

PostHandshakeAuth

Instances3Eq, Show, Extension

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

datadata PreSharedKey

#

Constructors

PreSharedKeyClientHello [PskIdentity] [ByteString]
PreSharedKeyServerHello Int

Instances3Eq, Show, Extension

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

datadata PskIdentity

#

Constructors

PskIdentity ByteString Word32

Instances2Eq, Show

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

newtypenewtype PskKexMode

#

Constructors

PskKexMode
- fromPskKexMode :: Word8

Instances2Eq, Show

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

patternpattern PSK_DHE_KE :: PskKexMode

#

patternpattern PSK_KE :: PskKexMode

#

newtypenewtype PskKeyExchangeModes

#

Constructors

PskKeyExchangeModes [PskKexMode]

Instances3Eq, Show, Extension

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

newtypenewtype RecordSizeLimit

#

Constructors

RecordSizeLimit Word16

Instances3Eq, Show, Extension

Eq RecordSizeLimitDefined in tls-2.4.9 · Network.TLS.Extension
Show RecordSizeLimitDefined in tls-2.4.9 · Network.TLS.Extension
Extension RecordSizeLimitDefined in tls-2.4.9 · Network.TLS.Extension

datadata SecureRenegotiation

#

Secure Renegotiation

Constructors

SecureRenegotiation ByteString ByteString

Instances3Eq, Show, Extension

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

newtypenewtype ServerName

#

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

Constructors

ServerName [ServerNameType]

Instances3Eq, Show, Extension

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

datadata ServerNameType

#

Constructors

ServerNameHostName HostName
ServerNameOther (Word8, ByteString)

Instances2Eq, Show

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

newtypenewtype SessionTicket

#

Constructors

SessionTicket Ticket

Instances3Eq, Show, Extension

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

newtypenewtype SignatureAlgorithms

#

Constructors

SignatureAlgorithms [HashAndSignatureAlgorithm]

Instances3Eq, Show, Extension

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

newtypenewtype SignatureAlgorithmsCert

#

Constructors

SignatureAlgorithmsCert [HashAndSignatureAlgorithm]

Instances3Eq, Show, Extension

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

newtypenewtype SupportedGroups

#

Constructors

SupportedGroups [Group]

Instances3Eq, Show, Extension

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

datadata SupportedVersions

#

Constructors

SupportedVersionsClientHello [Version]
SupportedVersionsServerHello Version

Instances3Eq, Show, Extension

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

valuecheckChangeCipherSpec :: Fragment a -> Either TLSError ()

#

A ChangeCipherSpec is the single byte 1. RFC 8446 Section 5 answers any other value with unexpected_message, and TLS 1.2, which does not say, is answered the same way: a record of two of them included.

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

#

valuedecodePacket13

:: 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)

#

valueencodeUpdateTranscriptHash12 :: Context -> Handshake -> IO ByteString

#

valueencodeUpdateTranscriptHash13 :: Context -> Handshake13 -> IO ByteString

#

valueupdateTranscriptHash12 :: Context -> HandshakeR -> IO ()

#

valueupdateTranscriptHash13 :: Context -> Handshake13R -> IO ()

#

valuedecodeAlert :: Get (AlertLevel, AlertDescription)

#

valuedecodeAlerts

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

#

valuedecodeChangeCipherSpec :: ByteString -> Either TLSError ()

#

valuedecodeClientHello' :: ByteString -> Either TLSError Handshake

#

valuedecodeHandshake

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

#

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

#

valuedecodeHeader :: ByteString -> Either TLSError Header

#

valuedecodePreMainSecret :: ByteString -> Either TLSError (Version, 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.

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

#

valueencodeCertificate :: CertificateChain -> ByteString

#

valueencodeChangeCipherSpec :: ByteString

#

valueencodeHandshake :: Handshake -> ByteString

#

valueencodeHandshake' :: Handshake -> ByteString

#

valueencodeHeader :: Header -> ByteString

#

valueencodePreMainSecret :: Version -> ByteString -> ByteString

#

valueencodeSignedDHParams

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

#

valueencodeSignedECDHParams

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

#

valuegenerateExtendedMainSecret

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

#

valuegenerateKeyBlock

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

#

valuegenerateMainSecret

:: Version
-> Cipher
-> Secret
-> ClientRandom
-> ServerRandom
-> Secret

#

valuegetBinaryVersion :: Get Version

#

valuegetClientRandom32 :: Get ClientRandom

#

valuegetDNames :: Get [DistinguishedName]

#

Decode a list CA distinguished names

valuegetExtensions :: Int -> Get [ExtensionRaw]

#

valuegetHandshakeType :: Get HandshakeType

#

valuegetPRF :: Version -> Cipher -> PRF

#

The TLS12 PRF is cipher specific, and some TLS12 algorithms use SHA384 instead of the default SHA256.

valuegetServerRandom32 :: Get ServerRandom

#

valuegetSession :: Get Session

#

valuegetSignatureHashAlgorithm :: Get HashAndSignatureAlgorithm

#

valueputBinaryVersion :: Version -> Put

#

valueputClientRandom32 :: ClientRandom -> Put

#

valueputDNames :: [DistinguishedName] -> Put

#

Encode a list of distinguished names.

valueputExtension :: ExtensionRaw -> Put

#

valueputServerRandom32 :: ServerRandom -> Put

#

valueputSession :: Session -> Put

#

valueputSignatureHashAlgorithm :: HashAndSignatureAlgorithm -> Put

#

typetype PRF = Secret -> ByteString -> Int -> Secret

#

datadata CurrentParams

#

Constructors

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

Instances2Eq, Show

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

valuedecodeHandshake13

:: HandshakeType
-> ByteString
-> Either TLSError Handshake13

#

valuedecodeHandshakeRecord13

:: ByteString
-> GetResult (HandshakeType, ByteString)

#

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

#

valueencodeCertificate13

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

#

valueencodeHandshake13 :: Handshake13 -> ByteString

#

valuesignatureSchemesForTLS13 :: [(HashAlgorithm, SignatureAlgorithm)]

#

valuesupportedSignatureSchemes :: [HashAndSignatureAlgorithm]

#

valueemptyCertificateChain_ :: CertificateChain_

#

valuehrrRandom :: ServerRandom

#

valueisHelloRetryRequest :: ServerRandom -> Bool

#

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.

valuepacketType :: Packet -> ProtocolType

#

valueserverDHParamsFrom :: DHParams -> DHPublic -> ServerDHParams

#

valueserverDHParamsToParams :: ServerDHParams -> DHParams

#

valueserverDHParamsToPublic :: ServerDHParams -> DHPublic

#

valueshowCertificateChain :: CertificateChain -> String

#

valuetypeOfHandshake :: Handshake -> HandshakeType

#

newtypenewtype DistinguishedName

#

A list of OID and strings.

Instances6Eq, Ord, Show, Semigroup, Monoid, ASN1Object

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

newtypenewtype AlertDescription

#

Constructors

AlertDescription
- fromAlertDescription :: Word8

Instances2Eq, Show

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

patternpattern AccessDenied :: AlertDescription

#

patternpattern BadCertificate :: AlertDescription

#

patternpattern BadCertificateHashValue :: AlertDescription

#

patternpattern BadCertificateStatusResponse :: AlertDescription

#

patternpattern BadRecordMac :: AlertDescription

#

patternpattern CertificateExpired :: AlertDescription

#

patternpattern CertificateRequired :: AlertDescription

#

patternpattern CertificateRevoked :: AlertDescription

#

patternpattern CertificateUnknown :: AlertDescription

#

patternpattern CertificateUnobtainable :: AlertDescription

#

patternpattern CloseNotify :: AlertDescription

#

patternpattern DecodeError :: AlertDescription

#

patternpattern DecompressionFailure :: AlertDescription

#

patternpattern DecryptError :: AlertDescription

#

patternpattern DecryptionFailed :: AlertDescription

#

patternpattern ExportRestriction :: AlertDescription

#

patternpattern HandshakeFailure :: AlertDescription

#

patternpattern IllegalParameter :: AlertDescription

#

patternpattern InappropriateFallback :: AlertDescription

#

patternpattern InsufficientSecurity :: AlertDescription

#

patternpattern InternalError :: AlertDescription

#

patternpattern MissingExtension :: AlertDescription

#

patternpattern NoApplicationProtocol :: AlertDescription

#

patternpattern NoRenegotiation :: AlertDescription

#

patternpattern ProtocolVersion :: AlertDescription

#

patternpattern RecordOverflow :: AlertDescription

#

patternpattern UnexpectedMessage :: AlertDescription

#

patternpattern UnknownCa :: AlertDescription

#

patternpattern UnknownPskIdentity :: AlertDescription

#

patternpattern UnrecognizedName :: AlertDescription

#

patternpattern UnsupportedCertificate :: AlertDescription

#

patternpattern UnsupportedExtension :: AlertDescription

#

patternpattern UserCanceled :: AlertDescription

#

newtypenewtype AlertLevel

#

Constructors

AlertLevel
- fromAlertLevel :: Word8

Instances2Eq, Show

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

patternpattern AlertLevel_Fatal :: AlertLevel

#

patternpattern AlertLevel_Warning :: AlertLevel

#

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.4.9 · Network.TLS.Error
Show TLSErrorDefined in tls-2.4.9 · Network.TLS.Error
MonadError TLSError RecordMDefined in tls-2.4.9 · Network.TLS.Record.State
MonadError TLSError TLSStDefined in tls-2.4.9 · Network.TLS.State

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.4.9 · Network.TLS.Error
Show TLSExceptionDefined in tls-2.4.9 · Network.TLS.Error
Exception TLSExceptionDefined in tls-2.4.9 · Network.TLS.Error

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.4.9 · Network.TLS.Extension
Show ExtensionIDDefined in tls-2.4.9 · Network.TLS.Extension

datadata ExtensionRaw

#

The raw content of a TLS extension.

Constructors

ExtensionRaw ExtensionID ByteString

Instances2Eq, Show

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

newtypenewtype HashAlgorithm

#

Constructors

HashAlgorithm
- fromHashAlgorithm :: Word8

Instances2Eq, Show

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

patternpattern HashIntrinsic :: HashAlgorithm

#

patternpattern HashMD5 :: HashAlgorithm

#

patternpattern HashNone :: HashAlgorithm

#

patternpattern HashSHA1 :: HashAlgorithm

#

patternpattern HashSHA224 :: HashAlgorithm

#

patternpattern HashSHA256 :: HashAlgorithm

#

patternpattern HashSHA384 :: HashAlgorithm

#

patternpattern HashSHA512 :: HashAlgorithm

#

typetype HashAndSignatureAlgorithm = (HashAlgorithm, SignatureAlgorithm)

#

newtypenewtype SignatureAlgorithm

#

Constructors

SignatureAlgorithm
- fromSignatureAlgorithm :: Word8

Instances2Eq, Show

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

patternpattern SignatureAnonymous :: SignatureAlgorithm

#

patternpattern SignatureBrainpoolP256 :: SignatureAlgorithm

#

patternpattern SignatureBrainpoolP384 :: SignatureAlgorithm

#

patternpattern SignatureBrainpoolP512 :: SignatureAlgorithm

#

patternpattern SignatureDSA :: SignatureAlgorithm

#

patternpattern SignatureECDSA :: SignatureAlgorithm

#

patternpattern SignatureEd25519 :: SignatureAlgorithm

#

patternpattern SignatureEd448 :: SignatureAlgorithm

#

patternpattern SignatureRSA :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA256 :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA384 :: SignatureAlgorithm

#

patternpattern SignatureRSApssRSAeSHA512 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA256 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA384 :: SignatureAlgorithm

#

patternpattern SignatureRSApsspssSHA512 :: SignatureAlgorithm

#

newtypenewtype CertificateChain_

#

Constructors

CertificateChain_ CertificateChain

Instances2Eq, Show

Eq CertificateChain_Defined in tls-2.4.9 · Network.TLS.Struct
Show CertificateChain_Defined in tls-2.4.9 · Network.TLS.Struct

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.4.9 · Network.TLS.Struct
Ord CertificateTypeDefined in tls-2.4.9 · Network.TLS.Struct
Show CertificateTypeDefined in tls-2.4.9 · Network.TLS.Struct

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

#

patternpattern CertificateType_RSA_Sign :: CertificateType

#

TLS10 and up, RFC5246

datadata CipherData

#

Constructors

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

Instances2Eq, Show

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

datadata ClientHello

#

Constructors

CH
- chVersion :: Version
- chRandom :: ClientRandom
- chSession :: Session
- chCiphers :: [CipherId]
- chComps :: [CompressionID]
- chExtensions :: [ExtensionRaw]

Instances2Eq, Show

Eq ClientHelloDefined in tls-2.4.9 · Network.TLS.Struct
Show ClientHelloDefined in tls-2.4.9 · Network.TLS.Struct

datadata ClientKeyXchgAlgorithmData

#

Constructors

CKX_RSA ByteString
CKX_DH DHPublic
CKX_ECDH ByteString

Instances2Eq, Show

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

newtypenewtype ClientRandom

#

Constructors

ClientRandom
- unClientRandom :: ByteString

Instances2Eq, Show

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

datadata DigitallySigned

#

Constructors

DigitallySigned HashAndSignatureAlgorithm Signature

Instances2Eq, Show

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

typetype FinishedData = ByteString

#

Deprecated. use VerifyData

datadata Handshake

#

Constructors

ClientHello ClientHello
ServerHello ServerHello
Certificate CertificateChain_
HelloRequest
ServerHelloDone
ClientKeyXchg ClientKeyXchgAlgorithmData
ServerKeyXchg ServerKeyXchgAlgorithmData
CertRequest [CertificateType] [HashAndSignatureAlgorithm] [DistinguishedName]
CertVerify DigitallySigned
Finished VerifyData
NewSessionTicket Second Ticket

Instances2Eq, Show

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

typetype HandshakeR = (Handshake, WireBytes)

#

newtypenewtype HandshakeType

#

Constructors

HandshakeType
- fromHandshakeType :: Word8

Instances2Eq, Show

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

patternpattern HandshakeType_CertRequest :: HandshakeType

#

patternpattern HandshakeType_CertVerify :: HandshakeType

#

patternpattern HandshakeType_Certificate :: HandshakeType

#

patternpattern HandshakeType_ClientHello :: HandshakeType

#

patternpattern HandshakeType_ClientKeyXchg :: HandshakeType

#

patternpattern HandshakeType_CompressedCertificate :: HandshakeType

#

patternpattern HandshakeType_EncryptedExtensions :: HandshakeType

#

patternpattern HandshakeType_EndOfEarlyData :: HandshakeType

#

patternpattern HandshakeType_Finished :: HandshakeType

#

patternpattern HandshakeType_HelloRequest :: HandshakeType

#

patternpattern HandshakeType_KeyUpdate :: HandshakeType

#

patternpattern HandshakeType_NewSessionTicket :: HandshakeType

#

patternpattern HandshakeType_ServerHello :: HandshakeType

#

patternpattern HandshakeType_ServerHelloDone :: HandshakeType

#

patternpattern HandshakeType_ServerKeyXchg :: HandshakeType

#

datadata Header

#

Constructors

Header ProtocolType Version Word16

datadata Packet

#

Constructors

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

Instances2Eq, Show

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

newtypenewtype ProtocolType

#

Constructors

ProtocolType
- fromProtocolType :: Word8

Instances2Eq, Show

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

patternpattern ProtocolType_Alert :: ProtocolType

#

patternpattern ProtocolType_AppData :: ProtocolType

#

patternpattern ProtocolType_ChangeCipherSpec :: ProtocolType

#

patternpattern ProtocolType_Handshake :: ProtocolType

#

datadata ServerDHParams

#

Constructors

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

Instances2Eq, Show

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

datadata ServerECDHParams

#

Constructors

ServerECDHParams Group GroupPublicA

Instances2Eq, Show

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

datadata ServerHello

#

Constructors

SH
- shVersion :: Version
- shRandom :: ServerRandom
- shSession :: Session
- shCipher :: CipherId
- shComp :: CompressionID
- shExtensions :: [ExtensionRaw]

Instances2Eq, Show

Eq ServerHelloDefined in tls-2.4.9 · Network.TLS.Struct
Show ServerHelloDefined in tls-2.4.9 · 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.4.9 · Network.TLS.Struct
Show ServerKeyXchgAlgorithmDataDefined in tls-2.4.9 · Network.TLS.Struct

datadata ServerRSAParams

#

Constructors

ServerRSAParams
- rsa_modulus :: Integer
- rsa_exponent :: Integer

Instances2Eq, Show

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

newtypenewtype ServerRandom

#

Constructors

ServerRandom
- unServerRandom :: ByteString

Instances2Eq, Show

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

newtypenewtype Session

#

Constructors

Session (Maybe SessionID)

Instances2Eq, Show

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

typetype Signature = ByteString

#

newtypenewtype VerifyData

#

Constructors

VerifyData ByteString

Instances2Eq, Show

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

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]

Instances6Eq, Show, Generic, DebugShow, Serialise, Rep

Eq SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Show SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Everything but sessionSecret, which renders as <secret>: whoever has it can resume the session. debugShow renders it.
Generic SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
DebugShow SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Serialise SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
type Rep SessionData = D1 ('MetaData "SessionData" "Network.TLS.Types.Session" "tls-2.4.9-ByAGBT1JYRq7CxE2OAvacr" '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.4.9 · Network.TLS.Types.Session

typetype SessionID = ByteString

#

A session ID

newtypenewtype Version

#

Versions known to TLS

Constructors

Version Word16

Instances6Eq, Ord, Show, Generic, Serialise, Rep

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

patternpattern SSL2 :: Version

#

patternpattern SSL3 :: Version

#

patternpattern TLS10 :: Version

#

patternpattern TLS11 :: Version

#

patternpattern TLS12 :: Version

#

patternpattern TLS13 :: Version

#

valuecontentType :: Packet13 -> ProtocolType

#

valueisKeyUpdate13 :: Handshake13 -> Bool

#

valuetypeOfHandshake13 :: Handshake13 -> HandshakeType

#

typetype CertReqContext = ByteString

#

Certificate request context for TLS 1.3.

datadata Handshake13

#

Constructors

ServerHello13 ServerHello
NewSessionTicket13 Second Word32 TicketNonce SessionIDorTicket_ [ExtensionRaw]
EndOfEarlyData13
EncryptedExtensions13 [ExtensionRaw]
Certificate13 CertReqContext CertificateChain_ [[ExtensionRaw]]
CertRequest13 CertReqContext [ExtensionRaw]
CertVerify13 DigitallySigned
Finished13 VerifyData
KeyUpdate13 KeyUpdate
CompressedCertificate13 CertReqContext CertificateChain_ [[ExtensionRaw]]

Instances2Eq, Show

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

typetype Handshake13R = (Handshake13, WireBytes)

#

datadata KeyUpdate

#

UpdateNotRequested UpdateRequested

Instances2Eq, Show

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

datadata Packet13

#

Constructors

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

Instances2Eq, Show

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

newtypenewtype SessionIDorTicket_

#

Constructors

SessionIDorTicket_ ByteString

Instances2Eq, Show

Eq SessionIDorTicket_Defined in tls-2.4.9 · Network.TLS.Struct13
Show SessionIDorTicket_Defined in tls-2.4.9 · Network.TLS.Struct13

newtypenewtype TicketNonce

#

Constructors

TicketNonce ByteString

Instances2Eq, Show

Eq TicketNonceDefined in tls-2.4.9 · Network.TLS.Struct13
Show TicketNonceDefined in tls-2.4.9 · Network.TLS.Struct13

valuebigNumFromInteger :: Integer -> BigNum

#

valuebigNumToInteger :: BigNum -> Integer

#

valuedefaultRecordSizeLimit :: Int

#

valueinvertRole :: Role -> Role

#

valuemaxHandshakeSize :: Int

#

The largest handshake message we will reassemble.

A handshake message carries a 24-bit length, so a peer may announce close to 16MB and then feed it a record at a time. Records are bounded, but the message they are reassembled into was not, and the fragments are held until it is complete -- before anything has authenticated the peer.

The largest legitimate one is a Certificate message. A long chain of post-quantum certificates runs to tens of kilobytes, so this leaves an order of magnitude over anything real while taking two orders of magnitude off what a peer can ask us to hold.

valueglobalCipherDict :: IORef [Cipher]

#

valueis0RTTPossible :: SessionData -> Bool

#

valueisTicket :: SessionIDorTicket -> Bool

#

valueshowsSessionData :: ShowS -> Int -> SessionData -> ShowS

#

What the two instances above share, so that a field added to SessionData cannot reach one of them and not the other.

valuetoSessionID :: Ticket -> SessionID

#

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".

newtypenewtype BigNum

#

Constructors

BigNum ByteString

Instances2Eq, Show

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

datadata Direction

#

Direction

Tx Rx

Instances2Eq, Show

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

datadata Role

#

Role

ClientRole ServerRole

Instances2Eq, Show

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

newtypenewtype TranscriptHash

#

Constructors

TranscriptHash ByteString

Instances1Show

Show TranscriptHashDefined in tls-2.4.9 · Network.TLS.Types

typetype WireBytes = [ByteString]

#

typetype AddDat = ByteString

#

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.4.9 · Network.TLS.Types.Cipher
Show BulkDefined in tls-2.4.9 · Network.TLS.Types.Cipher

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

#

typetype BulkAdditionalData = ByteString

#

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

#

datadata BulkDirection

#

BulkEncrypt BulkDecrypt

Instances2Eq, Show

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

datadata BulkFunctions

#

Constructors

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

typetype BulkIV = Nonce

#

typetype BulkKey = Secret

#

typetype BulkNonce = Nonce

#

newtypenewtype BulkStream

#

Constructors

BulkStream (ByteString -> (ByteString, BulkStream))

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.4.9 · Network.TLS.Types.Cipher
Show CipherDefined in tls-2.4.9 · Network.TLS.Types.Cipher

typetype CipherID = Word16

#

Cipher identification

newtypenewtype CipherId

#

Constructors

CipherId
- fromCipherId :: Word16

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

Enum CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Eq CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Integral CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Num CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Ord CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Read CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Real CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Show CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
Generic CipherIdDefined in tls-2.4.9 · Network.TLS.Types.Cipher
type Rep CipherId = D1 ('MetaData "CipherId" "Network.TLS.Types.Cipher" "tls-2.4.9-ByAGBT1JYRq7CxE2OAvacr" 'True) (C1 ('MetaCons "CipherId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCipherId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in tls-2.4.9 · 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.4.9 · Network.TLS.Types.Cipher
Show CipherKeyExchangeTypeDefined in tls-2.4.9 · Network.TLS.Types.Cipher

typetype CipherText = ByteString

#

typetype IV = ByteString

#

typetype Key = ScrubbedBytes

#

typetype Nonce = ByteString

#

typetype PlainText = ByteString

#

typetype Secret = ScrubbedBytes

#

newtypenewtype AnyTrafficSecret a

#

Constructors

AnyTrafficSecret Secret

Instances3Show, DebugShow, TrafficSecret

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

datadata ApplicationSecret

#

Phantom type indicating application traffic secrets.

Instances3HasCryptLevel, LogLabel

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

newtypenewtype BaseSecret a

#

Constructors

BaseSecret Secret

Instances2Show, DebugShow

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

newtypenewtype ClientTrafficSecret a

#

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

Constructors

ClientTrafficSecret Secret

Instances6Show, DebugShow, LogLabel, TrafficSecret

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

datadata EarlySecret

#

Phantom type indicating early traffic secret.

Instances2HasCryptLevel, LogLabel

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

datadata HandshakeSecret

#

Phantom type indicating handshake traffic secrets.

Instances3HasCryptLevel, LogLabel

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

newtypenewtype MainSecret

#

Constructors

MainSecret Secret

Instances3Show, DebugShow, LogLabel

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

datadata ResumptionSecret

#

datadata SecretPair a

#

Constructors

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

Instances1Show

Show (SecretPair a)Defined in tls-2.4.9 · 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.4.9 · Network.TLS.Types.Secret

newtypenewtype ServerTrafficSecret a

#

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

Constructors

ServerTrafficSecret Secret

Instances5Show, DebugShow, LogLabel, TrafficSecret

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

typetype TrafficSecrets a = (ClientTrafficSecret a, ServerTrafficSecret a)

#

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

typetype CompressionID = Word8

#

Compression identification

typetype Millisecond = Word64

#

typetype Second = Word32

#

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]

Instances6Eq, Show, Generic, DebugShow, Serialise, Rep

Eq SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Show SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Everything but sessionSecret, which renders as <secret>: whoever has it can resume the session. debugShow renders it.
Generic SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
DebugShow SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
Serialise SessionDataDefined in tls-2.4.9 · Network.TLS.Types.Session
type Rep SessionData = D1 ('MetaData "SessionData" "Network.TLS.Types.Session" "tls-2.4.9-ByAGBT1JYRq7CxE2OAvacr" '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.4.9 · 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.4.9 · Network.TLS.Types.Session
Eq SessionFlagDefined in tls-2.4.9 · Network.TLS.Types.Session
Show SessionFlagDefined in tls-2.4.9 · Network.TLS.Types.Session
Generic SessionFlagDefined in tls-2.4.9 · Network.TLS.Types.Session
Serialise SessionFlagDefined in tls-2.4.9 · Network.TLS.Types.Session
type Rep SessionFlag = D1 ('MetaData "SessionFlag" "Network.TLS.Types.Session" "tls-2.4.9-ByAGBT1JYRq7CxE2OAvacr" 'False) (C1 ('MetaCons "SessionEMS" 'PrefixI 'False) U1)Defined in tls-2.4.9 · Network.TLS.Types.Session

typetype SessionID = ByteString

#

A session ID

typetype SessionIDorTicket = ByteString

#

Identity

datadata TLS13TicketInfo

#

Constructors

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

Instances5Eq, Show, Generic, Serialise, Rep

Eq TLS13TicketInfoDefined in tls-2.4.9 · Network.TLS.Types.Session
Show TLS13TicketInfoDefined in tls-2.4.9 · Network.TLS.Types.Session
Generic TLS13TicketInfoDefined in tls-2.4.9 · Network.TLS.Types.Session
Serialise TLS13TicketInfoDefined in tls-2.4.9 · Network.TLS.Types.Session
type Rep TLS13TicketInfo = D1 ('MetaData "TLS13TicketInfo" "Network.TLS.Types.Session" "tls-2.4.9-ByAGBT1JYRq7CxE2OAvacr" '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.4.9 · Network.TLS.Types.Session

typetype Ticket = ByteString

#

Encrypted session ticket (encrypt(encode SessionData)).

newtypenewtype Version

#

Versions known to TLS

Constructors

Version Word16

Instances6Eq, Ord, Show, Generic, Serialise, Rep

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

patternpattern SSL2 :: Version

#

patternpattern SSL3 :: Version

#

patternpattern TLS10 :: Version

#

patternpattern TLS11 :: Version

#

patternpattern TLS12 :: Version

#

patternpattern TLS13 :: Version

#

valuegetBytes :: Int -> Get ByteString

#

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

valuegetWord8 :: Get Word8

#

Read a Word8 from the monad state

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.

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.

valueputWord8 :: Putter Word8

#

Efficiently write a byte into the output buffer

valuerunPut :: Put -> ByteString

#

Run the Put monad with a serialiser

valueencodeWord16 :: Word16 -> ByteString

#

valueencodeWord32 :: Word32 -> ByteString

#

valueencodeWord64 :: Word64 -> ByteString

#

valuegetBigNum16 :: Get BigNum

#

valuegetInteger16 :: Get Integer

#

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

#

valuegetOpaque16 :: Get ByteString

#

valuegetOpaque24 :: Get ByteString

#

valuegetOpaque8 :: Get ByteString

#

valuegetWord16 :: Get Word16

#

valuegetWord24 :: Get Int

#

valuegetWord32 :: Get Word32

#

valuegetWord64 :: Get Word64

#

valuegetWords16 :: Get [Word16]

#

valuegetWords8 :: Get [Word8]

#

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

#

valueputBigNum16 :: BigNum -> Put

#

valueputBytes :: ByteString -> Put

#

valueputInteger16 :: Integer -> Put

#

valueputOpaque16 :: ByteString -> Put

#

valueputOpaque24 :: ByteString -> Put

#

valueputOpaque8 :: ByteString -> Put

#

valueputWord16 :: Word16 -> Put

#

valueputWord24 :: Int -> Put

#

valueputWord32 :: Word32 -> Put

#

valueputWord64 :: Word64 -> Put

#

valueputWords16 :: [Word16] -> Put

#

valueputWords8 :: [Word8] -> Put

#

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

#

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

typetype Put = PutM ()

#

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

typetype GetContinuation a = ByteString -> GetResult a

#

datadata GetResult a

#

Constructors

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

valuegetCertificate :: SignedCertificate -> Certificate

#

Get the Certificate associated to a SignedCertificate

valuevalidateDefault

:: CertificateStore
The trusted certificate store for CA
-> ValidationCache
the validation cache callbacks
-> ServiceID
identification of the connection
-> CertificateChain
the certificate chain we want to validate
-> IO [FailedReason]
the return failed reasons (empty list is no failure)

#

Validate using the default hooks and checks and the SHA256 mechanism as hashing mechanism

valuedefaultValidationCache :: ValidationCache

#

valueexceptionValidationCache :: [(ServiceID, Fingerprint)] -> ValidationCache

#

create a simple constant cache that list exceptions to the certification validation. Typically this is use to allow self-signed certificates for specific use, with out-of-bounds user checks.

No fingerprints will be added after the instance is created.

The underlying structure for the check is kept as a list, as usually the exception list will be short, but when the list go above a dozen exceptions it's recommended to use another cache mechanism with a faster lookup mechanism (hashtable, map, etc).

Note that only one fingerprint is allowed per ServiceID, for other use, another cache mechanism need to be use.

valuegetCertificateChainLeaf :: CertificateChain -> SignedExact Certificate

#

valueisNullCertificateChain :: CertificateChain -> Bool

#

valuepubkeyType :: PubKey -> String

#

valuevalidateClientCertificate

#

A utility function for client authentication which can be used onClientCertificate.

Since: 2.1.7

valuewrapCertificateChecks :: [FailedReason] -> CertificateUsage

#

typetype SignedCertificate = SignedExact Certificate

#

A Signed Certificate

valuecertExtensions :: Certificate -> Extensions

#

Extensions

valuecertIssuerDN :: Certificate -> DistinguishedName

#

Issuer DN

valuecertPubKey :: Certificate -> PubKey

#

Public key

valuecertSerial :: Certificate -> Integer

#

Serial number

valuecertSignatureAlg :: Certificate -> SignatureALG

#

Signature algorithm

valuecertSubjectDN :: Certificate -> DistinguishedName

#

Subject DN

valuecertValidity :: Certificate -> (DateTime, DateTime)

#

Validity period (UTC)

valuecertVersion :: Certificate -> Int

#

Version

newtypenewtype CertificateChain

#

A chain of X.509 certificates in exact form.

Constructors

CertificateChain [SignedExact Certificate]

Instances2Eq, Show

Eq CertificateChainDefined in crypton-x509-1.9.2 · Data.X509.CertificateChain
Show CertificateChainDefined in crypton-x509-1.9.2 · Data.X509.CertificateChain

datadata CertificateStore

#

A Collection of certificate or store of certificates.

Instances2Semigroup, Monoid

Semigroup CertificateStoreDefined in crypton-x509-store-1.9.0 · Data.X509.CertificateStore
Monoid CertificateStoreDefined in crypton-x509-store-1.9.0 · Data.X509.CertificateStore

datadata FailedReason

#

Possible reason of certificate and chain failure.

The values InvalidName and InvalidWildcard are internal-only and are never returned by the validation functions. NameMismatch is returned instead.

Instances2Eq, Show

Eq FailedReasonDefined in crypton-x509-validation-1.9.1 · Data.X509.Validation
Show FailedReasonDefined in crypton-x509-validation-1.9.1 · Data.X509.Validation

datadata ValidationCache

#

All the callbacks needed for querying and adding to the cache.

Instances1Default

Default ValidationCacheDefined in crypton-x509-validation-1.9.1 · Data.X509.Validation.Cache

typetype ServiceID = (HostName, ByteString)

#

identification of the connection consisting of the fully qualified host name (e.g. www.example.com) and an optional suffix.

The suffix is not used by the validation process, but is used by the optional cache to identity certificate per service on a specific host. For example, one might have a different certificate on 2 differents ports (443 and 995) for the same host.

for TCP connection, it's recommended to use: :port, or :service for the suffix.

datadata CertificateRejectReason

#

Certificate and Chain rejection reason

Constructors

Instances2Eq, Show

Eq CertificateRejectReasonDefined in tls-2.4.9 · Network.TLS.X509
Show CertificateRejectReasonDefined in tls-2.4.9 · Network.TLS.X509

datadata CertificateUsage

#

Certificate Usage callback possible returns values.

Constructors

CertificateUsageAccept
usage of certificate accepted
CertificateUsageReject CertificateRejectReason
usage of certificate rejected

Instances2Eq, Show

Eq CertificateUsageDefined in tls-2.4.9 · Network.TLS.X509
Show CertificateUsageDefined in tls-2.4.9 · Network.TLS.X509

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 ()

#