PHPackages                             soden46/garudacrypt - 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. [Security](/categories/security)
4. /
5. soden46/garudacrypt

ActiveLibrary[Security](/categories/security)

soden46/garudacrypt
===================

garudacrypt is an installation package for data encryption purposes using cryptographic methods

00PHP

Since Mar 19Pushed 3y ago1 watchersCompare

[ Source](https://github.com/soden46/garudacrypt)[ Packagist](https://packagist.org/packages/soden46/garudacrypt)[ RSS](/packages/soden46-garudacrypt/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (1)Used By (0)

Garuda encryption / decryption in Laravel
=========================================

[](#garuda-encryption--decryption-in-laravel)

[![Latest Version on Packagist](https://camo.githubusercontent.com/34f6f094c42b078a1862fd0ab8e2140d70649faf5d7a96f21c781ae661dbbdb5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f736f64656e34362f67617275646163727970742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/soden46/garudacrypt)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/1d0d71eda1b422f57d791cf97f63c859cdae84fff8f691c4d46ac52ae5018f0c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f736f64656e34362f67617275646163727970742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/soden46/garudacrypt)

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.

Installation and usage
----------------------

[](#installation-and-usage)

This package requires PHP 8.0 and Laravel 9.0 or higher.

You can install the package via composer:

```
composer require soden46/garudacrypt
```

Usage
-----

[](#usage)

### Tutorials

[](#tutorials)

For a detailed description of how to encrypt files in Laravel using this package, please see the following articles:

### Description

[](#description)

This package will automatically register a facade called `GarudaCrypt`. The `GarudaCrypt` 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 `GarudaCrypt` 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="Soden46\GarudaCrypt\GarudaCryptServiceProvider"

```

This is the contents of the published file:

```
return [
    /*
     * The default key used for all file encryption / decryption
     * This package will look for a SHA256_KEY and GARUDA_CRYPT_KEY in your env file
     * If no SHA256_KEY and GARUDA_CRYPT_KEY is found, then it will use your Laravel APP_KEY
     */
    'key' => env('GARUDA_CRYPT_KEY', env('APP_KEY')),
    'sha' =>  env('SHA256_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`:

```
GarudaCrypt::encrypt('file.txt');
```

You can also specify a different `disk`, just as you would normally with the Laravel `Storage` facade:

```
GarudaCrypt::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`:

```
GarudaCrypt::encrypt('file.txt', 'encrypted.txt');
```

The following examples both achive the same results as above, with the only difference that the original file is not deleted:

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

// or save the encrypted copy with a different name
GarudaCrypt::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`:

```
GarudaCrypt::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`:

```
GarudaCrypt::decrypt('encrypted.txt');
```

As with the encryption, you can also specify a different `disk`, just as you would normally with the Laravel `Storage` facade:

```
GarudaCrypt::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`:

```
GarudaCrypt::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
GarudaCrypt::decryptCopy('file.txt.enc');

// or save the decrypted copy with a different name, while preserving the file.txt.enc
GarudaCrypt::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 () {
    GarudaCrypt::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.

```
GarudaCrypt::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 = GarudaCrypt::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)

- [Syarif Syarifuddin](https://github.com/soden46)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

13

—

LowBetter than 1% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity23

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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/4fbd945878f6df6eec859d81d50fe35d3e51717c9b694472200e73cb64640607?d=identicon)[soden46](/maintainers/soden46)

---

Top Contributors

[![soden46](https://avatars.githubusercontent.com/u/65828433?v=4)](https://github.com/soden46 "soden46 (24 commits)")

---

Tags

cryptodecryptdecryptionencryptencryptionencryption-decryptionhashhashinglaravel

### Embed Badge

![Health badge](/badges/soden46-garudacrypt/health.svg)

```
[![Health](https://phpackages.com/badges/soden46-garudacrypt/health.svg)](https://phpackages.com/packages/soden46-garudacrypt)
```

###  Alternatives

[defuse/php-encryption

Secure PHP Encryption Library

3.9k162.4M214](/packages/defuse-php-encryption)[roave/security-advisories

Prevents installation of composer packages with known security vulnerabilities: no API, simply require it

2.9k97.3M6.4k](/packages/roave-security-advisories)[mews/purifier

Laravel 5/6/7/8/9/10 HtmlPurifier Package

2.0k16.7M113](/packages/mews-purifier)[robrichards/xmlseclibs

A PHP library for XML Security

41278.1M118](/packages/robrichards-xmlseclibs)[bjeavons/zxcvbn-php

Realistic password strength estimation PHP library based on Zxcvbn JS

86917.5M63](/packages/bjeavons-zxcvbn-php)[enlightn/security-checker

A PHP dependency vulnerabilities scanner based on the Security Advisories Database.

33732.2M110](/packages/enlightn-security-checker)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)