README

使用本包，您可以在Laravel项目中加密和解密任意大小的文件。此包使用流和CBC加密，每次加密/解密数据的一个片段。

分支

此包是从soarecostin/file-vault分叉而来，以添加对Laravel 9的支持。

安装和使用

此包需要PHP 8.0和Laravel 8.0或更高版本。

您可以通过composer安装此包

composer require brainstud/file-vault

使用

教程

有关如何使用此包在Laravel中加密文件的详细描述，请参阅以下文章

描述

此包将自动注册一个名为FileVault的facade。此FileVault facade使用Laravel的Storage，允许您指定一个disk，就像您在处理Laravel Storage时通常做的那样。所有需要传递到包加密/解密函数的文件名/路径都相对于磁盘根文件夹。默认情况下，使用的是local磁盘，但您可以在每次调用FileVault方法时指定不同的磁盘，或者通过发布此包的配置文件来设置默认磁盘。

如果您想更改默认的disk或更改加密时使用的key/cipher，您可以发布配置文件

php artisan vendor:publish --provider="Brainstud\FileVault\FileVaultServiceProvider"

这是发布文件的包含内容

return [
    /*
     * The default key used for all file encryption / decryption
     * This package will look for a FILE_VAULT_KEY in your env file
     * If no FILE_VAULT_KEY is found, then it will use your Laravel APP_KEY
     */
    'key' => env('FILE_VAULT_KEY', env('APP_KEY')),

    /*
     * The cipher used for encryption.
     * Supported options are AES-128-CBC and AES-256-CBC
     */
    'cipher' => 'AES-256-CBC',

    /*
     * The Storage disk used by default to locate your files.
     */
    'disk' => 'local',
];

加密文件

encrypt方法将搜索一个文件，加密它并将其保存到相同的目录中，同时删除原始文件。

public function encrypt(string $sourceFile, string $destFile = null, $deleteSource = true)

encryptCopy方法将搜索一个文件，加密它并将其保存到相同的目录中，同时保留原始文件。

public function encryptCopy(string $sourceFile, string $destFile = null)

示例

以下示例将在local磁盘上搜索file.txt，将加密文件保存为file.txt.enc并删除原始file.txt

FileVault::encrypt('file.txt');

您也可以指定不同的disk，就像您通常使用Laravel Storage facade一样

FileVault::disk('s3')->encrypt('file.txt');

您也可以通过传递第二个参数来指定加密文件的名称。以下示例将在local磁盘上搜索file.txt，将加密文件保存为encrypted.txt并删除原始file.txt

FileVault::encrypt('file.txt', 'encrypted.txt');

以下示例都实现了上述结果，唯一的区别是原始文件不会被删除

// save the encrypted copy to file.txt.enc
FileVault::encryptCopy('file.txt');

// or save the encrypted copy with a different name
FileVault::encryptCopy('file.txt', 'encrypted.txt');

解密文件

decrypt方法将搜索一个文件，解密它并将其保存到相同的目录中，同时删除加密文件。

public function decrypt(string $sourceFile, string $destFile = null, $deleteSource = true)

decryptCopy方法将搜索一个文件，解密它并将其保存到相同的目录中，同时保留加密文件。

public function decryptCopy(string $sourceFile, string $destFile = null)

示例

以下示例将在local磁盘上搜索file.txt.enc，将解密文件保存为file.txt并删除加密文件file.txt.enc

FileVault::decrypt('file.txt.enc');

如果需要解密的文件不以.enc扩展名结尾，则解密文件将具有.dec扩展名。以下示例将在local磁盘上搜索encrypted.txt，将解密文件保存为encrypted.txt.dec并删除加密文件encrypted.txt

FileVault::decrypt('encrypted.txt');

与加密一样，您也可以指定不同的 磁盘，就像您通常使用 Laravel 的 Storage 门面一样。

FileVault::disk('s3')->decrypt('file.txt.enc');

您还可以通过传递第二个参数来指定解密文件的不同的名称。以下示例将搜索 encrypted.txt 到 local 磁盘，将解密文件保存为 decrypted.txt，并删除原始的 encrypted.txt。

FileVault::decrypt('encrypted.txt', 'decrypted.txt');

以下示例都实现了上述相同的结果，唯一的区别是原始（加密）文件不会被删除。

// save the decrypted copy to file.txt while preserving file.txt.enc
FileVault::decryptCopy('file.txt.enc');

// or save the decrypted copy with a different name, while preserving the file.txt.enc
FileVault::decryptCopy('file.txt.enc', 'decrypted.txt');

流式传输解密文件

有时您可能只想允许用户下载解密文件，但不需要存储实际的解密文件。为此，您可以使用 streamDecrypt 函数来解密文件，并将其写入到 php://output 流。您可以使用 Laravel 的 streamDownload 方法（自 5.6 版本起可用）来生成可下载的响应。

return response()->streamDownload(function () {
    FileVault::streamDecrypt('file.txt')
}, 'laravel-readme.md');

为每个文件使用不同的密钥

您可能需要使用不同的密钥来加密文件。您可以使用 key 方法显式指定用于加密的密钥。

FileVault::key($encryptionKey)->encrypt('file.txt');

请注意，加密密钥的长度必须是 16 个字节（对于 AES-128-CBC 密码）和 32 个字节（对于 AES-256-CBC 密码）。

您可以通过使用 generateKey 方法生成具有正确长度（基于配置文件中指定的密码）的密钥。

$encryptionKey = FileVault::generateKey();

测试

使用以下命令运行测试：

composer test

变更日志

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

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何安全问题，请通过电子邮件 dev@brainstud.com 而不是使用问题跟踪器来报告。

brainstud / file-vault

维护者

详情