Struct TlsConfig 

pub struct TlsConfig {
    pub cert: PathBuf,
    pub key: PathBuf,
    pub https_redirection_config: RedirectionConfig,
    /* private fields */
}

Represents TLS (Transport Layer Security) configuration options

Fields

cert: PathBuf

Path to a certificate

key: PathBuf

Path to a private key

https_redirection_config: RedirectionConfig

HTTPS redirection configuration options

Implementations

impl TlsConfig

pub fn new() -> TlsConfig

Creates a new, default TLS configuration

pub fn from_pem(path: impl AsRef<Path>) -> TlsConfig

Creates a configuration by loading cert and key files with default names from a specified folder

pub fn from_pem_files(cert_file_path: &str, key_file_path: &str) -> TlsConfig

Creates a configuration by specifying a path to cert and key files specifically

pub fn set_pem(self, path: impl AsRef<Path>) -> TlsConfig

Sets the cert and key files with default names from the specified folder

pub fn set_key(self, key_path: &str) -> TlsConfig

Sets the path to a key file

pub fn set_cert(self, cert_path: &str) -> TlsConfig

Sets the path to a key file

pub fn with_cert_path(self, path: impl AsRef<Path>) -> TlsConfig

Configure the path to the certificate

pub fn with_key_path(self, path: impl AsRef<Path>) -> TlsConfig

Configure the path to the private key

pub fn with_optional_client_auth(self, path: impl AsRef<Path>) -> TlsConfig

Configures the trust anchor for optional TLS client authentication.

Default: None

pub fn with_required_client_auth(self, path: impl AsRef<Path>) -> TlsConfig

Configures the trust anchor for required TLS client authentication.

Default: None

pub fn with_https_redirection(self) -> TlsConfig

Configures web server to redirect HTTP requests to HTTPS

Default: false

pub fn with_http_port(self, port: u16) -> TlsConfig

Configures the port for HTTP listener that redirects to HTTPS

pub fn with_hsts<T>(self, config: T) -> TlsConfig

where T: FnOnce(HstsConfig) -> HstsConfig,

Configures HSTS header. If HSTS has already been preconfigured, it does not overwrite it

Default values:

• preload: true
• include_sub_domains: true
• max-age: 30 days (2,592,000 seconds)
• exclude_hosts: empty list

Example

use volga::tls::TlsConfig;

let tls = TlsConfig::new()
    .with_hsts(|hsts| hsts.with_preload(false));

pub fn set_hsts(self, hsts_config: HstsConfig) -> TlsConfig

Configures HSTS header

Default values:

• preload: true
• include_sub_domains: true
• max-age: 30 days (2,592,000 seconds)
• exclude_hosts: empty list

pub fn with_hsts_preload(self, preload: bool) -> TlsConfig

Configures whether to set preload in HSTS header

Default value: true

pub fn with_hsts_sub_domains(self, include: bool) -> TlsConfig

Configures whether to set includeSubDomains in the HSTS header

Default: true

pub fn with_hsts_max_age(self, max_age: Duration) -> TlsConfig

Configures max_age for HSTS header

Default: 30 days (2,592,000 seconds)

pub fn with_hsts_exclude_hosts( self, exclude_hosts: &[&'static str], ) -> TlsConfig

Configures a list of host names that will not add the HSTS header.

Default: empty list

Trait Implementations

impl Default for TlsConfig

fn default() -> TlsConfig

Returns the “default value” for a type.