acmex 0.8.0

AcmeX: High-performance, extensible ACME v2 (RFC 8555) client and server in Rust, supporting multiple DNS providers, storage backends, and crypto libraries.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# AcmeX v0.4.0 - 完整文件清单

**最终更新时间**: 2026-02-07  
**项目版本**: v0.4.0  
**总文件数**: 35+ 个  
**总代码行**: 4468 行  
**总文档行**: 5450+ 行

---

## 📂 项目结构

### 源代码文件 (src/)

#### 核心模块

```
src/
├── lib.rs                    # 库入口 (139 行)
│   ├── 模块声明
│   ├── 公共 API 导出
│   └── Prelude 模块
│
├── account/                  # 账户管理
│   ├── mod.rs               # 模块导出 (5 行)
│   ├── credentials.rs        # 密钥对管理 (150+ 行)
│   ├── manager.rs           # 账户管理器 (341 行)
│   └── account.rs           # 账户对象 (85+ 行)
│
├── order/                    # 订单管理
│   ├── mod.rs               # 模块导出 (10 行)
│   ├── objects.rs           # 订单对象 (180+ 行)
│   ├── manager.rs           # 订单管理器 (340 行) ⭐ v0.3.0
│   └── csr.rs               # CSR 生成 (150+ 行) ⭐ v0.3.0
│
├── challenge/               # 挑战验证
│   ├── mod.rs               # ChallengeSolver trait (40+ 行)
│   ├── http01.rs            # HTTP-01 实现 (156 行)
│   └── dns01.rs             # DNS-01 实现 (198 行)
│
├── dns/                      # DNS 提供商 ⭐ v0.4.0
│   ├── mod.rs               # 模块导出 (10 行)
│   └── providers/
│       ├── mod.rs           # 提供商导出 (18 行)
│       ├── cloudflare.rs     # CloudFlare (100+ 行)
│       ├── digitalocean.rs   # DigitalOcean (100+ 行)
│       ├── linode.rs         # Linode (100+ 行)
│       └── route53.rs        # Route53 桩 (40+ 行)
│
├── storage/                  # 证书存储 ⭐ v0.4.0
│   ├── mod.rs               # 模块导出 (30 行)
│   ├── file.rs              # FileStorage (80+ 行)
│   ├── redis.rs             # RedisStorage (80+ 行)
│   ├── encrypted.rs         # EncryptedStorage (120+ 行)
│   └── cert_store.rs        # CertificateStore (60+ 行)
│
├── renewal/                  # 自动续期 ⭐ v0.4.0
│   └── mod.rs               # RenewalScheduler (170+ 行)
│
├── metrics/                  # Prometheus 指标 ⭐ v0.4.0
│   └── mod.rs               # MetricsRegistry (60+ 行)
│
├── cli/                      # 命令行工具 ⭐ v0.4.0
│   ├── mod.rs               # CLI 执行 (40+ 行)
│   └── args.rs              # 参数解析 (100+ 行)
│
├── protocol/                 # ACME 协议
│   ├── mod.rs               # 模块导出 (10 行)
│   ├── directory.rs         # Directory 管理 (95+ 行)
│   ├── jwk.rs               # JWK 和 JWS (180+ 行)
│   └── nonce.rs             # Nonce 管理 (65+ 行)
│
├── client.rs                 # 高级客户端 API (280+ 行) ⭐ v0.3.0
├── error.rs                  # 错误处理 (150+ 行)
└── types.rs                  # 基础类型 (200+ 行)
```

### 文档文件 (docs/)

#### 版本报告

```
docs/
├── V0.1.0_COMPLETION_REPORT.md      (完成报告)
├── V0.2.0_COMPLETION_REPORT.md      (完成报告)
├── V0.3.0_COMPLETION_REPORT.md      (完成报告)
└── V0.4.0_COMPLETION_REPORT.md      (完成报告) ⭐ v0.4.0
```

#### 技术文档

```
docs/
├── HTTP-01_IMPLEMENTATION.md        (HTTP-01 实现细节)
├── DNS-01_IMPLEMENTATION.md         (DNS-01 实现细节)
├── CHALLENGE_EXAMPLES.md            (挑战验证示例)
└── INTEGRATION_EXAMPLES.md          (集成示例)
```

#### 使用指南

```
docs/
├── V0.3.0_INTEGRATION_EXAMPLES.md   (v0.3.0 集成示例)
├── V0.4.0_USAGE_GUIDE.md            (v0.4.0 使用指南) ⭐ v0.4.0
└── MAIN_README.md                   (主要概览) ⭐ v0.4.0
```

#### 项目总结

```
docs/
├── README.md                        (文档首页)
├── DELIVERABLES_CHECKLIST.md        (交付清单)
├── FINAL_PROJECT_SUMMARY.md         (最终总结) ⭐ v0.4.0
└── FINAL_V0.2.0_SUMMARY.md          (v0.2.0 总结)
```

### 配置文件

```
根目录/
├── Cargo.toml                       (项目配置 - 83 行)
│   ├── [package] 元数据
│   ├── [dependencies] 依赖 (25 个)
│   ├── [dev-dependencies] 开发依赖
│   └── [features] Feature flags (8 个)
│
├── Cargo.lock                       (依赖锁定)
├── LICENSE-MIT                      (MIT 许可证)
└── LICENSE-APACHE                   (Apache 2.0 许可证)

根目录/
├── README.md                        (中文说明)
├── README_ZH.md                     (中文说明)
└── MAIN_README.md                   (项目主要介绍) ⭐ v0.4.0
```

---

## 📊 文件统计

### 源代码

```
总行数:         4468 行
├── account/    ~650 行
├── order/      ~730 行
├── challenge/  ~500 行
├── dns/        ~440 行
├── storage/    ~370 行
├── renewal/    ~170 行
├── metrics/    ~60 行
├── cli/        ~140 行
├── protocol/   ~500 行
├── client/     ~280 行
├── error/      ~150 行
├── types/      ~200 行
└── lib/        ~139 行
```

### 文档

```
总行数:        5450+ 行
├── 完成报告:  2000+ 行
├── 技术文档:  1200+ 行
├── 使用指南:  1800+ 行
└── 其他:      450+ 行
```

### 测试

```
单元测试:       50+ 个
├── account:    10+ 个
├── challenge:  10+ 个
├── order:      10+ 个
├── storage:    10+ 个
└── renewal:    10+ 个
```

---

## 🎯 功能映射

### v0.1.0 - 核心 ACME 协议

| 功能           | 文件                     | 行数   | 状态 |
|--------------|------------------------|------|----|
| Account 注册   | account/manager.rs     | 341  ||
| KeyPair 生成   | account/credentials.rs | 150+ ||
| Directory 管理 | protocol/directory.rs  | 95+  ||
| Nonce 管理     | protocol/nonce.rs      | 65+  ||
| JWS/JWK 签名   | protocol/jwk.rs        | 180+ ||

### v0.2.0 - 挑战验证

| 功能              | 文件                  | 行数  | 状态 |
|-----------------|---------------------|-----|----|
| HTTP-01 服务器     | challenge/http01.rs | 156 ||
| DNS-01 记录       | challenge/dns01.rs  | 198 ||
| ChallengeSolver | challenge/mod.rs    | 40+ ||
| Mock DNS        | challenge/dns01.rs  | 50+ ||

### v0.3.0 - 证书签发

| 功能     | 文件               | 行数   | 状态 |
|--------|------------------|------|----|
| 订单管理   | order/manager.rs | 340  ||
| CSR 生成 | order/csr.rs     | 150+ ||
| 高级客户端  | client.rs        | 280+ ||
| 证书验证   | order/csr.rs     | 50+  ||

### v0.4.0 - 企业级功能

| 功能               | 文件                            | 行数   | 状态 |
|------------------|-------------------------------|------|----|
| CloudFlare DNS   | dns/providers/cloudflare.rs   | 100+ ||
| DigitalOcean DNS | dns/providers/digitalocean.rs | 100+ ||
| Linode DNS       | dns/providers/linode.rs       | 100+ ||
| Route53 (桩)      | dns/providers/route53.rs      | 40+  ||
| FileStorage      | storage/file.rs               | 80+  ||
| RedisStorage     | storage/redis.rs              | 80+  ||
| EncryptedStorage | storage/encrypted.rs          | 120+ ||
| CertificateStore | storage/cert_store.rs         | 60+  ||
| RenewalScheduler | renewal/mod.rs                | 170+ ||
| Prometheus 指标    | metrics/mod.rs                | 60+  ||
| CLI 工具           | cli/                          | 140+ ||

---

## 📦 依赖清单

### 核心依赖

```toml
# 异步运行时
tokio = { version = "1.40", features = ["full"] }

# HTTP 客户端
reqwest = { version = "0.12", features = ["json", "rustls-tls"] }

# 序列化
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"

# 加密后端
aws-lc-rs = { version = "1.15.4", optional = true }
ring = { version = "0.17", optional = true }

# 密钥生成
rcgen = "0.13"

# 时间处理
jiff = { version = "0.2.19", features = ["serde"] }

# 证书解析
x509-parser = "0.16"

# DNS 解析
hickory-resolver = "0.25"
hickory-proto = "0.25"

# 编码
base64 = "0.22"
pem = "3.0"
rustls-pemfile = "2.0"

# 类型系统
async-trait = "0.1"
thiserror = "2.0"

# 日志
tracing = "0.1"
tracing-subscriber = "0.3"

# 监控
prometheus = "0.14"

# CLI
clap = { version = "4.5", features = ["derive"] }

# 配置
toml = "0.8"

# 工具
rand = "0.8"
```

### 可选依赖

```toml
# Redis 存储
redis = { version = "0.26", optional = true }

# HTTP 服务器 (axum 已在依赖中)
axum = { version = "0.8", features = ["macros"] }
hyper = "1.4"
```

---

## 🧪 测试文件

### 单元测试

```
src/
├── account/manager.rs:tests       (10+ 个)
├── order/manager.rs:tests         (10+ 个)
├── challenge/http01.rs:tests      (5+ 个)
├── challenge/dns01.rs:tests       (5+ 个)
├── storage/file.rs:tests          (5+ 个)
├── storage/encrypted.rs:tests     (5+ 个)
├── renewal/mod.rs:tests           (5+ 个)
└── client/mod.rs:tests            (5+ 个)
```

---

## 📋 完成清单

### 实现清单

- [x] v0.1.0 核心 ACME 协议
- [x] v0.2.0 HTTP-01 和 DNS-01 验证
- [x] v0.3.0 订单管理和证书签发
- [x] v0.4.0 DNS 提供商、存储、续期、监控、CLI

### 文档清单

- [x] 版本完成报告 (4 个)
- [x] 技术实现文档 (2 个)
- [x] 使用示例集合 (3 个)
- [x] 快速开始指南 (1 个)
- [x] API 参考 (40+ 页)
- [x] 架构设计说明 (1 个)

### 质量清单

- [x] 编译无错误
- [x] 编译无警告
- [x] MSRV 1.92.0 支持
- [x] Edition 2024 支持
- [x] 零 unsafe 代码
- [x] 完整错误处理
- [x] 丰富的日志记录

---

## 🚀 快速命令

```bash
# 构建
cargo build --release

# 测试
cargo test

# 文档
cargo doc --lib --no-deps --open

# 检查
cargo check

# 全功能构建
cargo build --release \
  --features dns-cloudflare,dns-route53,dns-digitalocean,dns-linode,redis,metrics,cli
```

---

## 📞 文件导航

### 从零开始学习

1. [MAIN_README.md]./docs/MAIN_README.md - 项目概览
2. 查看 [V0.1.0_COMPLETION_REPORT.md]./docs/V0.1.0_COMPLETION_REPORT.md - 核心概念
3. 学习 [CHALLENGE_EXAMPLES.md]./docs/CHALLENGE_EXAMPLES.md - 挑战验证
4. 参考 [V0.4.0_USAGE_GUIDE.md]./docs/V0.4.0_USAGE_GUIDE.md - 完整功能

### 查找具体功能

| 我想...         | 查看文件                                               |
|---------------|----------------------------------------------------|
| 申请证书          | client.rs, V0.3.0_*.md                             |
| HTTP-01 验证    | challenge/http01.rs, HTTP-01_IMPLEMENTATION.md     |
| DNS-01 验证     | challenge/dns01.rs, DNS-01_IMPLEMENTATION.md       |
| 使用 CloudFlare | dns/providers/cloudflare.rs, V0.4.0_USAGE_GUIDE.md |
| 自动续期          | renewal/mod.rs, V0.4.0_USAGE_GUIDE.md              |
| Redis 存储      | storage/redis.rs, V0.4.0_USAGE_GUIDE.md            |
| CLI 工具        | cli/, V0.4.0_USAGE_GUIDE.md                        |

---

## 📈 项目增长路径

```
2026-02-07 v0.1.0     2092 行代码  +  基础协议
           v0.2.0      406 行代码  +  挑战验证
           v0.3.0      770 行代码  +  证书签发
           v0.4.0     1200 行代码  +  企业功能
           
总计:      4468 行代码  5450+ 行文档
```

---

**项目状态**: ✅ **v0.4.0 完成**  
**最后更新**: 2026-02-07  
**维护者**: houseme  
**许可证**: MIT OR Apache-2.0

🎉 **感谢您使用 AcmeX!**