PQCrypto-SIDH 项目使用教程
1. 项目目录结构及介绍
PQCrypto-SIDH 项目的目录结构如下:
PQCrypto-SIDH/
├── KAT/
├── Visual Studio/
├── src/
│ ├── P434_api.h
│ ├── P503_api.h
│ ├── P610_api.h
│ ├── P751_api.h
│ ├── ...
├── tests/
│ ├── aes/
│ ├── rng/
│ ├── PQCtestKAT_kem.c
│ ├── ...
├── Makefile
├── README.md
├── LICENSE
└── ...
目录结构介绍
- KAT/: 包含已知答案测试(Known Answer Test, KAT)文件,用于验证 KEM(Key Encapsulation Mechanism)的正确性。
- Visual Studio/: 包含 Visual Studio 的项目文件,用于在 Windows 环境下编译和运行项目。
- src/: 包含项目的源代码文件,包括主要的 API 头文件(如
P434_api.h等)和实现文件。 - tests/: 包含测试文件,用于测试项目的各个功能模块。
- Makefile: 用于在 Linux 环境下编译项目的 Makefile 文件。
- README.md: 项目的基本介绍和使用说明。
- LICENSE: 项目的开源许可证文件。
2. 项目的启动文件介绍
PQCrypto-SIDH 项目没有明确的“启动文件”,因为它是一个库项目,主要用于实现基于超奇异同源的密码学方案。项目的启动通常是通过编译和链接库文件,然后在应用程序中调用相应的 API 来实现的。
编译和运行
Linux 环境
在 Linux 环境下,可以使用以下命令编译项目:
make
编译完成后,可以运行测试文件来验证库的功能:
./tests/arith_tests-p434
./tests/arith_tests-p503
./tests/arith_tests-p610
./tests/arith_tests-p751
Windows 环境
在 Windows 环境下,可以使用 Visual Studio 打开 Visual Studio/SIDH.sln 解决方案文件,选择相应的平台(x64 或 Win32)和配置(Fast 或 Generic),然后点击“生成解决方案”进行编译。
编译完成后,可以在 tests/ 目录下找到生成的可执行文件,运行这些文件来测试库的功能。
3. 项目的配置文件介绍
PQCrypto-SIDH 项目的主要配置文件是 Makefile 和 Visual Studio 解决方案文件 SIDH.sln。
Makefile
Makefile 文件用于在 Linux 环境下配置和编译项目。它包含以下主要配置选项:
- ARCH: 指定目标架构(如 x64、x86、ARM 等)。
- CC: 指定编译器(如 gcc 或 clang)。
- OPT_LEVEL: 指定优化级别(如 FAST 或 GENERIC)。
- USE_MULX 和 USE_ADX: 指定是否使用特定的 CPU 指令集优化。
示例配置:
make ARCH=x64 CC=gcc OPT_LEVEL=FAST USE_MULX=TRUE USE_ADX=TRUE
Visual Studio 解决方案文件
SIDH.sln 文件用于在 Visual Studio 中配置和编译项目。在 Visual Studio 中打开该文件后,可以选择不同的平台(x64 或 Win32)和配置(Fast 或 Generic)来编译项目。
其他配置
项目还包含一些其他的配置文件,如 src/ 目录下的 API 头文件(如 P434_api.h 等),这些文件定义了库的接口和参数,用户可以根据需要进行配置和调用。
总结
PQCrypto-SIDH 项目是一个高效的基于超奇异同源的密码学库,支持多种平台和架构。通过编译和运行测试文件,用户可以验证库的功能并集成到自己的应用程序中。项目的配置主要通过 Makefile 和 Visual Studio 解决方案文件进行管理。