Safe Haskell	None
Language	Haskell2010

Rustls.Internal

Description

Internal module, not subject to PVP.

Synopsis

newtype ALPNProtocol = ALPNProtocol {
- unALPNProtocol :: ByteString
}
newtype CipherSuite = CipherSuite (Ptr SupportedCipherSuite)
cipherSuiteID :: CipherSuite -> Word16
showCipherSuite :: CipherSuite -> Text
data ClientConfigBuilder = ClientConfigBuilder {
- clientConfigRoots :: ClientRoots
- clientConfigTLSVersions :: [TLSVersion]
- clientConfigCipherSuites :: [CipherSuite]
- clientConfigALPNProtocols :: [ALPNProtocol]
- clientConfigEnableSNI :: Bool
- clientConfigCertifiedKeys :: [CertifiedKey]
}
data ClientRoots
- = ClientRootsFromFile FilePath
- | ClientRootsInMemory [PEMCertificates]
data PEMCertificates
- = PEMCertificatesStrict ByteString
- | PEMCertificatesLax ByteString
data CertifiedKey = CertifiedKey {
- certificateChain :: ByteString
- privateKey :: ByteString
}
data ClientConfig = ClientConfig {
- clientConfigPtr :: ForeignPtr ClientConfig
- clientConfigLogCallback :: Maybe LogCallback
}
data ClientCertVerifier
- = ClientCertVerifier [PEMCertificates]
- | ClientCertVerifierOptional [PEMCertificates]
data ServerConfigBuilder = ServerConfigBuilder {
- serverConfigCertifiedKeys :: NonEmpty CertifiedKey
- serverConfigTLSVersions :: [TLSVersion]
- serverConfigCipherSuites :: [CipherSuite]
- serverConfigALPNProtocols :: [ALPNProtocol]
- serverConfigIgnoreClientOrder :: Bool
- serverConfigClientCertVerifier :: Maybe ClientCertVerifier
}
data ServerConfig = ServerConfig {
- serverConfigPtr :: ForeignPtr ServerConfig
- serverConfigLogCallback :: Maybe LogCallback
}
data LogLevel
- = LogLevelError
- | LogLevelWarn
- | LogLevelInfo
- | LogLevelDebug
- | LogLevelTrace
newtype LogCallback = LogCallback {
- unLogCallback :: FunPtr LogCallback
}
newtype HandshakeQuery (side :: Side) a = HandshakeQuery (ReaderT Connection' IO a)
handshakeQuery :: (Connection' -> IO a) -> HandshakeQuery side a
newtype RustlsException = RustlsException {
- rustlsErrorCode :: Word32
}
resultMsg :: Result -> Text
isCertError :: RustlsException -> Bool
rethrowR :: Result -> IO ()
class Backend b where
- backendRead :: b -> Ptr Word8 -> CSize -> IO CSize
- backendWrite :: b -> Ptr Word8 -> CSize -> IO CSize
data ByteStringBackend = ByteStringBackend {
- bsbRead :: Int -> IO ByteString
- bsbWrite :: ByteString -> IO ()
}
data Side
- = Client
- | Server
newtype Connection (side :: Side) = Connection (MVar Connection')
data Connection' = forall b.Backend b => Connection' {
- conn :: Ptr Connection
- backend :: b
- lenPtr :: Ptr CSize
- ioMsgReq :: MVar IOMsgReq
- ioMsgRes :: MVar IOMsgRes
- interactThread :: ThreadId
}
withConnection :: Connection side -> (Connection' -> IO a) -> IO a
data ReadOrWrite
- = Read
- | Write
data IOMsgReq
- = Request ReadOrWrite
- | Done IOResult
data IOMsgRes
- = UsingBuffer (Ptr Word8) CSize (Ptr CSize)
- | DoneFFI
interactTLS :: Connection' -> ReadOrWrite -> IO ()
data RunTLSMode
- = TLSHandshake
- | TLSRead
- | TLSWrite
runTLS :: Connection' -> RunTLSMode -> IO ()
cSizeToInt :: CSize -> Int
intToCSize :: Int -> CSize
strToText :: Str -> IO Text
ignoreExceptions :: IO () -> IO ()
ignoreSyncExceptions :: IO () -> IO ()

Documentation

newtype ALPNProtocol Source #

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

Instances details

Eq ALPNProtocol Source #
Instance details Defined in Rustls.Internal Methods (==) :: ALPNProtocol -> ALPNProtocol -> Bool # (/=) :: ALPNProtocol -> ALPNProtocol -> Bool #
Ord ALPNProtocol Source #
Instance details 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 #
Show ALPNProtocol Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> ALPNProtocol -> ShowS # show :: ALPNProtocol -> String # showList :: [ALPNProtocol] -> ShowS #
Generic ALPNProtocol Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ALPNProtocol :: Type -> Type # Methods from :: ALPNProtocol -> Rep ALPNProtocol x # to :: Rep ALPNProtocol x -> ALPNProtocol #
type Rep ALPNProtocol Source #
Instance details Defined in Rustls.Internal type Rep ALPNProtocol = D1 ('MetaData "ALPNProtocol" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'True) (C1 ('MetaCons "ALPNProtocol" 'PrefixI 'True) (S1 ('MetaSel ('Just "unALPNProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newtype CipherSuite Source #

A TLS cipher suite supported by Rustls.

Constructors

CipherSuite (Ptr SupportedCipherSuite)

Instances

Instances details

Eq CipherSuite Source #
Instance details Defined in Rustls.Internal Methods (==) :: CipherSuite -> CipherSuite -> Bool # (/=) :: CipherSuite -> CipherSuite -> Bool #
Ord CipherSuite Source #
Instance details 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 #
Show CipherSuite Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> CipherSuite -> ShowS # show :: CipherSuite -> String # showList :: [CipherSuite] -> ShowS #

cipherSuiteID :: CipherSuite -> Word16 Source #

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 Source #

Get the text representation of a cipher suite.

data ClientConfigBuilder Source #

Rustls client config builder.

Constructors

ClientConfigBuilder

Fields

clientConfigRoots :: ClientRoots
Client root certificates.
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

Instances details

Show ClientConfigBuilder Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> ClientConfigBuilder -> ShowS # show :: ClientConfigBuilder -> String # showList :: [ClientConfigBuilder] -> ShowS #
Generic ClientConfigBuilder Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ClientConfigBuilder :: Type -> Type # Methods from :: ClientConfigBuilder -> Rep ClientConfigBuilder x # to :: Rep ClientConfigBuilder x -> ClientConfigBuilder #
type Rep ClientConfigBuilder Source #
Instance details Defined in Rustls.Internal type Rep ClientConfigBuilder = D1 ('MetaData "ClientConfigBuilder" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'False) (C1 ('MetaCons "ClientConfigBuilder" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientConfigRoots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientRoots) :: (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 ClientRoots Source #

How to look up root certificates.

Constructors

ClientRootsFromFile FilePath	Fetch PEM-encoded root certificates from a file.
ClientRootsInMemory [PEMCertificates]	Use in-memory PEM-encoded certificates.

Instances

Instances details

Show ClientRoots Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> ClientRoots -> ShowS # show :: ClientRoots -> String # showList :: [ClientRoots] -> ShowS #
Generic ClientRoots Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ClientRoots :: Type -> Type # Methods from :: ClientRoots -> Rep ClientRoots x # to :: Rep ClientRoots x -> ClientRoots #
type Rep ClientRoots Source #
Instance details Defined in Rustls.Internal type Rep ClientRoots = D1 ('MetaData "ClientRoots" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'False) (C1 ('MetaCons "ClientRootsFromFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath)) :+: C1 ('MetaCons "ClientRootsInMemory" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PEMCertificates])))

data PEMCertificates Source #

In-memory PEM-encoded certificates.

Constructors

PEMCertificatesStrict ByteString

Syntactically valid PEM-encoded certificates.

PEMCertificatesLax ByteString

PEM-encoded certificates, ignored if syntactically invalid.

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

Instances

Instances details

Show PEMCertificates Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> PEMCertificates -> ShowS # show :: PEMCertificates -> String # showList :: [PEMCertificates] -> ShowS #
Generic PEMCertificates Source #
Instance details Defined in Rustls.Internal Associated Types type Rep PEMCertificates :: Type -> Type # Methods from :: PEMCertificates -> Rep PEMCertificates x # to :: Rep PEMCertificates x -> PEMCertificates #
type Rep PEMCertificates Source #
Instance details Defined in Rustls.Internal type Rep PEMCertificates = D1 ('MetaData "PEMCertificates" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'False) (C1 ('MetaCons "PEMCertificatesStrict" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "PEMCertificatesLax" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

data CertifiedKey Source #

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

Instances details

Show CertifiedKey Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> CertifiedKey -> ShowS # show :: CertifiedKey -> String # showList :: [CertifiedKey] -> ShowS #
Generic CertifiedKey Source #
Instance details Defined in Rustls.Internal Associated Types type Rep CertifiedKey :: Type -> Type # Methods from :: CertifiedKey -> Rep CertifiedKey x # to :: Rep CertifiedKey x -> CertifiedKey #
type Rep CertifiedKey Source #
Instance details Defined in Rustls.Internal type Rep CertifiedKey = D1 ('MetaData "CertifiedKey" "Rustls.Internal" "rustls-0.0.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 Source #

Assembled configuration for a Rustls client connection.

Constructors

ClientConfig

Fields

clientConfigPtr :: ForeignPtr ClientConfig
clientConfigLogCallback :: Maybe LogCallback
A logging callback. If it throws an exception, a note will be printed to stderr.
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 Source #

How to verify TLS client certificates.

Constructors

ClientCertVerifier [PEMCertificates]	Root certificates used to verify TLS client certificates.
ClientCertVerifierOptional [PEMCertificates]	Root certificates used to verify TLS client certificates if present, but does not reject clients which provide no certificate.

Instances

Instances details

Show ClientCertVerifier Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> ClientCertVerifier -> ShowS # show :: ClientCertVerifier -> String # showList :: [ClientCertVerifier] -> ShowS #
Generic ClientCertVerifier Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ClientCertVerifier :: Type -> Type # Methods from :: ClientCertVerifier -> Rep ClientCertVerifier x # to :: Rep ClientCertVerifier x -> ClientCertVerifier #
type Rep ClientCertVerifier Source #
Instance details Defined in Rustls.Internal type Rep ClientCertVerifier = D1 ('MetaData "ClientCertVerifier" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'False) (C1 ('MetaCons "ClientCertVerifier" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PEMCertificates])) :+: C1 ('MetaCons "ClientCertVerifierOptional" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PEMCertificates])))

data ServerConfigBuilder Source #

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

Instances details

Show ServerConfigBuilder Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> ServerConfigBuilder -> ShowS # show :: ServerConfigBuilder -> String # showList :: [ServerConfigBuilder] -> ShowS #
Generic ServerConfigBuilder Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ServerConfigBuilder :: Type -> Type # Methods from :: ServerConfigBuilder -> Rep ServerConfigBuilder x # to :: Rep ServerConfigBuilder x -> ServerConfigBuilder #
type Rep ServerConfigBuilder Source #
Instance details Defined in Rustls.Internal type Rep ServerConfigBuilder = D1 ('MetaData "ServerConfigBuilder" "Rustls.Internal" "rustls-0.0.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 Source #

Assembled configuration for a Rustls server connection.

Constructors

ServerConfig

Fields

serverConfigPtr :: ForeignPtr ServerConfig
serverConfigLogCallback :: Maybe LogCallback
A logging callback. If it throws an exception, a note will be printed to stderr.
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 Source #

Rustls log level.

Constructors

LogLevelError
LogLevelWarn
LogLevelInfo
LogLevelDebug
LogLevelTrace

Instances

Instances details

Bounded LogLevel Source #
Instance details Defined in Rustls.Internal Methods minBound :: LogLevel # maxBound :: LogLevel #
Enum LogLevel Source #
Instance details 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] #
Eq LogLevel Source #
Instance details Defined in Rustls.Internal Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel Source #
Instance details 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 #
Show LogLevel Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Generic LogLevel Source #
Instance details Defined in Rustls.Internal Associated Types type Rep LogLevel :: Type -> Type # Methods from :: LogLevel -> Rep LogLevel x # to :: Rep LogLevel x -> LogLevel #
type Rep LogLevel Source #
Instance details Defined in Rustls.Internal type Rep LogLevel = D1 ('MetaData "LogLevel" "Rustls.Internal" "rustls-0.0.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 Source #

A Rustls connection logging callback.

Constructors

LogCallback
Fields unLogCallback :: FunPtr LogCallback

newtype HandshakeQuery (side :: Side) a Source #

A Monad to get TLS connection information via handshake.

Constructors

HandshakeQuery (ReaderT Connection' IO a)

Instances

Instances details

Monad (HandshakeQuery side) Source #
Instance details 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 #
Functor (HandshakeQuery side) Source #
Instance details Defined in Rustls.Internal Methods fmap :: (a -> b) -> HandshakeQuery side a -> HandshakeQuery side b # (<$) :: a -> HandshakeQuery side b -> HandshakeQuery side a #
Applicative (HandshakeQuery side) Source #
Instance details 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 #

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

newtype RustlsException Source #

TLS exception thrown by Rustls.

Use displayException for a human-friendly representation.

Constructors

RustlsException
Fields rustlsErrorCode :: Word32

Instances

Instances details

Show RustlsException Source #
Instance details Defined in Rustls.Internal Methods showsPrec :: Int -> RustlsException -> ShowS # show :: RustlsException -> String # showList :: [RustlsException] -> ShowS #
Exception RustlsException Source #
Instance details Defined in Rustls.Internal Methods toException :: RustlsException -> SomeException # fromException :: SomeException -> Maybe RustlsException # displayException :: RustlsException -> String #

resultMsg :: Result -> Text Source #

isCertError :: RustlsException -> Bool Source #

Checks if the given RustlsException represents a certificate error.

rethrowR :: Result -> IO () Source #

class Backend b where Source #

Underlying data sources for Rustls.

Methods

backendRead Source #

Arguments

:: b
-> Ptr Word8	Target buffer pointer.
-> CSize	Target buffer length.
-> IO CSize	Amount of bytes read.

Read data from the backend into the given buffer.

backendWrite Source #

Arguments

:: b
-> Ptr Word8	Source buffer pointer.
-> CSize	Source buffer length.
-> IO CSize	Amount of bytes written.

Write data from the given buffer to the backend.

Instances

Instances details

Backend Socket Source #
Instance details Defined in Rustls.Internal Methods backendRead :: Socket -> Ptr Word8 -> CSize -> IO CSize Source # backendWrite :: Socket -> Ptr Word8 -> CSize -> IO CSize Source #
Backend ByteStringBackend Source #	This instance will silently truncate `ByteString`s which are too long.
Instance details Defined in Rustls.Internal Methods backendRead :: ByteStringBackend -> Ptr Word8 -> CSize -> IO CSize Source # backendWrite :: ByteStringBackend -> Ptr Word8 -> CSize -> IO CSize Source #

data ByteStringBackend Source #

An in-memory Backend.

Constructors

ByteStringBackend
Fields bsbRead :: Int -> IO ByteString Read a `ByteString` with the given max length. bsbWrite :: ByteString -> IO () Write a `ByteString`.

Instances

Instances details

Generic ByteStringBackend Source #
Instance details Defined in Rustls.Internal Associated Types type Rep ByteStringBackend :: Type -> Type # Methods from :: ByteStringBackend -> Rep ByteStringBackend x # to :: Rep ByteStringBackend x -> ByteStringBackend #
Backend ByteStringBackend Source #	This instance will silently truncate `ByteString`s which are too long.
Instance details Defined in Rustls.Internal Methods backendRead :: ByteStringBackend -> Ptr Word8 -> CSize -> IO CSize Source # backendWrite :: ByteStringBackend -> Ptr Word8 -> CSize -> IO CSize Source #
type Rep ByteStringBackend Source #
Instance details Defined in Rustls.Internal type Rep ByteStringBackend = D1 ('MetaData "ByteStringBackend" "Rustls.Internal" "rustls-0.0.0.0-inplace" 'False) (C1 ('MetaCons "ByteStringBackend" 'PrefixI 'True) (S1 ('MetaSel ('Just "bsbRead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Int -> IO ByteString)) :*: S1 ('MetaSel ('Just "bsbWrite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ByteString -> IO ()))))

data Side Source #

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

Constructors

Client
Server

newtype Connection (side :: Side) Source #

A Rustls connection.

Constructors

Connection (MVar Connection')

data Connection' Source #

Constructors

forall b.Backend b => Connection'
Fields conn :: Ptr Connection backend :: b lenPtr :: Ptr CSize ioMsgReq :: MVar IOMsgReq ioMsgRes :: MVar IOMsgRes interactThread :: ThreadId

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

data ReadOrWrite Source #

Constructors

Read
Write

data IOMsgReq Source #

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 Source #

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

data RunTLSMode Source #

Constructors

TLSHandshake
TLSRead
TLSWrite

Instances

Instances details

Eq RunTLSMode Source #
Instance details Defined in Rustls.Internal Methods (==) :: RunTLSMode -> RunTLSMode -> Bool # (/=) :: RunTLSMode -> RunTLSMode -> Bool #

runTLS :: Connection' -> RunTLSMode -> IO () Source #

cSizeToInt :: CSize -> Int Source #

intToCSize :: Int -> CSize Source #

strToText :: Str -> IO Text Source #

ignoreExceptions :: IO () -> IO () Source #

ignoreSyncExceptions :: IO () -> IO () Source #