Replace feature no-patches with BORING_BSSL{,_FIPS}_ASSUME_PATCHED
Feature no-patches is ever only useful when setting other env variables
BORING_BSSL{,_FIPS}{,_SOURCE}_PATH, and it has no impact on the APIs
provided by any of the boring crates, so we may as well make it an env
variable itself so downstream users have less features to propagate
across their own crate graph.
This commit is contained in:
parent
f5f47dd5a7
commit
9a0bd94f99
|
|
@ -71,14 +71,6 @@ rpk = []
|
||||||
# can be provided by setting `BORING_BSSL{,_FIPS}_SOURCE_PATH`.
|
# can be provided by setting `BORING_BSSL{,_FIPS}_SOURCE_PATH`.
|
||||||
pq-experimental = []
|
pq-experimental = []
|
||||||
|
|
||||||
# Disables git patching of the BoringSSL sources for features like `rpk` and `pq-experimental`,
|
|
||||||
# but keeps the related Rust API.
|
|
||||||
#
|
|
||||||
# Supposed to be used with either pre-compiled BoringSSL (via `BORING_BSSL{,_FIPS}_PATH` env
|
|
||||||
# variable) or with custom BoringSSL sources (via `BORING_BSSL{,_FIPS}_SOURCE_PATH` env variable)
|
|
||||||
# already containing required patches.
|
|
||||||
no-patches = []
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
bindgen = { workspace = true }
|
bindgen = { workspace = true }
|
||||||
cmake = { workspace = true }
|
cmake = { workspace = true }
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,6 @@ pub(crate) struct Config {
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) struct Features {
|
pub(crate) struct Features {
|
||||||
pub(crate) no_patches: bool,
|
|
||||||
pub(crate) fips: bool,
|
pub(crate) fips: bool,
|
||||||
pub(crate) fips_link_precompiled: bool,
|
pub(crate) fips_link_precompiled: bool,
|
||||||
pub(crate) pq_experimental: bool,
|
pub(crate) pq_experimental: bool,
|
||||||
|
|
@ -27,6 +26,7 @@ pub(crate) struct Env {
|
||||||
pub(crate) include_path: Option<PathBuf>,
|
pub(crate) include_path: Option<PathBuf>,
|
||||||
pub(crate) source_path: Option<PathBuf>,
|
pub(crate) source_path: Option<PathBuf>,
|
||||||
pub(crate) precompiled_bcm_o: Option<PathBuf>,
|
pub(crate) precompiled_bcm_o: Option<PathBuf>,
|
||||||
|
pub(crate) assume_patched: bool,
|
||||||
pub(crate) debug: Option<OsString>,
|
pub(crate) debug: Option<OsString>,
|
||||||
pub(crate) opt_level: Option<OsString>,
|
pub(crate) opt_level: Option<OsString>,
|
||||||
pub(crate) android_ndk_home: Option<PathBuf>,
|
pub(crate) android_ndk_home: Option<PathBuf>,
|
||||||
|
|
@ -71,15 +71,15 @@ impl Config {
|
||||||
let is_external_native_lib_source =
|
let is_external_native_lib_source =
|
||||||
!is_precompiled_native_lib && self.env.source_path.is_none();
|
!is_precompiled_native_lib && self.env.source_path.is_none();
|
||||||
|
|
||||||
if self.features.no_patches && is_external_native_lib_source {
|
if self.env.assume_patched && is_external_native_lib_source {
|
||||||
panic!(
|
panic!(
|
||||||
"`no-patches` feature is supposed to be used with `BORING_BSSL{{,_FIPS}}_PATH`\
|
"`BORING_BSSL_{{,_FIPS}}_ASSUME_PATCHED` env variable is supposed to be used with\
|
||||||
or `BORING_BSSL{{,_FIPS}}_SOURCE_PATH` env variables"
|
`BORING_BSSL{{,_FIPS}}_PATH` or `BORING_BSSL{{,_FIPS}}_SOURCE_PATH` env variables"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
let features_with_patches_enabled = self.features.rpk || self.features.pq_experimental;
|
let features_with_patches_enabled = self.features.rpk || self.features.pq_experimental;
|
||||||
let patches_required = features_with_patches_enabled && !self.features.no_patches;
|
let patches_required = features_with_patches_enabled && !self.env.assume_patched;
|
||||||
let build_from_sources_required = self.features.fips_link_precompiled || patches_required;
|
let build_from_sources_required = self.features.fips_link_precompiled || patches_required;
|
||||||
|
|
||||||
if is_precompiled_native_lib && build_from_sources_required {
|
if is_precompiled_native_lib && build_from_sources_required {
|
||||||
|
|
@ -90,14 +90,12 @@ impl Config {
|
||||||
|
|
||||||
impl Features {
|
impl Features {
|
||||||
fn from_env() -> Self {
|
fn from_env() -> Self {
|
||||||
let no_patches = env::var_os("CARGO_FEATURE_NO_PATCHES").is_some();
|
|
||||||
let fips = env::var_os("CARGO_FEATURE_FIPS").is_some();
|
let fips = env::var_os("CARGO_FEATURE_FIPS").is_some();
|
||||||
let fips_link_precompiled = env::var_os("CARGO_FEATURE_FIPS_LINK_PRECOMPILED").is_some();
|
let fips_link_precompiled = env::var_os("CARGO_FEATURE_FIPS_LINK_PRECOMPILED").is_some();
|
||||||
let pq_experimental = env::var_os("CARGO_FEATURE_PQ_EXPERIMENTAL").is_some();
|
let pq_experimental = env::var_os("CARGO_FEATURE_PQ_EXPERIMENTAL").is_some();
|
||||||
let rpk = env::var_os("CARGO_FEATURE_RPK").is_some();
|
let rpk = env::var_os("CARGO_FEATURE_RPK").is_some();
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
no_patches,
|
|
||||||
fips,
|
fips,
|
||||||
fips_link_precompiled,
|
fips_link_precompiled,
|
||||||
pq_experimental,
|
pq_experimental,
|
||||||
|
|
@ -121,14 +119,15 @@ impl Env {
|
||||||
} else {
|
} else {
|
||||||
var(name)
|
var(name)
|
||||||
}
|
}
|
||||||
.map(PathBuf::from)
|
|
||||||
};
|
};
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
path: boringssl_var("BORING_BSSL_PATH"),
|
path: boringssl_var("BORING_BSSL_PATH").map(PathBuf::from),
|
||||||
include_path: boringssl_var("BORING_BSSL_INCLUDE_PATH"),
|
include_path: boringssl_var("BORING_BSSL_INCLUDE_PATH").map(PathBuf::from),
|
||||||
source_path: boringssl_var("BORING_BSSL_SOURCE_PATH"),
|
source_path: boringssl_var("BORING_BSSL_SOURCE_PATH").map(PathBuf::from),
|
||||||
precompiled_bcm_o: boringssl_var("BORING_BSSL_PRECOMPILED_BCM_O"),
|
precompiled_bcm_o: boringssl_var("BORING_BSSL_PRECOMPILED_BCM_O").map(PathBuf::from),
|
||||||
|
assume_patched: boringssl_var("BORING_BSSL_ASSUME_PATCHED")
|
||||||
|
.is_some_and(|v| !v.is_empty()),
|
||||||
debug: var("DEBUG"),
|
debug: var("DEBUG"),
|
||||||
opt_level: var("OPT_LEVEL"),
|
opt_level: var("OPT_LEVEL"),
|
||||||
android_ndk_home: var("ANDROID_NDK_HOME").map(Into::into),
|
android_ndk_home: var("ANDROID_NDK_HOME").map(Into::into),
|
||||||
|
|
|
||||||
|
|
@ -496,7 +496,7 @@ fn built_boring_source_path(config: &Config) -> &PathBuf {
|
||||||
static BUILD_SOURCE_PATH: OnceLock<PathBuf> = OnceLock::new();
|
static BUILD_SOURCE_PATH: OnceLock<PathBuf> = OnceLock::new();
|
||||||
|
|
||||||
BUILD_SOURCE_PATH.get_or_init(|| {
|
BUILD_SOURCE_PATH.get_or_init(|| {
|
||||||
if config.features.no_patches {
|
if config.env.assume_patched {
|
||||||
println!(
|
println!(
|
||||||
"cargo:warning=skipping git patches application, provided\
|
"cargo:warning=skipping git patches application, provided\
|
||||||
native BoringSSL is expected to have the patches included"
|
native BoringSSL is expected to have the patches included"
|
||||||
|
|
|
||||||
|
|
@ -25,23 +25,19 @@ fips = ["boring-sys/fips"]
|
||||||
fips-link-precompiled = ["boring-sys/fips-link-precompiled"]
|
fips-link-precompiled = ["boring-sys/fips-link-precompiled"]
|
||||||
|
|
||||||
# Enables Raw public key API (https://datatracker.ietf.org/doc/html/rfc7250)
|
# Enables Raw public key API (https://datatracker.ietf.org/doc/html/rfc7250)
|
||||||
|
# This feature is necessary in order to compile the bindings for the
|
||||||
|
# default branch of boringSSL. Alternatively, a version of boringSSL that
|
||||||
|
# implements the same feature set can be provided by setting
|
||||||
|
# `BORING_BSSL{,_FIPS}_SOURCE_PATH` and `BORING_BSSL{,_FIPS}_ASSUME_PATCHED`.
|
||||||
rpk = ["boring-sys/rpk"]
|
rpk = ["boring-sys/rpk"]
|
||||||
|
|
||||||
# Applies a patch to the boringSSL source code that enables support for PQ key
|
# Applies a patch to the boringSSL source code that enables support for PQ key
|
||||||
# exchange. This feature is necessary in order to compile the bindings for the
|
# exchange. This feature is necessary in order to compile the bindings for the
|
||||||
# default branch of boringSSL. Alternatively, a version of boringSSL that
|
# default branch of boringSSL. Alternatively, a version of boringSSL that
|
||||||
# implements the same feature set can be provided by setting
|
# implements the same feature set can be provided by setting
|
||||||
# `BORING_BSSL{,_FIPS}_SOURCE_PATH`.
|
# `BORING_BSSL{,_FIPS}_SOURCE_PATH` and `BORING_BSSL{,_FIPS}_ASSUME_PATCHED`.
|
||||||
pq-experimental = ["boring-sys/pq-experimental"]
|
pq-experimental = ["boring-sys/pq-experimental"]
|
||||||
|
|
||||||
# Disables git patching of the BoringSSL sources for features like `rpk` and `pq-experimental`,
|
|
||||||
# but keeps the related Rust API.
|
|
||||||
#
|
|
||||||
# Supposed to be used with either pre-compiled BoringSSL (via `BORING_BSSL{,_FIPS}_PATH` env
|
|
||||||
# variable) or with custom BoringSSL sources (via `BORING_BSSL{,_FIPS}_SOURCE_PATH` env variable)
|
|
||||||
# already containing required patches.
|
|
||||||
no-patches = ["boring-sys/no-patches"]
|
|
||||||
|
|
||||||
# Controlling key exchange preferences at compile time
|
# Controlling key exchange preferences at compile time
|
||||||
|
|
||||||
# Choose key exchange preferences at compile time. This prevents the user from
|
# Choose key exchange preferences at compile time. This prevents the user from
|
||||||
|
|
|
||||||
|
|
@ -28,14 +28,6 @@ fips-link-precompiled = ["tokio-boring/fips-link-precompiled"]
|
||||||
# Enables experimental post-quantum crypto (https://blog.cloudflare.com/post-quantum-for-all/)
|
# Enables experimental post-quantum crypto (https://blog.cloudflare.com/post-quantum-for-all/)
|
||||||
pq-experimental = ["tokio-boring/pq-experimental"]
|
pq-experimental = ["tokio-boring/pq-experimental"]
|
||||||
|
|
||||||
# Disables git patching of the BoringSSL sources for features like `rpk` and `pq-experimental`,
|
|
||||||
# but keeps the related Rust API.
|
|
||||||
#
|
|
||||||
# Supposed to be used with either pre-compiled BoringSSL (via `BORING_BSSL{,_FIPS}_PATH` env
|
|
||||||
# variable) or with custom BoringSSL sources (via `BORING_BSSL{,_FIPS}_SOURCE_PATH` env variable)
|
|
||||||
# already containing required patches.
|
|
||||||
no-patches = ["tokio-boring/no-patches"]
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
antidote = { workspace = true }
|
antidote = { workspace = true }
|
||||||
http = { workspace = true }
|
http = { workspace = true }
|
||||||
|
|
|
||||||
|
|
@ -25,14 +25,6 @@ fips-link-precompiled = ["boring/fips-link-precompiled", "boring-sys/fips-link-p
|
||||||
# Enables experimental post-quantum crypto (https://blog.cloudflare.com/post-quantum-for-all/)
|
# Enables experimental post-quantum crypto (https://blog.cloudflare.com/post-quantum-for-all/)
|
||||||
pq-experimental = ["boring/pq-experimental"]
|
pq-experimental = ["boring/pq-experimental"]
|
||||||
|
|
||||||
# Disables git patching of the BoringSSL sources for features like `rpk` and `pq-experimental`,
|
|
||||||
# but keeps the related Rust API.
|
|
||||||
#
|
|
||||||
# Supposed to be used with either pre-compiled BoringSSL (via `BORING_BSSL{,_FIPS}_PATH` env
|
|
||||||
# variable) or with custom BoringSSL sources (via `BORING_BSSL{,_FIPS}_SOURCE_PATH` env variable)
|
|
||||||
# already containing required patches.
|
|
||||||
no-patches = ["boring/no-patches"]
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
boring = { workspace = true }
|
boring = { workspace = true }
|
||||||
boring-sys = { workspace = true }
|
boring-sys = { workspace = true }
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue