From 69366fdda53fa66f83ef3d4d5919267c8e476343 Mon Sep 17 00:00:00 2001 From: 0rangeFox Date: Mon, 17 Jun 2024 10:32:59 +0100 Subject: [PATCH] Rename feature `tls` to `openssl`. --- actix-settings/CHANGES.md | 2 +- actix-settings/Cargo.toml | 2 +- actix-settings/src/error.rs | 8 ++++---- actix-settings/src/lib.rs | 18 +++++++++--------- actix-settings/src/settings/mod.rs | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/actix-settings/CHANGES.md b/actix-settings/CHANGES.md index 8ca903cfee..3093de83c8 100644 --- a/actix-settings/CHANGES.md +++ b/actix-settings/CHANGES.md @@ -2,7 +2,7 @@ ## Unreleased -- Use new feature named `tls` for TLS settings. [#380] +- Add new feature named `openssl` for TLS settings using `OpenSSL` dependency. [#380] - Add new function `settings::tls::Tls::get_ssl_acceptor_builder()` to build `openssl::ssl::SslAcceptorBuilder`. [#380] - Implement TLS logic for `ApplySettings::try_apply_settings()`. [#380] - Add `openssl` dependency; diff --git a/actix-settings/Cargo.toml b/actix-settings/Cargo.toml index a468a9ac78..93de496be3 100644 --- a/actix-settings/Cargo.toml +++ b/actix-settings/Cargo.toml @@ -14,7 +14,7 @@ rust-version.workspace = true rustdoc-args = ["--cfg", "docsrs"] [features] -tls = ["openssl", "actix-web/openssl"] +openssl = ["dep:openssl", "actix-web/openssl"] [dependencies] actix-http = "3" diff --git a/actix-settings/src/error.rs b/actix-settings/src/error.rs index 1e3cd8f301..c60fe08bd1 100644 --- a/actix-settings/src/error.rs +++ b/actix-settings/src/error.rs @@ -1,7 +1,7 @@ use std::{env::VarError, io, num::ParseIntError, path::PathBuf, str::ParseBoolError}; use derive_more::{Display, Error}; -#[cfg(feature = "tls")] +#[cfg(feature = "openssl")] use openssl::error::ErrorStack as OpenSSLError; use toml::de::Error as TomlError; @@ -32,7 +32,7 @@ pub enum Error { IoError(io::Error), /// OpenSSL Error. - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[display(fmt = "OpenSSL error: {_0}")] OpenSSLError(OpenSSLError), @@ -71,7 +71,7 @@ impl From for Error { } } -#[cfg(feature = "tls")] +#[cfg(feature = "openssl")] impl From for Error { fn from(err: OpenSSLError) -> Self { Self::OpenSSLError(err) @@ -115,7 +115,7 @@ impl From for io::Error { Error::IoError(io_error) => io_error, - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] Error::OpenSSLError(ossl_error) => io::Error::new(io::ErrorKind::Other, ossl_error), Error::ParseBoolError(_) => { diff --git a/actix-settings/src/lib.rs b/actix-settings/src/lib.rs index 67ade12225..b4496aa1e5 100644 --- a/actix-settings/src/lib.rs +++ b/actix-settings/src/lib.rs @@ -90,7 +90,7 @@ mod error; mod parse; mod settings; -#[cfg(feature = "tls")] +#[cfg(feature = "openssl")] pub use self::settings::Tls; pub use self::{ error::Error, @@ -268,7 +268,7 @@ where fn try_apply_settings(mut self, settings: &ActixSettings) -> AsResult { for Address { host, port } in &settings.hosts { - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] { if settings.tls.enabled { self = self.bind_openssl( @@ -280,7 +280,7 @@ where } } - #[cfg(not(feature = "tls"))] + #[cfg(not(feature = "openssl"))] { self = self.bind(format!("{host}:{port}"))?; } @@ -683,7 +683,7 @@ mod tests { assert_eq!(settings.actix.shutdown_timeout, Timeout::Seconds(42)); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_tls_enabled() { let mut settings = Settings::from_default_template(); @@ -692,7 +692,7 @@ mod tests { assert!(settings.actix.tls.enabled); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_with_env_var_tls_enabled() { let mut settings = Settings::from_default_template(); @@ -706,7 +706,7 @@ mod tests { assert!(settings.actix.tls.enabled); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_tls_certificate() { let mut settings = Settings::from_default_template(); @@ -725,7 +725,7 @@ mod tests { ); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_with_env_var_tls_certificate() { let mut settings = Settings::from_default_template(); @@ -748,7 +748,7 @@ mod tests { ); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_tls_private_key() { let mut settings = Settings::from_default_template(); @@ -767,7 +767,7 @@ mod tests { ); } - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] #[test] fn override_field_with_env_var_tls_private_key() { let mut settings = Settings::from_default_template(); diff --git a/actix-settings/src/settings/mod.rs b/actix-settings/src/settings/mod.rs index c6d6c07624..acd3162966 100644 --- a/actix-settings/src/settings/mod.rs +++ b/actix-settings/src/settings/mod.rs @@ -8,10 +8,10 @@ mod max_connections; mod mode; mod num_workers; mod timeout; -#[cfg(feature = "tls")] +#[cfg(feature = "openssl")] mod tls; -#[cfg(feature = "tls")] +#[cfg(feature = "openssl")] pub use self::tls::Tls; pub use self::{ address::Address, backlog::Backlog, keep_alive::KeepAlive, @@ -60,6 +60,6 @@ pub struct ActixSettings { pub shutdown_timeout: Timeout, /// TLS (HTTPS) configuration. - #[cfg(feature = "tls")] + #[cfg(feature = "openssl")] pub tls: Tls, }