Skip to main content

A Django model field that encrypt your data when save to and decrypt when get from database. It keeps data always encrypted in database.

Project description



A Django model field that encrypt your data when save to and decrypt when get from database. It keeps data always encrypted in database. Base on symmetric encryption, it support query the origin text and return encrypted objects in Django.


  • 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
  • Use AES-256-ECB algorithm
  • Support PostgreSQL and MySQL database
  • Support Django model field db_index and unique attributes


pip install django-mirage-field


from mirage import fields
class TestModel(models.Model):
    phone = fields.EncryptedIntegerField()
obj = TestModel.objects.get(phone=18866677777)          # 123       # 18866677777
type( # int
database=# select * from testmodel where id = 123;
         id          |           phone
 123 | -bYijegsEDrmS1s7ilnspA==
from mirage.crypto import Crypto
c = Crypto(key="")                      # key is optional, default will use settings.SECRET_KEY
c.encrypt('18866677777')                # -bYijegsEDrmS1s7ilnspA==
c.decrypt('-bYijegsEDrmS1s7ilnspA==')   # 18866677777


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

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

Model Fields

  1. EncryptedTextField
  2. EncryptedCharField
  3. EncryptedEmailField
  4. EncryptedIntegerField

Data Migrate


1. Migrations

add app_name,model_name,field_name in migrations.RunPython

from import Migrator

migrations.RunPython(Migrator("app_name", "model_name", "field_name").encrypt, reverse_code=Migrator("app_name", 'model_name', 'field_name').decrypt),

2. Commands


  • --app
  • --model
  • --field
  • --method (optional: encrypt, decrypt, encrypt_to, decrypt_to, copy_to)
  • --tofield (need when use encryt_to, decrypt_to, copy_to method)

Optional options:

  • --offset ("select * from xxx where id > offset")
  • --total ("select * from xxx order by id limit total")
  • --limit: set the query count in every update, default is 1000, if you set -1, mirage will query all rows one time to update.


./ mirage --app=yourapp --model=testmodel --field=address --method=encrypt --offset=2000000 --total=3000000

./ mirage --app=yourapp --model=testmodel --field=address --method=encrypt_to --tofield=encrypted_address


from mirage import exceptions
  1. EncryptedFieldException


Migrate data: 6000,000 columns takes 40 minutes, Average 1 column/2.5ms

Only encrypt/decrypt: Average 1 value/ms


Project details

Download files

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

Files for django-mirage-field, version 1.1.6
Filename, size File type Python version Upload date Hashes
Filename, size django-mirage-field-1.1.6.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page