Download the PHP package spaze/encryption without Composer
On this page you can find all versions of the php package spaze/encryption. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spaze/encryption
More information about spaze/encryption
Files in spaze/encryption
Package encryption
Short Description Various encryption helpers, uses Halite (which uses Sodium) for cryptography
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package encryption
Various encryption helpers
Various encryption helpers, uses paragonie/halite (which uses Sodium) for cryptography. Support key rotation.
Usage in Nette framework
Although it can be used anywhere, this library doesn't depend on anything from the Nette Framework.
Define encryption keys
Add this (or similar) to your config.local.neon parameters section (DO NOT COMMIT THIS TO REPOSITORY):
YOU HAVE TO GENERATE YOUR OWN KEYS. You can use for example
to generate a key, then add the prefix. You can have multiple keys in each group (here we see two groups: password and email), meaning you will be able to decrypt data encrypted with these keys. Data will always be encrypted with what's defined in activeKeyIds section.
The configuration is an example one, you don't need to use groups, or even the config key names (like activeKeyIds), the only place where these will be used is when you define the service, or services.
Services
Then define services for each key group (feel free to commit this):
Use the services in this class which needs to encrypt and decrypt email addresses for whatever reason:
Pass the properly configured encryption service to the class:
Key rotation
You can always add a new encryption key, set it as an active key and from that moment, the data will be encrypted with the new key. Unless you remove the old key, it will be possible to decrypt data encrypted with it. You can then take all the data encrypted with the old key and re-encrypt them just to change they key which was used to encrypt them. Once done you can delete the old key.
You can use needsReEncrypt($ciphertext): bool to see if the data is encrypted with an inactive key and thus should be re-encrypted with the currently active one.
Running tests
If you want to contribute (awesome, thanks!), you should add/run tests for your contributions.
First install dev dependencies by running composer install, then run tests with composer test, see scripts in composer.json. Tests are also run on GitHub with Actions on each push.
You can fix coding style issues automatically by running composer cs-fix.
