Trait TlsProvider

pub trait TlsProvider<S: StreamOps>:
    Clone
    + Send
    + Sync
    + 'static {
    type Connector: TlsConnector<S, Conn = Self::TlsStream> + Send + Sync + Unpin;
    type TlsStream: AsyncRead + AsyncWrite + StreamOps + CertifiedConn + Unpin + Send + 'static;

    // Required methods
    fn tls_connector(&self) -> Self::Connector;
    fn supports_keying_material_export(&self) -> bool;
}

Trait for a runtime that knows how to create TLS connections over TCP streams of type S.

This is separate from TlsConnector because eventually we may eventually want to support multiple TlsConnector implementations that use a single Runtime.

See the TlsConnector documentation for a discussion of the Tor-specific limitations of this trait: If you are implementing something other than Tor, this is not the functionality you want.

Required Associated Types

type Connector: TlsConnector<S, Conn = Self::TlsStream> + Send + Sync + Unpin

The Connector object that this provider can return.

type TlsStream: AsyncRead + AsyncWrite + StreamOps + CertifiedConn + Unpin + Send + 'static

The type of the stream returned by that connector.

Required Methods

fn tls_connector(&self) -> Self::Connector

Return a TLS connector for use with this runtime.

fn supports_keying_material_export(&self) -> bool

Return true iff the keying material exporters (RFC 5705) is supported.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<S> TlsProvider<S> for AsyncStdNativeTlsRuntime

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and crate feature async-std only.

type Connector = <CompoundRuntime<AsyncStd, AsyncStd, RealCoarseTimeProvider, AsyncStd, AsyncStd, NativeTlsProvider, AsyncStd> as TlsProvider<S>>::Connector

type TlsStream = <CompoundRuntime<AsyncStd, AsyncStd, RealCoarseTimeProvider, AsyncStd, AsyncStd, NativeTlsProvider, AsyncStd> as TlsProvider<S>>::TlsStream

impl<S> TlsProvider<S> for AsyncStdRustlsRuntime

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and crate feature async-std only.

type Connector = <CompoundRuntime<AsyncStd, AsyncStd, RealCoarseTimeProvider, AsyncStd, AsyncStd, RustlsProvider, AsyncStd> as TlsProvider<S>>::Connector

type TlsStream = <CompoundRuntime<AsyncStd, AsyncStd, RealCoarseTimeProvider, AsyncStd, AsyncStd, RustlsProvider, AsyncStd> as TlsProvider<S>>::TlsStream

impl<S> TlsProvider<S> for PreferredRuntime

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

type Connector = <TokioNativeTlsRuntime as TlsProvider<S>>::Connector

type TlsStream = <TokioNativeTlsRuntime as TlsProvider<S>>::TlsStream

impl<S> TlsProvider<S> for NativeTlsProvider

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and (crate features async-std or tokio) and crate feature native-tls only.

type Connector = NativeTlsConnector<S>

type TlsStream = TlsStream<S>

impl<S> TlsProvider<S> for RustlsProvider

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and (crate features async-std or tokio) and crate feature rustls only.

type Connector = RustlsConnector<S>

type TlsStream = TlsStream<S>

impl<S> TlsProvider<S> for TokioNativeTlsRuntime

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and crate feature tokio only.

type Connector = <CompoundRuntime<TokioRuntimeHandle, TokioRuntimeHandle, RealCoarseTimeProvider, TokioRuntimeHandle, TokioRuntimeHandle, NativeTlsProvider, TokioRuntimeHandle> as TlsProvider<S>>::Connector

type TlsStream = <CompoundRuntime<TokioRuntimeHandle, TokioRuntimeHandle, RealCoarseTimeProvider, TokioRuntimeHandle, TokioRuntimeHandle, NativeTlsProvider, TokioRuntimeHandle> as TlsProvider<S>>::TlsStream

impl<S> TlsProvider<S> for TokioRustlsRuntime

where S: AsyncRead + AsyncWrite + StreamOps + Unpin + Send + 'static,

Available on (crate features native-tls or rustls) and crate feature tokio only.

type Connector = <CompoundRuntime<TokioRuntimeHandle, TokioRuntimeHandle, RealCoarseTimeProvider, TokioRuntimeHandle, TokioRuntimeHandle, RustlsProvider, TokioRuntimeHandle> as TlsProvider<S>>::Connector

type TlsStream = <CompoundRuntime<TokioRuntimeHandle, TokioRuntimeHandle, RealCoarseTimeProvider, TokioRuntimeHandle, TokioRuntimeHandle, RustlsProvider, TokioRuntimeHandle> as TlsProvider<S>>::TlsStream

impl<TaskR, SleepR, CoarseTimeR, TcpR, UnixR, TlsR, UdpR, S> TlsProvider<S> for CompoundRuntime<TaskR, SleepR, CoarseTimeR, TcpR, UnixR, TlsR, UdpR>

where TcpR: NetStreamProvider, TlsR: TlsProvider<S>, UnixR: Clone + Send + Sync + 'static, SleepR: Clone + Send + Sync + 'static, CoarseTimeR: Clone + Send + Sync + 'static, TaskR: Clone + Send + Sync + 'static, UdpR: Clone + Send + Sync + 'static, S: StreamOps,

type Connector = <TlsR as TlsProvider<S>>::Connector

type TlsStream = <TlsR as TlsProvider<S>>::TlsStream

impl TlsProvider<<MockNetProvider as NetStreamProvider>::Stream> for MockRuntime

impl TlsProvider<LocalStream> for MockNetProvider

impl<R: Runtime> TlsProvider<<MockNetProvider as NetStreamProvider>::Stream> for MockNetRuntime<R>

impl<R: Runtime> TlsProvider<<R as NetStreamProvider>::Stream> for MockSleepRuntime<R>