README

composer require defuse/php-encryption

这是一个用于在PHP中使用密钥或密码加密数据的库。 它需要PHP 5.6或更高版本以及OpenSSL 1.0.1或更高版本。 我们建议使用仍然具有安全支持的PHP版本，即撰写本文时为PHP 8.0或更高版本。使用此库与不支持PHP版本可能导致安全漏洞。

php-encryption的当前版本是v2.4.0。该库预计将保持稳定，并至少到2024年1月1日，作者将继续提供安全更新和错误修复。

该库是Taylor Hornby和Scott Arciszewski以及众多开源贡献者共同努力的成果。

与其他PHP加密库相比，该库的特点是首先，它是安全的。作者们以前每天都会遇到不安全的PHP加密代码，因此他们创建了此库，以向生态系统带来更多安全性。其次，此库“不易误用”。像libsodium一样，其API设计易于以安全方式使用，难以在不安全的方式中使用。

依赖关系

此库不需要除PHP 5.6或更高版本以及启用了OpenSSL扩展（版本1.0.1或更高）之外的特殊依赖项（这是默认设置）。它使用random_compat，该库包含在此库中，因此您的用户无需遵循任何特殊安装步骤。

从教程开始。您可以在安装和验证文档中找到获取此库代码的安全说明。

阅读教程并获取代码后，请参阅此库提供的每个类的正式文档

如果您遇到困难，请参阅常见问题解答。那里解释了最常见的故障的修复方法。

如果您是密码学家并想了解此库的工作细节，请参阅密码学详细信息文档。

如果您想为此库做出贡献，请参阅内部开发者文档。

此库旨在用于需要加密静态数据的PHP服务器端软件。如果您正在构建需要加密客户端的软件，或构建需要跨平台加密/解密支持的系统，我们强烈建议使用libsodium。

如果文档不足以让您了解如何使用此库，那么您可以查看使用此库的示例项目

此代码尚未经过正式的付费安全审计。然而，它已经得到了PHP安全社区成员的大量审查，并且作者在密码学方面有丰富的经验。几乎可以肯定，使用这个库比使用其他任何PHP加密库都要安全。

如果您将此库作为您的商业项目的一部分，并希望资助一次正式审计，请联系Taylor Hornby。

用于签名当前和新版本的GnuPG公钥可在dist/signingkey-new.asc中找到。其指纹为

6DD6 E677 0281 5846 FC85  25A3 DD2E 507F 7BDB 1669

您可以通过Taylor Hornby的联系方式页面和twitter进行验证。

较旧版本使用（现已过期）的公钥在dist/signingkey-old.asc中签名。旧公钥的指纹为

2FA6 1D8D 99B9 2658 6BAC  3D53 385E E055 A129 1538

旧公钥的指纹可以通过Taylor Hornby的联系方式页面和twitter进行验证。

可用旧公钥对新公钥的签名在dist/signingkey-new.asc.sig中。