diff --git a/Cargo.toml b/Cargo.toml index 96ec2fb3e..80b803228 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ members = [ resolver = "2" [workspace.package] -version = "5.0.0-alpha.3" +version = "5.0.0" rust-version = "1.85" repository = "https://github.com/cloudflare/boring" edition = "2021" @@ -20,9 +20,9 @@ tag-prefix = "" publish = false [workspace.dependencies] -boring-sys = { version = "5.0.0-alpha.3", path = "./boring-sys" } -boring = { version = "5.0.0-alpha.3", path = "./boring" } -tokio-boring = { version = "5.0.0-alpha.3", path = "./tokio-boring" } +boring-sys = { version = "5.0.0", path = "./boring-sys" } +boring = { version = "5.0.0", path = "./boring" } +tokio-boring = { version = "5.0.0", path = "./tokio-boring" } bindgen = { version = "0.72.0", default-features = false, features = ["runtime"] } bitflags = "2.9" diff --git a/README.md b/README.md index dde5796ea..9f948242b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ [![crates.io](https://img.shields.io/crates/v/boring.svg)](https://crates.io/crates/boring) -BoringSSL bindings for the Rust programming language and TLS adapters for [tokio](https://github.com/tokio-rs/tokio) +[BoringSSL](https://boringssl.googlesource.com/boringssl) is Google's fork of OpenSSL for Chrome/Chromium and Android. + +This crate provides safe bindings for the Rust programming language and TLS adapters for [tokio](https://github.com/tokio-rs/tokio) and [hyper](https://github.com/hyperium/hyper) built on top of it. ## Documentation @@ -13,14 +15,14 @@ and [hyper](https://github.com/hyperium/hyper) built on top of it. # Upgrading from `boring` v4 - * First update to boring 4.20 and ensure it builds without any deprecation warnings. + * First update to boring 4.21 and ensure it builds without any deprecation warnings. * `pq-experimental` Cargo feature is no longer needed. Post-quantum crypto is enabled by default. * `fips-precompiled` Cargo feature has been merged into `fips`. Set `BORING_BSSL_FIPS_PATH` env var to use a precompiled library. * `fips-compat` Cargo feature has been renamed to `legacy-compat-deprecated` (4cb7e260a85b7) - * `SslCurve` and `SslCurveNid` have been removed. Use `set_curves_list()`. + * `SslCurve` and `SslCurveNid` have been removed. Curve names are more stable and portable identifiers. Use `curve_name()` and `set_curves_list()`. * `Ssl::new_from_ref` -> `Ssl::new()`. * `X509Builder::append_extension2` -> `X509Builder::append_extension`. - * `X509Store` is now cheaply cloneable, but immutable. `SslContextBuilder.cert_store_mut()` can't be used after `.set_cert_store()`. Use `.set_cert_store_builder()` if you need `.cert_store_mut()`. + * `X509Store` is now cheaply cloneable, but immutable. `SslContextBuilder.cert_store_mut()` can't be used after `.set_cert_store()`. If you need `.cert_store_mut()`, either don't overwrite the default store, or use `.set_cert_store_builder()`. * `X509StoreBuilder::add_cert` takes a reference. * `hyper` 0.x support has been removed. Use `hyper` 1.x. diff --git a/boring-sys/Cargo.toml b/boring-sys/Cargo.toml index cecc83f51..72845c85e 100644 --- a/boring-sys/Cargo.toml +++ b/boring-sys/Cargo.toml @@ -12,6 +12,7 @@ links = "boringssl" build = "build/main.rs" readme = "README.md" categories = ["cryptography", "external-ffi-bindings"] +keywords = ["tls", "boringssl", "openssl", "fips", "ml-kem"] edition = { workspace = true } rust-version = { workspace = true } include = [ diff --git a/boring-sys/README.md b/boring-sys/README.md deleted file mode 120000 index 32d46ee88..000000000 --- a/boring-sys/README.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/boring-sys/README.md b/boring-sys/README.md new file mode 100644 index 000000000..fe4d7db20 --- /dev/null +++ b/boring-sys/README.md @@ -0,0 +1,15 @@ +# Low-level bindings to BoringSSL + +[BoringSSL](https://boringssl.googlesource.com/boringssl) is Google's fork of OpenSSL for Chrome/Chromium and Android. + +This crate builds the BoringSSL library (or optionally links a pre-built version) and generates FFI bindings for it. +It supports FIPS-compatible builds of BoringSSL, as well as Post-Quantum crypto and Raw Public Key features. + +To use BoringSSL from Rust, prefer the [higher-level safe API](https://docs.rs/boring). + +## Contribution + +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 under the terms of both the Apache License, +Version 2.0 and the MIT license without any additional terms or conditions. diff --git a/boring/Cargo.toml b/boring/Cargo.toml index 465cbb294..b9605ff13 100644 --- a/boring/Cargo.toml +++ b/boring/Cargo.toml @@ -7,7 +7,7 @@ description = "BoringSSL bindings" repository = { workspace = true } documentation = "https://docs.rs/boring" readme = "README.md" -keywords = ["crypto", "tls", "ssl", "dtls"] +keywords = ["tls", "ssl", "dtls", "post-quantum", "fips"] categories = ["cryptography", "api-bindings"] edition = { workspace = true } rust-version = { workspace = true }