Skip to main content

A set of django fields that internally are encrypted using the cryptography.io native python encryption library.

Project description

Django Cryptographic Fields
===========================

.. image:: https://circleci.com/gh/foundertherapy/django-cryptographic-fields.png
:target: https://circleci.com/gh/foundertherapy/django-cryptographic-fields

About
-----

``django-cryptographic-fields`` is set of fields that wrap standard Django
fields with encryption provided by the python cryptography library. These
fields are much more compatible with a 12-factor design since they take their
encryption key from the settings file instead of a file on disk used by
``keyczar``.

While keyczar is an excellent tool to use for encryption, it's not compatible
with Python 3, and it requires, for hosts like Heroku, that you either check
your key file into your git repository for deployment, or implement manual
post-deployment processing to write the key stored in an environment variable
into a file that keyczar can read.

Getting Started
---------------

$ pip install django-cryptographic-fields

Add "cryptographic_fields" to your INSTALLED_APPS setting like this:

INSTALLED_APPS = (
...
'cryptographic_fields',
)

``django-cryptographic-fields`` expects the encryption key to be specified
using ``FIELD_ENCRYPTION_KEY`` in your project's ``settings.py`` file. For
example, to load it from the local environment:

import os

FIELD_ENCRYPTION_KEY = os.environ.get('FIELD_ENCRYPTION_KEY', '')

To use an encrypted field in a Django model, use one of the fields from the
``cryptographic_fields`` module:

from cryptographic_fields.fields import EncryptedCharField

class EncryptedFieldModel(models.Model):
encrypted_char_field = EncryptedCharField(max_length=100)

For fields that require ``max_length`` to be specified, the ``Encrypted``
variants of those fields will automatically increase the size of the database
field to hold the encrypted form of the content. For example, a 3 character
CharField will automatically specify a database field size of 100 characters
when ``EncryptedCharField(max_length=3)`` is specified.

Due to the nature of the encrypted data, filtering by values contained in
encrypted fields won't work properly. Sorting is also not supported.

Generating an Encryption Key
----------------------------

There is a Django management command ``generate_encryption_key`` provided
with the ``cryptographic_fields`` library. Use this command to generate a new
encryption key to set as ``settings.FIELD_ENCRYPTION_KEY``.

./manage.py generate_encryption_key

Running this command will print an encryption key to the terminal, which can
be configured in your environment or settings file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-cryptographic-fields-0.5.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django-cryptographic-fields-0.5.0.tar.gz.

File metadata

File hashes

Hashes for django-cryptographic-fields-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c28395dbff9741096cbd03a110be4760522a1e3d253379d7e52eb891511e95a0
MD5 c42099b18d3366b398a4f8767b2989a0
BLAKE2b-256 bf005d16ab46456f157a40cbf52f9300de81809fd8e5f172b0746ea0aa21f3f3

See more details on using hashes here.

File details

Details for the file django-cryptographic-fields-0.5.0.macosx-10.11-x86_64.tar.gz.

File metadata

File hashes

Hashes for django-cryptographic-fields-0.5.0.macosx-10.11-x86_64.tar.gz
Algorithm Hash digest
SHA256 424e5e08b2dbe7c1a9af10e696ad4d2534300c5cc2b645f1412e3612dc164f29
MD5 b9ad4fb4175ebd2bbe14d233d6fffea3
BLAKE2b-256 5dddc4e773f6516c931bebac9a0b3718c87fa96b2f6f6ce17eaa4e128b6c9c87

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page