Skip to main content

This is a collection of Django Model Field classes that are encrypted using PyNaCl.

Project description

Django NaCl Encrypted Fields

GitHub Actions: test GitHub Actions: lint Documentation Status

This is a collection of Django Model Field classes that are encrypted using PyNaCl. This package is largely based on django-encrypted-fields, which makes use of the outdated Keyczar library to encrypt fields. Besides that, it is inspired by django-fernet-field.

About PyNaCl

PyNaCl is a Python binding to libsodium, which is a fork of the Networking and Cryptography library. These libraries have a stated goal of improving usability, security and speed.

Getting Started

Install django-nacl-fields:

pip install django-nacl-fields

Add nacl_encrypted_fields to your INSTALLED_APPS:


Create a key to be used for encryption:

$ python createkey
# put the following line in your
NACL_FIELDS_KEY = b'p1Et2Rb@;^BYdo`ZRFi!Hc-MXu(^|bVqA-FGqffM'

In your

NACL_FIELDS_KEY = b'p1Et2Rb@;^BYdo`ZRFi!Hc-MXu(^|bVqA-FGqffM'

Then, in your

from django.db import models
from nacl_encrypted_fields.fields import NaClTextField

class MyModel(models.Model):
    text_field = NaClTextField()

Use the model as you would normally and the data will be stored encrypted in the database.

Note: Encrypted data cannot be used to query or sort. In SQL, these will all look like text fields with random text.

It is also possible to append the fields key to your settings file automatically upon creation, by using the -f flag:

python createkey -f

Where is the path to your settings file.

Available Fields

Currently build-in and unit-tested fields.

  • NaClCharField
  • NaClTextField
  • NaClDateTimeField
  • NaClIntegerField
  • NaClFloatField
  • NaClEmailField
  • NaClBooleanField
  • NaClJSONField

Encrypt Your Own Fields

Making new fields can be done by using the provided NaClFieldMixin:

from django.db import models
from nacl_encrypted_fields import NaClFieldMixin

class NaClIPAddressField(NaClFieldMixin, models.IPAddressField):

Please report any issues you encounter when trying this.


Start a PostgreSQL Docker container for testing using:

docker run --rm -e POSTGRES_PASSWORD=postgres POSTGRES_DB=github_actions postgres

Then, you can run tests in another window using:

python -m venv env
source env/bin/activate
pip install '.[test]'
python test

Before you contribute, make sure you lint your code:

pip install '.[lint]'
flake8 --exclude .git,pycache,docs/,build,dist,env

After you code is done, free free to open a new pull request.


Download files

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

Source Distribution

django-nacl-fields-4.1.0.tar.gz (14.5 kB view hashes)

Uploaded source

Built Distribution

django_nacl_fields-4.1.0-py3-none-any.whl (12.9 kB view hashes)

Uploaded py3

Supported by

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