README

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

分支

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

安装和使用

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

您可以通过 composer 安装此包

composer require iknowitza/vault

用法

教程

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

描述

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

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

php artisan vendor:publish --provider="iknowitza\Vault\VaultServiceProvider"

这是发布文件的包含内容

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

您也可以通过传入第二个参数为解密文件指定不同的名称。以下示例将在local磁盘上搜索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');

请注意，对于AES-128-CBC密码，加密密钥必须为16字节长，对于AES-256-CBC密码，必须为32字节长。

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

$encryptionKey = FileVault::generateKey();

测试

使用以下命令运行测试

composer test

变更日志

有关最近更改的更多信息，请参阅变更日志

贡献

有关详细信息，请参阅贡献指南

安全

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

iknowitza / vault

维护者

详细信息