Recommend this page to a friend! |
Classes of Francisco | Symfony PHP Encrypt Decrypt Bundle | README.md | Download |
|
DownloadPSolutions Encrypt BundleA bundle to handle encoding and decoding of parameters using OpenSSL and Doctrine lifecycle events. It's a fork of https://github.com/mogilvie/EncryptBundle Features include: - v1 is Symfony 6.4 and 7.0 compatible. - Uses OpenSSL - Uses Event listeners Features road map:
LicenseThis bundle is under the MIT license. See the complete license in the bundle:
AboutEncryptBundle has been written for the Parolla Plugins and Parolla websites to encode users private data. The bundle is expanded in a larger gdpr-bundle. Reporting an issue or a feature requestIssues and feature requests are tracked in the Github issue tracker. When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps. InstallationStep 1: Install from packageOpen a command console, enter your project directory and execute the following command to download the latest development version of this bundle:
Step 2: Enable the bundleThe receipe will create a package config file under config/packages/psolutions_encrypt.yaml. If required, enable the bundle by adding it to the list of registered bundles
in the
Step 2: Configure the bundleGenerate a 256-bit key using the command provided in the bundle.
Copy the key into your .env file.
Maker will have created a packages yaml file. The key is resolved in there.
You can disable encryption by setting the 'is_disabled' option to true. Decryption still continues if any values contain the \<ENC> suffix. If you want to define your own annotation/attribute, then this can be used to trigger encryption by adding the annotation class name to the 'annotation_classes' option array. You can pass the class name of your own encyptor service using the optional encryptorClass option. Alternative EncryptKeyEventThe EncryptKey can be set via a dispatched event listener, which overrides any .env or param.yml defined key. Create a listener for the EncryptKeyEvents::LOAD_KEY event and set your encryption key at that point. Step 3: Create the entitiesAdd the Encrypted attribute class within the entity.
Add the attribute #[Encrypted] to the properties you want encrypted.
Where encrypting a field you will need to set the column type as string. Your getters and setters may also need to be type declared. For example, boolean should either be return declared bool, or return a bool using a ternary method.
For DateTime parameters store the date as a string, and use the getters and setters to convert that string. You may also need to create a DataTransformer if you are using the parameter in a form with the DateType form type. Step 4: General UseThe bundle comes with an DoctrineEncryptListener. This listener catches the doctrine events onLoad, onFlush and postFlush. The onLoad event listener will decrypt your entity parameter at loading. This means that your forms and form fields will already be decrypted. The onFlush and postFlush event listeners will check if encryption is enabled, and encrypt the data before entry to the database. So, in normal CRUD operation you do not need to do anything in the controller for encrypting or decrypting the data. Step 5: Decrypt in services and controllersYou can of course inject the EncryptorInterface service any time into classes either by using autowiring or defining the injection in your service definitions.
Or you can dispatch the EncryptEvent.
Step 5: Decrypt in templatesIf you query a repository using a select with an array result then the doctrine onLoad event subscriber will not decrypt any encrypted values. In this case, use the twig filter to decrypt your value when rendering.
CommandsYou have already seen the command to generate a encryption key:
You can decrypt/encrypt the entire database using the following
The requried argument should be be decrypt or encrypt. There is an option to define the database connection if you employ multiple connections in your application. |