Download the PHP package athens/encryption without Composer

On this page you can find all versions of the php package athens/encryption. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package encryption

Build Status Code Climate Test Coverage Latest Stable Version

Athens\Encryption

Seamlessly encrypt/decrypt Propel2 data fields. This library is a plugin for the Propel2 ORM framework.

For example:

Given the table definition above, the string "Some data that will be encrypted." is encrypted in memory before being sent to the database. When we retrieve MySecretData later, the ciphertext is decrypted before being returned.

Note/Tradeoff

Athens/Encryption breaks Propel's native search/find/sort methods on the encrypted field(s). Because the plain-texts of encrypted fields are not available to the database, no database method of search or sort can operate on these fields. A search or sort can only be accomplished by retrieving all rows, decrypting all values, and performing a search/sort on those. If you have many rows and you need to search/sort on encrypted fields, this process may be impractically slow.

Installation

This library is published on packagist. To install using Composer, add the "Athens/Encryption": "0.1.*" line to your "require" dependencies:

Of course, if you're not using Composer then you can download the repository using the Download ZIP button at right.

Use

This client library provides a Cipher class and one Propel2 Behavior class.

To designate a field as encrypted in your Propel schema, set its type as varbinary and include the encryption behavior. You may include multiple columns in the encryption behavior:

Then build your models and database as usual.

Before querying the database, you must initialize the Cipher class with your passphrase:

The argument $my_passphrase should be a string of random characters. A length of 32-64 characters is appropriate for your passphrase. Because the cipher is initialized with every page load, the passphrase must be stored on your server in a location accessible to PHP. However, the passphrase should not be in a file which is viewable to web-visitors, and it almost certainly should not be included in your source/version control (git, scm, etc.).

That's it! The class setters for MySecretData and MySecretData2 now seamlessly encrypt their data before it is sent to the database. The class getters for MySecretData and MySecretData2 seamlessly decrypt data after retrieving it from the database.

Remember that search/find and sort are now broken for MySecretData and MySecretData2, for reasons discussed above.

Compatibility

Todo

See GitHub issue tracker.

Getting Involved

Feel free to open pull requests or issues. GitHub is the canonical location of this project.

Here's the general sequence of events for code contribution:

  1. Open an issue in the issue tracker.
  2. In any order:
    • Submit a pull request with a failing test that demonstrates the issue/feature.
    • Get acknowledgement/concurrence.
  3. Revise your pull request to pass the test in (2). Include documentation, if appropriate.

All versions of encryption with dependencies

PHP Build Version
Package Version
Requires propel/propel Version ~2.0@dev
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package athens/encryption contains the following files

Loading the files please wait ....