OQS-curl Docker镜像文档

1. 镜像概述和主要用途

OQS-curl是一个集成量子安全加密（QSC）功能的Docker镜像，基于curl工具构建，旨在提供量子安全的TLS通信能力。该镜像集成了OpenQuantumSafe项目的oqs-provider和最新版OpenSSL（v3/master），使curl能够支持量子安全密钥交换（KEM）算法，适用于量子计算时代的安全通信测试与验证。

2. 核心功能和特性

量子安全TLS支持：集成oqs-provider，支持多种量子安全密钥交换算法（KEM）和签名算法
内置测试服务器：包含openssl s_server实现的QSC-enabled TLS测试服务器，便于快速验证功能
标准curl兼容性：保留所有标准curl参数，同时扩展支持量子安全算法指定
灵活配置选项：通过命令行参数（--curves）或环境变量（DEFAULT_GROUPS、KEM_ALG等）指定量子安全算法
性能测试工具：内置性能测试脚本，支持量化不同QSC算法的TLS握手性能

3. 使用场景和适用范围

量子安全TLS通信测试：验证量子安全算法在TLS 1.3协议中的实际应用
第三方QSC服务器交互：与任何支持OQS的TLS服务器建立安全连接并获取数据
算法性能评估：测试不同量子安全算法的TLS握手效率和计算性能
安全协议开发：为量子安全通信协议的开发和调试提供标准化测试环境

4. 使用方法和配置说明

4.1 快速开始：内置测试服务器交互

4.1.1 启动测试服务器

通过以下命令启动内置QSC-enabled TLS测试服务器：

bash
docker run -it openquantumsafe/curl

默认情况下，服务器使用kyber768作为KEM算法。如需指定其他KEM算法，可通过KEM_ALG环境变量配置：

bash
docker run -e KEM_ALG=p384_kyber768 -it openquantumsafe/curl

4.1.2 客户端连接测试

在容器内命令行中，使用curl连接测试服务器，验证量子安全TLS握手：

bash
# 方法1：通过--curves参数指定KEM算法
curl --curves kyber768 https://localhost:4433

# 方法2：通过环境变量DEFAULT_GROUPS指定KEM算法
DEFAULT_GROUPS=p384_kyber768 curl https://localhost:4433

上述命令返回TLS连接详情，包含量子安全算法使用信息。--curves参数支持的算法列表见oqs-provider支持的KEM算法。

4.2 与外部QSC-enabled TLS服务器交互

除内置测试服务器外，镜像可直接与外部OQS-enabled TLS（1.3）服务器通信，命令格式如下：

bash
docker run -it openquantumsafe/curl curl <OQS-server URL>

4.2.1 算法指定示例

显式指定量子安全KEM算法：

bash
# 使用--curves参数
docker run -it openquantumsafe/curl curl --curves kyber512 [***]

# 使用环境变量DEFAULT_GROUPS
docker run -e DEFAULT_GROUPS=p256_kyber768 -it openquantumsafe/curl curl [***]

4.3 性能测试

4.3.1 TLS握手性能测试

通过内置perftest.sh脚本测试不同QSC算法的TLS握手性能，默认测试200秒，使用kyber768（KEM）和dilithium2（签名）算法。

基本用法：

bash
docker run -it openquantumsafe/curl perftest.sh

自定义测试参数：通过环境变量配置测试时长、KEM算法和签名算法：

bash
docker run -e TEST_TIME=5 \
           -e KEM_ALG=kyber768 \
           -e SIG_ALG=dilithium3 \
           -it openquantumsafe/curl perftest.sh

TEST_TIME：测试持续时间（秒），默认200
KEM_ALG：量子安全密钥交换算法，需从oqs-provider支持的KEM列表选择
SIG_ALG：量子安全签名算法，需从OpenQuantumSafe支持的签名算法选择

4.3.2 算法性能测试

使用openssl speed命令测试特定算法的原始计算性能：

测试所有算法：

bash
docker run -it openquantumsafe/curl openssl speed

测试指定算法：

bash
# 测试kyber512算法，持续2秒
docker run -it openquantumsafe/curl openssl speed -seconds 2 kyber512

支持的算法名称可参考oqs-provider算法列表。

5. 配置参数与环境变量

参数/环境变量	用途	取值范围	默认值
`--curves`	命令行参数，指定QSC KEM算法	oqs-provider支持的KEM算法	无
`DEFAULT_GROUPS`	环境变量，指定默认QSC KEM算法	同上	无
`KEM_ALG`	环境变量，指定测试服务器KEM算法	同上	`kyber768`
`TEST_TIME`	环境变量，TLS握手测试时长（秒）	正整数	200
`SIG_ALG`	环境变量，TLS握手测试签名算法	OpenQuantumSafe支持的签名算法	`dilithium2`