README

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

分支

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

安装和用法

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

您可以通过composer安装此包

composer require brainstud/file-vault

用法

教程

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

描述

此包将自动注册一个名为 FileVault 的外观。该 FileVault 外观使用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 外观一样

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');

与加密类似，您也可以指定不同的 disk，就像您通常使用Laravel Storage 外观一样

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

您还可以通过传递第二个参数来指定解密文件的名称。以下示例将搜索本地磁盘中的encrypted.txt，将解密文件保存为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

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全

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

ufhy / file-vault

维护者

详细信息