Rustls.Internal

Internal module, not subject to PVP.

Documentation

newtype ALPNProtocol

An ALPN protocol ID. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for a list of registered IDs.

Constructors

ALPNProtocol

Fields

• unALPNProtocol :: ByteString

Instances

Generic ALPNProtocol

Defined in Rustls.Internal

Associated Types

type Rep ALPNProtocol :: Type -> Type

Methods

from :: ALPNProtocol -> Rep ALPNProtocol x

to :: Rep ALPNProtocol x -> ALPNProtocol

Show ALPNProtocol

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ALPNProtocol -> ShowS

show :: ALPNProtocol -> String

showList :: [ALPNProtocol] -> ShowS

Eq ALPNProtocol

Defined in Rustls.Internal

Methods

(==) :: ALPNProtocol -> ALPNProtocol -> Bool

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

Ord ALPNProtocol

Defined in Rustls.Internal

Methods

compare :: ALPNProtocol -> ALPNProtocol -> Ordering

(<) :: ALPNProtocol -> ALPNProtocol -> Bool

(<=) :: ALPNProtocol -> ALPNProtocol -> Bool

(>) :: ALPNProtocol -> ALPNProtocol -> Bool

(>=) :: ALPNProtocol -> ALPNProtocol -> Bool

max :: ALPNProtocol -> ALPNProtocol -> ALPNProtocol

min :: ALPNProtocol -> ALPNProtocol -> ALPNProtocol

type Rep ALPNProtocol

Defined in Rustls.Internal

type Rep ALPNProtocol = D1 ('MetaData "ALPNProtocol" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ALPNProtocol" 'PrefixI 'True) (S1 ('MetaSel ('Just "unALPNProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype CipherSuite

A TLS cipher suite supported by Rustls.

Constructors

CipherSuite (ConstPtr SupportedCipherSuite)

Instances

Show CipherSuite

Defined in Rustls.Internal

Methods

showsPrec :: Int -> CipherSuite -> ShowS

show :: CipherSuite -> String

showList :: [CipherSuite] -> ShowS

Eq CipherSuite

Defined in Rustls.Internal

Methods

(==) :: CipherSuite -> CipherSuite -> Bool

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

Ord CipherSuite

Defined in Rustls.Internal

Methods

compare :: CipherSuite -> CipherSuite -> Ordering

(<) :: CipherSuite -> CipherSuite -> Bool

(<=) :: CipherSuite -> CipherSuite -> Bool

(>) :: CipherSuite -> CipherSuite -> Bool

(>=) :: CipherSuite -> CipherSuite -> Bool

max :: CipherSuite -> CipherSuite -> CipherSuite

min :: CipherSuite -> CipherSuite -> CipherSuite

cipherSuiteID :: CipherSuite -> Word16

Get the IANA value from a cipher suite. The bytes are interpreted in network order.

See https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4 for a list.

showCipherSuite :: CipherSuite -> Text

Get the text representation of a cipher suite.

data ClientConfigBuilder

Rustls client config builder.

Constructors

ClientConfigBuilder

Fields

• clientConfigServerCertVerifier :: ServerCertVerifier

  The server certificate verifier.

• clientConfigTLSVersions :: [TLSVersion]

  Supported TLSVersions. When empty, good defaults are used.

• clientConfigCipherSuites :: [CipherSuite]

  Supported CipherSuites in order of preference. When empty, good defaults are used.

• clientConfigALPNProtocols :: [ALPNProtocol]

  ALPN protocols.

• clientConfigEnableSNI :: Bool

  Whether to enable Server Name Indication. Defaults to True.

• clientConfigCertifiedKeys :: [CertifiedKey]

  List of CertifiedKeys for client authentication.

  Clients that want to support both ECDSA and RSA certificates will want the ECDSA to go first in the list.

Instances

Generic ClientConfigBuilder

Defined in Rustls.Internal

Associated Types

type Rep ClientConfigBuilder :: Type -> Type

Methods

from :: ClientConfigBuilder -> Rep ClientConfigBuilder x

to :: Rep ClientConfigBuilder x -> ClientConfigBuilder

Show ClientConfigBuilder

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ClientConfigBuilder -> ShowS

show :: ClientConfigBuilder -> String

showList :: [ClientConfigBuilder] -> ShowS

type Rep ClientConfigBuilder

Defined in Rustls.Internal

type Rep ClientConfigBuilder = D1 ('MetaData "ClientConfigBuilder" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ClientConfigBuilder" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientConfigServerCertVerifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServerCertVerifier) :*: (S1 ('MetaSel ('Just "clientConfigTLSVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TLSVersion]) :*: S1 ('MetaSel ('Just "clientConfigCipherSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CipherSuite]))) :*: (S1 ('MetaSel ('Just "clientConfigALPNProtocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ALPNProtocol]) :*: (S1 ('MetaSel ('Just "clientConfigEnableSNI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "clientConfigCertifiedKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CertifiedKey])))))

data ServerCertVerifier

How to verify TLS server certificates.

Constructors

ServerCertVerifier

Fields

• serverCertVerifierCertificates :: NonEmpty PEMCertificates

  Certificates used to verify TLS server certificates.

• serverCertVerifierCRLs :: [CertificateRevocationList]

  List of certificate revocation lists used to verify TLS server certificates.

Instances

Generic ServerCertVerifier

Defined in Rustls.Internal

Associated Types

type Rep ServerCertVerifier :: Type -> Type

Methods

from :: ServerCertVerifier -> Rep ServerCertVerifier x

to :: Rep ServerCertVerifier x -> ServerCertVerifier

Show ServerCertVerifier

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ServerCertVerifier -> ShowS

show :: ServerCertVerifier -> String

showList :: [ServerCertVerifier] -> ShowS

type Rep ServerCertVerifier

Defined in Rustls.Internal

type Rep ServerCertVerifier = D1 ('MetaData "ServerCertVerifier" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ServerCertVerifier" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverCertVerifierCertificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PEMCertificates)) :*: S1 ('MetaSel ('Just "serverCertVerifierCRLs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CertificateRevocationList])))

data PEMCertificates

A source of PEM-encoded certificates.

Constructors

PEMCertificatesInMemory ByteString PEMCertificateParsing

In-memory PEM-encoded certificates.

PemCertificatesFromFile FilePath PEMCertificateParsing

Fetch PEM-encoded root certificates from a file.

Instances

Generic PEMCertificates

Defined in Rustls.Internal

Associated Types

type Rep PEMCertificates :: Type -> Type

Methods

from :: PEMCertificates -> Rep PEMCertificates x

to :: Rep PEMCertificates x -> PEMCertificates

Show PEMCertificates

Defined in Rustls.Internal

Methods

showsPrec :: Int -> PEMCertificates -> ShowS

show :: PEMCertificates -> String

showList :: [PEMCertificates] -> ShowS

type Rep PEMCertificates

Defined in Rustls.Internal

type Rep PEMCertificates = D1 ('MetaData "PEMCertificates" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PEMCertificatesInMemory" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PEMCertificateParsing)) :+: C1 ('MetaCons "PemCertificatesFromFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PEMCertificateParsing)))

data PEMCertificateParsing

Parsing mode for PEM-encoded certificates.

Constructors

PEMCertificateParsingStrict

Fail if syntactically invalid.

PEMCertificateParsingLax

Ignore if syntactically invalid.

This may be useful on systems that have syntactically invalid root certificates.

Instances

Bounded PEMCertificateParsing

Defined in Rustls.Internal

Methods

minBound :: PEMCertificateParsing

maxBound :: PEMCertificateParsing

Enum PEMCertificateParsing

Defined in Rustls.Internal

Methods

succ :: PEMCertificateParsing -> PEMCertificateParsing

pred :: PEMCertificateParsing -> PEMCertificateParsing

toEnum :: Int -> PEMCertificateParsing

fromEnum :: PEMCertificateParsing -> Int

enumFrom :: PEMCertificateParsing -> [PEMCertificateParsing]

enumFromThen :: PEMCertificateParsing -> PEMCertificateParsing -> [PEMCertificateParsing]

enumFromTo :: PEMCertificateParsing -> PEMCertificateParsing -> [PEMCertificateParsing]

enumFromThenTo :: PEMCertificateParsing -> PEMCertificateParsing -> PEMCertificateParsing -> [PEMCertificateParsing]

Generic PEMCertificateParsing

Defined in Rustls.Internal

Associated Types

type Rep PEMCertificateParsing :: Type -> Type

Methods

from :: PEMCertificateParsing -> Rep PEMCertificateParsing x

to :: Rep PEMCertificateParsing x -> PEMCertificateParsing

Show PEMCertificateParsing

Defined in Rustls.Internal

Methods

showsPrec :: Int -> PEMCertificateParsing -> ShowS

show :: PEMCertificateParsing -> String

showList :: [PEMCertificateParsing] -> ShowS

Eq PEMCertificateParsing

Defined in Rustls.Internal

Methods

(==) :: PEMCertificateParsing -> PEMCertificateParsing -> Bool

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

Ord PEMCertificateParsing

Defined in Rustls.Internal

Methods

compare :: PEMCertificateParsing -> PEMCertificateParsing -> Ordering

(<) :: PEMCertificateParsing -> PEMCertificateParsing -> Bool

(<=) :: PEMCertificateParsing -> PEMCertificateParsing -> Bool

(>) :: PEMCertificateParsing -> PEMCertificateParsing -> Bool

(>=) :: PEMCertificateParsing -> PEMCertificateParsing -> Bool

max :: PEMCertificateParsing -> PEMCertificateParsing -> PEMCertificateParsing

min :: PEMCertificateParsing -> PEMCertificateParsing -> PEMCertificateParsing

type Rep PEMCertificateParsing

Defined in Rustls.Internal

type Rep PEMCertificateParsing = D1 ('MetaData "PEMCertificateParsing" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PEMCertificateParsingStrict" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PEMCertificateParsingLax" 'PrefixI 'False) (U1 :: Type -> Type))

data CertifiedKey

A complete chain of certificates plus a private key for the leaf certificate.

Constructors

CertifiedKey

Fields

• certificateChain :: ByteString

  PEM-encoded certificate chain.

• privateKey :: ByteString

  PEM-encoded private key.

Instances

Generic CertifiedKey

Defined in Rustls.Internal

Associated Types

type Rep CertifiedKey :: Type -> Type

Methods

from :: CertifiedKey -> Rep CertifiedKey x

to :: Rep CertifiedKey x -> CertifiedKey

Show CertifiedKey

Defined in Rustls.Internal

Methods

showsPrec :: Int -> CertifiedKey -> ShowS

show :: CertifiedKey -> String

showList :: [CertifiedKey] -> ShowS

type Rep CertifiedKey

Defined in Rustls.Internal

type Rep CertifiedKey = D1 ('MetaData "CertifiedKey" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "CertifiedKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateChain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

data ClientConfig

Assembled configuration for a Rustls client connection.

Constructors

ClientConfig

Fields

• clientConfigPtr :: ForeignPtr ClientConfig
• clientConfigLogCallback :: Maybe LogCallback

  A logging callback.

  Note that this is a record selector, so you can use it as a setter:

  >>> :{
  setLogCallback :: LogCallback -> ClientConfig -> ClientConfig
  setLogCallback logCallback clientConfig =
    clientConfig { clientConfigLogCallback = Just logCallback }
  :}
  

data ClientCertVerifier

How to verify TLS client certificates.

Constructors

ClientCertVerifier

Fields

• clientCertVerifierPolicy :: ClientCertVerifierPolicy

  Which client connections are allowed.

• clientCertVerifierCertificates :: NonEmpty PEMCertificates

  Certificates used to verify TLS client certificates.

• clientCertVerifierCRLs :: [CertificateRevocationList]

  List of certificate revocation lists used to verify TLS client certificates.

Instances

Generic ClientCertVerifier

Defined in Rustls.Internal

Associated Types

type Rep ClientCertVerifier :: Type -> Type

Methods

from :: ClientCertVerifier -> Rep ClientCertVerifier x

to :: Rep ClientCertVerifier x -> ClientCertVerifier

Show ClientCertVerifier

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ClientCertVerifier -> ShowS

show :: ClientCertVerifier -> String

showList :: [ClientCertVerifier] -> ShowS

type Rep ClientCertVerifier

Defined in Rustls.Internal

type Rep ClientCertVerifier = D1 ('MetaData "ClientCertVerifier" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ClientCertVerifier" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientCertVerifierPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientCertVerifierPolicy) :*: (S1 ('MetaSel ('Just "clientCertVerifierCertificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PEMCertificates)) :*: S1 ('MetaSel ('Just "clientCertVerifierCRLs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CertificateRevocationList]))))

data ClientCertVerifierPolicy

Which client connections are allowed by a ClientCertVerifier.

Constructors

AllowAnyAuthenticatedClient

Allow any authenticated client (i.e. offering a trusted certificate), and reject clients offering none.

AllowAnyAnonymousOrAuthenticatedClient

Allow any authenticated client (i.e. offering a trusted certificate), but also allow clients offering none.

Instances

Bounded ClientCertVerifierPolicy

Defined in Rustls.Internal

Methods

minBound :: ClientCertVerifierPolicy

maxBound :: ClientCertVerifierPolicy

Enum ClientCertVerifierPolicy

Defined in Rustls.Internal

Methods

succ :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy

pred :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy

toEnum :: Int -> ClientCertVerifierPolicy

fromEnum :: ClientCertVerifierPolicy -> Int

enumFrom :: ClientCertVerifierPolicy -> [ClientCertVerifierPolicy]

enumFromThen :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> [ClientCertVerifierPolicy]

enumFromTo :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> [ClientCertVerifierPolicy]

enumFromThenTo :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> [ClientCertVerifierPolicy]

Generic ClientCertVerifierPolicy

Defined in Rustls.Internal

Associated Types

type Rep ClientCertVerifierPolicy :: Type -> Type

Methods

from :: ClientCertVerifierPolicy -> Rep ClientCertVerifierPolicy x

to :: Rep ClientCertVerifierPolicy x -> ClientCertVerifierPolicy

Show ClientCertVerifierPolicy

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ClientCertVerifierPolicy -> ShowS

show :: ClientCertVerifierPolicy -> String

showList :: [ClientCertVerifierPolicy] -> ShowS

Eq ClientCertVerifierPolicy

Defined in Rustls.Internal

Methods

(==) :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Bool

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

Ord ClientCertVerifierPolicy

Defined in Rustls.Internal

Methods

compare :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Ordering

(<) :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Bool

(<=) :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Bool

(>) :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Bool

(>=) :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> Bool

max :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> ClientCertVerifierPolicy

min :: ClientCertVerifierPolicy -> ClientCertVerifierPolicy -> ClientCertVerifierPolicy

type Rep ClientCertVerifierPolicy

Defined in Rustls.Internal

type Rep ClientCertVerifierPolicy = D1 ('MetaData "ClientCertVerifierPolicy" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "AllowAnyAuthenticatedClient" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AllowAnyAnonymousOrAuthenticatedClient" 'PrefixI 'False) (U1 :: Type -> Type))

newtype CertificateRevocationList

One or more PEM-encoded certificate revocation lists (CRL).

Constructors

CertificateRevocationList

Fields

• unCertificateRevocationList :: ByteString

Instances

Generic CertificateRevocationList

Defined in Rustls.Internal

Associated Types

type Rep CertificateRevocationList :: Type -> Type

Methods

from :: CertificateRevocationList -> Rep CertificateRevocationList x

to :: Rep CertificateRevocationList x -> CertificateRevocationList

Show CertificateRevocationList

Defined in Rustls.Internal

Methods

showsPrec :: Int -> CertificateRevocationList -> ShowS

show :: CertificateRevocationList -> String

showList :: [CertificateRevocationList] -> ShowS

type Rep CertificateRevocationList

Defined in Rustls.Internal

type Rep CertificateRevocationList = D1 ('MetaData "CertificateRevocationList" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'True) (C1 ('MetaCons "CertificateRevocationList" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCertificateRevocationList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data ServerConfigBuilder

Rustls client config builder.

Constructors

ServerConfigBuilder

Fields

• serverConfigCertifiedKeys :: NonEmpty CertifiedKey

  List of CertifiedKeys.

• serverConfigTLSVersions :: [TLSVersion]

  Supported TLSVersions. When empty, good defaults are used.

• serverConfigCipherSuites :: [CipherSuite]

  Supported CipherSuites in order of preference. When empty, good defaults are used.

• serverConfigALPNProtocols :: [ALPNProtocol]

  ALPN protocols.

• serverConfigIgnoreClientOrder :: Bool

  Ignore the client's ciphersuite order. Defaults to False.

• serverConfigClientCertVerifier :: Maybe ClientCertVerifier

  Optionally, a client cert verifier.

Instances

Generic ServerConfigBuilder

Defined in Rustls.Internal

Associated Types

type Rep ServerConfigBuilder :: Type -> Type

Methods

from :: ServerConfigBuilder -> Rep ServerConfigBuilder x

to :: Rep ServerConfigBuilder x -> ServerConfigBuilder

Show ServerConfigBuilder

Defined in Rustls.Internal

Methods

showsPrec :: Int -> ServerConfigBuilder -> ShowS

show :: ServerConfigBuilder -> String

showList :: [ServerConfigBuilder] -> ShowS

type Rep ServerConfigBuilder

Defined in Rustls.Internal

type Rep ServerConfigBuilder = D1 ('MetaData "ServerConfigBuilder" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ServerConfigBuilder" 'PrefixI 'True) ((S1 ('MetaSel ('Just "serverConfigCertifiedKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty CertifiedKey)) :*: (S1 ('MetaSel ('Just "serverConfigTLSVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TLSVersion]) :*: S1 ('MetaSel ('Just "serverConfigCipherSuites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CipherSuite]))) :*: (S1 ('MetaSel ('Just "serverConfigALPNProtocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ALPNProtocol]) :*: (S1 ('MetaSel ('Just "serverConfigIgnoreClientOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "serverConfigClientCertVerifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientCertVerifier))))))

data ServerConfig

Assembled configuration for a Rustls server connection.

Constructors

ServerConfig

Fields

• serverConfigPtr :: ForeignPtr ServerConfig
• serverConfigLogCallback :: Maybe LogCallback

  A logging callback.

  Note that this is a record selector, so you can use it as a setter:

  >>> :{
  setLogCallback :: LogCallback -> ServerConfig -> ServerConfig
  setLogCallback logCallback serverConfig =
    serverConfig { serverConfigLogCallback = Just logCallback }
  :}
  

data LogLevel

Rustls log level.

Constructors

LogLevelError

LogLevelWarn

LogLevelInfo

LogLevelDebug

LogLevelTrace

Instances

Bounded LogLevel

Defined in Rustls.Internal

Methods

minBound :: LogLevel

maxBound :: LogLevel

Enum LogLevel

Defined in Rustls.Internal

Methods

succ :: LogLevel -> LogLevel

pred :: LogLevel -> LogLevel

toEnum :: Int -> LogLevel

fromEnum :: LogLevel -> Int

enumFrom :: LogLevel -> [LogLevel]

enumFromThen :: LogLevel -> LogLevel -> [LogLevel]

enumFromTo :: LogLevel -> LogLevel -> [LogLevel]

enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel]

Generic LogLevel

Defined in Rustls.Internal

Associated Types

type Rep LogLevel :: Type -> Type

Methods

from :: LogLevel -> Rep LogLevel x

to :: Rep LogLevel x -> LogLevel

Show LogLevel

Defined in Rustls.Internal

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Eq LogLevel

Defined in Rustls.Internal

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Ord LogLevel

Defined in Rustls.Internal

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

type Rep LogLevel

Defined in Rustls.Internal

type Rep LogLevel = D1 ('MetaData "LogLevel" "Rustls.Internal" "rustls-0.1.0.0-inplace" 'False) ((C1 ('MetaCons "LogLevelError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LogLevelWarn" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LogLevelInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LogLevelDebug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LogLevelTrace" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype LogCallback

A Rustls connection logging callback.

Constructors

LogCallback

Fields

• unLogCallback :: FunPtr LogCallback

newtype HandshakeQuery (side :: Side) a

A Monad to get TLS connection information via handshake.

Constructors

HandshakeQuery (ReaderT Connection' IO a)

Instances

Applicative (HandshakeQuery side)

Defined in Rustls.Internal

Methods

pure :: a -> HandshakeQuery side a

(<*>) :: HandshakeQuery side (a -> b) -> HandshakeQuery side a -> HandshakeQuery side b

liftA2 :: (a -> b -> c) -> HandshakeQuery side a -> HandshakeQuery side b -> HandshakeQuery side c

(*>) :: HandshakeQuery side a -> HandshakeQuery side b -> HandshakeQuery side b

(<*) :: HandshakeQuery side a -> HandshakeQuery side b -> HandshakeQuery side a

Functor (HandshakeQuery side)

Defined in Rustls.Internal

Methods

fmap :: (a -> b) -> HandshakeQuery side a -> HandshakeQuery side b

(<$) :: a -> HandshakeQuery side b -> HandshakeQuery side a

Monad (HandshakeQuery side)

Defined in Rustls.Internal

Methods

(>>=) :: HandshakeQuery side a -> (a -> HandshakeQuery side b) -> HandshakeQuery side b

(>>) :: HandshakeQuery side a -> HandshakeQuery side b -> HandshakeQuery side b

return :: a -> HandshakeQuery side a

handshakeQuery :: (Connection' -> IO a) -> HandshakeQuery side a

newtype RustlsException

TLS exception thrown by Rustls.

Use displayException for a human-friendly representation.

Constructors

RustlsException

Fields

• rustlsErrorCode :: Word32

Instances

Exception RustlsException

Defined in Rustls.Internal

Methods

toException :: RustlsException -> SomeException

fromException :: SomeException -> Maybe RustlsException

displayException :: RustlsException -> String

Show RustlsException

Defined in Rustls.Internal

Methods

showsPrec :: Int -> RustlsException -> ShowS

show :: RustlsException -> String

showList :: [RustlsException] -> ShowS

resultMsg :: Result -> Text

isCertError :: RustlsException -> Bool

Checks if the given RustlsException represents a certificate error.

rethrowR :: Result -> IO ()

newtype RustlsLogException

Wrapper for exceptions thrown in a LogCallback.

Constructors

RustlsLogException SomeException

Instances

Exception RustlsLogException

Defined in Rustls.Internal

Methods

toException :: RustlsLogException -> SomeException

fromException :: SomeException -> Maybe RustlsLogException

displayException :: RustlsLogException -> String

Show RustlsLogException

Defined in Rustls.Internal

Methods

showsPrec :: Int -> RustlsLogException -> ShowS

show :: RustlsLogException -> String

showList :: [RustlsLogException] -> ShowS

data RustlsUnknownLogLevel

Constructors

RustlsUnknownLogLevel LogLevel

Instances

Exception RustlsUnknownLogLevel

Defined in Rustls.Internal

Methods

toException :: RustlsUnknownLogLevel -> SomeException

fromException :: SomeException -> Maybe RustlsUnknownLogLevel

displayException :: RustlsUnknownLogLevel -> String

Show RustlsUnknownLogLevel

Defined in Rustls.Internal

Methods

showsPrec :: Int -> RustlsUnknownLogLevel -> ShowS

show :: RustlsUnknownLogLevel -> String

showList :: [RustlsUnknownLogLevel] -> ShowS

data Backend

Underlying data source for Rustls.

Constructors

Backend

Fields

• backendRead :: Ptr Word8 -> CSize -> IO CSize

  Read data from the backend into the given buffer.

• backendWrite :: Ptr Word8 -> CSize -> IO CSize

  Write data from the given buffer to the backend.

mkSocketBackend :: Socket -> Backend

mkByteStringBackend

Arguments

:: (Int -> IO ByteString)

Read a ByteString with the given max length.

This will silently truncate ByteStrings which are too long.

-> (ByteString -> IO ())

Write a ByteString.

-> Backend

An in-memory Backend.

data Side

Type-level indicator whether a Connection is client- or server-side.

Constructors

Client

Server

newtype Connection (side :: Side)

A Rustls connection.

Constructors

Connection (MVar Connection')

data Connection'

Constructors

Connection'

Fields

• conn :: Ptr Connection
• backend :: Backend
• lenPtr :: Ptr CSize
• ioMsgReq :: MVar IOMsgReq
• ioMsgRes :: MVar IOMsgRes
• interactThread :: ThreadId

withConnection :: Connection side -> (Connection' -> IO a) -> IO a

data ReadOrWrite

Constructors

Read

Write

data IOMsgReq

Messages sent to the background thread.

Constructors

Request ReadOrWrite

Request to start a read or a write FFI call from the background thread. It should respond with UsingBuffer.

Done IOResult

Notify the background thread that we are done interacting with the buffer.

data IOMsgRes

Messages sent from the background thread.

Constructors

UsingBuffer (Ptr Word8) CSize (Ptr CSize)

Reply with a buffer, either containing the read data, or awaiting a write to this buffer.

DoneFFI

Notify that the FFI call finished.

interactTLS :: Connection' -> ReadOrWrite -> IO CSize

data IsEOF

Constructors

IsEOF

NotEOF

Instances

Show IsEOF

Defined in Rustls.Internal

Methods

showsPrec :: Int -> IsEOF -> ShowS

show :: IsEOF -> String

showList :: [IsEOF] -> ShowS

Eq IsEOF

Defined in Rustls.Internal

Methods

(==) :: IsEOF -> IsEOF -> Bool

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

completeIO :: Connection' -> IO IsEOF

Helper function, see complete_io from rustls.

https://github.com/rustls/rustls/blob/v/0.23.4/rustls/src/conn.rs#L544

completePriorIO :: Connection' -> IO ()

getIsHandshaking :: Connection' -> IO Bool

getWantsRead :: Connection' -> IO Bool

getWantsWrite :: Connection' -> IO Bool

whenM :: Monad m => m Bool -> m () -> m ()

loopWhileTrue :: Monad m => m Bool -> m ()

cSizeToInt :: CSize -> Int

intToCSize :: Int -> CSize

strToText :: Str -> IO Text

ignoreExceptions :: IO () -> IO ()

ignoreSyncExceptions :: IO () -> IO ()