Rustls.Internal.FFI

Internal module, not subject to PVP.

Documentation

newtype ConstPtr a

A pointer with the C const qualifier. For instance, an argument of type ConstPtr CInt would be marshalled as const int*.

While const-ness generally does not matter for ccall imports (since const and non-const pointers typically have equivalent calling conventions), it does matter for capi imports. See GHC #22043.

@since base-4.18.0.0

Constructors

ConstPtr

Fields

• unConstPtr :: Ptr a

Instances

Storable (ConstPtr a)

Defined in GHC.Internal.Foreign.Storable

Methods

sizeOf :: ConstPtr a -> Int

alignment :: ConstPtr a -> Int

peekElemOff :: Ptr (ConstPtr a) -> Int -> IO (ConstPtr a)

pokeElemOff :: Ptr (ConstPtr a) -> Int -> ConstPtr a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (ConstPtr a)

pokeByteOff :: Ptr b -> Int -> ConstPtr a -> IO ()

peek :: Ptr (ConstPtr a) -> IO (ConstPtr a)

poke :: Ptr (ConstPtr a) -> ConstPtr a -> IO ()

Show (ConstPtr a)

Defined in GHC.Internal.Foreign.C.ConstPtr

Methods

showsPrec :: Int -> ConstPtr a -> ShowS

show :: ConstPtr a -> String

showList :: [ConstPtr a] -> ShowS

Eq (ConstPtr a)

Defined in GHC.Internal.Foreign.C.ConstPtr

Methods

(==) :: ConstPtr a -> ConstPtr a -> Bool

(/=) :: ConstPtr a -> ConstPtr a -> Bool

Ord (ConstPtr a)

Defined in GHC.Internal.Foreign.C.ConstPtr

Methods

compare :: ConstPtr a -> ConstPtr a -> Ordering

(<) :: ConstPtr a -> ConstPtr a -> Bool

(<=) :: ConstPtr a -> ConstPtr a -> Bool

(>) :: ConstPtr a -> ConstPtr a -> Bool

(>=) :: ConstPtr a -> ConstPtr a -> Bool

max :: ConstPtr a -> ConstPtr a -> ConstPtr a

min :: ConstPtr a -> ConstPtr a -> ConstPtr a

type ConstCString = ConstPtr CChar

Client

Config

data ClientConfig

data ClientConfigBuilder

clientConfigBuilderNewCustom :: ConstPtr CryptoProvider -> ConstPtr TLSVersion -> CSize -> Ptr (Ptr ClientConfigBuilder) -> IO Result

clientConfigBuilderFree :: Ptr ClientConfigBuilder -> IO ()

clientConfigBuilderBuild :: Ptr ClientConfigBuilder -> Ptr (ConstPtr ClientConfig) -> IO Result

clientConfigFree :: FinalizerPtr ClientConfig

clientConfigBuilderSetALPNProtocols :: Ptr ClientConfigBuilder -> ConstPtr SliceBytes -> CSize -> IO Result

clientConfigBuilderSetEnableSNI :: Ptr ClientConfigBuilder -> CBool -> IO ()

clientConfigBuilderSetCertifiedKey :: Ptr ClientConfigBuilder -> ConstPtr (ConstPtr CertifiedKey) -> CSize -> IO Result

data WebPkiServerCertVerifierBuilder

data ServerCertVerifier

webPkiServerCertVerifierBuilderNewWithProvider :: ConstPtr CryptoProvider -> ConstPtr RootCertStore -> IO (Ptr WebPkiServerCertVerifierBuilder)

webPkiServerCertVerifierBuilderAddCrl :: Ptr WebPkiServerCertVerifierBuilder -> ConstPtr Word8 -> CSize -> IO Result

webPkiServerCertVerifierBuilderFree :: Ptr WebPkiServerCertVerifierBuilder -> IO ()

webPkiServerCertVerifierBuilderBuild :: Ptr WebPkiServerCertVerifierBuilder -> Ptr (Ptr ServerCertVerifier) -> IO Result

platformServerCertVerifierWithProvider :: ConstPtr CryptoProvider -> IO (Ptr ServerCertVerifier)

serverCertVerifierFree :: Ptr ServerCertVerifier -> IO ()

clientConfigBuilderSetServerVerifier :: Ptr ClientConfigBuilder -> ConstPtr ServerCertVerifier -> IO ()

Connection

clientConnectionNew

Arguments

:: ConstPtr ClientConfig

-> ConstCString

Hostname.

-> Ptr (Ptr Connection)

-> IO Result

serverConnectionNew :: ConstPtr ServerConfig -> Ptr (Ptr Connection) -> IO Result

Server

Config

data ServerConfig

data ServerConfigBuilder

serverConfigBuilderNewCustom :: ConstPtr CryptoProvider -> ConstPtr TLSVersion -> CSize -> Ptr (Ptr ServerConfigBuilder) -> IO Result

serverConfigBuilderFree :: Ptr ServerConfigBuilder -> IO ()

serverConfigBuilderBuild :: Ptr ServerConfigBuilder -> Ptr (ConstPtr ServerConfig) -> IO Result

serverConfigFree :: FinalizerPtr ServerConfig

serverConfigBuilderSetALPNProtocols :: Ptr ServerConfigBuilder -> ConstPtr SliceBytes -> CSize -> IO Result

serverConfigBuilderSetIgnoreClientOrder :: Ptr ServerConfigBuilder -> CBool -> IO Result

serverConfigBuilderSetCertifiedKeys :: Ptr ServerConfigBuilder -> ConstPtr (ConstPtr CertifiedKey) -> CSize -> IO Result

data WebPkiClientCertVerifierBuilder

data ClientCertVerifier

webPkiClientCertVerifierBuilderNewWithProvider :: ConstPtr CryptoProvider -> ConstPtr RootCertStore -> IO (Ptr WebPkiClientCertVerifierBuilder)

webPkiClientCertVerifierBuilderAddCrl :: Ptr WebPkiClientCertVerifierBuilder -> ConstPtr Word8 -> CSize -> IO Result

webPkiClientCertVerifierBuilderAllowUnauthenticated :: Ptr WebPkiClientCertVerifierBuilder -> IO Result

webPkiClientCertVerifierBuilderFree :: Ptr WebPkiClientCertVerifierBuilder -> IO ()

webPkiClientCertVerifierBuilderBuild :: Ptr WebPkiClientCertVerifierBuilder -> Ptr (Ptr ClientCertVerifier) -> IO Result

clientCertVerifierFree :: Ptr ClientCertVerifier -> IO ()

serverConfigBuilderSetClientVerifier :: Ptr ServerConfigBuilder -> ConstPtr ClientCertVerifier -> IO ()

Certificate stuff

data CertifiedKey

certifiedKeyBuild :: ConstPtr Word8 -> CSize -> ConstPtr Word8 -> CSize -> Ptr (ConstPtr CertifiedKey) -> IO Result

certifiedKeyFree :: ConstPtr CertifiedKey -> IO ()

data Certificate

certificateGetDER :: ConstPtr Certificate -> Ptr (ConstPtr Word8) -> Ptr CSize -> IO Result

Connection

data Connection

connectionFree :: Ptr Connection -> IO ()

Read/write

Read

type ReadCallback = Ptr Userdata -> Ptr Word8 -> CSize -> Ptr CSize -> IO IOResult

mkReadCallback :: ReadCallback -> IO (FunPtr ReadCallback)

connectionWantsRead :: ConstPtr Connection -> IO CBool

connectionRead :: Ptr Connection -> Ptr Word8 -> CSize -> Ptr CSize -> IO Result

connectionReadTls :: Ptr Connection -> FunPtr ReadCallback -> Ptr Userdata -> Ptr CSize -> IO IOResult

Write

type WriteCallback = Ptr Userdata -> ConstPtr Word8 -> CSize -> Ptr CSize -> IO IOResult

mkWriteCallback :: WriteCallback -> IO (FunPtr WriteCallback)

connectionWantsWrite :: ConstPtr Connection -> IO CBool

connectionWrite :: Ptr Connection -> Ptr Word8 -> CSize -> Ptr CSize -> IO Result

connectionWriteTls :: Ptr Connection -> FunPtr WriteCallback -> Ptr Userdata -> Ptr CSize -> IO IOResult

Misc

connectionProcessNewPackets :: Ptr Connection -> IO Result

connectionIsHandshaking :: ConstPtr Connection -> IO CBool

connectionSendCloseNotify :: Ptr Connection -> IO ()

connectionSetBufferLimit :: Ptr Connection -> CSize -> IO ()

connectionGetALPNProtocol :: ConstPtr Connection -> Ptr (ConstPtr Word8) -> Ptr CSize -> IO ()

connectionGetProtocolVersion :: ConstPtr Connection -> IO TLSVersion

connectionGetNegotiatedCipherSuite :: ConstPtr Connection -> IO Word16

connectionGetNegotiatedCipherSuiteName :: ConstPtr Connection -> Ptr Str -> IO ()

serverConnectionGetSNIHostname :: ConstPtr Connection -> Ptr Word8 -> CSize -> Ptr CSize -> IO Result

connectionGetPeerCertificate :: ConstPtr Connection -> CSize -> IO (ConstPtr Certificate)

Logging

connectionSetLogCallback :: Ptr Connection -> FunPtr LogCallback -> IO ()

type LogCallback = Ptr Userdata -> ConstPtr LogParams -> IO ()

mkLogCallback :: LogCallback -> IO (FunPtr LogCallback)

data LogParams

Constructors

LogParams

Fields

• rustlsLogParamsLevel :: LogLevel
• rustlsLogParamsMessage :: Str

Instances

GStorable LogParams

Defined in Rustls.Internal.FFI

Methods

gsizeOf :: LogParams -> Int

galignment :: LogParams -> Int

gpeekByteOff :: Ptr b -> Int -> IO LogParams

gpokeByteOff :: Ptr b -> Int -> LogParams -> IO ()

Generic LogParams

Defined in Rustls.Internal.FFI

Associated Types

type Rep LogParams

Defined in Rustls.Internal.FFI

type Rep LogParams = D1 ('MetaData "LogParams" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "LogParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "rustlsLogParamsLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "rustlsLogParamsMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Str)))

Methods

from :: LogParams -> Rep LogParams x

to :: Rep LogParams x -> LogParams

type Rep LogParams

Defined in Rustls.Internal.FFI

type Rep LogParams = D1 ('MetaData "LogParams" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "LogParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "rustlsLogParamsLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogLevel) :*: S1 ('MetaSel ('Just "rustlsLogParamsMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Str)))

newtype LogLevel

Constructors

LogLevel CSize

Instances

Storable LogLevel

Defined in Rustls.Internal.FFI

Methods

sizeOf :: LogLevel -> Int

alignment :: LogLevel -> Int

peekElemOff :: Ptr LogLevel -> Int -> IO LogLevel

pokeElemOff :: Ptr LogLevel -> Int -> LogLevel -> IO ()

peekByteOff :: Ptr b -> Int -> IO LogLevel

pokeByteOff :: Ptr b -> Int -> LogLevel -> IO ()

peek :: Ptr LogLevel -> IO LogLevel

poke :: Ptr LogLevel -> LogLevel -> IO ()

Show LogLevel

Defined in Rustls.Internal.FFI

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Eq LogLevel

Defined in Rustls.Internal.FFI

Methods

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

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

Misc

data Str

Constructors

Str CString CSize

Instances

GStorable Str

Defined in Rustls.Internal.FFI

Methods

gsizeOf :: Str -> Int

galignment :: Str -> Int

gpeekByteOff :: Ptr b -> Int -> IO Str

gpokeByteOff :: Ptr b -> Int -> Str -> IO ()

Generic Str

Defined in Rustls.Internal.FFI

Associated Types

type Rep Str

Defined in Rustls.Internal.FFI

type Rep Str = D1 ('MetaData "Str" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CSize)))

Methods

from :: Str -> Rep Str x

to :: Rep Str x -> Str

type Rep Str

Defined in Rustls.Internal.FFI

type Rep Str = D1 ('MetaData "Str" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CSize)))

data SliceBytes

Constructors

SliceBytes (Ptr Word8) CSize

Instances

GStorable SliceBytes

Defined in Rustls.Internal.FFI

Methods

gsizeOf :: SliceBytes -> Int

galignment :: SliceBytes -> Int

gpeekByteOff :: Ptr b -> Int -> IO SliceBytes

gpokeByteOff :: Ptr b -> Int -> SliceBytes -> IO ()

Generic SliceBytes

Defined in Rustls.Internal.FFI

Associated Types

type Rep SliceBytes

Defined in Rustls.Internal.FFI

type Rep SliceBytes = D1 ('MetaData "SliceBytes" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "SliceBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Word8)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CSize)))

Methods

from :: SliceBytes -> Rep SliceBytes x

to :: Rep SliceBytes x -> SliceBytes

type Rep SliceBytes

Defined in Rustls.Internal.FFI

type Rep SliceBytes = D1 ('MetaData "SliceBytes" "Rustls.Internal.FFI" "rustls-0.2.0.0-inplace" 'False) (C1 ('MetaCons "SliceBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Word8)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CSize)))

hsVersion :: Ptr Str -> IO ()

data Userdata

(Unused) userdata.

Result

newtype Result

Constructors

Result Word32

Instances

Show Result

Defined in Rustls.Internal.FFI

Methods

showsPrec :: Int -> Result -> ShowS

show :: Result -> String

showList :: [Result] -> ShowS

Eq Result

Defined in Rustls.Internal.FFI

Methods

(==) :: Result -> Result -> Bool

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

Ord Result

Defined in Rustls.Internal.FFI

Methods

compare :: Result -> Result -> Ordering

(<) :: Result -> Result -> Bool

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

(>) :: Result -> Result -> Bool

(>=) :: Result -> Result -> Bool

max :: Result -> Result -> Result

min :: Result -> Result -> Result

resultIsCertError :: Result -> CBool

errorMsg :: Result -> CString -> CSize -> Ptr CSize -> IO ()

Some values

resultOk :: Result

resultInsufficientSize :: Result

IOResult

newtype IOResult

Constructors

IOResult CInt

Instances

Eq IOResult

Defined in Rustls.Internal.FFI

Methods

(==) :: IOResult -> IOResult -> Bool

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

ioResultOk :: IOResult

ioResultErr :: IOResult

TLS params

data SupportedCipherSuite

supportedCipherSuiteGetSuite :: ConstPtr SupportedCipherSuite -> Word16

hsSupportedCipherSuiteGetName :: ConstPtr SupportedCipherSuite -> Ptr Str -> IO ()

hsSupportedCiphersuiteProtocolVersion :: ConstPtr SupportedCipherSuite -> IO TLSVersion

newtype TLSVersion

A TLS protocol version supported by Rustls.

Constructors

TLSVersion

Fields

• unTLSVersion :: Word16

Instances

Storable TLSVersion

Defined in Rustls.Internal.FFI

Methods

sizeOf :: TLSVersion -> Int

alignment :: TLSVersion -> Int

peekElemOff :: Ptr TLSVersion -> Int -> IO TLSVersion

pokeElemOff :: Ptr TLSVersion -> Int -> TLSVersion -> IO ()

peekByteOff :: Ptr b -> Int -> IO TLSVersion

pokeByteOff :: Ptr b -> Int -> TLSVersion -> IO ()

peek :: Ptr TLSVersion -> IO TLSVersion

poke :: Ptr TLSVersion -> TLSVersion -> IO ()

Show TLSVersion

Defined in Rustls.Internal.FFI

Methods

showsPrec :: Int -> TLSVersion -> ShowS

show :: TLSVersion -> String

showList :: [TLSVersion] -> ShowS

Eq TLSVersion

Defined in Rustls.Internal.FFI

Methods

(==) :: TLSVersion -> TLSVersion -> Bool

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

Ord TLSVersion

Defined in Rustls.Internal.FFI

Methods

compare :: TLSVersion -> TLSVersion -> Ordering

(<) :: TLSVersion -> TLSVersion -> Bool

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

(>) :: TLSVersion -> TLSVersion -> Bool

(>=) :: TLSVersion -> TLSVersion -> Bool

max :: TLSVersion -> TLSVersion -> TLSVersion

min :: TLSVersion -> TLSVersion -> TLSVersion

pattern TLS12 :: TLSVersion

pattern TLS13 :: TLSVersion

Crypto provider

data CryptoProvider

data CryptoProviderBuilder

cryptoProviderBuilderNewFromDefault :: Ptr (Ptr CryptoProviderBuilder) -> IO Result

cryptoProviderBuilderNewWithBase :: ConstPtr CryptoProvider -> IO (Ptr CryptoProviderBuilder)

cryptoProviderBuilderSetCipherSuites :: Ptr CryptoProviderBuilder -> ConstPtr (ConstPtr SupportedCipherSuite) -> CSize -> IO Result

cryptoProviderBuilderBuild :: Ptr CryptoProviderBuilder -> Ptr (ConstPtr CryptoProvider) -> IO Result

cryptoProviderBuilderFree :: Ptr CryptoProviderBuilder -> IO ()

cryptoProviderFree :: FinalizerPtr CryptoProvider

cryptoProviderCiphersuitesLen :: ConstPtr CryptoProvider -> CSize

cryptoProviderCiphersuitesGet :: ConstPtr CryptoProvider -> CSize -> ConstPtr SupportedCipherSuite

Root cert store

data RootCertStoreBuilder

data RootCertStore

rootCertStoreBuilderNew :: IO (Ptr RootCertStoreBuilder)

rootCertStoreBuilderAddPem :: Ptr RootCertStoreBuilder -> ConstPtr Word8 -> CSize -> CBool -> IO Result

rootCertStoreBuilderLoadRootsFromFile :: Ptr RootCertStoreBuilder -> ConstCString -> CBool -> IO Result

rootCertStoreBuilderFree :: Ptr RootCertStoreBuilder -> IO ()

rootCertStoreBuilderBuild :: Ptr RootCertStoreBuilder -> Ptr (ConstPtr RootCertStore) -> IO Result

rootCertStoreFree :: ConstPtr RootCertStore -> IO ()