Provides utilities to host a axum-server server that
accepts the HTTP and HTTPS protocol on the same port. See
bind_dual_protocol().
A common use case for this is if a HTTPS server is hosted on a
non-traditional port, having no corresponding HTTP port. This can be an
issue for clients who try to connect over HTTP and get a connection reset
error. See ServerExt::set_upgrade().
The simplest way to start is to use bind_dual_protocol():
let app = Router::new().route(
"/",
routing::get(|request: Request<Body>| async move {
match request.extensions().get::<Protocol>().unwrap() {
Protocol::Tls => "Hello, secure World!",
Protocol::Plain => "Hello, insecure World!",
}
}),
);
// User-supplied certificate and private key.
let config = RustlsConfig::from_der(certificate, private_key).await?;
axum_server_dual_protocol::bind_dual_protocol(address, config)
.serve(app.into_make_service())
.await?;We now have a server accepting both HTTP and HTTPS requests! Now we can
automatically upgrade incoming HTTP requests to HTTPS using
ServerExt::set_upgrade() like this:
use axum_server_dual_protocol::ServerExt;
axum_server_dual_protocol::bind_dual_protocol(address, config)
.set_upgrade(true)
.serve(app.into_make_service())
.await?;Alternatively UpgradeHttpLayer can be used:
let app = Router::new()
.route("/", routing::get(|| async { "Hello, world!" }))
.layer(UpgradeHttpLayer);As this library heavily relies on axum-server, axum,
tower and hyper the MSRV depends on theirs. At the point of time
this was written the highest MSRV was axum with 1.66.
See the CHANGELOG file for details.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.