7 个版本

0.10.62 2023年12月24日
0.10.61 2023年12月5日
0.10.60 2023年11月23日
0.10.57 2023年8月28日

#1519 in 密码学

Download history 1/week @ 2024-05-26 5/week @ 2024-06-30 10/week @ 2024-07-14 55/week @ 2024-07-28

70 个月下载量
tokio-tongsuo 中使用

Apache-2.0

1.5MB
35K SLoC

rust-tongsuo

基于 Rust 编程语言的通硕绑定,基于 rust-openssl

默认功能将使用通硕,您可以通过禁用 通硕 功能来使用 OpenSSL。

文档.

发布支持

当前支持的 通硕 版本为 0.10,tongsuo-sys 为 0.9。

新主要版本将每年最多发布一次。在新版本发布后,旧的主要版本将支持3个月,在此期间将修复部分错误,之后将完全停止支持。

贡献

除非您明确声明,否则根据 Apache-2.0 许可证定义,任何有意提交以包含在您的工作中的贡献,均应同时根据 Apache 许可证第 2 版和 MIT 许可证的条款进行双重许可,没有任何附加条款或条件。


lib.rs:

OpenSSL 绑定

此 crate 提供了对流行的 OpenSSL 加密库的安全接口。支持 OpenSSL 版本 1.0.1 到 3.x.x 以及 LibreSSL 版本 2.5 到 3.7.x。

构建

构建此 crate 需要 OpenSSL 库和头文件。有多种选项可用于定位 OpenSSL。

供应商

如果启用了 vendored Cargo 功能,则将使用 openssl-src crate 编译并将 OpenSSL 静态链接到副本。构建过程需要 C 编译器、perl(和 perl-core)以及 make。OpenSSL 版本将通常跟踪最新的 OpenSSL 发布,版本更改不被视为破坏性更改。

[dependencies]
openssl = { version = "0.10", features = ["vendored"] }

供应商副本将不会配置为自动找到系统的根证书,但可以使用 openssl-probe crate 来执行此操作。

自动

openssl-sys crate 将自动检测 macOS 上的 Homebrew 和 Windows 上的 vcpkg 上的 OpenSSL 安装。此外,它将在类 Unix 系统上使用 pkg-config 来查找系统安装。

$ brew install openssl@3

$ sudo port install openssl

$ sudo pkgin install openssl

$ sudo pacman -S pkg-config openssl

$ sudo apt-get install pkg-config libssl-dev

$ sudo dnf install pkg-config perl-FindBin openssl-devel

$ apk add pkgconfig openssl-dev

$ sudo zypper in libopenssl-devel

手动

可以使用一组环境变量来指向 openssl-sys 的 OpenSSL 安装。它们将覆盖自动检测逻辑。

  • OPENSSL_DIR - 如果指定,则为 OpenSSL 安装目录。目录应包含包含库和头文件的 libinclude 子目录。
  • OPENSSL_LIB_DIROPENSSL_INCLUDE_DIR - 如果指定,则分别包含 OpenSSL 库和头文件的目录。如果 OpenSSL 安装在一个非标准目录布局中,可以使用此功能。
  • OPENSSL_STATIC - 如果设置,则 crate 将静态链接到 OpenSSL 而不是动态链接。
  • OPENSSL_LIBS - 如果设置,则是一个用冒号分隔的库名称列表,用于链接(例如 ssl:crypto)。如果由于某种原因使用了非标准库名称,则可以使用此功能。
  • OPENSSL_NO_VENDOR - 如果设置,即使启用了 vendored 功能,也始终在系统中查找 OpenSSL。

此外,这些变量可以用大写目标架构(例如 X86_64_UNKNOWN_LINUX_GNU_OPENSSL_DIR)作为前缀,这在交叉编译时可能很有用。

功能检测

各个支持的 OpenSSL 版本中已添加和删除了 API,并且此库公开了链接的版本中可用的功能。这意味着当针对一个 OpenSSL 版本构建时,方法、常量和甚至模块都会存在,但当针对另一个版本构建时则不会存在!API 将记录任何版本特定的可用性限制。

如果需要,可以使用构建脚本来检测编译时的 OpenSSL 或 LibreSSL 版本。如果需要,openssl-sys crate 通过 DEP_OPENSSL_VERSION_NUMBERDEP_OPENSSL_LIBRESSL_VERSION_NUMBER 环境变量将版本传递给构建脚本。版本格式是 OpenSSL 发布版本的十六进制编码:0xMNNFFPPS。例如,版本 1.0.2g 的编码是 0x1_00_02_07_0

例如,假设我们想要调整客户端使用的 TLSv1.3 密码套件,但同时也想针对不支持 TLSv1.3 的 OpenSSL 版本进行编译

Cargo.toml

[dependencies]
openssl-sys = "0.9"
openssl = "0.10"

build.rs

use std::env;

fn main() {
    if let Ok(v) = env::var("DEP_OPENSSL_VERSION_NUMBER") {
        let version = u64::from_str_radix(&v, 16).unwrap();

        if version >= 0x1_01_01_00_0 {
            println!("cargo:rustc-cfg=openssl111");
        }
    }
}

lib.rs

use openssl::ssl::{SslConnector, SslMethod};

let mut ctx = SslConnector::builder(SslMethod::tls()).unwrap();

// set_ciphersuites was added in OpenSSL 1.1.1, so we can only call it when linking against that version
#[cfg(openssl111)]
ctx.set_ciphersuites("TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256").unwrap();

依赖关系

~0.4–2.1MB
~48K SLoC