HACL* 开源项目教程

2024-09-27 01:21:03作者：吴年前Myrtle

1. 项目目录结构及介绍

HACL* 是一个用F*语言编写的现代加密算法库，强调形式化验证。以下是其基本目录结构概述：

- ci                         # 持续集成相关的配置
- docker                     # Docker构建相关
- github                     # GitHub操作配置
- nix                        # Nix构建系统配置
- code                       # 主代码区域
- doc                        # 文档资料
- hints                      # 编译或验证提示文件
- lib                        # 库代码
- obj                        # 编译对象文件（可能是中间产物）
- providers                  # 不同实现提供商的代码，如HACL*、ValeCrypt等
- specs                      # 规范或测试规范
- tests                      # 测试套件
- tools                      # 工具集
- vale                       # Vale相关代码，可能用于高性能密码学组件
- dist                       # 包含编译后的C代码，用于直接集成到C项目中
- drone.yml                 # Drone CI配置
- gitattributes              # Git属性配置
- gitignore                  # 忽略文件列表
- CHANGES.md                 # 更新日志
- CODEOWNERS.md             # 代码所有者文档
- CODE_OF_CONDUCT.md         # 行为准则
- GOVERNANCE.md              # 治理文档
- Hacl.fst                   # F*源码文件，部分加密逻辑定义
- config.json                # 配置文件，可能用于工具或构建过程
- LICENSE                    # 许可证文件，Apache-2.0
- MAINTAINERS.md             # 维护者信息
- Makefile                   # 主Makefile，用于编译和构建
- Makefile.common            # 共享Makefile片段
- Makefile.include           # Makefile包含的公共规则
- Makefile.local             # 局部特定配置
- Makefile.openssl           # 与OpenSSL相关的构建规则
- PULL_REQUEST.md            # 提交PR时的指导文档
- README.md                  # 项目读我文件
- SECURITY.md                # 安全相关信息

每个子目录或文件都服务于项目开发的不同方面，比如dist目录下的是正式产出的C代码，可以直接在生产环境中使用；而tests和spec则是确保代码质量的关键部分。

2. 项目的启动文件介绍

HACL项目本身不涉及传统意义上的“启动文件”，它的运行更多依赖于命令行工具和构建脚本，特别是通过Makefile来编译和验证代码。尽管如此，主要的入口点可以认为是顶级的Makefile，它负责调度不同的构建任务，包括编译Low源代码到C代码、执行测试、以及生成文档等。开发者通常通过运行make命令开始工作流程。

3. 项目的配置文件介绍

Makefile：虽然不是一个传统的配置文件，但它控制着整个构建过程，包括编译选项、目标、依赖关系等。
config.json：在HACL*项目中，这个文件可能存储了某些编译或验证阶段所需的配置信息。
gitignore 和 gitattributes：这两文件分别定义了哪些文件不应被Git版本控制系统跟踪和如何处理特定类型的文件。
CHANGES.md 和 README.md：虽然主要用于文档，但也间接充当配置角色，提供项目变化记录和快速入门指南。
CODEOWNERS, CODE_OF_CONDUCT.md, GOVERNANCE.md: 这些文件定义了项目管理、行为准则和治理模式，对于贡献者而言也是一种“软性”配置。