From 58d2b58d70bb86a61f5a6e03f7dc5d1fdfbe91ab Mon Sep 17 00:00:00 2001 From: 0x676e67 Date: Wed, 18 Jun 2025 22:19:30 +0800 Subject: [PATCH] docs: update prefer chacha20 option docs (#81) --- boring/src/ssl/connector.rs | 6 +++++- boring/src/ssl/mod.rs | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/boring/src/ssl/connector.rs b/boring/src/ssl/connector.rs index 22a001a1..f4836e85 100644 --- a/boring/src/ssl/connector.rs +++ b/boring/src/ssl/connector.rs @@ -287,7 +287,11 @@ impl ConnectConfiguration { unsafe { ffi::SSL_set_aes_hw_override(self.as_ptr(), enable as _) } } - /// Sets whether the aes chacha20 preference should be enabled. + /// Sets whether the ChaCha20 preference should be enabled. + /// + /// Controls the priority of TLS 1.3 cipher suites. When set to `true`, the client prefers: + /// AES_128_GCM, CHACHA20_POLY1305, then AES_256_GCM. Useful in environments with specific + /// encryption requirements. #[cfg(not(feature = "fips"))] #[corresponds(SSL_set_prefer_chacha20)] pub fn set_prefer_chacha20(&mut self, enable: bool) { diff --git a/boring/src/ssl/mod.rs b/boring/src/ssl/mod.rs index 6f31e56f..1efc7c8d 100644 --- a/boring/src/ssl/mod.rs +++ b/boring/src/ssl/mod.rs @@ -1910,7 +1910,11 @@ impl SslContextBuilder { unsafe { ffi::SSL_CTX_set_aes_hw_override(self.as_ptr(), enable as _) } } - /// Sets whether the aes chacha20 preference should be enabled. + /// Sets whether the ChaCha20 preference should be enabled. + /// + /// Controls the priority of TLS 1.3 cipher suites. When set to `true`, the client prefers: + /// AES_128_GCM, CHACHA20_POLY1305, then AES_256_GCM. Useful in environments with specific + /// encryption requirements. #[cfg(not(feature = "fips"))] #[corresponds(SSL_CTX_set_prefer_chacha20)] pub fn set_prefer_chacha20(&mut self, enable: bool) {