initbiz / file-vault
Requires
- php: ^8.0
- ext-openssl: *
- illuminate/support: ^8.0 || ^9.0 || ^10.0
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0
- phpstan/phpstan: ^1.4
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-09-07 17:29:41 UTC
README
使用此包,您可以在Laravel项目中加密和解密任何大小的文件。此包使用流和CBC加密模式,一次加密/解密一段数据。
分支
此包是从Brainstud分支出来的,以添加对Laravel 10的支持。
安装和使用
此包需要PHP 8.0和Laravel 8.0或更高版本。
您可以通过composer安装此包
composer require initbiz/file-vault
使用
教程
有关如何使用此包在Laravel中加密文件的具体描述,请参阅以下文章
描述
此包将自动注册一个名为FileVault
的facade。该FileVault
facade使用Laravel Storage
,并允许您指定一个disk
,就像您在处理Laravel Storage时做的那样。您需要传递给包的加密/解密函数的所有文件名/路径都是相对于磁盘根目录的。默认情况下,使用的是local
磁盘,但您可以在每次调用FileVault
方法时指定不同的磁盘,或者通过发布此包的配置文件将默认磁盘设置为其他选项。
如果您想更改默认的disk
或更改加密所使用的key
/cipher
,您可以发布配置文件
php artisan vendor:publish --provider="Initbiz\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');
您还可以通过传递第二个参数来指定解密文件的不同的名称。以下示例将在 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');
请注意,加密密钥必须为 16 字节长(用于 AES-128-CBC
密码),32 字节长(用于 AES-256-CBC
密码)。
您可以使用 generateKey
方法生成正确长度的密钥(根据配置文件中指定的密码)
$encryptionKey = FileVault::generateKey();
测试
使用以下命令运行测试
composer test
变更日志
请参阅 CHANGELOG 了解最近更改的详细信息。
贡献
请参阅 CONTRIBUTING 了解详细信息。
安全
如果您发现任何安全相关的问题,请通过电子邮件 contact@init.biz 而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。
Laravel 包模板
此包使用 Laravel 包模板 生成。