django-crypto-fields

|pypi| |actions| |codecov| |downloads| |maintainability| |black|

django-crypto-fields

Add encrypted field classes to your Django models where unique=True and unique_together attributes work as expected.

Current version

+-------------------------+----------------+---------------+----------+-----------+ | Version | Python | Django | DB | Cache | +=========================+================+===============+==========+===========+ | 1.0.0+ | 3.12+ | 5.2+ | mysql | cache | | | | | postgres | framework | +-------------------------+----------------+---------------+----------+-----------+

Older versions

+-------------------------+----------------+---------------+----------+-----------+ | Version | Python | Django | DB | Cache | +=========================+================+===============+==========+===========+ | < 0.3.7 | 3.8, 3.9, 3.10 | 3.2, 4.0, 4.1 | mysql | N/A | +-------------------------+----------------+---------------+----------+-----------+ | 0.3.8 - 0.3.9 | 3.11+ | 4.2+ | mysql | N/A | +-------------------------+----------------+---------------+----------+-----------+ | 0.4.0 - 0.4.1 | 3.11+ | 4.2+ | mysql | cache | | | | | | framework | +-------------------------+----------------+---------------+----------+-----------+ | 0.4.2+ | 3.11+ | 4.2+ | mysql | cache | | | | | postgres | framework | +-------------------------+----------------+---------------+----------+-----------+

django-crypto-fields uses pycryptodomex

We use this module in projects built with the ClinicEDC_: A clinical trials data management framework.

Usage

.. code-block:: python

from django.db import models
from django_crypto_fields.fields import EncryptedTextField, FirstnameField, IdentityField

class PatientModel (models.Model):

    first_name = FirstnameField(
        verbose_name="First Name")

    identity = IdentityField(
        verbose_name="Identity",
        unique=True)

    comment = EncryptedTextField(
        max_length=500)

Installation

add to INSTALLED_APPS:

.. code-block:: python

INSTALLED_APPS = (
	# ...
    'django_crypto_fields.apps.AppConfig',
    # ...
)

Add DJANGO_CRYPTO_FIELDS_KEY_PATH to the folder in settings:

.. code-block:: python

# folder where the encryption keys are stored
# Do not set for tests
DJANGO_CRYPTO_FIELDS_KEY_PATH = '/etc/myproject/django_crypto_fields'

Add KEY_PREFIX (optional, the default is "user"):

.. code-block:: python

# optional filename prefix for encryption keys files:
KEY_PREFIX = 'bhp066'

Run migrate to create the django_crypto_fields.crypt table:

.. code-block:: bash

python manage.py migrate django_crypto_fields

Encryption keys

Take care of the encryption keys!

In your tests you can set settings.DEBUG = True and settings.AUTO_CREATE_KEYS = True so that keys are generated for your tests. Encryption keys will not automatically generate on a production system (DEBUG=False) unless settings.AUTO_CREATE_KEYS = True.

By default assumes your test module is runtests.py. You can changes this by setting settings.DJANGO_CRYPTO_FIELDS_TEST_MODULE.

When are encryption keys loaded?

The encryption keys are loaded as a side effect of accessing the keys module. The keys module is imported in this apps AppConfig just before import_models. During runtime the encryption keys are stored in the encryption_keys global.

See module apps.py, module keys.py and fields.BaseField constructor.

History

django-crypto-fields has been used in our audited research projects that use our "Edc" for data collection and management. Data collected in our Edc are considered "source documents". django-crypto-field adds field level encryption for sensitive field values such as names, identifiers, dob, etc (PII). Authorized study personnel accessing the data through the application can see PII. Downstream data management staff and statisticians accessing the database directly cannot.

Features

• All values are stored as a pair of hash (hashlib.pbkdf2_hmac) and secret (rsa or aes);
• A model using a django-crypto-fields field class stores the hash only;
• A separate table relates the hash to it's secret and is referenced internally by the field class;

Advantages

• Automatically creates encryption key sets (RSA, AES and salt) and stores them in the KEY_PATH folder;
• Supports unique constraints and compound constraints that including encrypted fields. The hash is stored in the model's db_table and not the secret. The unique=True and unique_together attributes work as expected;
• The dataset is de-identified at rest. This has many advantages but helps us work well with our analysis team. The data analysis team do not need to see PII. They just want a de-identified dataset. A de-identified dataset is one where PII fields are encrypted and others not. With the RSA keys removed, the dataset is effectively de-identified;
• Datasets from other systems with shared PII values, such as identity numbers, can be prepared for meta-analysis using the same keys and algorithms;
• The dataset can be permanently obscured by dropping the Crypt table from the DB (it has all the secrets);
• By default field classes exist for two sets of keys. You can customize KEY_FILENAMES to create as many sets as needed. With multiple sets of keys you have more control over who gets to see what.

Disadvantages

• Limited support for lookup types. The "query value" is the hash not the decrypted secret, so Django lookups like ['startswith', 'istartswith', 'endswith', 'iendswith', 'contains', 'icontains', 'iexact'] are not supported.
• Hashing with a secret may be considered less secure than just a "secret". You decide what your requirements are. For systems that collect PII in fields classes from django-crypto-fields, we take all the basic security precautions: OS and application-level password protection, Full-Drive encryption, physical security and so on.

Other encrypted field modules are available if you just want to use encrypted field classes in Django models and do not need unique constraints nor plan to join tables on encrypted fields for analysis.

Contribute

• Issue Tracker: github.com/erikvw/django-crypto-fields/issues
• Source Code: github.com/erikvw/django-crypto-fields

.. _ClinicEDC: https://github.com/clinicedc

.. |pypi| image:: https://img.shields.io/pypi/v/django-crypto-fields.svg :target: https://pypi.python.org/pypi/django-crypto-fields

.. |actions| image:: https://github.com/erikvw/django-crypto-fields/actions/workflows/build.yml/badge.svg :target: https://github.com/erikvw/django-crypto-fields/actions/workflows/build.yml

.. |codecov| image:: https://codecov.io/gh/erikvw/django-crypto-fields/branch/develop/graph/badge.svg :target: https://codecov.io/gh/erikvw/django-crypto-fields

.. |downloads| image:: https://pepy.tech/badge/django-crypto-fields :target: https://pepy.tech/project/django-crypto-fields

.. |maintainability| image:: https://api.codeclimate.com/v1/badges/34293a3ec19da8d7fb16/maintainability :target: https://codeclimate.com/github/erikvw/django-crypto-fields/maintainability :alt: Maintainability

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Code Style