## 概述
Sodium crypto library是一个现代化的，易于使用的软件库，用于加密，解密，签名，密码散列等。
Sodium 出现的目的也是为了代替 Mcrypt 这个原来的加密扩展。在 PHP7.2 之后，Mcrypt 已经被移除，在 PHP7.1 时就已经被标记为过时。不过，Sodium 扩展的应用也并不是很多，大部分情况下我们都会使用 OpenSSL 来进行加密操作，同时，Sodium 扩展提供的函数也非常多
Sodium 扩展在 PHP7.2 后是跟随 PHP 源码一起发布的，只需要在编译的时候加上`--with-sodium`即可安装成功。如果是 PHP7.2 之前的版本，需要单独安装这个扩展。同时，操作系统中也需要安装 `libsodium-devel` 库
## 安装
```
sudo pecl install -f libsodium
```
以下表示安装成功
```
Build process completed successfully
Installing '/usr/local/php-7.4/lib/php/extensions/no-debug-non-zts-20190902/sodium.so'
install ok: channel://pecl.php.net/libsodium-2.0.23
configuration option "php_ini" is not set to php.ini location
You should add "extension=sodium.so" to php.ini
```
安装错误
```
checking for libsodium... configure: error: Please install libsodium - See https://github.com/jedisct1/libsodium
ERROR: `/tmp/pear/temp/libsodium/configure --with-php-config=/usr/local/php-7.4/bin/php-config' failed
```
请安装扩展系统扩展库`libsodium-dev`
```
sudo apt install libsodium-dev
Reading package lists... Done
Building dependency tree
Reading state information... Done
The following NEW packages will be installed:
libsodium-dev
0 upgraded, 1 newly installed, 0 to remove and 254 not upgraded.
Need to get 160 kB of archives.
After this operation, 760 kB of additional disk space will be used.
Get:1 http://mirrors.cloud.aliyuncs.com/ubuntu bionic/main amd64 libsodium-dev amd64 1.0.16-2 [160 kB]
Fetched 160 kB in 0s (1,514 kB/s)
Selecting previously unselected package libsodium-dev:amd64.
(Reading database ... 161808 files and directories currently installed.)
Preparing to unpack .../libsodium-dev_1.0.16-2_amd64.deb ...
Unpacking libsodium-dev:amd64 (1.0.16-2) ...
Setting up libsodium-dev:amd64 (1.0.16-2) ...
```
修改`php.ini`
```
extension=sodium.so
```
查看模块
```
php -m |grep sodium
sodium
```
## 简单使用
**加密**
```
<?php
/**
* @desc libsodium
* @author Tinywan(ShaoBo Wan)
* @date 2024/8/14 22:45
*/
require '../vendor/autoload.php';
$secretKey = sodium_crypto_secretbox_keygen();
$message = 'Sensitive 开源技术小栈';
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$encryptedMessage = sodium_crypto_secretbox($message, $nonce, $secretKey);
var_dump($encryptedMessage);
```
输出
```
string(44) "�̥|}3�¢ҥ[zm n\ƮV½¯C"
```
**解密**
```
$decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $secretKey);
var_dump($decryptedMessage);
```
输出
```
string(28) "Sensitive 开源技术小栈"
```
## 随机数据
在使用密码学时，经常需要随机字节或整数用于各种目的（加密密钥，随机数等）。具体来说，您需要使用密码学安全随机数生成器（CSPRNG）.一个通用的随机数生成器是不够的。
### 随机字节
如果你需要一个由随机字节组成的字符串，你可以使用`\Sodium\randombytes_buf()`。
```
$string = \Sodium\randombytes_buf($num_bytes);
```
如果将`$num_bytes`设置为32，则`$string`将是一个32字节的字符串，每个字节将是0到255之间的随机值的字符表示。
### 随机整数
如果你需要一个在0和一个特定上限之间的均匀分布的随机整数，你可以使用`\Sodium\randombytes_uniform（）`。
例如，如果您需要一个介于1和100之间的数字：
```
$int = \Sodium\randombytes_uniform(100) + 1;
```
请注意，在上面的例子中，`$int`的可能值范围从1到100，因为`\Sodium\randombytes_uniform`将返回0到99之间的随机整数。100**不**包括在`\Sodium\randombytes_uniform（100）`的可能输出值中。
### 随机16位整数
返回一个介于0和65535（含）之间的整数，服从均匀分布。
```
$tcp_port = \Sodium\randombytes_random16();
```
## 对称加密算法 AEAD_AES_256_GCM
对数据进行 AES-256-GCM 加密和解密。可以使用 `openssl` 和 `sodium` 扩展来实现加密，它们都支持 `AES-256-GCM` 算法，下面将给出两种扩展的代码示例。
微信支付最新的 V3 版本接口，微信返回的报文中，如果涉及敏感信息，是需要基于 AEAD_AES_256_GCM 进行解密的。在官方文档中，也提供了 PHP 对应的解密方式，其中使用的就是 Sodium 扩展库中的函数。
如何解密证书和回调报文：https://pay.weixin.qq.com/docs/merchant/development/interface-rules/certificate-callback-decryption.html#_2-%E8%A7%A3%E5%AF%86
### Sodium 扩展实现
```php
<?php
/**
* @desc 对称加密算法 AES-256-GCM 代码示例
* @author Tinywan(ShaoBo Wan)
* @date 2024/8/14 9:15
*/
declare(strict_types=1);
/**
* @desc 加密
* @param string $data
* @param string $keygen
* @param string $aad
* @return array
* @throws SodiumException
* @throws \Random\RandomException
* @author Tinywan(ShaoBo Wan)
*/
function aes256gcm_encrypt(string $data, string $keygen, string $aad = ''): array
{
$iv = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES);
$encrypt = sodium_crypto_aead_aes256gcm_encrypt($data, $aad, $iv, $keygen);
return [
'iv' => sodium_bin2base64($iv, SODIUM_BASE64_VARIANT_ORIGINAL),
'aad' => sodium_bin2base64($aad, SODIUM_BASE64_VARIANT_ORIGINAL),
'cipher_text' => sodium_bin2base64($encrypt, SODIUM_BASE64_VARIANT_ORIGINAL),
];
}
/**
* @desc 解密
* @param array $secretData
* @param string $keygen
* @return false|string
* @throws SodiumException
* @author Tinywan(ShaoBo Wan)
*/
function aes256gcm_decrypt(array $secretData, string $keygen)
{
$iv = sodium_base642bin($secretData['iv'], SODIUM_BASE64_VARIANT_ORIGINAL);
$aad = sodium_base642bin($secretData['aad'], SODIUM_BASE64_VARIANT_ORIGINAL);
$cipherText = sodium_base642bin($secretData['cipher_text'], SODIUM_BASE64_VARIANT_ORIGINAL);
return sodium_crypto_aead_aes256gcm_decrypt($cipherText, $aad, $iv, $keygen);
}
/**
* @desc 主函数
* @return void
* @throws SodiumException
* @throws \Random\RandomException
* @author Tinywan(ShaoBo Wan)
*/
function main()
{
if (!sodium_crypto_aead_aes256gcm_is_available()) {
exit('Not support AES-256-GCM');
}
// 生成AES-256-GCM的密钥
$keygen = sodium_crypto_aead_aes256gcm_keygen();
// 加密原文内容
$data = '开源技术小栈';
$secretData = aes256gcm_encrypt($data, $keygen, 'tinywan');
// 解密
$plainText = aes256gcm_decrypt($secretData, $keygen);
echo '[x] 加密原文：' .$data.PHP_EOL;
echo '[x] 密文数据：' . json_encode($secretData) .PHP_EOL;
echo '[x] 解密原文：' .$plainText.PHP_EOL;
}
main();
```
执行结果
```ts
[x] 加密原文：开源技术小栈
[x] 密文数据：{"iv":"KGMwg3PKlihp46qo","aad":"dGlueXdhbg==","cipher_text":"6oRb78FP33byDBhlBc0g6e7DYH0k3Oiethup+4YeWPN4Xw=="}
[x] 解密原文：开源技术小栈
```
### Openssl扩展实现
```php
<?php
/**
* @desc openssl.php
* @author Tinywan(ShaoBo Wan)
* @date 2024/8/14 9:22
*/
declare(strict_types=1);
/**
* @desc 加密
* @param string $data
* @param string $keygen
* @param string $aad
* @return array
* @throws \Random\RandomException
* @author Tinywan(ShaoBo Wan)
*/
function aes256gcm_encrypt(string $data, string $keygen, string $aad = ''): array
{
$cipher = 'aes-256-gcm';
$ivLen = openssl_cipher_iv_length($cipher);
$iv = random_bytes($ivLen);
$encrypt = openssl_encrypt($data, $cipher, $keygen, OPENSSL_RAW_DATA, $iv, $tag, $aad);
return [
'iv' => base64_encode($iv),
'tag' => base64_encode($tag),
'aad' => base64_encode($aad),
'cipher_text' => base64_encode($encrypt),
];
}
/**
* @desc 解密
* @param array $secretData
* @param string $keygen
* @return false|string
* @author Tinywan(ShaoBo Wan)
*/
function aes256gcm_decrypt(array $secretData, string $keygen)
{
$iv = base64_decode($secretData['iv']);
$tag = base64_decode($secretData['tag']);
$aad = base64_decode($secretData['aad']);
$cipherText = base64_decode($secretData['cipher_text']);
$cipher = 'aes-256-gcm';
return openssl_decrypt($cipherText, $cipher, $keygen, OPENSSL_RAW_DATA, $iv, $tag, $aad);
}
/**
* @desc 主函数
* @return void
* @throws SodiumException
* @throws \Random\RandomException
* @author Tinywan(ShaoBo Wan)
*/
function main()
{
// AES-256-GCM需要32字节的密钥
$keygen = bin2hex(random_bytes(16));
// 加密
$data = '开源技术小栈';
$secretData = aes256gcm_encrypt($data, $keygen, 'tinywan');
// 解密
$plainText = aes256gcm_decrypt($secretData, $keygen);
echo '[x] 加密原文：' . $data . PHP_EOL;
echo '[x] 密文数据：' . json_encode($secretData) . PHP_EOL;
echo '[x] 解密原文：' . $plainText . PHP_EOL;
}
main();
```
执行结果
```ts
[x] 加密原文：开源技术小栈
[x] 密文数据：{"iv":"CUit1bBOIOOM4Oaa","tag":"hlyP0MpykCNekBd1Kkobdw==","aad":"dGlueXdhbg==","cipher_text":"ToKc2+rVh8udQa\/bUtKodoC+"}
[x] 解密原文：开源技术小栈
```
### AAD参数（Additional Authenticated Data）
在上面的代码示例中，可以看到在加密的时候有一个`$aad`参数，如果在加密的时候使用了这个参数，那么在解密时也需要使用同样的AAD值才能成功解密。
> 什么时候会需要用到AAD呢？
用户`Tinywan`在微信公众号上写了一篇私密文章，微信公众号使用 `AES-256-GCM` 加密了这篇文章，然后存储到了数据库里，`AAD`的取值是`Tinywan`的用户`ID`。
后续如果`Tinywan`去查看这篇文章，微信公众号会使用`Tinywan`的用户`ID（AAD值）`去解密，因为解密的`AAD`值与加密的`AAD`值相同，所以可以成功解密。
然后有一个黑客`ShaoBoWan`，他也向微信公众号发出解密这篇文章的请求，微信公众号就会使用`ShaoBoWan`的用户`ID`作为`AAD`去解密这篇文章，但因为`AAD`值错误，肯定是解密不了的，所以这时候`AAD`的作用就体现了出来。
## 其他
https://paragonie.com/book/pecl-libsodium
https://cloud.tencent.com/developer/information/%E5%9C%A8PHP%E5%87%BD%E6%95%B0%E4%B8%AD%E4%BD%BF%E7%94%A8Sodium%E5%BA%93-article
https://paragonie.com/book/pecl-libsodium/read/00-intro.md#what-is-libsodium
- 设计模式系列
- 工厂方法模式
- 序言
- Windows程序注册为服务的工具WinSW
- 基础
- 安装
- 开发规范
- 目录结构
- 配置
- 快速入门
- 架构
- 请求流程
- 架构总览
- URL访问
- 容器和依赖注入
- 中间件
- 事件
- 代码层结构
- 四个层次
- 路由
- 控制器
- 请求
- 响应
- 数据库
- MySQL实时同步数据到ES解决方案
- 阿里云DTS数据MySQL同步至Elasticsearch实战
- PHP中的MySQL连接池
- PHP异步非阻塞MySQL客户端连接池
- 模型
- 视图
- 注解
- @SpringBootApplication(exclude={DataSourceAutoConfiguration.calss})
- @EnableFeignClients(basePackages = "com.wotu.feign")
- @EnableAspectJAutoProxy
- @EnableDiscoveryClient
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 验证
- 验证器
- 验证规则
- 扩展库
- 附录
- Spring框架知识体系详解
- Maven
- Maven和Composer
- 构建Maven项目
- 实操课程
- 01.初识SpringBoot
- 第1章 Java Web发展史与学习Java的方法
- 第2章 环境与常见问题踩坑
- 第3章 springboot的路由与控制器
- 02.Java编程思想深度理论知识
- 第1章 Java编程思想总体
- 第2章 英雄联盟的小案例理解Java中最为抽象的概念
- 第3章 彻底理解IOC、DI与DIP
- 03.Spring与SpringBoot理论篇
- 第1章 Spring与SpringBoot导学
- 第2章 Spring IOC的核心机制：实例化与注入
- 第3章 SpringBoot基本配置原理
- 04.SprinBoot的条件注解与配置
- 第1章 conditonal 条件注解
- 第2章 SpringBoot自动装配解析
- 05.Java异常深度剖析
- 第1章 Java异常分类剖析与自定义异常
- 第2章 自动配置Url前缀
- 06.参数校验机制与LomBok工具集的使用
- 第1章 LomBok工具集的使用
- 第2章 参数校验机制以及自定义校验
- 07.项目分层设计与JPA技术
- 第1章 项目分层原则与层与层的松耦合原则
- 第2章 数据库设计、实体关系与查询方案探讨
- 第3章 JPA的关联关系与规则查询
- 08.ORM的概念与思维
- 第1章 ORM的概念与思维
- 第2章 Banner等相关业务
- 第3章 再谈数据库设计技巧与VO层对象的技巧
- 09.JPA的多种查询规则
- 第1章 DozerBeanMapper的使用
- 第2章 详解SKU的规格设计
- 第3章 通用泛型Converter
- 10.令牌与权限
- 第1章 通用泛型类与java泛型的思考
- 常见问题
- 微服务
- demo
- PHP中Self、Static和parent的区别
- Swoole-Cli
- 为什么要使用现代化PHP框架？
- 公众号
- 一键部署微信公众号Markdown编辑器（支持适配和主题设计）
- Autodesigner 2.0发布
- Luya 一个现代化PHP开发框架
- PHPZip - 创建、读取和管理 ZIP 文件的简单库
- 吊打Golang的PHP界天花板webman压测对比
- 简洁而强大的 YAML 解析库
- 推荐一个革命性的PHP测试框架：Kahlan
- ServBay下一代Web开发环境
- 基于Websocket和Canvas实现多人协作实时共享白板
- Apipost预执行脚本如何调用外部PHP语言
- 认证和授权的安全令牌 Bearer Token
- Laradock PHP 的 Docker 完整本地开发环境
- 高效接口防抖策略，确保数据安全，避免重复提交的终极解决方案！
- TIOBE 6月榜单：PHP稳步前行，编程语言生态的微妙变化
- Aho-Corasick字符串匹配算法的实现
- Redis键空间通知 Keyspace Notification 事件订阅
- ServBay如何启用并运行Webman项目
- 使用mpdf实现导出pdf文件功能
- Medoo 轻量级PHP数据库框架
- 在PHP中编写和运行单元测试
- 9 PHP运行时基准性能测试
- QR码生成器在PHP中的源代码
- 使用Gogs极易搭建的自助Git服务
- Gitea
- webman如何记录SQL到日志？
- Sentry PHP: 实时监测并处理PHP应用程序中的错误
- Swoole v6 Alpha 版本已发布
- Proxypin
- Rust实现的Redis内存数据库发布
- PHP 8.4.0 Alpha 1 测试版本发布
- 121
- Golang + Vue 开发的开源轻量 Linux 服务器运维管理面板
- 内网穿透 FRP VS Tailscale
- 新一代开源代码托管平台Gitea
- 微服务系列
- Nacos云原生配置中心介绍与使用
- 轻量级的开源高性能事件库libevent
- 国密算法
- 国密算法（商用密码）
- GmSSL 支持国密SM2/SM3/SM4/SM9/SSL 密码工具箱
- GmSSL PHP 使用
- 数据库
- SQLite数据库的Web管理工具
- 阿里巴巴MySQL数据库强制规范
- PHP
- PHP安全测试秘密武器 PHPGGC
- 使用declare（strict_types=1）来获得更健壮的PHP代码
- PHP中的魔术常量
- OSS 直传阿里腾讯示例
- PHP源码编译安装APCu扩展实现数据缓存
- BI性能DuckDB数据管理系统
- 为什么别人可以是架构师！而我却不是？
- 密码还在用 MD5 加盐？不如试试 password_hash
- Elasticsearch 在电商领域的应用与实践
- Cron 定时任务入门
- 如何动态设置定时任务！而不是写死在Linux Crontab
- Elasticsearch的四种查询方式，你知道多少？
- Meilisearch vs Elasticsearch
- OpenSearch vs Elasticsearch
- Emlog 轻量级开源博客及建站系统
- 现代化PHP原生协程引擎 PRipple
- 使用Zephir编写C扩展将PHP源代码编译加密
- 如何将PHP源代码编译加密，同时保证代码能正常的运行
- 为什么选择Zephir给PHP编写动态扩展库？
- 使用 PHP + XlsWriter实现百万级数据导入导出
- Rust编写PHP扩展
- 阿里云盘开放平台对接进行文件同步
- 如何构建自己的PHP静态可执行文件
- IM后端架构
- RESTful设计方法和规范
- PHP编译器BPC 7.3 发布,成功编译ThinkPHP8
- 高性能的配置管理扩展 Yaconf
- PHP实现雪花算法库 Snowflake
- PHP官方现代化核心加密库Sodium
- pie
- 现代化、精简、非阻塞PHP标准库PSL
- PHP泛型和集合
- 手把手教你正确使用 Composer包管理
- JWT双令牌认证实现无感Token自动续期
- 最先进PHP大模型深度学习库TransformersPHP
- PHP如何启用 FFI 扩展
- PHP超集语言PXP
- 低延迟双向实时事件通信 Socket.IO
- PHP OOP中的继承和多态
- 强大的现代PHP高级调试工具Kint
- PHP基金会
- 基于webman+vue3高质量中后台框架SaiAdmin
- 开源免费的定时任务管理系统：Gocron
- 简单强大OCR工具EasyOCR在PHP中使用
- PHP代码抽象语法树工具PHP AST Viewer
- MySQL数据库管理工具PHPMyAdmin
- Rust编写的一款高性能多人代码编辑器Zed
- 超高性能PHP框架Workerman v5.0.0-beta.8 发布
- 高并发系列
- 入门介绍及安装
- Lua脚本开发 Hello World
- 执行流程与阶段详解
- Nginx Lua API 接口开发
- Lua模块开发
- OpenResty 高性能的正式原因
- 记一次查找 lua-resty-mysql 库 insert_id 的 bug
- 包管理工具OPM和LuaRocks使用
- 异步非阻塞HTTP客户端库 lua-resty-http
- Nginx 内置绑定变量
- Redis协程网络库 lua-resty-redis
- 动态HTML渲染库 lua-testy-template
- 单独的
- StackBlitz在线开发环境
- AI
- 基础概念
- 12312
- 基础镜像的坑
- 利用phpy实现 PHP 编写 Vision Transformer (ViT) 模型
- 语义化版本 2.0.0