Struct TlsServerConfig 

pub struct TlsServerConfig(/* private fields */);

Available on crate feature tls only.

A backend agnostic TLS server config

It holds a set of fine-grained config pieces (e.g. TlsServerAuth, TlsAlpn) and exposes typed setters for the settings both TLS backends support. Backend crates add setters for their backend-specific pieces (e.g. dynamic cert issuance + caching, or a native escape hatch) via extension traits (RustlsServerConfigExt / BoringServerConfigExt).

Implementations

impl TlsServerConfig

pub fn new() -> TlsServerConfig

Create an empty config.

pub fn default_http() -> Result<TlsServerConfig, Box<dyn Error + Sync + Send>>

Create a new config using with:

• ALPN: H2, http1.1
• Self signed certificate (freshly generated)
• Keylogger: KeyLogIntent::Environment

pub fn self_signed_http_auto() -> Result<TlsServerConfig, Box<dyn Error + Sync + Send>>

Create a config that serves a freshly generated self-signed identity and offers HTTP/2 + HTTP/1.1 via ALPN.

pub fn write_to(&self, extensions: &Extensions)

Transfer this config’s pieces onto extensions (appending, so they override existing entries of the same type — newest-wins).

pub fn with_server_auth(self, auth: ServerAuthData) -> TlsServerConfig

Set the server auth: the certificate chain + private key to serve.

Dynamic / on-the-fly cert issuance (with caching) is backend-specific; configure it via the backend’s server-config extension trait.

pub fn set_server_auth(&mut self, auth: ServerAuthData) -> &mut TlsServerConfig

Set the server auth: the certificate chain + private key to serve.

Dynamic / on-the-fly cert issuance (with caching) is backend-specific; configure it via the backend’s server-config extension trait.

pub fn try_with_self_signed( self, data: SelfSignedData, ) -> Result<TlsServerConfig, Box<dyn Error + Sync + Send>>

Generate a fresh self-signed identity and serve it.

pub fn try_set_self_signed( &mut self, data: SelfSignedData, ) -> Result<&mut TlsServerConfig, Box<dyn Error + Sync + Send>>

Generate a fresh self-signed identity and serve it.

pub fn with_single_cert(self, data: ServerAuthData) -> TlsServerConfig

Serve the provided certificate chain + private key.

pub fn set_single_cert(&mut self, data: ServerAuthData) -> &mut TlsServerConfig

Serve the provided certificate chain + private key.

pub fn with_alpn( self, protocols: SmallVec<[ApplicationProtocol; 2]>, ) -> TlsServerConfig

Set the ALPN protocols accepted (in preference order).

pub fn set_alpn( &mut self, protocols: SmallVec<[ApplicationProtocol; 2]>, ) -> &mut TlsServerConfig

Set the ALPN protocols accepted (in preference order).

pub fn with_alpn_http_auto(self) -> TlsServerConfig

Accept HTTP/2 and HTTP/1.1 via ALPN.

pub fn set_alpn_http_auto(&mut self) -> &mut TlsServerConfig

Accept HTTP/2 and HTTP/1.1 via ALPN.

pub fn with_alpn_http_1(self) -> TlsServerConfig

Accept HTTP/1.1 only via ALPN.

pub fn set_alpn_http_1(&mut self) -> &mut TlsServerConfig

Accept HTTP/1.1 only via ALPN.

pub fn with_alpn_http_2(self) -> TlsServerConfig

Accept HTTP/2 only via ALPN.

pub fn set_alpn_http_2(&mut self) -> &mut TlsServerConfig

Accept HTTP/2 only via ALPN.

pub fn with_supported_versions( self, versions: Vec<ProtocolVersion>, ) -> TlsServerConfig

Set the supported protocol versions.

pub fn set_supported_versions( &mut self, versions: Vec<ProtocolVersion>, ) -> &mut TlsServerConfig

Set the supported protocol versions.

pub fn with_keylog(self, intent: KeyLogIntent) -> TlsServerConfig

Set the keylog intent.

pub fn set_keylog(&mut self, intent: KeyLogIntent) -> &mut TlsServerConfig

Set the keylog intent.

pub fn with_client_verify(self, mode: ClientVerifyMode) -> TlsServerConfig

Set how the client is verified (mTLS).

pub fn set_client_verify( &mut self, mode: ClientVerifyMode, ) -> &mut TlsServerConfig

Set how the client is verified (mTLS).

pub fn with_store_client_cert_chain(self, store: bool) -> TlsServerConfig

Set whether the client certificate chain is captured into NegotiatedTlsParameters.

pub fn set_store_client_cert_chain( &mut self, store: bool, ) -> &mut TlsServerConfig

Set whether the client certificate chain is captured into NegotiatedTlsParameters.

pub fn as_extensions(&self) -> &Extensions

Trait Implementations

impl BoringServerConfigExt for TlsServerConfig

fn with_cert_issuer(self, data: ServerCertIssuerData) -> TlsServerConfig

Issue server certs on the fly (from a CA or a custom [DynamicCertIssuer]), with optional in-memory caching.

fn set_cert_issuer( &mut self, data: ServerCertIssuerData, ) -> &mut TlsServerConfig

Issue server certs on the fly (from a CA or a custom [DynamicCertIssuer]), with optional in-memory caching.

impl Clone for TlsServerConfig

fn clone(&self) -> TlsServerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TlsServerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TlsServerConfig

fn default() -> TlsServerConfig

Returns the “default value” for a type.

impl RamaTryFrom<&TlsServerConfig, RamaTlsRustlsCrateMarker> for ServerConfig

type Error = Box<dyn Error + Sync + Send>

fn rama_try_from( value: &TlsServerConfig, ) -> Result<ServerConfig, <ServerConfig as RamaTryFrom<&TlsServerConfig, RamaTlsRustlsCrateMarker>>::Error>

impl RamaTryFrom<TlsServerConfig, RamaTlsRustlsCrateMarker> for ServerConfig

type Error = Box<dyn Error + Sync + Send>

fn rama_try_from( value: TlsServerConfig, ) -> Result<ServerConfig, <ServerConfig as RamaTryFrom<TlsServerConfig, RamaTlsRustlsCrateMarker>>::Error>

impl RustlsServerConfigExt for TlsServerConfig

fn with_modify_rustls_config( self, modify: impl Fn(ServerConfig) -> Result<ServerConfig, Box<dyn Error + Sync + Send>> + Send + Sync + 'static, ) -> TlsServerConfig

Take over the final rustls ServerConfig build: see ModifyRustlsServerConfig.

fn set_modify_rustls_config( &mut self, modify: impl Fn(ServerConfig) -> Result<ServerConfig, Box<dyn Error + Sync + Send>> + Send + Sync + 'static, ) -> &mut TlsServerConfig

Take over the final rustls ServerConfig build: see ModifyRustlsServerConfig.

fn with_dynamic_config( self, provider: Arc<impl DynamicConfigProvider>, ) -> TlsServerConfig

Resolve a full rustls::ServerConfig per ClientHello via a DynamicConfigProvider

fn set_dynamic_config( &mut self, provider: Arc<impl DynamicConfigProvider>, ) -> &mut TlsServerConfig

Resolve a full rustls::ServerConfig per ClientHello via a DynamicConfigProvider

impl TryFrom<&TlsServerConfig> for TlsAcceptorData

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( value: &TlsServerConfig, ) -> Result<TlsAcceptorData, <TlsAcceptorData as TryFrom<&TlsServerConfig>>::Error>

Performs the conversion.

impl TryFrom<&TlsServerConfig> for TlsAcceptorData

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from( value: &TlsServerConfig, ) -> Result<TlsAcceptorData, <TlsAcceptorData as TryFrom<&TlsServerConfig>>::Error>

Performs the conversion.