开源项目 `password-hashing` 使用教程

1. 项目的目录结构及介绍

password-hashing/
├── CMakeLists.txt
├── LICENSE
├── README.md
├── scripts/
│   ├── benchmark.sh
│   ├── build.sh
│   ├── clean.sh
│   ├── test.sh
│   └── valgrind.sh
├── src/
│   ├── argon2.c
│   ├── argon2.h
│   ├── core.c
│   ├── core.h
│   ├── encoding.c
│   ├── encoding.h
│   ├── opt.c
│   ├── opt.h
│   ├── thread.c
│   ├── thread.h
│   ├── timing.c
│   ├── timing.h
│   └── blake2/
│       ├── blake2b.c
│       ├── blake2b.h
│       ├── blake2s.c
│       ├── blake2s.h
│       ├── blake2-impl.h
│       ├── blake2.h
│       ├── genkat-c.c
│       └── kat.h
└── test/
    ├── test.c
    ├── test.h
    ├── test_blake2b.c
    ├── test_blake2s.c
    ├── test_encoding.c
    ├── test_opt.c
    ├── test_threads.c
    └── test_timing.c

目录结构介绍

• CMakeLists.txt: CMake 配置文件，用于构建项目。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• scripts/: 包含一些用于构建、测试和清理项目的脚本。
• src/: 项目的源代码目录，包含 Argon2 密码哈希算法的实现。
  • argon2.c 和 argon2.h: Argon2 算法的主要实现文件。
  • core.c 和 core.h: 核心功能实现文件。
  • encoding.c 和 encoding.h: 编码功能实现文件。
  • opt.c 和 opt.h: 优化功能实现文件。
  • thread.c 和 thread.h: 多线程功能实现文件。
  • timing.c 和 timing.h: 计时功能实现文件。
  • blake2/: Blake2 哈希算法的实现文件。
• test/: 包含测试代码，用于验证项目的正确性。

2. 项目的启动文件介绍

项目的启动文件主要是 src/argon2.c，这是 Argon2 密码哈希算法的主要实现文件。该文件包含了 Argon2 算法的初始化、运行和清理函数。

主要函数介绍

• argon2_hash(): 用于执行 Argon2 哈希操作。
• argon2_verify(): 用于验证给定的密码是否匹配哈希值。
• argon2_error_message(): 用于获取错误信息。

3. 项目的配置文件介绍

项目的配置文件主要是 CMakeLists.txt，这是一个 CMake 配置文件，用于构建和管理项目。

主要配置项介绍

• project(argon2): 定义项目名称。
• add_library(argon2 SHARED src/argon2.c src/core.c src/blake2/blake2b.c ...): 定义生成共享库的源文件。
• add_executable(argon2-test test/test.c): 定义测试可执行文件。
• target_link_libraries(argon2-test argon2): 链接库文件。

通过这些配置项，可以构建出项目的共享库和测试可执行文件。