Skip to content

mention provider usage in docstring #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tofay merged 3 commits into from
Sep 25, 2026
Merged

mention provider usage in docstring #49

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24bf2a3
doc: mention provider usage in docstring
tofay Sep 25, 2026
1a31b7b
typo
tofay Sep 25, 2026
3f5f7d0
reword
tofay Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
//!
//! ```toml
//! [dependencies]
//! rustls = { version = "0.23.0", features = ["tls12", "std"], default-features = false }
//! rustls_openssl = "0.3"
//! rustls = { version = "0.23", features = ["tls12", "std"], default-features = false }
//! rustls_openssl = "0.4"
//! ```
//!
//! ### Configuration
Expand All @@ -72,7 +72,13 @@
//! - `tls12`: Enables TLS 1.2 cipher suites. Enabled by default.
//! - `prefer-post-quantum`: Enables X25519MLKEM768 as the first key exchange group. Enabled by default.
//! - `vendored`: Enables vendored OpenSSL. Disabled by default.
//! - `fips`: No longer used.
//! - `fips`: No longer used. See [fips] for FIPS support.
//!
//! # OpenSSL API Usage
//!
//! When targeting OpenSSL 3.0 or later this crate uses OpenSSL's provider APIs (`EVP_*`).
//! Legacy cryptographic interfaces (e.g., direct `HMAC_*` or `RSA_*` functions) are used only when
//! targeting OpenSSL 1.1.1.
#![warn(missing_docs)]
use openssl::rand::rand_priv_bytes;
use rustls::SupportedCipherSuite;
Expand Down Expand Up @@ -181,8 +187,10 @@ fn cipher_suite_available(cipher_suite: &SupportedCipherSuite) -> bool {
/// The specified cipher suites and key exchange groups should be defined in descending order of preference.
/// i.e the first elements have the highest priority during negotiation.
///
/// If OpenSSL is running in FIPS mode, non-approved algorithms may be filtered
/// out by runtime availability checks.
/// No runtime filtering is performed on the provided cipher suites and key exchange groups
/// so the caller is responsible for ensuring that the provided algorithms are available at runtime.
/// This can be done by using [available_cipher_suites()] and [kx_group::available_groups()].
///
///
/// Sample usage:
/// ```rust
Expand Down
Loading