Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/picodexter/pcdxparameterencryptionbundle

A Symfony bundle that allows you to encrypt and decrypt parameters
https://github.com/picodexter/pcdxparameterencryptionbundle

bundle crypto decryption encryption parameters symfony symfony-bundle symfony2 symfony2-bundle symfony3 symfony3-bundle

Last synced: about 2 months ago
JSON representation

A Symfony bundle that allows you to encrypt and decrypt parameters

Host: GitHub
URL: https://github.com/picodexter/pcdxparameterencryptionbundle
Owner: picodexter
License: mit
Archived: true
Created: 2017-04-24T22:23:57.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2020-07-11T23:40:27.000Z (over 4 years ago)
Last Synced: 2024-09-29T16:01:26.720Z (about 2 months ago)
Topics: bundle, crypto, decryption, encryption, parameters, symfony, symfony-bundle, symfony2, symfony2-bundle, symfony3, symfony3-bundle
Language: PHP
Homepage:
Size: 513 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# PcdxParameterEncryptionBundle

## DEPRECATION WARNING!

### THIS BUNDLE IS NOW DEPRECATED / ABANDONED

The [Symfony Secrets management](https://symfony.com/doc/current/configuration/secrets.html)
that was introduced with Symfony 4.4 offers an official solution for the
original purpose of this bundle.

Please refer to it instead.

Active development on this project has therefore been stopped.

## END OF DEPRECATION WARNING

This bundle lets you save Symfony parameters in an encrypted form and
automatically decrypt them during runtime.

[![Latest Stable Version](https://img.shields.io/packagist/v/picodexter/parameter-encryption-bundle.svg?style=flat)](https://packagist.org/packages/picodexter/parameter-encryption-bundle)
[![Build Status](https://img.shields.io/travis/picodexter/PcdxParameterEncryptionBundle/master.svg?style=flat)](https://travis-ci.org/picodexter/PcdxParameterEncryptionBundle)
[![Code Coverage](https://img.shields.io/coveralls/picodexter/PcdxParameterEncryptionBundle/master.svg?style=flat)](https://coveralls.io/github/picodexter/PcdxParameterEncryptionBundle)

## Purpose

### What It Does

This bundle allows developers to save sensitive information in Symfony
parameters in an encrypted form so that it can be committed to a VCS. The only
remaining sensitive information, the decryption key, could then be saved in an
unversioned `parameters.yml` file or simply passed in an environment variable.

Through this approach you can easily keep all stage-specific configuration
files in the VCS and use a switch mechanism to detect which one to load. This
helps you keep the number of stage-specific (automatically) deployed but
unversioned files to an absolute minimum.

### What It Does Not Do

The intention is **not** to provide security in a way that an attacker with
access to the webspace file system wouldn't be able to decrypt the parameters.

The PHP process needs to read both the encrypted data as well as the decryption
key(s), be it in the file system or in memory as an environment variable.
Someone who manages to infiltrate the process therefore automatically gains
relevant read access to both pieces of information as well.

Additionally, anyone who can read the Symfony application cache would be able
to extract the dumped container including all decrypted parameters anyway.

## Features

* Provides encryption for Symfony parameters
* Does not impact overall application performance when container is cached
* Allows defining keys in base64 encoded format to support binary values
* Allows generating keys with PBKDF2
* Allows specifying multiple algorithm configurations to enable usage of
different methods of encryption in the same application
* Modular approach to harness encryption ciphers from reputable third-party
Composer packages
* Highly configurable
* Highly extensible (custom encrypters, decrypters, key transformers, ...)
* 100% code coverage

Furthermore, this bundle comes with the following ciphers out-of-the-box:

### Symmetric Ciphers

* Caesar

## Documentation

The documentation source files are located in the `Resources/doc/` directory of
this bundle.

## Installation

Please refer to the [Getting Started guide](Resources/doc/getting-started.rst).

## License

This bundle is released under the [MIT license](LICENSE).

## Authors

* picodexter | [GitHub](https://github.com/picodexter) | [picodexter.io](https://picodexter.io/)

See also the [list of contributors](https://github.com/picodexter/PcdxParameterEncryptionBundle/contributors).

## Contributing

The official project repository with the issue tracker can be found
[on GitHub](https://github.com/picodexter/PcdxParameterEncryptionBundle).

Please refer to the [contributing document](CONTRIBUTING.md).