Libsodium-PHP 开源项目教程

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

Libsodium-PHP 项目的目录结构相对简单，主要包含以下几个部分：

• src/: 该目录包含了所有 PHP 扩展的源代码。

  • libsodium.c: 主文件，包含了扩展的主要实现。
  • php_libsodium.h: 头文件，定义了扩展的接口和结构。
  • crypto_aead.c, crypto_auth.c, crypto_box.c, crypto_generichash.c, crypto_hash.c, crypto_kdf.c, crypto_kx.c, crypto_pwhash.c, crypto_scalarmult.c, crypto_secretbox.c, crypto_shorthash.c, crypto_sign.c, crypto_stream.c, randombytes.c, utils.c, version.c: 这些文件分别实现了不同的加密功能。

• tests/: 该目录包含了测试脚本，用于验证扩展的功能是否正常。

  • basic.phpt, crypto_aead.phpt, crypto_auth.phpt, crypto_box.phpt, crypto_generichash.phpt, crypto_hash.phpt, crypto_kdf.phpt, crypto_kx.phpt, crypto_pwhash.phpt, crypto_scalarmult.phpt, crypto_secretbox.phpt, crypto_shorthash.phpt, crypto_sign.phpt, crypto_stream.phpt, randombytes.phpt, utils.phpt, version.phpt: 这些测试文件分别对应不同的加密功能。

• config.m4: 该文件用于配置扩展的构建过程。

• CREDITS: 该文件列出了项目的贡献者。

• LICENSE: 该文件包含了项目的许可证信息。

• README.md: 该文件提供了项目的概述和基本使用说明。

2. 项目的启动文件介绍

Libsodium-PHP 的启动文件是 src/libsodium.c。这个文件包含了扩展的入口点，负责初始化扩展并注册所有提供的函数。以下是一些关键部分：

• PHP_MINIT_FUNCTION(libsodium): 该函数在 PHP 启动时调用，用于初始化扩展的状态和注册所有函数。

• PHP_MSHUTDOWN_FUNCTION(libsodium): 该函数在 PHP 关闭时调用，用于清理扩展的状态。

• PHP_RINIT_FUNCTION(libsodium): 该函数在每个请求开始时调用，用于初始化请求级别的状态。

• PHP_RSHUTDOWN_FUNCTION(libsodium): 该函数在每个请求结束时调用，用于清理请求级别的状态。

• PHP_MINFO_FUNCTION(libsodium): 该函数在显示 PHP 信息时调用，用于显示扩展的信息。

3. 项目的配置文件介绍

Libsodium-PHP 的配置文件是 config.m4。这个文件用于配置扩展的构建过程，包括检测所需的依赖项、设置编译选项等。以下是一些关键部分：

• PHP_ARG_WITH(libsodium, for libsodium support,: 该部分用于定义构建选项，允许用户指定是否启用 libsodium 支持。

• PHP_CHECK_LIBRARY(sodium, crypto_aead_xchacha20poly1105_ietf_keybytes,: 该部分用于检测 libsodium 库是否存在，并检查其版本是否符合要求。

• PHP_ADD_INCLUDE($LIBSODIUM_DIR/include): 该部分用于添加 libsodium 的头文件路径。

• PHP_ADD_LIBRARY_WITH_PATH(sodium, $LIBSODIUM_DIR/lib, LIBSODIUM_SHARED_LIBADD): 该部分用于添加 libsodium 的库路径。

• **`PHP_NEW_EXTENSION(libsodium, src/libsodium.c src/crypto_aead.c src/crypto_auth.c src/crypto_box.c src/crypto_generichash.c src/crypto_hash.c src/crypto_kdf.c