#[cfg_attr(not(any(feature = "rest", feature = "grpc")), allow(dead_code))]
pub(crate) fn is_loopback_host(host: &str) -> bool {
host.eq_ignore_ascii_case("localhost")
|| host == "127.0.0.1"
|| host == "::1"
|| host == "[::1]"
}
#[cfg_attr(not(any(feature = "rest", feature = "grpc")), allow(dead_code))]
pub(crate) fn ensure_secure_scheme(
label: &str,
scheme: &str,
host: Option<&str>,
secure_scheme: &str,
) -> Result<(), String> {
if scheme.eq_ignore_ascii_case(secure_scheme) {
return Ok(());
}
if host.is_some_and(is_loopback_host) {
return Ok(());
}
Err(format!(
"{label} must use the encrypted `{secure_scheme}://` scheme (got \
`{scheme}://`); plaintext transport is refused because it would expose \
tenant identifiers, CSRF tokens, and session cookies — the only \
exception is a loopback host (localhost/127.0.0.1/::1) for local \
development (X-2, CONTRACT.md §6)"
))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn https_is_accepted() {
assert!(ensure_secure_scheme("base_url", "https", Some("example.com"), "https").is_ok());
}
#[test]
fn plaintext_routable_host_is_rejected() {
let err = ensure_secure_scheme("base_url", "http", Some("example.com"), "https")
.expect_err("plaintext http against a routable host must be rejected");
assert!(err.contains("https"));
assert!(err.contains("http"));
}
#[test]
fn plaintext_loopback_is_allowed() {
for host in ["localhost", "127.0.0.1", "::1", "[::1]", "LOCALHOST"] {
assert!(
ensure_secure_scheme("base_url", "http", Some(host), "https").is_ok(),
"loopback host {host} must be allowed over plaintext for dev"
);
}
}
#[test]
fn the_required_scheme_is_a_parameter_not_a_constant() {
assert!(ensure_secure_scheme("some url", "amqps", Some("broker"), "amqps").is_ok());
assert!(ensure_secure_scheme("some url", "amqp", Some("broker"), "amqps").is_err());
assert!(ensure_secure_scheme("some url", "amqp", Some("localhost"), "amqps").is_ok());
}
#[test]
fn scheme_comparison_is_case_insensitive() {
assert!(ensure_secure_scheme("base_url", "HTTPS", Some("example.com"), "https").is_ok());
}
}