加密
介绍
Laravel 的加密服务提供了一个简单、便捷的接口,通过 OpenSSL 使用 AES-256 和 AES-128 加密算法对文本进行加密和解密。Laravel 所有的加密值都使用消息认证码(MAC)进行了签名,以确保加密后的底层值无法被修改或篡改。
配置
在使用 Laravel 的加密器之前,您必须在 config/app.php
配置文件中设置 key
配置选项。这个配置值由 APP_KEY
环境变量驱动。您应该使用 php artisan key:generate
命令来生成这个变量的值,因为 key:generate
命令会使用 PHP 的安全随机字节生成器来为您的应用程序构建一个加密安全的密钥。通常,APP_KEY
环境变量的值会在 【Laravel 安装】时为您自动生成。
优雅地轮换加密密钥
如果您更改了应用程序的加密密钥,所有已认证的用户会话将会被登出。这是因为所有的 cookie,包括会话 cookie,都是由 Laravel 加密的。此外,使用之前的加密密钥加密的数据将无法再被解密。
为了解决这个问题,Laravel 允许您在应用程序的 APP_PREVIOUS_KEYS
环境变量中列出之前的加密密钥。这个变量可以包含一个用逗号分隔的所有先前加密密钥的列表:
APP_KEY="base64:J63qRTDLub5NuZvP+kb8YIorGS6qFYHKVo6u7179stY="
APP_PREVIOUS_KEYS="base64:2nLsGFGzyoae2ax3EF2Lyq/hH6QghBGLIq5uL+Gp8/w="
当您设置了这个环境变量后,Laravel 在加密值时会始终使用“当前”的加密密钥。然而,在解密值时,Laravel 会首先尝试使用当前密钥,如果使用当前密钥解密失败,Laravel 会尝试所有之前的密钥,直到其中一个密钥能够成功解密该值。
这种优雅的解密方式允许用户在加密密钥轮换时仍然可以不间断地使用您的应用程序。
使用加密器
加密一个值
您可以使用 Crypt
门面提供的 encryptString
方法对一个值进行加密。所有加密的值都是使用 OpenSSL 和 AES-256-CBC 加密算法加密的。此外,所有加密的值都会使用消息认证码(MAC)进行签名。集成的消息认证码将防止任何被恶意用户篡改的值被解密:
<?php
namespace App\Http\Controllers;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Crypt;
class DigitalOceanTokenController extends Controller
{
/**
* 存储用户的 DigitalOcean API token。
*/
public function store(Request $request): RedirectResponse
{
$request->user()->fill([
'token' => Crypt::encryptString($request->token),
])->save();
return redirect('/secrets');
}
}
解密一个值
您可以使用 Crypt
门面提供的 decryptString
方法来解密值。如果无法正确解密值,例如当消息认证码无效时,将抛出 Illuminate\Contracts\Encryption\DecryptException
异常:
use Illuminate\Contracts\Encryption\DecryptException;
use Illuminate\Support\Facades\Crypt;
try {
$decrypted = Crypt::decryptString($encryptedValue);
} catch (DecryptException $e) {
// ...
}