Safe Haskell | None |
---|---|
Language | Haskell2010 |
Network.TLS
Description
Native Haskell TLS protocol implementation for servers and clients.
This provides a high-level implementation of a sensitive security protocol, eliminating a common set of security issues through the use of the advanced type system, high level constructions and common Haskell features.
Currently implement the TLS1.2 and TLS 1.3 protocol, and support RSA and Ephemeral (Elliptic curve and regular) Diffie Hellman key exchanges, and many extensions.
The tipical usage is:
socket <- ... ctx <- contextNew socket <params> handshake ctx ... (using recvData and sendData) bye
Synopsis
- data Context
- contextNew :: (MonadIO m, HasBackend backend, TLSParams params) => backend -> params -> m Context
- handshake :: MonadIO m => Context -> m ()
- sendData :: MonadIO m => Context -> ByteString -> m ()
- recvData :: MonadIO m => Context -> m ByteString
- bye :: MonadIO m => Context -> m ()
- class HasBackend a where
- initializeBackend :: a -> IO ()
- getBackend :: a -> Backend
- data Backend = Backend {
- backendFlush :: IO ()
- backendClose :: IO ()
- backendSend :: ByteString -> IO ()
- backendRecv :: Int -> IO ByteString
- class TLSParams a
- data ClientParams
- defaultParamsClient :: HostName -> ByteString -> ClientParams
- clientServerIdentification :: ClientParams -> (HostName, ByteString)
- clientUseServerNameIndication :: ClientParams -> Bool
- clientWantSessionResume :: ClientParams -> Maybe (SessionID, SessionData)
- clientWantSessionResumeList :: ClientParams -> [(SessionID, SessionData)]
- clientShared :: ClientParams -> Shared
- clientHooks :: ClientParams -> ClientHooks
- clientSupported :: ClientParams -> Supported
- clientDebug :: ClientParams -> DebugParams
- clientLimit :: ClientParams -> Limit
- clientUseEarlyData :: ClientParams -> Bool
- data ServerParams
- defaultParamsServer :: ServerParams
- serverWantClientCert :: ServerParams -> Bool
- serverCACertificates :: ServerParams -> [SignedCertificate]
- serverDHEParams :: ServerParams -> Maybe DHParams
- serverHooks :: ServerParams -> ServerHooks
- serverShared :: ServerParams -> Shared
- serverSupported :: ServerParams -> Supported
- serverDebug :: ServerParams -> DebugParams
- serverLimit :: ServerParams -> Limit
- serverEarlyDataSize :: ServerParams -> Int
- serverTicketLifetime :: ServerParams -> Int
- data Shared
- defaultShared :: Shared
- sharedCredentials :: Shared -> Credentials
- sharedSessionManager :: Shared -> SessionManager
- sharedCAStore :: Shared -> CertificateStore
- sharedValidationCache :: Shared -> ValidationCache
- sharedHelloExtensions :: Shared -> [ExtensionRaw]
- data ClientHooks
- defaultClientHooks :: ClientHooks
- type OnCertificateRequest = ([CertificateType], Maybe [HashAndSignatureAlgorithm], [DistinguishedName]) -> IO (Maybe (CertificateChain, PrivKey))
- onCertificateRequest :: ClientHooks -> OnCertificateRequest
- type OnServerCertificate = CertificateStore -> ValidationCache -> ServiceID -> CertificateChain -> IO [FailedReason]
- onServerCertificate :: ClientHooks -> OnServerCertificate
- validateClientCertificate :: CertificateStore -> ValidationCache -> CertificateChain -> IO CertificateUsage
- onSuggestALPN :: ClientHooks -> IO (Maybe [ByteString])
- onCustomFFDHEGroup :: ClientHooks -> DHParams -> DHPublic -> IO GroupUsage
- onServerFinished :: ClientHooks -> Information -> IO ()
- data ServerHooks
- defaultServerHooks :: ServerHooks
- onClientCertificate :: ServerHooks -> CertificateChain -> IO CertificateUsage
- onUnverifiedClientCert :: ServerHooks -> IO Bool
- onCipherChoosing :: ServerHooks -> Version -> [Cipher] -> Cipher
- onServerNameIndication :: ServerHooks -> Maybe HostName -> IO Credentials
- onNewHandshake :: ServerHooks -> Measurement -> IO Bool
- onALPNClientSuggest :: ServerHooks -> Maybe ([ByteString] -> IO ByteString)
- onEncryptedExtensionsCreating :: ServerHooks -> [ExtensionRaw] -> IO [ExtensionRaw]
- data Measurement
- nbHandshakes :: Measurement -> Word32
- bytesReceived :: Measurement -> Word32
- bytesSent :: Measurement -> Word32
- data Supported
- defaultSupported :: Supported
- supportedVersions :: Supported -> [Version]
- supportedCiphers :: Supported -> [Cipher]
- supportedCompressions :: Supported -> [Compression]
- supportedHashSignatures :: Supported -> [HashAndSignatureAlgorithm]
- supportedSecureRenegotiation :: Supported -> Bool
- supportedClientInitiatedRenegotiation :: Supported -> Bool
- supportedExtendedMainSecret :: Supported -> EMSMode
- supportedSession :: Supported -> Bool
- supportedFallbackScsv :: Supported -> Bool
- supportedEmptyPacket :: Supported -> Bool
- supportedGroups :: Supported -> [Group]
- data DebugParams
- defaultDebugParams :: DebugParams
- debugSeed :: DebugParams -> Maybe Seed
- debugPrintSeed :: DebugParams -> Seed -> IO ()
- debugVersionForced :: DebugParams -> Maybe Version
- debugKeyLogger :: DebugParams -> String -> IO ()
- data Limit
- defaultLimit :: Limit
- limitHandshakeFragment :: Limit -> Int
- limitRecordSize :: Limit -> Maybe Int
- newtype Credentials = Credentials [Credential]
- type Credential = (CertificateChain, PrivKey)
- credentialLoadX509 :: FilePath -> FilePath -> IO (Either String Credential)
- credentialLoadX509FromMemory :: ByteString -> ByteString -> Either String Credential
- credentialLoadX509Chain :: FilePath -> [FilePath] -> FilePath -> IO (Either String Credential)
- credentialLoadX509ChainFromMemory :: ByteString -> [ByteString] -> ByteString -> Either String Credential
- data SessionManager
- noSessionManager :: SessionManager
- sessionResume :: SessionManager -> SessionIDorTicket -> IO (Maybe SessionData)
- sessionResumeOnlyOnce :: SessionManager -> SessionIDorTicket -> IO (Maybe SessionData)
- sessionEstablish :: SessionManager -> SessionIDorTicket -> SessionData -> IO (Maybe Ticket)
- sessionInvalidate :: SessionManager -> SessionIDorTicket -> IO ()
- sessionUseTicket :: SessionManager -> Bool
- type SessionID = ByteString
- type SessionIDorTicket = ByteString
- type Ticket = ByteString
- data SessionData
- sessionVersion :: SessionData -> Version
- sessionCipher :: SessionData -> CipherID
- sessionCompression :: SessionData -> CompressionID
- sessionClientSNI :: SessionData -> Maybe HostName
- sessionSecret :: SessionData -> ByteString
- sessionGroup :: SessionData -> Maybe Group
- sessionTicketInfo :: SessionData -> Maybe TLS13TicketInfo
- sessionALPN :: SessionData -> Maybe ByteString
- sessionMaxEarlyDataSize :: SessionData -> Int
- sessionFlags :: SessionData -> [SessionFlag]
- data SessionFlag = SessionEMS
- data TLS13TicketInfo
- is0RTTPossible :: SessionData -> Bool
- data ValidationCache = ValidationCache {}
- defaultValidationCache :: ValidationCache
- type ValidationCacheQueryCallback = ServiceID -> Fingerprint -> Certificate -> IO ValidationCacheResult
- type ValidationCacheAddCallback = ServiceID -> Fingerprint -> Certificate -> IO ()
- data ValidationCacheResult
- exceptionValidationCache :: [(ServiceID, Fingerprint)] -> ValidationCache
- newtype Version where
- data Compression = CompressionC a => Compression a
- nullCompression :: Compression
- type HashAndSignatureAlgorithm = (HashAlgorithm, SignatureAlgorithm)
- supportedSignatureSchemes :: [HashAndSignatureAlgorithm]
- newtype HashAlgorithm where
- HashAlgorithm { }
- pattern HashMD5 :: HashAlgorithm
- pattern HashSHA1 :: HashAlgorithm
- pattern HashSHA224 :: HashAlgorithm
- pattern HashSHA256 :: HashAlgorithm
- pattern HashSHA384 :: HashAlgorithm
- pattern HashSHA512 :: HashAlgorithm
- pattern HashNone :: HashAlgorithm
- pattern HashIntrinsic :: HashAlgorithm
- newtype SignatureAlgorithm where
- SignatureAlgorithm { }
- pattern SignatureAnonymous :: SignatureAlgorithm
- pattern SignatureRSA :: SignatureAlgorithm
- pattern SignatureDSA :: SignatureAlgorithm
- pattern SignatureECDSA :: SignatureAlgorithm
- pattern SignatureRSApssRSAeSHA256 :: SignatureAlgorithm
- pattern SignatureRSApssRSAeSHA384 :: SignatureAlgorithm
- pattern SignatureRSApssRSAeSHA512 :: SignatureAlgorithm
- pattern SignatureEd25519 :: SignatureAlgorithm
- pattern SignatureEd448 :: SignatureAlgorithm
- pattern SignatureRSApsspssSHA256 :: SignatureAlgorithm
- pattern SignatureRSApsspssSHA384 :: SignatureAlgorithm
- pattern SignatureRSApsspssSHA512 :: SignatureAlgorithm
- pattern SignatureBrainpoolP256 :: SignatureAlgorithm
- pattern SignatureBrainpoolP384 :: SignatureAlgorithm
- pattern SignatureBrainpoolP512 :: SignatureAlgorithm
- newtype Group where
- supportedNamedGroups :: [Group]
- data EMSMode
- = NoEMS
- | AllowEMS
- | RequireEMS
- type DHParams = Params
- type DHPublic = PublicNumber
- data GroupUsage
- data CertificateUsage
- data CertificateRejectReason
- newtype CertificateType where
- CertificateType { }
- pattern CertificateType_RSA_Sign :: CertificateType
- pattern CertificateType_DSA_Sign :: CertificateType
- pattern CertificateType_ECDSA_Sign :: CertificateType
- pattern CertificateType_Ed25519_Sign :: CertificateType
- pattern CertificateType_Ed448_Sign :: CertificateType
- newtype CertificateChain = CertificateChain [SignedExact Certificate]
- type HostName = String
- data MaxFragmentEnum
- ctxBackend :: Context -> Backend
- contextFlush :: Context -> IO ()
- contextClose :: Context -> IO ()
- data Information
- contextGetInformation :: Context -> IO (Maybe Information)
- infoVersion :: Information -> Version
- infoCipher :: Information -> Cipher
- infoCompression :: Information -> Compression
- infoMainSecret :: Information -> Maybe ByteString
- infoExtendedMainSecret :: Information -> Bool
- infoClientRandom :: Information -> Maybe ClientRandom
- infoServerRandom :: Information -> Maybe ServerRandom
- infoSupportedGroup :: Information -> Maybe Group
- infoTLS12Resumption :: Information -> Bool
- infoTLS13HandshakeMode :: Information -> Maybe HandshakeMode13
- infoIsEarlyDataAccepted :: Information -> Bool
- data ClientRandom
- data ServerRandom
- unClientRandom :: ClientRandom -> ByteString
- unServerRandom :: ServerRandom -> ByteString
- data HandshakeMode13
- getClientCertificateChain :: Context -> IO (Maybe CertificateChain)
- getNegotiatedProtocol :: MonadIO m => Context -> m (Maybe ByteString)
- getClientSNI :: MonadIO m => Context -> m (Maybe HostName)
- updateKey :: MonadIO m => Context -> KeyUpdateRequest -> m Bool
- data KeyUpdateRequest
- requestCertificate :: Context -> IO Bool
- getTLSUnique :: Context -> IO (Maybe ByteString)
- getTLSExporter :: Context -> IO (Maybe ByteString)
- getTLSServerEndPoint :: Context -> IO (Maybe ByteString)
- getFinished :: Context -> IO (Maybe VerifyData)
- getPeerFinished :: Context -> IO (Maybe VerifyData)
- data Hooks
- defaultHooks :: Hooks
- hookRecvHandshake :: Hooks -> Handshake -> IO Handshake
- hookRecvHandshake13 :: Hooks -> Handshake13 -> IO Handshake13
- hookRecvCertificates :: Hooks -> CertificateChain -> IO ()
- hookLogging :: Hooks -> Logging
- contextModifyHooks :: Context -> (Hooks -> Hooks) -> IO ()
- data Handshake
- contextHookSetHandshakeRecv :: Context -> (Handshake -> IO Handshake) -> IO ()
- data Handshake13
- contextHookSetHandshake13Recv :: Context -> (Handshake13 -> IO Handshake13) -> IO ()
- contextHookSetCertificateRecv :: Context -> (CertificateChain -> IO ()) -> IO ()
- data Logging
- defaultLogging :: Logging
- loggingPacketSent :: Logging -> String -> IO ()
- loggingPacketRecv :: Logging -> String -> IO ()
- loggingIOSent :: Logging -> ByteString -> IO ()
- loggingIORecv :: Logging -> Header -> ByteString -> IO ()
- data Header = Header ProtocolType Version Word16
- newtype ProtocolType where
- ProtocolType { }
- pattern ProtocolType_ChangeCipherSpec :: ProtocolType
- pattern ProtocolType_Alert :: ProtocolType
- pattern ProtocolType_Handshake :: ProtocolType
- pattern ProtocolType_AppData :: ProtocolType
- contextHookSetLogging :: Context -> Logging -> IO ()
- data TLSError
- data KxError
- newtype AlertDescription where
- AlertDescription { }
- pattern DecodeError :: AlertDescription
- pattern CloseNotify :: AlertDescription
- pattern UnexpectedMessage :: AlertDescription
- pattern BadRecordMac :: AlertDescription
- pattern DecryptionFailed :: AlertDescription
- pattern RecordOverflow :: AlertDescription
- pattern DecompressionFailure :: AlertDescription
- pattern HandshakeFailure :: AlertDescription
- pattern BadCertificate :: AlertDescription
- pattern UnsupportedCertificate :: AlertDescription
- pattern CertificateRevoked :: AlertDescription
- pattern CertificateExpired :: AlertDescription
- pattern CertificateUnknown :: AlertDescription
- pattern IllegalParameter :: AlertDescription
- pattern UnknownCa :: AlertDescription
- pattern AccessDenied :: AlertDescription
- pattern DecryptError :: AlertDescription
- pattern ExportRestriction :: AlertDescription
- pattern ProtocolVersion :: AlertDescription
- pattern InsufficientSecurity :: AlertDescription
- pattern InternalError :: AlertDescription
- pattern InappropriateFallback :: AlertDescription
- pattern UserCanceled :: AlertDescription
- pattern NoRenegotiation :: AlertDescription
- pattern MissingExtension :: AlertDescription
- pattern UnsupportedExtension :: AlertDescription
- pattern CertificateUnobtainable :: AlertDescription
- pattern UnrecognizedName :: AlertDescription
- pattern BadCertificateStatusResponse :: AlertDescription
- pattern BadCertificateHashValue :: AlertDescription
- pattern UnknownPskIdentity :: AlertDescription
- pattern CertificateRequired :: AlertDescription
- pattern NoApplicationProtocol :: AlertDescription
- data TLSException
- class CompressionC a where
- compressionCID :: a -> CompressionID
- compressionCDeflate :: a -> ByteString -> (a, ByteString)
- compressionCInflate :: a -> ByteString -> (a, ByteString)
- type CompressionID = Word8
- data PubKey
- data PrivKey
- data Cipher = Cipher {}
- data Hash
- data CipherKeyExchangeType
- data Bulk = Bulk {
- bulkName :: String
- bulkKeySize :: Int
- bulkIVSize :: Int
- bulkExplicitIV :: Int
- bulkAuthTagLen :: Int
- bulkBlockSize :: Int
- bulkF :: BulkFunctions
- data BulkFunctions
- = BulkBlockF (BulkDirection -> BulkKey -> BulkBlock)
- | BulkStreamF (BulkDirection -> BulkKey -> BulkStream)
- | BulkAeadF (BulkDirection -> BulkKey -> BulkAEAD)
- data BulkDirection
- data BulkState
- newtype BulkStream = BulkStream (ByteString -> (ByteString, BulkStream))
- type BulkBlock = BulkIV -> ByteString -> (ByteString, BulkIV)
- type BulkAEAD = BulkNonce -> ByteString -> BulkAdditionalData -> (ByteString, AuthTag)
- bulkInit :: Bulk -> BulkDirection -> BulkKey -> BulkState
- type CipherID = Word16
- cipherKeyBlockSize :: Cipher -> Int
- type BulkKey = ByteString
- type BulkIV = ByteString
- type BulkNonce = ByteString
- type BulkAdditionalData = ByteString
- cipherAllowedForVersion :: Version -> Cipher -> Bool
- hasMAC :: BulkFunctions -> Bool
- hasRecordIV :: BulkFunctions -> Bool
- elemCipher :: [CipherId] -> Cipher -> Bool
- intersectCiphers :: [CipherId] -> [Cipher] -> [Cipher]
- findCipher :: CipherID -> [Cipher] -> Maybe Cipher
- recvData' :: MonadIO m => Context -> m ByteString
- type Bytes = ByteString
- data ValidationChecks = ValidationChecks {}
- data ValidationHooks = ValidationHooks {
- hookMatchSubjectIssuer :: DistinguishedName -> Certificate -> Bool
- hookValidateTime :: DateTime -> Certificate -> [FailedReason]
- hookValidateName :: HostName -> Certificate -> [FailedReason]
- hookFilterReason :: [FailedReason] -> [FailedReason]
- clientUseMaxFragmentLength :: ClientParams -> Maybe MaxFragmentEnum
Basic APIs
Arguments
:: (MonadIO m, HasBackend backend, TLSParams params) | |
=> backend | Backend abstraction with specific method to interact with the connection type. |
-> params | Parameters of the context. |
-> m Context |
create a new context using the backend and parameters specified.
handshake :: MonadIO m => Context -> m () #
Handshake for a new TLS connection
This is to be called at the beginning of a connection, and during renegotiation.
Don't use this function as the acquire resource of bracket
.
sendData :: MonadIO m => Context -> ByteString -> m () #
sendData sends a bunch of data. It will automatically chunk data to acceptable packet size
recvData :: MonadIO m => Context -> m ByteString #
Get data out of Data packet, and automatically renegotiate if a Handshake ClientHello is received. An empty result means EOF.
bye :: MonadIO m => Context -> m () #
Notify the context that this side wants to close connection. This is important that it is called before closing the handle, otherwise the session might not be resumable (for version < TLS1.2). This doesn't actually close the handle.
Proper usage is as follows:
ctx <- contextNew <backend> <params> handshake ctx ... bye
The following code ensures nothing but is no harm.
bracket (contextNew <backend> <params>) bye $ \ctx -> do handshake ctx ...
Exceptions
Since 1.8.0, this library only throws exceptions of type TLSException
.
In the common case where the chosen backend is socket, IOException
may be thrown as well. This happens because the backend for sockets,
opaque to most modules in the tls
library, throws those exceptions.
Backend abstraction
class HasBackend a where #
Instances
HasBackend Handle # | |
Defined in Network.TLS.Backend | |
HasBackend Socket # | |
Defined in Network.TLS.Backend | |
HasBackend Backend # | |
Defined in Network.TLS.Backend |
Connection IO backend
Constructors
Backend | |
Fields
|
Instances
HasBackend Backend # | |
Defined in Network.TLS.Backend |
Parameters
Minimal complete definition
getTLSCommonParams, getTLSRole, doHandshake, doHandshakeWith, doRequestCertificate, doPostHandshakeAuthWith
Instances
TLSParams ClientParams # | |
Defined in Network.TLS.Context Methods getTLSCommonParams :: ClientParams -> CommonParams getTLSRole :: ClientParams -> Role doHandshake :: ClientParams -> Context -> IO () doHandshakeWith :: ClientParams -> Context -> Handshake -> IO () doRequestCertificate :: ClientParams -> Context -> IO Bool doPostHandshakeAuthWith :: ClientParams -> Context -> Handshake13 -> IO () | |
TLSParams ServerParams # | |
Defined in Network.TLS.Context Methods getTLSCommonParams :: ServerParams -> CommonParams getTLSRole :: ServerParams -> Role doHandshake :: ServerParams -> Context -> IO () doHandshakeWith :: ServerParams -> Context -> Handshake -> IO () doRequestCertificate :: ServerParams -> Context -> IO Bool doPostHandshakeAuthWith :: ServerParams -> Context -> Handshake13 -> IO () |
Client parameters
data ClientParams #
Instances
Show ClientParams # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> ClientParams -> ShowS # show :: ClientParams -> String # showList :: [ClientParams] -> ShowS # | |
TLSParams ClientParams # | |
Defined in Network.TLS.Context Methods getTLSCommonParams :: ClientParams -> CommonParams getTLSRole :: ClientParams -> Role doHandshake :: ClientParams -> Context -> IO () doHandshakeWith :: ClientParams -> Context -> Handshake -> IO () doRequestCertificate :: ClientParams -> Context -> IO Bool doPostHandshakeAuthWith :: ClientParams -> Context -> Handshake13 -> IO () |
defaultParamsClient :: HostName -> ByteString -> ClientParams #
Default value for ClientParams
clientServerIdentification :: ClientParams -> (HostName, ByteString) #
Define the name of the server, along with an extra service identification blob. this is important that the hostname part is properly filled for security reason, as it allow to properly associate the remote side with the given certificate during a handshake.
The extra blob is useful to differentiate services running on the same host, but that might have different certificates given. It's only used as part of the X509 validation infrastructure.
This value is typically set by defaultParamsClient
.
clientUseServerNameIndication :: ClientParams -> Bool #
Allow the use of the Server Name Indication TLS extension during handshake, which allow the client to specify which host name, it's trying to access. This is useful to distinguish CNAME aliasing (e.g. web virtual host).
Default: True
clientWantSessionResume :: ClientParams -> Maybe (SessionID, SessionData) #
try to establish a connection using this session for TLS 1.2/TLS 1.3.
This can be used for TLS 1.3 but for backward compatibility purpose only.
Use clientWantSessionResume13
instead for TLS 1.3.
Default: Nothing
clientWantSessionResumeList :: ClientParams -> [(SessionID, SessionData)] #
try to establish a connection using one of this sessions
especially for TLS 1.3.
This take precedence over clientWantSessionResume
.
For convenience, this can be specified for TLS 1.2 but only the first
entry is used.
Default: '[]'
clientShared :: ClientParams -> Shared #
See the default value of Shared
.
clientHooks :: ClientParams -> ClientHooks #
See the default value of ClientHooks
.
clientSupported :: ClientParams -> Supported #
In this element, you'll need to override the default empty value of
of supportedCiphers
with a suitable cipherlist.
See the default value of Supported
.
clientDebug :: ClientParams -> DebugParams #
See the default value of DebugParams
.
clientLimit :: ClientParams -> Limit #
clientUseEarlyData :: ClientParams -> Bool #
Client tries to send early data in TLS 1.3
via sendData
if possible.
If not accepted by the server, the early data
is automatically re-sent.
Default: False
Server parameters
data ServerParams #
Instances
Default ServerParams # | |
Defined in Network.TLS.Parameters Methods def :: ServerParams # | |
Show ServerParams # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> ServerParams -> ShowS # show :: ServerParams -> String # showList :: [ServerParams] -> ShowS # | |
TLSParams ServerParams # | |
Defined in Network.TLS.Context Methods getTLSCommonParams :: ServerParams -> CommonParams getTLSRole :: ServerParams -> Role doHandshake :: ServerParams -> Context -> IO () doHandshakeWith :: ServerParams -> Context -> Handshake -> IO () doRequestCertificate :: ServerParams -> Context -> IO Bool doPostHandshakeAuthWith :: ServerParams -> Context -> Handshake13 -> IO () |
serverWantClientCert :: ServerParams -> Bool #
Request a certificate from client.
Default: False
serverCACertificates :: ServerParams -> [SignedCertificate] #
This is a list of certificates from which the disinguished names are sent in certificate request messages. For TLS1.0, it should not be empty.
Default: '[]'
serverDHEParams :: ServerParams -> Maybe DHParams #
Server Optional Diffie Hellman parameters. Setting parameters is necessary for FFDHE key exchange when clients are not compatible with RFC 7919.
Value can be one of the standardized groups from module
Network.TLS.Extra.FFDHE or custom parameters generated with
generateParams
.
Default: Nothing
serverHooks :: ServerParams -> ServerHooks #
See the default value of ServerHooks
.
serverShared :: ServerParams -> Shared #
See the default value of Shared
.
serverSupported :: ServerParams -> Supported #
See the default value of Supported
.
serverDebug :: ServerParams -> DebugParams #
See the default value of DebugParams
.
serverLimit :: ServerParams -> Limit #
serverEarlyDataSize :: ServerParams -> Int #
Server accepts this size of early data in TLS 1.3. 0 (or lower) means that the server does not accept early data.
Default: 0
serverTicketLifetime :: ServerParams -> Int #
Lifetime in seconds for session tickets generated by the server. Acceptable value range is 0 to 604800 (7 days).
Default: 7200 (2 hours)
Shared
defaultShared :: Shared #
sharedCredentials :: Shared -> Credentials #
The list of certificates and private keys that a server will use as
part of authentication to clients. Actual credentials that are used
are selected dynamically from this list based on client capabilities.
Additional credentials returned by onServerNameIndication
are also
considered.
When credential list is left empty (the default value), no key exchange can take place.
Default: mempty
sharedSessionManager :: Shared -> SessionManager #
Callbacks used by clients and servers in order to resume TLS sessions. The default implementation never resumes sessions. Package tls-session-manager provides an in-memory implementation.
Default: noSessionManager
sharedCAStore :: Shared -> CertificateStore #
A collection of trust anchors to be used by a client as
part of validation of server certificates. This is set as
first argument to function onServerCertificate
. Package
crypton-x509-system
gives access to a default certificate store configured in the
system.
Default: mempty
sharedValidationCache :: Shared -> ValidationCache #
Callbacks that may be used by a client to cache certificate validation results (positive or negative) and avoid expensive signature check. The default implementation does not have any caching.
See the default value of ValidationCache
.
sharedHelloExtensions :: Shared -> [ExtensionRaw] #
Additional extensions to be sent during the Hello sequence.
For a client this is always included in message ClientHello. For a server, this is sent in messages ServerHello or EncryptedExtensions based on the TLS version.
Default: []
Client hooks
data ClientHooks #
A set of callbacks run by the clients for various corners of TLS establishment
Instances
Default ClientHooks # | |
Defined in Network.TLS.Parameters Methods def :: ClientHooks # | |
Show ClientHooks # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> ClientHooks -> ShowS # show :: ClientHooks -> String # showList :: [ClientHooks] -> ShowS # |
type OnCertificateRequest = ([CertificateType], Maybe [HashAndSignatureAlgorithm], [DistinguishedName]) -> IO (Maybe (CertificateChain, PrivKey)) #
Type for onCertificateRequest
. This type synonym is to make
document readable.
onCertificateRequest :: ClientHooks -> OnCertificateRequest #
This action is called when the a certificate request is
received from the server. The callback argument is the
information from the request. The server, at its
discretion, may be willing to continue the handshake
without a client certificate. Therefore, the callback is
free to return Nothing
to indicate that no client
certificate should be sent, despite the server's request.
In some cases it may be appropriate to get user consent
before sending the certificate; the content of the user's
certificate may be sensitive and intended only for
specific servers.
The action should select a certificate chain of one of
the given certificate types and one of the certificates
in the chain should (if possible) be signed by one of the
given distinguished names. Some servers, that don't have
a narrow set of preferred issuer CAs, will send an empty
DistinguishedName
list, rather than send all the names
from their trusted CA bundle. If the client does not
have a certificate chaining to a matching CA, it may
choose a default certificate instead.
Each certificate except the last should be signed by the following one. The returned private key must be for the first certificates in the chain. This key will be used to signing the certificate verify message.
The public key in the first certificate, and the matching
returned private key must be compatible with one of the
list of HashAndSignatureAlgorithm
value when provided.
TLS 1.3 changes the meaning of the list elements, adding
explicit code points for each supported pair of hash and
signature (public key) algorithms, rather than combining
separate codes for the hash and key. For details see
RFC 8446
section 4.2.3. When no compatible certificate chain is
available, return Nothing
if it is OK to continue
without a client certificate. Returning a non-matching
certificate should result in a handshake failure.
While the TLS version is not provided to the callback,
the content of the signature_algorithms
list provides
a strong hint, since TLS 1.3 servers will generally list
RSA pairs with a hash component of Intrinsic
(0x08
).
Note that is is the responsibility of this action to select a certificate matching one of the requested certificate types (public key algorithms). Returning a non-matching one will lead to handshake failure later.
Default: returns Nothing
anyway.
type OnServerCertificate = CertificateStore -> ValidationCache -> ServiceID -> CertificateChain -> IO [FailedReason] #
Type for onServerCertificate
. This type synonym is to make
document readable.
onServerCertificate :: ClientHooks -> OnServerCertificate #
Used by the client to validate the server certificate. The default
implementation calls validateDefault
which validates according to the
default hooks and checks provided by Data.X509.Validation. This can
be replaced with a custom validation function using different settings.
The function is not expected to verify the key-usage extension of the end-entity certificate, as this depends on the dynamically-selected cipher and this part should not be cached. Key-usage verification is performed by the library internally.
Default: validateDefault
validateClientCertificate :: CertificateStore -> ValidationCache -> CertificateChain -> IO CertificateUsage #
A utility function for client authentication which can be used
onClientCertificate
.
Since: 2.1.7
onSuggestALPN :: ClientHooks -> IO (Maybe [ByteString]) #
This action is called when the client sends ClientHello to determine ALPN values such as '["h2", "http/1.1"]'.
Default: returns Nothing
onCustomFFDHEGroup :: ClientHooks -> DHParams -> DHPublic -> IO GroupUsage #
This action is called to validate DHE parameters when the server
selected a finite-field group not part of the "Supported Groups
Registry" or not part of supportedGroups
list.
With TLS 1.3 custom groups have been removed from the protocol, so this callback is only used when the version negotiated is 1.2 or below.
The default behavior with (dh_p, dh_g, dh_size) and pub as follows:
- rejecting if dh_p is even
- rejecting unless 1 < dh_g && dh_g < dh_p - 1
- rejecting unless 1 < dh_p && pub < dh_p - 1
- rejecting if dh_size < 1024 (to prevent Logjam attack)
See RFC 7919 section 3.1 for recommandations.
onServerFinished :: ClientHooks -> Information -> IO () #
When a handshake is done, this hook can check Information
.
Server hooks
data ServerHooks #
A set of callbacks run by the server for various corners of the TLS establishment
Instances
Default ServerHooks # | |
Defined in Network.TLS.Parameters Methods def :: ServerHooks # | |
Show ServerHooks # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> ServerHooks -> ShowS # show :: ServerHooks -> String # showList :: [ServerHooks] -> ShowS # |
defaultServerHooks :: ServerHooks #
Default value for ServerHooks
onClientCertificate :: ServerHooks -> CertificateChain -> IO CertificateUsage #
This action is called when a client certificate chain is received from the client. When it returns a CertificateUsageReject value, the handshake is aborted.
The function is not expected to verify the key-usage extension of the certificate. This verification is performed by the library internally.
Default: returns the followings:
CertificateUsageReject (CertificateRejectOther "no client certificates expected")
onUnverifiedClientCert :: ServerHooks -> IO Bool #
onCipherChoosing :: ServerHooks -> Version -> [Cipher] -> Cipher #
Allow the server to choose the cipher relative to the the client version and the client list of ciphers.
This could be useful with old clients and as a workaround to the BEAST (where RC4 is sometimes prefered with TLS < 1.1)
The client cipher list cannot be empty.
Default: taking the head of ciphers.
onServerNameIndication :: ServerHooks -> Maybe HostName -> IO Credentials #
Allow the server to indicate additional credentials to be used depending on the host name indicated by the client.
This is most useful for transparent proxies where credentials must be generated on the fly according to the host the client is trying to connect to.
Returned credentials may be ignored if a client does not support the signature algorithms used in the certificate chain.
Default: returns mempty
onNewHandshake :: ServerHooks -> Measurement -> IO Bool #
At each new handshake, we call this hook to see if we allow handshake to happens.
Default: returns True
onALPNClientSuggest :: ServerHooks -> Maybe ([ByteString] -> IO ByteString) #
Allow the server to choose an application layer protocol
suggested from the client through the ALPN
(Application Layer Protocol Negotiation) extensions.
If the server supports no protocols that the client advertises
an empty ByteString
should be returned.
Default: Nothing
onEncryptedExtensionsCreating :: ServerHooks -> [ExtensionRaw] -> IO [ExtensionRaw] #
Allow to modify extensions to be sent in EncryptedExtensions of TLS 1.3.
Default: return
data Measurement #
record some data about this connection.
Instances
Show Measurement # | |
Defined in Network.TLS.Measurement Methods showsPrec :: Int -> Measurement -> ShowS # show :: Measurement -> String # showList :: [Measurement] -> ShowS # | |
Eq Measurement # | |
Defined in Network.TLS.Measurement |
nbHandshakes :: Measurement -> Word32 #
number of handshakes on this context
bytesReceived :: Measurement -> Word32 #
bytes received since last handshake
bytesSent :: Measurement -> Word32 #
bytes sent since last handshake
Supported
List all the supported algorithms, versions, ciphers, etc supported.
supportedVersions :: Supported -> [Version] #
Supported versions by this context. On the client side, the highest version will be used to establish the connection. On the server side, the highest version that is less or equal than the client version will be chosen.
Versions should be listed in preference order, i.e. higher versions first.
Default: [TLS13,TLS12]
supportedCiphers :: Supported -> [Cipher] #
Supported cipher methods. The default is empty, specify a suitable
cipher list. ciphersuite_default
is often
a good choice.
Default: []
supportedCompressions :: Supported -> [Compression] #
Supported compressions methods. By default only the "null" compression is supported, which means no compression will be performed. Allowing other compression method is not advised as it causes a connection failure when TLS 1.3 is negotiated.
Default: [nullCompression]
supportedHashSignatures :: Supported -> [HashAndSignatureAlgorithm] #
All supported hash/signature algorithms pair for client certificate verification and server signature in (EC)DHE, ordered by decreasing priority.
This list is sent to the peer as part of the "signature_algorithms"
extension. It is used to restrict accepted signatures received from
the peer at TLS level (not in X.509 certificates), but only when the
TLS version is 1.2 or above. In order to disable SHA-1 one must then
also disable earlier protocol versions in supportedVersions
.
The list also impacts the selection of possible algorithms when generating signatures.
Note: with TLS 1.3 some algorithms have been deprecated and will not be used even when listed in the parameter: MD5, SHA-1, SHA-224, RSA PKCS#1, DSA.
Default:
[ (HashIntrinsic, SignatureEd448) , (HashIntrinsic, SignatureEd25519) , (Struct.HashSHA256, SignatureECDSA) , (Struct.HashSHA384, SignatureECDSA) , (Struct.HashSHA512, SignatureECDSA) , (HashIntrinsic, SignatureRSApssRSAeSHA512) , (HashIntrinsic, SignatureRSApssRSAeSHA384) , (HashIntrinsic, SignatureRSApssRSAeSHA256) , (Struct.HashSHA512, SignatureRSA) , (Struct.HashSHA384, SignatureRSA) , (Struct.HashSHA256, SignatureRSA) , (Struct.HashSHA1, SignatureRSA) , (Struct.HashSHA1, SignatureDSA) ]
supportedExtendedMainSecret :: Supported -> EMSMode #
The mode regarding extended main secret. Enabling this extension provides better security for TLS versions 1.2. TLS 1.3 provides the security properties natively and does not need the extension.
By default the extension is RequireEMS
.
So, the handshake will fail when the peer does not support
the extension.
Default: RequireEMS
supportedSession :: Supported -> Bool #
Set if we support session.
Default: True
supportedFallbackScsv :: Supported -> Bool #
supportedEmptyPacket :: Supported -> Bool #
In ver <= TLS1.0, block ciphers using CBC are using CBC residue as IV, which can be guessed
by an attacker. Hence, an empty packet is normally sent before a normal data packet, to
prevent guessability. Some Microsoft TLS-based protocol implementations, however,
consider these empty packets as a protocol violation and disconnect. If this parameter is
False
, empty packets will never be added, which is less secure, but might help in rare
cases.
Default: True
supportedGroups :: Supported -> [Group] #
A list of supported elliptic curves and finite-field groups in the preferred order.
The list is sent to the server as part of the "supported_groups" extension. It is used in both clients and servers to restrict accepted groups in DH key exchange. Up until TLS v1.2, it is also used by a client to restrict accepted elliptic curves in ECDSA signatures.
The default value includes all groups with security strength of 128 bits or more.
Default: [X25519,X448,P256,FFDHE2048,FFDHE3072,FFDHE4096,P384,FFDHE6144,FFDHE8192,P521]
Debug parameters
data DebugParams #
All settings should not be used in production
Instances
Default DebugParams # | |
Defined in Network.TLS.Parameters Methods def :: DebugParams # | |
Show DebugParams # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> DebugParams -> ShowS # show :: DebugParams -> String # showList :: [DebugParams] -> ShowS # |
defaultDebugParams :: DebugParams #
Default value for DebugParams
debugSeed :: DebugParams -> Maybe Seed #
Disable the true randomness in favor of deterministic seed that will produce a deterministic random from. This is useful for tests and debugging purpose. Do not use in production
Default: Nothing
debugPrintSeed :: DebugParams -> Seed -> IO () #
Add a way to print the seed that was randomly generated. re-using the same seed
will reproduce the same randomness with debugSeed
Default: no printing
debugVersionForced :: DebugParams -> Maybe Version #
Force to choose this version in the server side.
Default: Nothing
debugKeyLogger :: DebugParams -> String -> IO () #
Printing main keys.
Default: no printing
Limit parameters
Limitations for security.
Since: 2.1.7
defaultLimit :: Limit #
Default value for Limit
.
limitHandshakeFragment :: Limit -> Int #
The limit to accept the number of each handshake message. For instance, a nasty client may send many fragments of client certificate.
Default: 32
limitRecordSize :: Limit -> Maybe Int #
Record size limit defined in RFC 8449.
If Nothing
, the "record_size_limit" extension is not used.
In the case of Just
: A client sends the "record_size_limit"
extension with this value to the server. A server sends back
this extension with its own value if a client sends the
extension. When negotiated, both my limit and peer's limit
are enabled for protected communication.
Default: Nothing
Shared parameters
Credentials
newtype Credentials #
Constructors
Credentials [Credential] |
Instances
Monoid Credentials # | |
Defined in Network.TLS.Credentials Methods mempty :: Credentials # mappend :: Credentials -> Credentials -> Credentials # mconcat :: [Credentials] -> Credentials # | |
Semigroup Credentials # | |
Defined in Network.TLS.Credentials Methods (<>) :: Credentials -> Credentials -> Credentials # sconcat :: NonEmpty Credentials -> Credentials # stimes :: Integral b => b -> Credentials -> Credentials # | |
Show Credentials # | |
Defined in Network.TLS.Credentials Methods showsPrec :: Int -> Credentials -> ShowS # show :: Credentials -> String # showList :: [Credentials] -> ShowS # |
type Credential = (CertificateChain, PrivKey) #
Arguments
:: FilePath | public certificate (X.509 format) |
-> FilePath | private key associated |
-> IO (Either String Credential) |
try to create a new credential object from a public certificate and the associated private key that are stored on the filesystem in PEM format.
credentialLoadX509FromMemory :: ByteString -> ByteString -> Either String Credential #
similar to credentialLoadX509
but take the certificate
and private key from memory instead of from the filesystem.
Arguments
:: FilePath | public certificate (X.509 format) |
-> [FilePath] | chain certificates (X.509 format) |
-> FilePath | private key associated |
-> IO (Either String Credential) |
similar to credentialLoadX509
but also allow specifying chain
certificates.
credentialLoadX509ChainFromMemory :: ByteString -> [ByteString] -> ByteString -> Either String Credential #
similar to credentialLoadX509FromMemory
but also allow
specifying chain certificates.
Session manager
data SessionManager #
A session manager.
In the server side, all fields are used.
In the client side, only sessionEstablish
is used.
noSessionManager :: SessionManager #
The session manager to do nothing.
sessionResume :: SessionManager -> SessionIDorTicket -> IO (Maybe SessionData) #
Used on TLS 1.2/1.3 servers to lookup SessionData
with SessionID
or to decrypt Ticket
to get SessionData
.
sessionResumeOnlyOnce :: SessionManager -> SessionIDorTicket -> IO (Maybe SessionData) #
Used for 0RTT on TLS 1.3 servers to lookup SessionData
with SessionID
or to decrypt Ticket
to get SessionData
.
sessionEstablish :: SessionManager -> SessionIDorTicket -> SessionData -> IO (Maybe Ticket) #
Used on TLS 1.2/1.3 servers to store SessionData
with SessionID
or to encrypt SessionData
to get Ticket
ignoring SessionID
. Used on TLS 1.2/1.3 clients to store SessionData
with SessionIDorTicket
and then return Nothing
. For clients, only this field should be set with noSessionManager
.
sessionInvalidate :: SessionManager -> SessionIDorTicket -> IO () #
Used TLS 1.2 servers to delete SessionData
with SessionID
on errors.
sessionUseTicket :: SessionManager -> Bool #
type SessionID = ByteString #
A session ID
type SessionIDorTicket = ByteString #
Identity
type Ticket = ByteString #
Encrypted session ticket (encrypt(encode SessionData
)).
Session data
data SessionData #
Session data to resume
Instances
sessionVersion :: SessionData -> Version #
sessionCipher :: SessionData -> CipherID #
sessionSecret :: SessionData -> ByteString #
sessionGroup :: SessionData -> Maybe Group #
sessionALPN :: SessionData -> Maybe ByteString #
sessionFlags :: SessionData -> [SessionFlag] #
data SessionFlag #
Some session flags
Constructors
SessionEMS | Session created with Extended Main Secret |
Instances
Enum SessionFlag # | |||||
Defined in Network.TLS.Types.Session Methods succ :: SessionFlag -> SessionFlag # pred :: SessionFlag -> SessionFlag # toEnum :: Int -> SessionFlag # fromEnum :: SessionFlag -> Int # enumFrom :: SessionFlag -> [SessionFlag] # enumFromThen :: SessionFlag -> SessionFlag -> [SessionFlag] # enumFromTo :: SessionFlag -> SessionFlag -> [SessionFlag] # enumFromThenTo :: SessionFlag -> SessionFlag -> SessionFlag -> [SessionFlag] # | |||||
Generic SessionFlag # | |||||
Defined in Network.TLS.Types.Session Associated Types
| |||||
Show SessionFlag # | |||||
Defined in Network.TLS.Types.Session Methods showsPrec :: Int -> SessionFlag -> ShowS # show :: SessionFlag -> String # showList :: [SessionFlag] -> ShowS # | |||||
Eq SessionFlag # | |||||
Defined in Network.TLS.Types.Session | |||||
Serialise SessionFlag # | |||||
Defined in Network.TLS.Types.Session Methods encode :: SessionFlag -> Encoding # decode :: Decoder s SessionFlag # encodeList :: [SessionFlag] -> Encoding # decodeList :: Decoder s [SessionFlag] # | |||||
type Rep SessionFlag # | |||||
data TLS13TicketInfo #
Instances
Generic TLS13TicketInfo # | |||||
Defined in Network.TLS.Types.Session Associated Types
Methods from :: TLS13TicketInfo -> Rep TLS13TicketInfo x # to :: Rep TLS13TicketInfo x -> TLS13TicketInfo # | |||||
Show TLS13TicketInfo # | |||||
Defined in Network.TLS.Types.Session Methods showsPrec :: Int -> TLS13TicketInfo -> ShowS # show :: TLS13TicketInfo -> String # showList :: [TLS13TicketInfo] -> ShowS # | |||||
Eq TLS13TicketInfo # | |||||
Defined in Network.TLS.Types.Session Methods (==) :: TLS13TicketInfo -> TLS13TicketInfo -> Bool # (/=) :: TLS13TicketInfo -> TLS13TicketInfo -> Bool # | |||||
Serialise TLS13TicketInfo # | |||||
Defined in Network.TLS.Types.Session Methods encode :: TLS13TicketInfo -> Encoding # decode :: Decoder s TLS13TicketInfo # encodeList :: [TLS13TicketInfo] -> Encoding # decodeList :: Decoder s [TLS13TicketInfo] # | |||||
type Rep TLS13TicketInfo # | |||||
Defined in Network.TLS.Types.Session |
is0RTTPossible :: SessionData -> Bool #
Validation Cache
data ValidationCache #
All the callbacks needed for querying and adding to the cache.
Constructors
ValidationCache | |
Fields
|
Instances
Default ValidationCache | |
Defined in Data.X509.Validation.Cache Methods def :: ValidationCache # |
type ValidationCacheQueryCallback #
Arguments
= ServiceID | connection's identification |
-> Fingerprint | fingerprint of the leaf certificate |
-> Certificate | leaf certificate |
-> IO ValidationCacheResult | return if the operation is succesful or not |
Validation cache query callback type
type ValidationCacheAddCallback #
Arguments
= ServiceID | connection's identification |
-> Fingerprint | fingerprint of the leaf certificate |
-> Certificate | leaf certificate |
-> IO () |
Validation cache callback type
data ValidationCacheResult #
The result of a cache query
Constructors
ValidationCachePass | cache allow this fingerprint to go through |
ValidationCacheDenied String | cache denied this fingerprint for further validation |
ValidationCacheUnknown | unknown fingerprint in cache |
Instances
Show ValidationCacheResult | |
Defined in Data.X509.Validation.Cache Methods showsPrec :: Int -> ValidationCacheResult -> ShowS # show :: ValidationCacheResult -> String # showList :: [ValidationCacheResult] -> ShowS # | |
Eq ValidationCacheResult | |
Defined in Data.X509.Validation.Cache Methods (==) :: ValidationCacheResult -> ValidationCacheResult -> Bool # (/=) :: ValidationCacheResult -> ValidationCacheResult -> Bool # |
exceptionValidationCache :: [(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.
Types
For Supported
Versions known to TLS
Bundled Patterns
pattern TLS12 :: Version | |
pattern TLS13 :: Version | |
pattern SSL2 :: Version | |
pattern SSL3 :: Version | |
pattern TLS10 :: Version | |
pattern TLS11 :: Version |
data Compression #
every compression need to be wrapped in this, to fit in structure
Constructors
CompressionC a => Compression a |
Instances
Show Compression # | |
Defined in Network.TLS.Compression Methods showsPrec :: Int -> Compression -> ShowS # show :: Compression -> String # showList :: [Compression] -> ShowS # | |
Eq Compression # | |
Defined in Network.TLS.Compression |
nullCompression :: Compression #
default null compression
newtype HashAlgorithm #
Constructors
HashAlgorithm | |
Fields |
Bundled Patterns
pattern HashMD5 :: HashAlgorithm | |
pattern HashSHA1 :: HashAlgorithm | |
pattern HashSHA224 :: HashAlgorithm | |
pattern HashSHA256 :: HashAlgorithm | |
pattern HashSHA384 :: HashAlgorithm | |
pattern HashSHA512 :: HashAlgorithm | |
pattern HashNone :: HashAlgorithm | |
pattern HashIntrinsic :: HashAlgorithm |
Instances
Show HashAlgorithm # | |
Defined in Network.TLS.HashAndSignature Methods showsPrec :: Int -> HashAlgorithm -> ShowS # show :: HashAlgorithm -> String # showList :: [HashAlgorithm] -> ShowS # | |
Eq HashAlgorithm # | |
Defined in Network.TLS.HashAndSignature Methods (==) :: HashAlgorithm -> HashAlgorithm -> Bool # (/=) :: HashAlgorithm -> HashAlgorithm -> Bool # | |
Show (HashAlgorithm, SignatureAlgorithm) # | |
Defined in Network.TLS.HashAndSignature Methods showsPrec :: Int -> (HashAlgorithm, SignatureAlgorithm) -> ShowS # show :: (HashAlgorithm, SignatureAlgorithm) -> String # showList :: [(HashAlgorithm, SignatureAlgorithm)] -> ShowS # |
newtype SignatureAlgorithm #
Constructors
SignatureAlgorithm | |
Fields |
Bundled Patterns
pattern SignatureAnonymous :: SignatureAlgorithm | |
pattern SignatureRSA :: SignatureAlgorithm | |
pattern SignatureDSA :: SignatureAlgorithm | |
pattern SignatureECDSA :: SignatureAlgorithm | |
pattern SignatureRSApssRSAeSHA256 :: SignatureAlgorithm | |
pattern SignatureRSApssRSAeSHA384 :: SignatureAlgorithm | |
pattern SignatureRSApssRSAeSHA512 :: SignatureAlgorithm | |
pattern SignatureEd25519 :: SignatureAlgorithm | |
pattern SignatureEd448 :: SignatureAlgorithm | |
pattern SignatureRSApsspssSHA256 :: SignatureAlgorithm | |
pattern SignatureRSApsspssSHA384 :: SignatureAlgorithm | |
pattern SignatureRSApsspssSHA512 :: SignatureAlgorithm | |
pattern SignatureBrainpoolP256 :: SignatureAlgorithm | |
pattern SignatureBrainpoolP384 :: SignatureAlgorithm | |
pattern SignatureBrainpoolP512 :: SignatureAlgorithm |
Instances
Show SignatureAlgorithm # | |
Defined in Network.TLS.HashAndSignature Methods showsPrec :: Int -> SignatureAlgorithm -> ShowS # show :: SignatureAlgorithm -> String # showList :: [SignatureAlgorithm] -> ShowS # | |
Eq SignatureAlgorithm # | |
Defined in Network.TLS.HashAndSignature Methods (==) :: SignatureAlgorithm -> SignatureAlgorithm -> Bool # (/=) :: SignatureAlgorithm -> SignatureAlgorithm -> Bool # | |
Show (HashAlgorithm, SignatureAlgorithm) # | |
Defined in Network.TLS.HashAndSignature Methods showsPrec :: Int -> (HashAlgorithm, SignatureAlgorithm) -> ShowS # show :: (HashAlgorithm, SignatureAlgorithm) -> String # showList :: [(HashAlgorithm, SignatureAlgorithm)] -> ShowS # |
Bundled Patterns
pattern P256 :: Group | |
pattern P384 :: Group | |
pattern P521 :: Group | |
pattern X25519 :: Group | |
pattern X448 :: Group | |
pattern FFDHE2048 :: Group | |
pattern FFDHE3072 :: Group | |
pattern FFDHE4096 :: Group | |
pattern FFDHE6144 :: Group | |
pattern FFDHE8192 :: Group |
supportedNamedGroups :: [Group] #
Client or server policy regarding Extended Main Secret
Constructors
NoEMS | Extended Main Secret is not used |
AllowEMS | Extended Main Secret is allowed |
RequireEMS | Extended Main Secret is required |
For parameters and hooks
type DHPublic = PublicNumber #
data GroupUsage #
Group usage callback possible return values.
Constructors
GroupUsageValid | usage of group accepted |
GroupUsageInsecure | usage of group provides insufficient security |
GroupUsageUnsupported String | usage of group rejected for other reason (specified as string) |
GroupUsageInvalidPublic | usage of group with an invalid public value |
Instances
Show GroupUsage # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> GroupUsage -> ShowS # show :: GroupUsage -> String # showList :: [GroupUsage] -> ShowS # | |
Eq GroupUsage # | |
Defined in Network.TLS.Parameters |
data CertificateUsage #
Certificate Usage callback possible returns values.
Constructors
CertificateUsageAccept | usage of certificate accepted |
CertificateUsageReject CertificateRejectReason | usage of certificate rejected |
Instances
Show CertificateUsage # | |
Defined in Network.TLS.X509 Methods showsPrec :: Int -> CertificateUsage -> ShowS # show :: CertificateUsage -> String # showList :: [CertificateUsage] -> ShowS # | |
Eq CertificateUsage # | |
Defined in Network.TLS.X509 Methods (==) :: CertificateUsage -> CertificateUsage -> Bool # (/=) :: CertificateUsage -> CertificateUsage -> Bool # |
data CertificateRejectReason #
Certificate and Chain rejection reason
Constructors
CertificateRejectExpired | |
CertificateRejectRevoked | |
CertificateRejectUnknownCA | |
CertificateRejectAbsent | |
CertificateRejectOther String |
Instances
Show CertificateRejectReason # | |
Defined in Network.TLS.X509 Methods showsPrec :: Int -> CertificateRejectReason -> ShowS # show :: CertificateRejectReason -> String # showList :: [CertificateRejectReason] -> ShowS # | |
Eq CertificateRejectReason # | |
Defined in Network.TLS.X509 Methods (==) :: CertificateRejectReason -> CertificateRejectReason -> Bool # (/=) :: CertificateRejectReason -> CertificateRejectReason -> Bool # |
newtype 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 | |
Fields |
Bundled Patterns
pattern CertificateType_RSA_Sign :: CertificateType | TLS10 and up, RFC5246 |
pattern CertificateType_DSA_Sign :: CertificateType | TLS10 and up, RFC5246 |
pattern CertificateType_ECDSA_Sign :: CertificateType | TLS10 and up, RFC8422 |
pattern CertificateType_Ed25519_Sign :: CertificateType | |
pattern CertificateType_Ed448_Sign :: CertificateType |
Instances
Show CertificateType # | |
Defined in Network.TLS.Struct Methods showsPrec :: Int -> CertificateType -> ShowS # show :: CertificateType -> String # showList :: [CertificateType] -> ShowS # | |
Eq CertificateType # | |
Defined in Network.TLS.Struct Methods (==) :: CertificateType -> CertificateType -> Bool # (/=) :: CertificateType -> CertificateType -> Bool # | |
Ord CertificateType # | |
Defined in Network.TLS.Struct Methods compare :: CertificateType -> CertificateType -> Ordering # (<) :: CertificateType -> CertificateType -> Bool # (<=) :: CertificateType -> CertificateType -> Bool # (>) :: CertificateType -> CertificateType -> Bool # (>=) :: CertificateType -> CertificateType -> Bool # max :: CertificateType -> CertificateType -> CertificateType # min :: CertificateType -> CertificateType -> CertificateType # |
newtype CertificateChain #
A chain of X.509 certificates in exact form.
Constructors
CertificateChain [SignedExact Certificate] |
Instances
Show CertificateChain | |
Defined in Data.X509.CertificateChain Methods showsPrec :: Int -> CertificateChain -> ShowS # show :: CertificateChain -> String # showList :: [CertificateChain] -> ShowS # | |
Show Credential # | |
Defined in Network.TLS.Credentials Methods showsPrec :: Int -> Credential -> ShowS # show :: Credential -> String # showList :: [Credential] -> ShowS # | |
Eq CertificateChain | |
Defined in Data.X509.CertificateChain Methods (==) :: CertificateChain -> CertificateChain -> Bool # (/=) :: CertificateChain -> CertificateChain -> Bool # |
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"
.
data MaxFragmentEnum #
Constructors
MaxFragment512 | |
MaxFragment1024 | |
MaxFragment2048 | |
MaxFragment4096 |
Instances
Show MaxFragmentEnum # | |
Defined in Network.TLS.Extension Methods showsPrec :: Int -> MaxFragmentEnum -> ShowS # show :: MaxFragmentEnum -> String # showList :: [MaxFragmentEnum] -> ShowS # | |
Eq MaxFragmentEnum # | |
Defined in Network.TLS.Extension Methods (==) :: MaxFragmentEnum -> MaxFragmentEnum -> Bool # (/=) :: MaxFragmentEnum -> MaxFragmentEnum -> Bool # |
Advanced APIs
Backend
ctxBackend :: Context -> Backend #
return the backend object associated with this context
contextFlush :: Context -> IO () #
A shortcut for 'backendFlush . ctxBackend'.
contextClose :: Context -> IO () #
A shortcut for 'backendClose . ctxBackend'.
Information gathering
data Information #
Information related to a running context, e.g. current cipher
Instances
Show Information # | |
Defined in Network.TLS.Parameters Methods showsPrec :: Int -> Information -> ShowS # show :: Information -> String # showList :: [Information] -> ShowS # | |
Eq Information # | |
Defined in Network.TLS.Parameters |
contextGetInformation :: Context -> IO (Maybe Information) #
Information about the current context
infoVersion :: Information -> Version #
infoCipher :: Information -> Cipher #
infoSupportedGroup :: Information -> Maybe Group #
infoTLS12Resumption :: Information -> Bool #
data ClientRandom #
Instances
Show ClientRandom # | |
Defined in Network.TLS.Struct Methods showsPrec :: Int -> ClientRandom -> ShowS # show :: ClientRandom -> String # showList :: [ClientRandom] -> ShowS # | |
Eq ClientRandom # | |
Defined in Network.TLS.Struct |
data ServerRandom #
Instances
Show ServerRandom # | |
Defined in Network.TLS.Struct Methods showsPrec :: Int -> ServerRandom -> ShowS # show :: ServerRandom -> String # showList :: [ServerRandom] -> ShowS # | |
Eq ServerRandom # | |
Defined in Network.TLS.Struct |
data HandshakeMode13 #
Type to show which handshake mode is used in TLS 1.3.
Constructors
FullHandshake | Full handshake is used. |
HelloRetryRequest | Full handshake is used with hello retry request. |
PreSharedKey | Server authentication is skipped. |
RTT0 | Server authentication is skipped and early data is sent. |
Instances
Show HandshakeMode13 # | |
Defined in Network.TLS.Handshake.State Methods showsPrec :: Int -> HandshakeMode13 -> ShowS # show :: HandshakeMode13 -> String # showList :: [HandshakeMode13] -> ShowS # | |
Eq HandshakeMode13 # | |
Defined in Network.TLS.Handshake.State Methods (==) :: HandshakeMode13 -> HandshakeMode13 -> Bool # (/=) :: HandshakeMode13 -> HandshakeMode13 -> Bool # |
getClientCertificateChain :: Context -> IO (Maybe CertificateChain) #
Getting certificates from a client, if any. Note that the certificates are not sent by a client on resumption even if client authentication is required. So, this API would be replaced by the one which can treat both cases of full-negotiation and resumption.
Negotiated
getNegotiatedProtocol :: MonadIO m => Context -> m (Maybe ByteString) #
If the ALPN extensions have been used, this will return get the protocol agreed upon.
getClientSNI :: MonadIO m => Context -> m (Maybe HostName) #
If the Server Name Indication extension has been used, return the hostname specified by the client.
Post-handshake actions
data KeyUpdateRequest #
How to update keys in TLS 1.3
Instances
Show KeyUpdateRequest # | |
Defined in Network.TLS.Core Methods showsPrec :: Int -> KeyUpdateRequest -> ShowS # show :: KeyUpdateRequest -> String # showList :: [KeyUpdateRequest] -> ShowS # | |
Eq KeyUpdateRequest # | |
Defined in Network.TLS.Core Methods (==) :: KeyUpdateRequest -> KeyUpdateRequest -> Bool # (/=) :: KeyUpdateRequest -> KeyUpdateRequest -> Bool # |
requestCertificate :: Context -> IO Bool #
Post-handshake certificate request with TLS 1.3. Returns True
if the
request was possible, i.e. if TLS 1.3 is used and the remote client supports
post-handshake authentication.
getTLSUnique :: Context -> IO (Maybe ByteString) #
Getting the "tls-unique" channel binding for TLS 1.2 (RFC5929).
For TLS 1.3, Nothing
is returned.
supportedExtendedMainSecret
must be RequireEMS
But in general, it is highly recommended to upgrade to TLS 1.3
and use the "tls-exporter" channel binding via getTLSExporter
.
getTLSExporter :: Context -> IO (Maybe ByteString) #
Getting the "tls-exporter" channel binding for TLS 1.3 (RFC9266).
For TLS 1.2, Nothing
is returned.
getTLSServerEndPoint :: Context -> IO (Maybe ByteString) #
Getting the "tls-server-end-point" channel binding for TLS 1.2 (RFC5929). For 1.3, there is no specifications for how to create it. In this implementation, a certificate chain without extensions is hashed like TLS 1.2.
getFinished :: Context -> IO (Maybe VerifyData) #
Deprecated: Use getTLSUnique instead
Getting TLS Finished sent to peer.
getPeerFinished :: Context -> IO (Maybe VerifyData) #
Deprecated: Use getTLSUnique instead
Getting TLS Finished received from peer.
Modifying hooks in context
A collection of hooks actions.
defaultHooks :: Hooks #
hookRecvHandshake13 :: Hooks -> Handshake13 -> IO Handshake13 #
called at each handshake message received for TLS 1.3
hookRecvCertificates :: Hooks -> CertificateChain -> IO () #
called at each certificate chain message received
hookLogging :: Hooks -> Logging #
hooks on IO and packets, receiving and sending.
Instances
data Handshake13 #
Instances
Show Handshake13 # | |
Defined in Network.TLS.Struct13 Methods showsPrec :: Int -> Handshake13 -> ShowS # show :: Handshake13 -> String # showList :: [Handshake13] -> ShowS # | |
Eq Handshake13 # | |
Defined in Network.TLS.Struct13 |
contextHookSetHandshake13Recv :: Context -> (Handshake13 -> IO Handshake13) -> IO () #
contextHookSetCertificateRecv :: Context -> (CertificateChain -> IO ()) -> IO () #
Hooks for logging
This is called when sending and receiving packets and IO
loggingPacketSent :: Logging -> String -> IO () #
loggingPacketRecv :: Logging -> String -> IO () #
loggingIOSent :: Logging -> ByteString -> IO () #
loggingIORecv :: Logging -> Header -> ByteString -> IO () #
Constructors
Header ProtocolType Version Word16 |
newtype ProtocolType #
Constructors
ProtocolType | |
Fields |
Bundled Patterns
pattern ProtocolType_ChangeCipherSpec :: ProtocolType | |
pattern ProtocolType_Alert :: ProtocolType | |
pattern ProtocolType_Handshake :: ProtocolType | |
pattern ProtocolType_AppData :: ProtocolType |
Instances
Show ProtocolType # | |
Defined in Network.TLS.Struct Methods showsPrec :: Int -> ProtocolType -> ShowS # show :: ProtocolType -> String # showList :: [ProtocolType] -> ShowS # | |
Eq ProtocolType # | |
Defined in Network.TLS.Struct |
contextHookSetLogging :: Context -> Logging -> IO () #
Errors and exceptions
Errors
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 |
Constructors
RSAError Error | |
KxUnsupported |
newtype AlertDescription #
Constructors
AlertDescription | |
Fields |
Bundled Patterns
pattern DecodeError :: AlertDescription | |
pattern CloseNotify :: AlertDescription | |
pattern UnexpectedMessage :: AlertDescription | |
pattern BadRecordMac :: AlertDescription | |
pattern DecryptionFailed :: AlertDescription | |
pattern RecordOverflow :: AlertDescription | |
pattern DecompressionFailure :: AlertDescription | |
pattern HandshakeFailure :: AlertDescription | |
pattern BadCertificate :: AlertDescription | |
pattern UnsupportedCertificate :: AlertDescription | |
pattern CertificateRevoked :: AlertDescription | |
pattern CertificateExpired :: AlertDescription | |
pattern CertificateUnknown :: AlertDescription | |
pattern IllegalParameter :: AlertDescription | |
pattern UnknownCa :: AlertDescription | |
pattern AccessDenied :: AlertDescription | |
pattern DecryptError :: AlertDescription | |
pattern ExportRestriction :: AlertDescription | |
pattern ProtocolVersion :: AlertDescription | |
pattern InsufficientSecurity :: AlertDescription | |
pattern InternalError :: AlertDescription | |
pattern InappropriateFallback :: AlertDescription | |
pattern UserCanceled :: AlertDescription | |
pattern NoRenegotiation :: AlertDescription | |
pattern MissingExtension :: AlertDescription | |
pattern UnsupportedExtension :: AlertDescription | |
pattern CertificateUnobtainable :: AlertDescription | |
pattern UnrecognizedName :: AlertDescription | |
pattern BadCertificateStatusResponse :: AlertDescription | |
pattern BadCertificateHashValue :: AlertDescription | |
pattern UnknownPskIdentity :: AlertDescription | |
pattern CertificateRequired :: AlertDescription | |
pattern NoApplicationProtocol :: AlertDescription |
Instances
Show AlertDescription # | |
Defined in Network.TLS.Error Methods showsPrec :: Int -> AlertDescription -> ShowS # show :: AlertDescription -> String # showList :: [AlertDescription] -> ShowS # | |
Eq AlertDescription # | |
Defined in Network.TLS.Error Methods (==) :: AlertDescription -> AlertDescription -> Bool # (/=) :: AlertDescription -> AlertDescription -> Bool # |
Exceptions
data 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 |
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. |
Instances
Exception TLSException # | |
Defined in Network.TLS.Error Methods toException :: TLSException -> SomeException # fromException :: SomeException -> Maybe TLSException # displayException :: TLSException -> String # backtraceDesired :: TLSException -> Bool # | |
Show TLSException # | |
Defined in Network.TLS.Error Methods showsPrec :: Int -> TLSException -> ShowS # show :: TLSException -> String # showList :: [TLSException] -> ShowS # | |
Eq TLSException # | |
Defined in Network.TLS.Error |
Raw types
Compressions class
class CompressionC a where #
supported compression algorithms need to be part of this class
Methods
compressionCID :: a -> CompressionID #
compressionCDeflate :: a -> ByteString -> (a, ByteString) #
compressionCInflate :: a -> ByteString -> (a, ByteString) #
type CompressionID = Word8 #
Compression identification
Crypto Key
Public key types known and used in X.509
Constructors
PubKeyRSA PublicKey | RSA public key |
PubKeyDSA PublicKey | DSA public key |
PubKeyDH (Integer, Integer, Integer, Maybe Integer, ([Word8], Integer)) | DH format with (p,g,q,j,(seed,pgenCounter)) |
PubKeyEC PubKeyEC | EC public key |
PubKeyX25519 PublicKey | X25519 public key |
PubKeyX448 PublicKey | X448 public key |
PubKeyEd25519 PublicKey | Ed25519 public key |
PubKeyEd448 PublicKey | Ed448 public key |
PubKeyUnknown OID ByteString | unrecognized format |
Private key types known and used in X.509
Constructors
PrivKeyRSA PrivateKey | RSA private key |
PrivKeyDSA PrivateKey | DSA private key |
PrivKeyEC PrivKeyEC | EC private key |
PrivKeyX25519 SecretKey | X25519 private key |
PrivKeyX448 SecretKey | X448 private key |
PrivKeyEd25519 SecretKey | Ed25519 private key |
PrivKeyEd448 SecretKey | Ed448 private key |
Instances
ASN1Object PrivKey | |
Show PrivKey | |
Show Credential # | |
Defined in Network.TLS.Credentials Methods showsPrec :: Int -> Credential -> ShowS # show :: Credential -> String # showList :: [Credential] -> ShowS # | |
Eq PrivKey | |
Ciphers & Predefined ciphers
Cipher algorithm
Constructors
Cipher | |
Fields
|
data CipherKeyExchangeType #
Constructors
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 |
Instances
Show CipherKeyExchangeType # | |
Defined in Network.TLS.Types.Cipher Methods showsPrec :: Int -> CipherKeyExchangeType -> ShowS # show :: CipherKeyExchangeType -> String # showList :: [CipherKeyExchangeType] -> ShowS # | |
Eq CipherKeyExchangeType # | |
Defined in Network.TLS.Types.Cipher Methods (==) :: CipherKeyExchangeType -> CipherKeyExchangeType -> Bool # (/=) :: CipherKeyExchangeType -> CipherKeyExchangeType -> Bool # |
Constructors
Bulk | |
Fields
|
data BulkFunctions #
Constructors
BulkBlockF (BulkDirection -> BulkKey -> BulkBlock) | |
BulkStreamF (BulkDirection -> BulkKey -> BulkStream) | |
BulkAeadF (BulkDirection -> BulkKey -> BulkAEAD) |
data BulkDirection #
Constructors
BulkEncrypt | |
BulkDecrypt |
Instances
Show BulkDirection # | |
Defined in Network.TLS.Types.Cipher Methods showsPrec :: Int -> BulkDirection -> ShowS # show :: BulkDirection -> String # showList :: [BulkDirection] -> ShowS # | |
Eq BulkDirection # | |
Defined in Network.TLS.Types.Cipher Methods (==) :: BulkDirection -> BulkDirection -> Bool # (/=) :: BulkDirection -> BulkDirection -> Bool # |
newtype BulkStream #
Constructors
BulkStream (ByteString -> (ByteString, BulkStream)) |
type BulkBlock = BulkIV -> ByteString -> (ByteString, BulkIV) #
type BulkAEAD = BulkNonce -> ByteString -> BulkAdditionalData -> (ByteString, AuthTag) #
cipherKeyBlockSize :: Cipher -> Int #
type BulkKey = ByteString #
type BulkIV = ByteString #
type BulkNonce = ByteString #
type BulkAdditionalData = ByteString #
cipherAllowedForVersion :: Version -> Cipher -> Bool #
Check if a specific Cipher
is allowed to be used
with the version specified
hasMAC :: BulkFunctions -> Bool #
hasRecordIV :: BulkFunctions -> Bool #
elemCipher :: [CipherId] -> Cipher -> Bool #
intersectCiphers :: [CipherId] -> [Cipher] -> [Cipher] #
Deprecated
recvData' :: MonadIO m => Context -> m ByteString #
Deprecated: use recvData that returns strict bytestring
same as recvData but returns a lazy bytestring.
type Bytes = ByteString #
Deprecated: Use Data.ByteString.Bytestring instead of Bytes.
data ValidationChecks #
A set of checks to activate or parametrize to perform on certificates.
It's recommended to use defaultChecks
to create the structure,
to better cope with future changes or expansion of the structure.
Constructors
ValidationChecks | |
Fields
|
Instances
Default ValidationChecks | |
Defined in Data.X509.Validation Methods def :: ValidationChecks # | |
Show ValidationChecks | |
Defined in Data.X509.Validation Methods showsPrec :: Int -> ValidationChecks -> ShowS # show :: ValidationChecks -> String # showList :: [ValidationChecks] -> ShowS # | |
Eq ValidationChecks | |
Defined in Data.X509.Validation Methods (==) :: ValidationChecks -> ValidationChecks -> Bool # (/=) :: ValidationChecks -> ValidationChecks -> Bool # |
data ValidationHooks #
A set of hooks to manipulate the way the verification works.
BEWARE, it's easy to change behavior leading to compromised security.
Constructors
ValidationHooks | |
Fields
|
Instances
Default ValidationHooks | |
Defined in Data.X509.Validation Methods def :: ValidationHooks # |
clientUseMaxFragmentLength :: ClientParams -> Maybe MaxFragmentEnum #
Deprecated: UseMaxFragmentLength is deprecated
Default: Nothing