第4章 wolfSSL 软件开发流程与质量保障
质量保障
wolfSSL 软件开发流程与质量保障
wolfSSL 生态由多个软件模块和组件构成,各有各的目标和用途。
wolfCrypt 加密引擎是一个轻量级加密库,提供一套完整且持续更新的主流算法,也包括 ChaCha20、Curve25519、Poly1305、后量子密码学和 SHA-3 等前沿算法。wolfCrypt 可用于安全地存储静态数据,并被 wolfSSL Inc. 的大多数产品所依赖。
wolfSSL 嵌入式 TLS 库支持最新的标准规范。该库利用 wolfCrypt 提供的算法,实现安全通信协议和相关机制,保障传输中的数据安全。
wolfMQTT 是一个 MQTT 客户端库,默认通过 TLS 安全会话使用安全 MQTT。
wolfSSH 是 SSH 2.0 协议的客户端与服务器实现库,专为资源最受限的嵌入式设备设计,同时提供完整的协议支持(包括 SFTP、SCP)以及公钥和/或密码认证。
wolfBoot 是一个安全引导加载程序,遵循开放标准设计,用于 IoT 系统的安全远程固件更新。
wolfTPM 是一个用于访问 TPM 2.0 安全加密设备功能的库。
wolfSentry 是一个面向资源受限的小型嵌入式系统设计的入侵检测与防御系统。
wolfHSM 是一个可移植的开源平台,将 wolfCrypt 引擎与 Infineon Aurix Tricore TC3XX 等硬件 HSM 集成,以最大化安全性和性能。它支持 SM2、SM3、SM4 以及 ML-KEM、LMS、XMSS 等后量子算法,为汽车应用优化加密处理。
我们的所有软件产品均按照流程所要求的质量标准进行工程化开发,本文档对此流程作了简要概述。
软件生命周期中的每一步都受到严格规则和测试标准的约束(包括严苛的模糊测试),以确保尽早发现代码中的缺陷和回归。
立即下载 获取最新的开源 GPLv3 版本!
软件工程流程概览
从软件工程的角度看,wolfSSL 软件组件的设计与开发生命周期分为三个步骤:
1. 软件需求与规范的识别与分析 2. 以 API 为导向的软件设计 3. 软件模块开发
每一步都通过一套专门的质量控制程序加以验证,包括:
- 单元测试与定期覆盖率分析 - API 一致性测试 - 在多种架构/编译器、多种用例及编译期配置选项组合下的集成测试 - 与其他实现之间的互操作性测试 - 算法与模块的形式化验证 - 模糊测试
为了提升代码安全性、及时发现潜在缺陷或异常行为,软件模块还会定期接受额外的质量控制,尤其是静态分析工具、动态内存诊断工具、fuzzer 等,而且新工具也在不断加入。
以 GPL 许可证发布源代码,并在 GitHub 平台上公开整个开发流程,意味着成百上千的用户、贡献者和关注该项目的用户能够实时了解代码的每一次变更以及代码评审中产生的讨论。企业安全机构、网络安全合作伙伴和学术研究者通过持续研究新漏洞、深入挖掘编写代码时不易察觉的潜在攻击面,做出了非常宝贵的贡献。wolfSSL Inc. 高度重视漏洞管理,针对紧急修复和快速发版制定了精确详细的检查清单。
由于相关规范不断演变,软件设计流程必须足够灵活,以便适应算法实现、使用建议以及安全协议与机制实现指南的更新。
NIST 通过"特别出版物"(SP)发布规范和指南。作为 NIST 的一部分,国家网络安全卓越中心(NCCoE)通过与行业组织、政府机构和学术机构的协作开展工作。与 IETF 出版物类似,NIST 的做法是频繁发布对早期出版物的更新和修正,以保持指南的时效性。NIST 内部指南的更新流程由"NIST 密码标准与指南开发流程"(NIST.IR.7977)规范。wolfCrypt 中的加密功能遵循 NIST 关于算法及其实现流程的最新规范。如后文所述,NIST 出版物和软件工具在算法与模块验证阶段发挥着重要作用。
wolfMQTT 基于 OASIS 提供的规范实现,最初涵盖 2015 年 12 月获批的 MQTT 3.1.1 版本。此后 wolfMQTT 不断演进,以支持 2019 年 3 月获批为最新 MQTT 标准的 OASIS MQTT 5.0 版本规范。
软件需求与规范
加密、安全通信协议和安全固件更新机制的实现指南由开放标准描述,这些标准由多家组织维护和编写。wolfSSL 软件项目的规范文档来自三大组织:
- IETF(互联网工程任务组):一个由工程师组成的大型开放国际社区,负责发布和更新互联网协议栈的文档,如今也包括安全通信协议以及密码套件中使用的算法 - NIST(美国国家标准与技术研究院):提供流程、模块和算法指南,其密码学实践在全球范围内被公认为最佳实践 - OASIS(结构化信息标准促进组织):一个全球性非营利联盟,致力于 IoT 和数据交换开放标准的开发
IETF 以"征求意见稿"(RFC)的形式发布新规范。每份 RFC 都有独立编号,需经过同行评审(通常要经历多个草案阶段)后才能发布。RFC 一旦获得唯一编号就永远不会被修改。要更新已发布在某个 RFC 中的标准,可以发布新的 RFC,其中可包含修正、勘误或对先前已发布 RFC 的替换。较新的 RFC 可以使较旧的 RFC 过时或被弃用。RFC 涵盖了 wolfSSL 大部分通信模块的规范,例如 TLS 协议标准(RFC8446)、DTLS(RFC6347)、TLS 扩展(RFC6066)等。wolfCrypt 库根据所支持的算法遵循相应加密原语的实现建议,例如 RSA 公钥加密(RFC8017)、用于 AEAD 的 ChaCha20/Poly1305(RFC8439)等等。wolfSSH 依据 RFC4250-RFC4254 系列规范设计和开发,该系列将 SSH-2 记录为提议的互联网标准。wolfBoot 最初依照 draft-ietf-suit-architecture 指南设计和开发,该草案后来成为 RFC9019。
软件设计
wolfSSL 开发的大多数软件组件都是结构化库的形式,采用以 API 为导向的设计。函数一旦成为 API 的一部分,其签名、用途和返回值的含义就永远不会改变,这保证了库在不同版本间的兼容性。如果要在现有功能上增加特性,会创建新的 API 函数,接受不同的参数或扩展特定接口。所有 API 函数调用都在模块用户手册中正式记录。
设计阶段最重要的考虑之一,是错误码在 API 各层之间的正确含义、传递和验证。每个错误码都有唯一且明确定义的含义,并在手册中说明。这便于使用该库的应用程序识别运行时错误。
由于加密和安全协议相关规范具有动态变化的特性,设计流程也必须随之调整。新规范会被分析并融入现有模块架构,同时保持现有 API 函数签名长期不变,确保不破坏现有功能。
软件开发与可追溯性
wolfSSL 的所有软件均遵循持续集成实践,通过集中的 git 主线仓库进行开发和维护。所有源代码在开发过程中随时公开可查,采用 GPL 许可证。
wolfSSL 生态中软件组件的生命周期不同于典型的开源开发流程,其设计符合修正条件判定覆盖(MC/DC)流程的要求。wolfSSL 拥有并维护整个代码库,这意味着对主线的变更和更新有严格的规则约束。仓库的修改仅允许 wolfSSL 工程师进行,且任何变更合并到 master 分支之前都必须遵守严格的同行评审政策。
要向 wolfSSL 仓库贡献代码,开发者必须通过 GitHub 提交"pull request"。该请求随后由一名或多名 wolfSSL 工程师评审(取决于补丁的规模、影响和性质)。评审通常会要求与设计文档的目标对齐、修改代码、重新适配和改进,之后代码才会被接受合并。只有经过批准的贡献者才能提交代码进行评审。wolfSSL 工程团队之外的贡献者必须事先获得批准,其代码才会被考虑纳入。
质量保障
代码功能的第一道验证在贡献者的开发机上本地完成。Git 的 commit 和 push 钩子确保代码只有通过第一轮功能和单元测试才能提交。pull request 发布后,会自动启动完整的回归和集成测试,测试结果会更新该 pull request 的状态。pull request 要被接受合并,必须通过同行评审以及回归和集成测试。在评审过程中,每次修改 pull request 的代码,测试都会自动重新触发。想更深入了解我们的测试和评审流程,请参阅 Overview of Testing in wolfSSL。
质量控制自动化
wolfSSL 部署了一套混合(本地 + 云端)基础设施,使用 Jenkins 协调节点之间的工作负载,定期执行质量控制。这包括每次评估贡献是否纳入主线时运行的软件测试,以及定期执行的其他质量控制(如每晚、每周)。
采用混合方案的原因在于 wolfSSL 软件生态的可移植性。软件必须运行在多种不同的硬件架构上,并与特定硬件组件(如硬件加密模块和 TPM)互操作。部分 Jenkins 节点使用物理机器,提供了配置和控制特定硬件目标的机制,包括可自动配置和编程的微控制器开发板。
有些测试需要长时间运行。持续集成工具非常适合将质量控制任务分散到较长的时间段内执行,确保每项测试都能定期进行。
算法与模块的形式化验证
为了验证实现的正确性和对标准的遵循,wolfSSL 软件组件使用 NIST 推荐的工具和流程进行测试,包括使用一组已知输入值(测试向量)和预期结果进行的全套功能测试。许多加密算法的正确性还可以通过检查计算的中间结果来验证。
NIST 还发布了一系列出版物(FIPS 140),协调联邦政府部门和机构使用的加密模块的要求和标准。通过美国和加拿大各地专业认可实验室的努力,有两个验证程序可用于认证是否符合 FIPS 140 法规。wolfCrypt 已通过 FIPS 140-3 验证。FIPS 认证要求加密模块通过两个程序完成验证:
- 加密算法验证程序(CAVP):对已实现的获准加密算法提供验证测试 - 加密模块验证程序(CMVP):认证该模块可供政府及受监管行业用于保护敏感数据和信息
CAVP/CMVP 中使用的同类测试会在主线上自动重复执行,确保代码修改不会影响 FIPS 140 所规定的算法和模块的完整性。
互操作性测试
验证协议行为在持续集成过程中保持一致的一个非常有效的方法,是与同一标准的不同实现进行互操作性测试。wolfSSL 质量控制基础设施提供了大量计划任务,使用其他实现作为通信的远端端点,并从共同的向量出发比较加密操作的结果。
单元测试
所有核心模块都必须进行单元测试,开发者在提交新代码时会在本机运行。
单元测试覆盖率每周统计一次,以确保新增功能不会造成覆盖率回归。借助 Jenkins 持续集成基础设施的自动化能力,wolfSSL 开发者每周都会在邮箱中收到完整的代码覆盖率报告。
API 一致性验证
有一组专门的测试用于验证实现变更不会改变应用开发视角下的 API 用法。这些测试从不更新,唯一的例外是向 API 添加新函数。API 必须在各版本间保持一致,因为它是应用程序与库之间的契约。每晚运行的一组测试就是为了验证这些方面的遵循情况。
集成测试
由于 wolfSSL 的可移植性,有必要扩展测试范围,加入自定义配置,即针对不同架构、不同编译期配置选项组合和测试应用程序编译软件。真实机器和虚拟机都用作运行测试套件的目标。在 x86、ARM、PowerPC、RISC-V、MIPS 等不同架构上自动化测试,可以确保架构相关的回归或缺陷在流程早期就能被发现和定位,预期行为在所有情况下保持一致。得益于持续集成基础设施的混合模式,多个目标连接到 Jenkins 节点,负责在各种特定的硬件和软件配置及用例下运行软件测试。
安全性评估:深入探查
持续集成基础设施还自动化了多种分析工具的运行。
静态分析工具通过探索编译期选项的所有不同组合并遍历不同代码路径,寻找代码中的任何不一致。这类工具通过在源码层面进行严格检查,能够检测编译器可能无法覆盖的各类编程错误、潜在缺陷和语言层面的未定义行为。wolfSSL 在 CI 中使用并自动化的工具包括 cppcheck、clang static analyzer(scan-build)、Facebook infer 等。
内存分析定期进行,以查找与内存处理相关的缺陷。wolfSSL 使用 valgrind memcheck 工具、clang sanitizer 等动态分析手段运行代码。这些工具能检测出诸如访问未初始化或已释放内存、使用未定义或未初始化的值、内存泄漏等内存错误。
Fuzzer 是提升代码应对意外情况鲁棒性的重要手段。这类工具的目标是通过快速注入大量随机输入来引发代码故障。模糊测试往往是发现代码中长期潜伏的缺陷和漏洞的非常有效的方式。wolfSSL 持续运行 fuzzer 来喂入 API 函数和传输后端,并定期轮换控制输出变异的 PRNG 的所有可能种子值。采用变异模糊测试时,某个种子值触发的缺陷可以通过手动以相同种子值重新运行同一测试来复现,便于通过分析工具和调试器轻松复现和分析。由于这类工具必须了解应用领域、协议结构和数据特征,wolfSSL 使用了两个为此专门编写的 fuzzer。WolfFuzz 在内存缓冲区上运行,对内部加密操作进行模糊测试。这种机制使模糊测试速度非常快,全部 4 万亿个 PRNG 种子可在三个月内测试完毕。另一个工具 wolfSSL Network Fuzzer 在 TCP/IP 上运行,因此速度慢得多,但在测试保障传输中数据安全的代码方面更加灵活。
漏洞管理
wolfSSL 高度重视漏洞问题,承诺在漏洞披露后 36 小时内发布新版本软件。这确保了在负责任披露的情况下,漏洞会在细节或概念验证复现方法公开之前就得到修复。
漏洞报告会触发应急程序,即一套必须完成的标准操作流程(S.O.P.),用于加快问题解决和新版本发布。漏洞报告会在最初 120 分钟内完成核实。在此阶段会创建一份文档,分发给内部工程团队,记录问题及所有可用工具,并附上复现说明,以便确认错误并评估修复方案是否完全解决了问题。修复工作可能需要几分钟到 24 小时不等,取决于问题的复杂程度。修复完成后,以内部补丁或公开 pull request 的形式提交——如果确定修复不会向监视 wolfSSL git 仓库的潜在攻击者泄露关键信息,则采用后者。补丁或公开 PR 随后由多名工程师评审,代码变更仍需通过人工代码评审和测试程序的双重验证。经过几轮评审迭代后,自动化集成服务器通过运行所有必要的发布前测试来验证修复。验证结束时,如果所有测试通过,就会发布新版本,并通过所有可用的沟通渠道通知所有用户和客户。
如有关于 wolfSSL 嵌入式 SSL/TLS 库的问题,或想在您的项目中使用 wolfSSL,请联系 facts@wolfssl.com!wolfSSL 支持 TLS 1.3、FIPS 140-2/3、DO-178 等更多标准!