Open Quantum Safe (liboqs) 项目中的内部API与公共API分离优化方案
2025-07-03 15:09:11作者:平淮齐Percy
在密码学库开发过程中,合理划分内部实现和公共接口是保证软件架构清晰性和安全性的重要实践。Open Quantum Safe项目的liboqs库近期针对这一问题进行了深入讨论和优化。
背景与问题分析
liboqs作为一个提供后量子密码学算法的开源库,其代码结构中包含了一些仅供内部使用的功能实现,如SHA2、SHA3哈希算法和AES加密的实现代码。这些实现虽然被标记为非公共API,但当前构建系统仍会将它们的头文件安装到系统include目录中,这可能导致以下问题:
- 用户可能误用这些非稳定接口
- 增加了不必要的API表面区域
- 可能引发未来的兼容性问题
同时,这些内部实现需要被测试程序访问以验证其正确性,这给构建系统设计带来了挑战。
技术解决方案
项目团队提出了一个优雅的解决方案:创建独立的内部库oqs-internal。该方案具有以下技术特点:
- 模块化分离:将内部实现代码(aes.h、sha2.h、sha3.h等)封装到独立的
oqs-internal库中 - 构建系统优化:通过CMake配置确保内部库仅用于构建过程,不参与安装
- 访问控制:设置适当的可见性属性(default),使测试程序可以链接访问
- 架构扩展性:为未来可能的内部共享代码提供了清晰的扩展路径
实现细节
在技术实现层面,该方案涉及以下关键点:
- CMake配置中明确区分PUBLIC_HEADERS和INTERNAL_HEADERS
- 创建独立的库目标(target)用于内部实现
- 调整测试程序的链接依赖关系
- 确保安装逻辑仅包含真正的公共头文件
优势与收益
这一架构改进带来了多方面好处:
- 接口清晰性:用户只能访问设计为稳定的公共API
- 测试便利性:测试程序仍可方便访问所有必要实现
- 跨平台兼容:特别解决了MacOS上共享库构建时的链接问题
- 维护友好:为未来的代码扩展提供了明确模式
总结
liboqs项目通过引入内部库的架构设计,优雅地解决了密码学库开发中常见的接口边界问题。这种方案不仅解决了当前的具体问题,还为项目未来的发展奠定了良好的架构基础,值得类似项目参考借鉴。这种分离内部实现与公共接口的做法,体现了专业密码学库开发的最佳实践。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0218
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0139
uni-appA cross-platform framework using Vue.jsJavaScript09
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
Ascend Extension for PyTorch
Python
758
968
昇腾LLM分布式训练框架
Python
186
231
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
700
1.4 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
880
2.03 K
暂无描述
Dockerfile
780
5.08 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
70
22
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
2.09 K
218