PHPackages                             snicco/encryption-bundle - 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. snicco/encryption-bundle

ActiveLibrary[Security](/categories/security)

snicco/encryption-bundle
========================

v1.10.1(1y ago)014.4k1LGPL-3.0-onlyPHPPHP ^7.4|^8.0

Since Apr 17Pushed 1y ago1 watchersCompare

[ Source](https://github.com/snicco/encryption-bundle)[ Packagist](https://packagist.org/packages/snicco/encryption-bundle)[ RSS](/packages/snicco-encryption-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (35)Used By (1)

Snicco - EncryptionBundle
=========================

[](#snicco---encryptionbundle)

[![codecov](https://camo.githubusercontent.com/a99e6ec528fffd1664e95534f9a09a4a09d2afe62799ff0d8774dc22d8453f6c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f7665726167652d3130302532352d73756363657373)](https://codecov.io/gh/snicco/snicco)[![Psalm Type-Coverage](https://camo.githubusercontent.com/c12cfed65c7da16501f7a84e7861b8c4757fc30e9dc00bb2983783dbb3f3f84c/68747470733a2f2f73686570686572642e6465762f6769746875622f736e6963636f2f736e6963636f2f636f7665726167652e7376673f)](https://shepherd.dev/github/snicco/snicco)[![Psalm level](https://camo.githubusercontent.com/c5e90ffcf3a5aa1f78f93bddde5db7627b114329393aa87697df8cedc7f5391a/68747470733a2f2f73686570686572642e6465762f6769746875622f736e6963636f2f736e6963636f2f6c6576656c2e7376673f)](https://psalm.dev/)[![PhpMetrics - Static Analysis](https://camo.githubusercontent.com/364ffb28ea219affd0fed2e99cc046bac0bf41da3f1d3814e0cbe4a4bb54c994/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5068704d6574726963732d5374617469635f416e616c797369732d326561343466)](https://snicco.github.io/snicco/phpmetrics/EncryptionBundle/index.html)[![PHP-Versions](https://camo.githubusercontent.com/241a10d25aa09d5e8a82ebd2b55780a63dd43736d958d4004c3166e650874aca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545372e34253743253545382e30253743253545382e312d626c7565)](https://camo.githubusercontent.com/241a10d25aa09d5e8a82ebd2b55780a63dd43736d958d4004c3166e650874aca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545372e34253743253545382e30253743253545382e312d626c7565)

This **WordPress** bundle integrates [`defuse/php-encryption`](https://github.com/defuse/php-encryption) in applications based on [`snicco/kernel`](https://github.com/snicco/kernel).

Make sure you have a read the [documentation of `defuse/php-encryption`](https://github.com/defuse/php-encryption/blob/master/docs/Tutorial.md).

Installation
------------

[](#installation)

```
composer install snicco/encryption-bundle
```

Configuration
-------------

[](#configuration)

See [config/encryption.php](config/encryption.php) for the available configuration options.

If this file does not exist in your configuration directory the default configuration will be copied the first time the kernel is booted in dev mode.

The `EncryptionOption::KEY_ASCII` is intentionally set to a value that will throw an exception.

**MAKE SURE TO READ THE DOCUMENTATION IN THE [config/encryption.php](config/encryption.php) FILE**.

Usage
-----

[](#usage)

You must first generate a valid defuse key by running:

```
vendor/bin/vendor/bin/generate-defuse-key
```

**MAKE SURE TO READ THE DOCUMENTATION IN THE [config/encryption.php](config/encryption.php) FILE** to determine the best way to load the output of the above command into your configuration.

Add the [`EncryptionBundle`](src/EncryptionBundle.php) to your `bundles.php`config file.

```