django-mirage-field

NOTE!!!

The maintainer tcitry has resigned from luojilab, he won't contribute this project ever, the latest code please refer: tcitry/django-mirage-field.

Introduce

A Django model fields collection that encrypt your data when save to and decrypt when get from database. It keeps data always encrypted in database. Base on AES, it supports query method like get() and filter() in Django.

Mirage can also migrate data from origin column to encrypted column in database with a good performance.

Features

• Use settings.SECRET_KEY as secret key default or anyelse which length >= 32
• Support CharField, TextField, IntegerField, EmailField
• Support Django ORM's get(), filter() query method
• Support AES-256-ECB and AES-256-CBC(v1.2.0)
• Support PostgreSQL and MySQL database
• Support Django model field db_index and unique attributes

Installation

pip install django-mirage-field

Usage

from mirage import fields
class TestModel(models.Model):
    age = fields.EncryptedIntegerField()

obj = TestModel.objects.get(age=18)
obj.id          # 1
obj.age         # 18
type(obj.age)   # int

database=# select * from testmodel where id = 1;
         id          |           age
---------------------+--------------------------
 1 | -bYijegsEDrmS1s7ilnspA==

from mirage.crypto import Crypto
c = Crypto()                      # key is optional, default will use settings.SECRET_KEY
c.encrypt('some_address')               # -bYijegsEDrmS1s7ilnspA==
c.decrypt('-bYijegsEDrmS1s7ilnspA==')   # some_address

Settings

• MIRAGESECRETKEY
• MIRAGECIPHERMODE (v1.2.0+)
• MIRAGECIPHERIV (v1.2.0+)

MIRAGESECRETKEY

You can use the settings.SECRETKEY as default key, if you want custom another key for mirage, set the MIRAGESECRET_KEY in settings.

Mirage will get the settings.MIRAGESECRETKEY first, if not set, mirage will get the settings.SECRET_KEY.

MIRAGECIPHERMODE

MIRAGECIPHERMODE is optional, choices are below, If don't set, default is ECB.

• ECB
• CBC

MIRAGECIPHERIV

MIRAGECIPHERIV is optional, if you don't set, it will use a default: "1234567890abcdef", it's length must be 16.

Model Fields

• EncryptedTextField
• EncryptedCharField
• EncryptedEmailField
• EncryptedIntegerField
• EncryptedURLField(v1.3.0+)

Data Migrate

AddmiragetoINSTALLED_APPS

Way 1. Migrations

add appname,modelname,fieldname in migrations.RunPython

from mirage.tools import Migrator
migrations.RunPython(Migrator("appname", "modelname", "fieldname").encrypt, reversecode=Migrator("appname", 'modelname', 'field_name').decrypt),

./manage.py mirage --app=yourapp --model=testmodel --field=address --method=encrypt --offset=2000000 --total=3000000
./manage.py mirage --app=yourapp --model=testmodel --field=address --method=encryptto --tofield=encryptedaddress

from mirage import exceptions