django-nacl-fields 1.0.1

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

~ pip install django-nacl-fields

Create a key to be used for encryption.

~ python manage.py createkey
# put the following line in your settings.py:
NACL_FIELDS_KEY = 'cGa9QJDY/FJhbITXHnrIqlgyeLDS04/WqWtgqPEIU4A='

In your settings.py (or append it automatically after generation using the -f flag)

NACL_FIELDS_KEY = 'cGa9QJDY/FJhbITXHnrIqlgyeLDS04/WqWtgqPEIU4A='

Then, in your models.py

from django.db import models
from nacl_encrypted_fields import NaClTextField


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

Use your model as normal and your data will be 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.

Available Fields

Currently build in and unit-tested fields.

• NaClCharField

• NaClTextField

• NaClDateTimeField

• NaClIntegerField

• NaClFloatField

• NaClEmailField

• NaClBooleanField

Encrypt Your Own Fields

Making new fields can be done by using the build-in NaClFieldMixin:

from django.db import models
from nacl_encrypted_fields import NaClFieldMixin

class EncryptedIPAddressField(NaClFieldMixin, models.IPAddressField):
        pass

Please report any issues you encounter when trying this.

References

• https://github.com/defrex/django-encrypted-fields

• https://github.com/orcasgit/django-fernet-fields