README

此包允许您轻松生成私钥/公钥对，并使用这些密钥加密/解密消息。

use Justmd5\Crypto\Rsa\KeyPair;
use Justmd5\Crypto\Rsa\PrivateKey;
use Justmd5\Crypto\Rsa\PublicKey;

// generating an RSA key pair
list($privateKey,$publicKey)   = (new KeyPair())->generate();

// when passing paths, the generated keys will be written those paths
(new KeyPair())->generate($pathToPrivateKey, $pathToPublicKey);

$data = 'my secret data';

$privateKey = PrivateKey::fromFile($pathToPrivateKey);
$encryptedData = $privateKey->encrypt($data); // returns something unreadable

$publicKey = PublicKey::fromFile($pathToPublicKey);
$decryptedData = $publicKey->decrypt($encryptedData); // returns 'my secret data'

此包中的大多数函数都是围绕 openssl_* 函数包装的，以提高开发体验。

安装

您可以通过 composer 安装此包

composer require justmd5/crypto

使用方法

您可以使用 KeyPair 类上的 generate 函数生成密钥对。

use Justmd5\Crypto\Rsa\KeyPair;

 list($privateKey,$publicKey)   = (new KeyPair())->generate();

您可以通过将路径传递给 generate 函数将密钥写入磁盘。

// when passing paths, the generate keys will to those paths
(new KeyPair())->generate($pathToPrivateKey, $pathToPublicKey);

您可以使用 password 方法用密码保护私钥

 $generate = (new KeyPair())->password('my-password')->generate();
list(passwordProtectedPrivateKey,$publicKey)   = (new KeyPair())->generate();

在生成私钥时使用密码时，在实例化 PrivateKey 类时需要该密码。

加载密钥

要从一个文件加载密钥，请使用 fromFile 静态方法。

Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey);
Justmd5\Crypto\Rsa\PublicKey::fromFile($pathToPublicKey);

或者，您也可以使用字符串创建密钥对象。

Justmd5\Crypto\Rsa\PrivateKey::fromString($privateKeyString);
Justmd5\Crypto\Rsa\PublicKey::fromString($publicKeyString);

如果私钥受密码保护，您需要将密码作为第二个参数传递。

Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey, $password);
Justmd5\Crypto\Rsa\PrivateKey::fromString($privateKeyString, $password);

如果您未指定正确的密码，将抛出 Justmd5\Crypto\Exceptions\InvalidPrivateKey 异常。

使用私钥加密消息，用公钥解密

以下是使用私钥加密数据和如何使用公钥解密它的方法。

$data = 'my secret data';

$privateKey = Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey);
$encryptedData = $privateKey->encrypt($data); // encrypted data contains something unreadable

$publicKey = Justmd5\Crypto\Rsa\PublicKey::fromFile($pathToPublicKey);
$decryptedData = $publicKey->decrypt($encryptedData); // decrypted data contains 'my secret data'

如果 decrypt 无法解密给定数据（可能是使用了不匹配的私钥来加密数据，或者数据被篡改），将抛出 Justmd5\Crypto\Exceptions\CouldNotDecryptData 类型的异常。

使用公钥加密消息，用私钥解密

以下是使用公钥加密数据和如何使用私钥解密它的方法。

$data = 'my secret data';

$publicKey = Justmd5\Crypto\Rsa\PublicKey::fromFile($pathToPublicKey);
$encryptedData = $publicKey->encrypt($data); // encrypted data contains something unreadable

$privateKey = Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey);
$decryptedData = $privateKey->decrypt($encryptedData); // decrypted data contains 'my secret data'

如果 decrypt 无法解密给定数据（可能是使用了不匹配的公钥来加密数据，或者数据被篡改），将抛出 Justmd5\Crypto\Exceptions\CouldNotDecryptData 类型的异常。

确定数据是否可以解密

Both the PublicKey and PrivateKey class have a canDecrypt method to determine if given data can be decrypted.

Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey)->canDecrypt($data); // returns a boolean;
Justmd5\Crypto\Rsa\PublicKey::fromFile($pathToPublicKey)->canDecrypt($data); // returns a boolean;

签名和验证数据

在 PrivateKey 类中，有一个 sign 方法可以生成给定数据的签名。在 PublicKey 类上的 verify 方法可以用来验证签名是否对于给定数据有效。

如果 verify 返回 true，您就可以确信私钥持有者已签名消息，并且消息没有被篡改。

$signature = Justmd5\Crypto\Rsa\PrivateKey::fromFile($pathToPrivateKey)->sign('my message'); // returns a string

$publicKey = Justmd5\Crypto\Rsa\PublicKey::fromFile($pathToPublicKey);

$publicKey->verify('my message', $signature) // returns true;
$publicKey->verify('my modified message', $signature) // returns false;

替代方案

此包旨在非常轻量级且易于使用。如果您需要更多功能，请考虑使用以下这些替代方案：

关于 RSA 的使用的一些建议

在编写本文档时，RSA 对于我们构建此包的使用案例来说是足够安全的。

要了解更多关于为什么 RSA 可能不足以满足您的需求，请阅读Paragonie.com 上的关于公共密钥加密的文章

测试

composer test

变更日志

请参阅CHANGELOG 了解最近更改的详细信息。

贡献

请参阅CONTRIBUTING 了解详细信息。

安全漏洞

请查阅我们的安全策略，了解如何报告安全漏洞。

感谢以下人员

spatie/crypto

鸣谢

许可协议

MIT许可协议（MIT）。请参阅许可文件获取更多信息。

justmd5 / crypto

维护者

详细信息