Rustls-ACME 项目使用教程

Rustls-ACME 项目使用教程

1. 项目的目录结构及介绍

Rustls-ACME 项目的目录结构如下：

rustls-acme/
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── src/
│   ├── acme.rs
│   ├── axum.rs
│   ├── cache.rs
│   ├── lib.rs
│   ├── tokio.rs
│   └── tokio.rs
└── tests/
    └── integration_test.rs

目录结构介绍

• Cargo.toml: 项目的依赖和元数据配置文件。
• LICENSE-APACHE 和 LICENSE-MIT: 项目的开源许可证文件。
• README.md: 项目的基本介绍和使用说明。
• src/: 包含项目的源代码文件。
  • acme.rs: ACME 客户端的实现。
  • axum.rs: 与 Axum 框架相关的代码。
  • cache.rs: 缓存相关的代码。
  • lib.rs: 库的入口文件。
  • tokio.rs: 与 Tokio 运行时相关的代码。
• tests/: 包含项目的测试代码。
  • integration_test.rs: 集成测试代码。

2. 项目的启动文件介绍

项目的启动文件是 src/lib.rs，它是 Rustls-ACME 库的入口文件。该文件定义了库的公共接口和主要功能模块。

src/lib.rs 文件介绍

• 导入了项目所需的所有模块和依赖。
• 定义了库的主要结构体和函数，如 AcmeConfig、AcmeAcceptor 等。
• 提供了高层次的 API，用于处理证书的获取、更新和 TLS 连接的接受。

3. 项目的配置文件介绍

项目的配置文件是 Cargo.toml，它包含了项目的依赖、版本信息和其他元数据。

Cargo.toml 文件介绍

[package]
name = "rustls-acme"
version = "0.10.1"
edition = "2021"

[dependencies]
async-io = "2.3.0"
async-trait = "0.1.53"
async-web-client = "0.6.2"
aws-lc-rs = { version = "1.5.2", optional = true }
axum-server = { version = "0.6", optional = true }
base64 = { version = "0.22", optional = true }
blocking = "1.4.1"
chrono = "0.4.24"
futures = "0.3.21"
futures-rustls = "0.26"
http = "1"
log = "0.4.17"
pem = "3.0.3"
rcgen = "0.13"
ring = "0.17.7"
serde = { version = "1.0.137", optional = true }
serde_json = "1.0.81"
thiserror = "1.0.31"
tokio = { version = "1.20.1", optional = true }
tokio-util = { version = "0.7.3", optional = true }
webpki-roots = { version = "0.26", optional = true }
x509-parser = "0.16"

[dev-dependencies]
axum = "0.7"
clap = "3.1.18"
macro_rules_attribute = "0.2.0"
simple_logger = "4.3.3"
smol = "2.0.0"
smol-macros = "0.1.0"
tokio = "1.35.1"
tokio-rustls = "0.26"
tokio-stream = "0.1.14"
tokio-util = "0.7.10"
warp = "0.3.4"

配置文件介绍

• [package]: 定义了项目的名称、版本和 Rust 版本。
• [dependencies]: