README

这是一个用于PHP中用密钥或密码加密数据的库。它需要PHP 5.4或更高版本。当前版本是v2.0.0，预计其作者将至少到2019年1月1日提供稳定支持和安全修复。

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

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

依赖项

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

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

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

如果您遇到困难，请查看常见问题解答中的答案。那里解释了解决最常见问题的解决方案。

如果您是密码学家并且想了解此库的工作细节，请查看密码学详情文档。

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

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

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

此代码尚未经过正式的、付费的安全审计。然而，它已经得到了PHP安全社区成员的大量审查，并且作者在密码学方面有经验。很可能会让您比几乎任何其他PHP加密库更安全。

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

用于签名发布的GnuPG公钥可在dist/signingkey.asc中找到。其指纹是

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

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