Struct axum_server::tls::TlsLoader

pub struct TlsLoader { /* fields omitted */ }

This is supported on crate feature tls-rustls only.

A struct that can be passed to TlsServer to reload tls configuration.

Example

use axum::{
    handler::get,
    Router,
};
use axum_server::tls::TlsLoader;
use tokio::time::{sleep, Duration};

#[tokio::main]
async fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, World!" }));

    let mut loader = TlsLoader::new();

    // Must be loaded before passing.
    loader
        .private_key_file("examples/self-signed-certs/key.pem")
        .certificate_file("examples/self-signed-certs/cert.pem")
        .load()
        .await
        .unwrap();

    tokio::spawn(reload_every_day(loader.clone()));

    axum_server::bind_rustls("127.0.0.1:3000")
        .loader(loader)
        .serve(app)
        .await
        .unwrap();
}

async fn reload_every_day(mut loader: TlsLoader) {
    loop {
        // Sleep first since certificates are loaded after loader is built.
        sleep(Duration::from_secs(3600 * 24)).await;

        // Can be loaded with recent settings.
        // For example: Read previously provided file contents again.
        loader.load().await.unwrap();

        // Can overwrite settings and load.
        loader
            .private_key_file("examples/self-signed-certs/reload/key.pem")
            .certificate_file("examples/self-signed-certs/reload/cert.pem")
            .load()
            .await
            .unwrap();
    }
}

Implementations

impl TlsLoader

pub fn new() -> Self

Create a TlsLoader.

pub fn config(&mut self, config: Arc<ServerConfig>) -> &mut Self

Provide ServerConfig containing private key and certificate(s).

When this value is set, other tls configurations are ignored.

Successive calls will overwrite last value.

pub fn private_key(&mut self, private_key: Vec<u8>) -> &mut Self

Set private key in PEM format.

Successive calls will overwrite last private key.

pub fn certificate(&mut self, certificate: Vec<u8>) -> &mut Self

Set certificate(s) in PEM format.

Successive calls will overwrite last certificate.

pub fn private_key_file(&mut self, path: impl AsRef<Path>) -> &mut Self

Set private key from file in PEM format.

Successive calls will overwrite last private key.

pub fn certificate_file(&mut self, path: impl AsRef<Path>) -> &mut Self

Set certificate(s) from file in PEM format.

Successive calls will overwrite last certificate.

pub async fn load(&mut self) -> Result<()>

Load private key or certificate(s).

Will apply to connections after this function is called.

Trait Implementations

impl Clone for TlsLoader

fn clone(&self) -> TlsLoader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TlsLoader

fn default() -> TlsLoader

Returns the “default value” for a type.