OpenSSL 3.0.0 设计（四）｜代码维护、FIPS 测试

译｜王祖熙 （花名：金九 )

蚂蚁集团开发工程师
负责国产化密码库 Tongsuo 的开发和维护
专注于密码学、高性能网络、网络安全等领域

本文 2862 字阅读 8 分钟

本文翻译 OpenSSL 官网文档：https://www.openssl.org/docs/OpenSSL300Design.html

Tongsuo-8.4.0 是基于 OpenSSL-3.0.3 开发，所以本文对 Tongsuo 开发者同样适用，内容丰富，值得一读！

由于文章篇幅较长，今天带来的是 《代码维护、FIPS 测试》 部分内

后续内容将随每周推送完整发布，请持续关注铜锁。

代码维护

源代码结构/目录树的清理

密码学实现（crypto/evp/e_*.c和大部分crypto/evp/m_*.c，以及任何定义EVP_CIPHER、EVP_MD、EVP_PKEY_METHOD、EVP_MAC或EVP_KDF的代码）必须移出 evp 目录，它们最终将成为一个或两个 Provider 的一部分，因此它们应该位于特定 Provider 的子目录中。

将创建一个新的目录providers/，用于存放特定 Provider 的代码。providers/build.info定义了哪些源文件在哪些 Provider 模块中使用。

共享源代码

FIPS Provider 模块和默认 Provider 将共享相同的源代码，在不同的条件下，例如不同的#include路径或定义的宏不同（后者需要在构建系统中添加支持）。下面是一个示例build.info文件，实现了这一点：

PROVIDERS=p_fips p_default

SOURCE[p_fips]=foo.c
INCLUDE[p_fips]=include/fips

SOURCE[p_default]=foo.c
INCLUDE[p_default]=include/default

或者，使用宏：

PROVIDERS=p_fips p_default

SOURCE[p_fips]=foo.c
DEFINE[p_fips]=FIPS_MODE

SOURCE[p_default]=foo.c

注意：一些关键字还不是 build.info 语言的一部分。

条件代码

我们需要对编译时包含 FIPS 特定代码的方法进行一致处理，并在某些情况下排除 FIPS 不允许的代码。

编译时的控制将通过#ifdef FIPS_MODE来进行，这确保所有相关的文件都明确地为非 FIPS 或在 FIPS 模块内部进行编译，由于每个文件都将被编译两次（在默认 Provider 和 FIPS 模块中各一次），一次使用每个设置，因此使用具有恒定值的运行时if语句没有好处。（此外，运行时设置并不总是有效（例如在扩展诸如BLOCK_CIPHER_custom之类的宏时，会创建全局变量或函数指针。）

构建系统将通过使用-DFIPS_MODE编译 FIPS Provider 对象文件，以及不带命令行定义的来自相同源的默认 Provider 对象文件来支持此操作。

对于运行时检查，将需要检查 TLS 连接是否处于 FIPS 模式，这可以通过以通用方式检查与特定SSL_CTX 或SSL对象关联的属性查询字符串来完成，以查看是否设置了“fips”属性。

FIPS 测试

需要进行以下类型的测试：

用于 CMVP 验证算法的 CAVS 测试；
能够运行所有 FIPS 模块算法的 FIPS 测试套件；
启动后故障测试；
Acumen 将编写使用 libcrypto 的应用程序，通过 EVP 层访问 FIPS Provider。

任何需要返回中间值（例如 CAVS 密钥生成）以显示信息（自检状态）或更改 FIPS 模块代码的正常流程的特殊情况代码（例如自检失败或在提供固定随机值的密钥生成循环中失败），将通过将回调函数嵌入到FIPS模块代码中进行控制。

建议将这些回调代码以条件编译的方式编入模块中中，因为其中一些值不应该被返回（例如，FIPS 模块不应该输出密钥生成中的中间值）。

针对需要使用固定 rand_bytes 的测试，将对rand_bytes()进行重写。

FIPS 测试回调

应用程序可以选择提供一个回调函数，用于处理从 FIPS 模块接收到的值（如果需要，可以注册多个回调函数）。

可选的应用程序回调函数的形式如下：

static int fips_test_callback(const char *type, void *arg)
{
    return 1;
}

回调函数的返回值可用于控制 FIPS 模块代码中的特殊情况的流程。

类型由 FIPS 模块钩子传入，FIPS模块中的每个不同的钩子应具有唯一的类型，类型决定了参数 arg 的内容（可以是结构体（例如中间值）、名称或整数）。

FIPS 模块中的回调函数的形式如下：

MY_STRUCT  data;   /* values that need to be returned to the application */
data.i = 1;
.....
if (FIPS_test_cb != NULL)
    FIPS_test_cb(FIPS_TEST_CB_RSA_KEYGEN_GET, (void *)&data);

POST 故障测试和日志记录

为了支持多个测试的失败，所有测试将始终运行而不提前退出（只是标记失败），在所有测试完成后，将返回失败状态。

用于日志记录或失败的参数将为：

struct {
    const char *desc;
    const char *state;
    const char *fail_reason;
};

其中：

type 是“post_integrity”、“post_cipher”、“post_digest”、“post_signature”、“post_drbg”等之一；
desc 是标识性名称，例如 AES_128_CBC；
state 是以下之一：

- “start” - 表示测试开始
- “corrupt” - 如果返回值为0，则测试将失败
- “pass” - 表示测试通过
- “fail” - 表示测试失败

fail_reason - 是失败的具体原因（例如，无法读取完整性模块文件或完整性校验和文件）。

CAVS测试

CAVS 测试将由实验室执行。

然而，每个 CAVS 测试文件也可以进行抽样，并添加到单元测试中，这意味着可以将单个测试的文件数据转换为单元测试内的二进制数据。

（DRBG_ctr 是已经实现了此功能的示例）。

这将确保以下内容：

CAVS 测试将可访问所需的接口（某些 CAVS 测试需要访问通常不需要的内部接口）；
算法的正常工作；
覆盖率。

如果与实验室之间有良好的沟通，我们可以跳过此步骤，但如果实验室发现缺少对内部访问器的访问，可能需要在代码中添加一些额外的回调钩子。