PHPackages omar-mostro/file-vault - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [File & Storage](/categories/file-storage) 4. / 5. omar-mostro/file-vault ActiveLibrary[File & Storage](/categories/file-storage) omar-mostro/file-vault ====================== 045PHP Since May 2Pushed 1y agoCompare [ Source](https://github.com/omar-mostro/file-vault)[ Packagist](https://packagist.org/packages/omar-mostro/file-vault)[ RSS](/packages/omar-mostro-file-vault/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) File encryption / decryption in Laravel ======================================= [](#file-encryption--decryption-in-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/78c7a37497b7164f0fcd92ca3b0c45604c9ed7fa9e5253e221da5e27339a4bb0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f627261696e737475642f66696c652d7661756c742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/brainstud/file-vault)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/b6464221b4ab06b502b27d1fa0bccb12242d47f5515c88203cbc86492b7ff7db/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f627261696e737475642f66696c652d7661756c742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/brainstud/file-vault) With this package, you can encrypt and decrypt files of any size in your Laravel project. This package uses streams and [CBC encryption](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_Block_Chaining_(CBC)), encrypting / decrypting a segment of data at a time. Fork ---- [](#fork) This package is forked from [soarecostin/file-vault](https://github.com/soarecostin/file-vault) to add Laravel 9 support. Installation and usage ---------------------- [](#installation-and-usage) This package requires PHP 8.0 and Laravel 8.0 or higher. You can install the package via composer: ``` composer require brainstud/file-vault ``` Usage ----- [](#usage) ### Tutorials [](#tutorials) For a detailed description of how to encrypt files in Laravel using this package, please see the following articles: - [Part 1: How to encrypt large files in Laravel](https://medium.com/swlh/how-to-encrypt-large-files-in-laravel-293460836ded?source=friends_link&sk=976ab6e5d1cfb52e10c801fe0cb04fca) - [Part 2: How to encrypt & upload large files to Amazon S3 in Laravel](https://medium.com/@soarecostin/how-to-encrypt-upload-large-files-to-amazon-s3-in-laravel-af88324a9aa?sk=a9a358a3892e898a60448d5314fb3dc0) ### Description [](#description) This package will automatically register a facade called `FileVault`. The `FileVault` facade is using the Laravel `Storage` and will allow you to specify a `disk`, just as you would normally do when working with Laravel Storage. All file names/paths that you will have to pass into the package encrypt/decrypt functions are relative to the disk root folder. By default, the `local` disk is used, but you can either specify a different disk each time you call one of `FileVault` methods, or you can set the default disk to something else, by publishing this package's config file. If you want to change the default `disk` or change the `key`/`cipher` used for encryption, you can publish the config file: ``` php artisan vendor:publish --provider="Brainstud\FileVault\FileVaultServiceProvider" ``` This is the contents of the published file: ``` 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', ]; ``` ### Encrypting a file [](#encrypting-a-file) The `encrypt` method will search for a file, encrypt it and save it in the same directory, while deleting the original file. ``` public function encrypt(string $sourceFile, string $destFile = null, $deleteSource = true) ``` The `encryptCopy` method will search for a file, encrypt it and save it in the same directory, while preserving the original file. ``` public function encryptCopy(string $sourceFile, string $destFile = null) ``` #### Examples: [](#examples) The following example will search for `file.txt` into the `local` disk, save the encrypted file as `file.txt.enc` and delete the original `file.txt`: ``` FileVault::encrypt('file.txt'); ``` You can also specify a different `disk`, just as you would normally with the Laravel `Storage` facade: ``` FileVault::disk('s3')->encrypt('file.txt'); ``` You can also specify a different name for the encrypted file by passing in a second parameter. The following example will search for `file.txt` into the `local` disk, save the encrypted file as `encrypted.txt` and delete the original `file.txt`: ``` FileVault::encrypt('file.txt', 'encrypted.txt'); ``` The following examples both achieve the same results as above, with the only difference that the original file is not deleted: ``` // 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'); ``` ### Decrypting a file [](#decrypting-a-file) The `decrypt` method will search for a file, decrypt it and save it in the same directory, while deleting the encrypted file. ``` public function decrypt(string $sourceFile, string $destFile = null, $deleteSource = true) ``` The `decryptCopy` method will search for a file, decrypt it and save it in the same directory, while preserving the encrypted file. ``` public function decryptCopy(string $sourceFile, string $destFile = null) ``` #### Examples: [](#examples-1) The following example will search for `file.txt.enc` into the `local` disk, save the decrypted file as `file.txt` and delete the encrypted file `file.txt.enc`: ``` FileVault::decrypt('file.txt.enc'); ``` If the file that needs to be decrypted doesn't end with the `.enc` extension, the decrypted file will have the `.dec` extention. The following example will search for `encrypted.txt` into the `local` disk, save the decrypted file as `encrypted.txt.dec` and delete the encrypted file `encrypted.txt`: ``` FileVault::decrypt('encrypted.txt'); ``` As with the encryption, you can also specify a different `disk`, just as you would normally with the Laravel `Storage` facade: ``` FileVault::disk('s3')->decrypt('file.txt.enc'); ``` You can also specify a different name for the decrypted file by passing in a second parameter. The following example will search for `encrypted.txt` into the `local` disk, save the decrypted file as `decrypted.txt` and delete the original `encrypted.txt`: ``` FileVault::decrypt('encrypted.txt', 'decrypted.txt'); ``` The following examples both achive the same results as above, with the only difference that the original (encrypted) file is not deleted: ``` // 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'); ``` ### Streaming a decrypted file [](#streaming-a-decrypted-file) Sometimes you will only want to allow users to download the decrypted file, but you don't need to store the actual decrypted file. For this, you can use the `streamDecrypt` function that will decrypt the file and will write it to the `php://output` stream. You can use the Laravel [`streamDownload` method](https://laravel.com/docs/6.x/responses#file-downloads) (available since 5.6) in order to generate a downloadable response: ``` return response()->streamDownload(function () { FileVault::streamDecrypt('file.txt') }, 'laravel-readme.md'); ``` ### Using a different key for each file [](#using-a-different-key-for-each-file) You may need to use different keys to encrypt your files. You can explicitly specify the key used for encryption using the `key` method. ``` FileVault::key($encryptionKey)->encrypt('file.txt'); ``` Please note that the encryption key must be 16 bytes long for the `AES-128-CBC` cipher and 32 bytes long for the `AES-256-CBC` cipher. You can generate a key with the correct length (based on the cipher specified in the config file) by using the `generateKey` method: ``` $encryptionKey = FileVault::generateKey(); ``` Testing ------- [](#testing) Run the tests with: ``` composer test ``` ### Changelog [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Security [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Brainstud](https://github.com/brainstudnl) - [Costin Soare](https://github.com/soarecostin) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. Laravel Package Boilerplate --------------------------- [](#laravel-package-boilerplate) This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). ### Health Score 18 — LowBetter than 8% of packages Maintenance38 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community10 Small or concentrated contributor base Maturity14 Early-stage or recently created project Bus Factor1 Top contributor holds 77.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/8195c4926fe4f41f81b0953c893b5520cda3695f5332be52980f6595b04b76f5?d=identicon)[omar-mostro](/maintainers/omar-mostro) --- Top Contributors [![soarecostin](https://avatars.githubusercontent.com/u/6401790?v=4)](https://github.com/soarecostin "soarecostin (34 commits)")[![niekp](https://avatars.githubusercontent.com/u/19265518?v=4)](https://github.com/niekp "niekp (5 commits)")[![omar-mostro](https://avatars.githubusercontent.com/u/8531363?v=4)](https://github.com/omar-mostro "omar-mostro (3 commits)")[![breadthe](https://avatars.githubusercontent.com/u/17433578?v=4)](https://github.com/breadthe "breadthe (2 commits)") ### Embed Badge ![Health badge](/badges/omar-mostro-file-vault/health.svg) ``` [![Health](https://phpackages.com/badges/omar-mostro-file-vault/health.svg)](https://phpackages.com/packages/omar-mostro-file-vault) ``` ### Alternatives [knplabs/gaufrette PHP library that provides a filesystem abstraction layer 2.5k39.8M123](/packages/knplabs-gaufrette)[google/cloud-storage Cloud Storage Client for PHP 34390.8M123](/packages/google-cloud-storage)[illuminate/filesystem The Illuminate Filesystem package. 15261.6M2.6k](/packages/illuminate-filesystem)[superbalist/flysystem-google-storage Flysystem adapter for Google Cloud Storage 26320.6M30](/packages/superbalist-flysystem-google-storage)[creocoder/yii2-flysystem The flysystem extension for the Yii framework 2931.7M61](/packages/creocoder-yii2-flysystem)[flowjs/flow-php-server PHP library for handling chunk uploads. Works with flow.js html5 file uploads. 2451.6M15](/packages/flowjs-flow-php-server) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)