{ "info": { "author": "tcitry", "author_email": "tcitry@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Framework :: Django :: 2.0", "Framework :: Django :: 2.1", "Framework :: Django :: 2.2", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP" ], "description": "# django-mirage-field\n\n![](https://img.shields.io/pypi/v/django-mirage-field.svg?label=django-mirage-field)\n\n## Introduce\n\nA 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.\n\n## Support\n\n* Use settings.SECRET_KEY as secret key default or anyelse which length >= 32\n* Support CharField\u3001TextField\u3001IntegerField\u3001EmailField\n* Support Django ORM's `get()`\u3001`filter()` query method\n* Use AES-256-ECB algorithm\n* Support PostgreSQL and MySQL database\n* Support Django model field `db_index` and `unique` attributes\n\n## Installation\n\n```bash\npip install django-mirage-field\n```\n\n## Usage\n\n```python\nfrom mirage import fields\nclass TestModel(models.Model):\n phone = fields.EncryptedIntegerField()\n```\n\n```python\nobj = TestModel.objects.get(phone=18866677777)\nobj.id # 123\nobj.phone # 18866677777\ntype(obj.phone) # int\n```\n\n```psql\ndatabase=# select * from testmodel where id = 123;\n id | phone\n---------------------+--------------------------\n 123 | -bYijegsEDrmS1s7ilnspA==\n```\n\n```python\nfrom mirage.crypto import Crypto\nc = Crypto(key=\"\") # key is optional, default will use settings.SECRET_KEY\nc.encrypt('18866677777') # -bYijegsEDrmS1s7ilnspA==\nc.decrypt('-bYijegsEDrmS1s7ilnspA==') # 18866677777\n```\n\n## Model Fields\n\n1. EncryptedTextField\n2. EncryptedCharField\n3. EncryptedEmailField\n4. EncryptedIntegerField\n\n## Data Migrate\n\nAdd`mirage`to`INSTALLED_APPS`\n\n### 1. Migrations\n\nadd `app_name`,`model_name`,`field_name` in [migrations.RunPython](https://docs.djangoproject.com/en/2.2/ref/migration-operations/#runpython)\n\n```\nfrom mirage.tools import Migrator\n\nmigrations.RunPython(Migrator(\"app_name\", \"model_name\", \"field_name\").encrypt, reverse_code=Migrator(\"app_name\", 'model_name', 'field_name').decrypt),\n```\n\n### 2. Commands\n\nOptions:\n\n* --app\n* --model\n* --field\n* --method (optional: `encrypt`, `decrypt`, `encrypt_to`, `decrypt_to`, `copy`)\n* --tofield (need when use `encryt_to`, `decrypt_to`, `copy` method)\n\nOptional options:\n\n* --offset (\"select * from xxx where id > offset\")\n* --total (\"select * from xxx order by id limit total\")\n\nExamples\n\n```\n./manage.py mirage --app=yourapp --model=testmodel --field=address --method=encrypt --offset=2000000 --total=3000000\n\n./manage.py mirage --app=yourapp --model=testmodel --field=address --method=encrypt_to --tofield=encrypted_address\n\n```\n\n## Exceptions\n\n```\nfrom mirage import exceptions\n```\n\n1. EncryptedFieldException\n\n## Performance\n\nMigrate data: 6000,000 columns takes 40 minutes, Average 1 column/2.5ms\n\nOnly encrypt/decrypt: Average 1 value/ms\n\n## Clients\n\n* [Java](https://github.com/luojilab/django-mirage-field/tree/master/client/java)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/luojilab/django-mirage-field", "keywords": "", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "django-mirage-field", "package_url": "https://pypi.org/project/django-mirage-field/", "platform": "", "project_url": "https://pypi.org/project/django-mirage-field/", "project_urls": { "Homepage": "https://github.com/luojilab/django-mirage-field" }, "release_url": "https://pypi.org/project/django-mirage-field/0.0.3/", "requires_dist": null, "requires_python": "", "summary": "A Django model field that encrypt your data when save to and decrypt when get from database. It keeps data always encrypted in database.", "version": "0.0.3" }, "last_serial": 5849004, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "5cacaaf2e0c27100265efe954d7da0cd", "sha256": "994b531f451a34f2285b4b2d58830bc56d38dee3242a1be659a8522aff926b4d" }, "downloads": -1, "filename": "django-mirage-field-0.0.1.tar.gz", "has_sig": false, "md5_digest": "5cacaaf2e0c27100265efe954d7da0cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5965, "upload_time": "2019-04-26T07:27:11", "url": "https://files.pythonhosted.org/packages/68/47/6b5fed24c0a96b36f62bbaa3821370d8804c5e0a3112bbd58476d27b83bc/django-mirage-field-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "09af190f6b0131299c875b38ad2f3f91", "sha256": "b703cf5ae9a700bd701fa5cdcd85aa932c829a41bf9d9abd646cab0eb74a5e86" }, "downloads": -1, "filename": "django-mirage-field-0.0.2.tar.gz", "has_sig": false, "md5_digest": "09af190f6b0131299c875b38ad2f3f91", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5965, "upload_time": "2019-04-28T04:59:08", "url": "https://files.pythonhosted.org/packages/0d/0c/6fd6cfc2c57538d2c10282cfd337681a390c722f7274b8dfa10be89d06cf/django-mirage-field-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "7d2a1cb1a45e06ef5833057ba602913f", "sha256": "55033664d0ace037c8e1e19ade23f8a529da0098a646fade128d67aa07ab207f" }, "downloads": -1, "filename": "django-mirage-field-0.0.3.tar.gz", "has_sig": false, "md5_digest": "7d2a1cb1a45e06ef5833057ba602913f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6218, "upload_time": "2019-09-18T09:40:36", "url": "https://files.pythonhosted.org/packages/d0/90/19df9916927a85c89d3fe2aa037a01b1e99818dea5ba0e2db116173f3bf0/django-mirage-field-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7d2a1cb1a45e06ef5833057ba602913f", "sha256": "55033664d0ace037c8e1e19ade23f8a529da0098a646fade128d67aa07ab207f" }, "downloads": -1, "filename": "django-mirage-field-0.0.3.tar.gz", "has_sig": false, "md5_digest": "7d2a1cb1a45e06ef5833057ba602913f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6218, "upload_time": "2019-09-18T09:40:36", "url": "https://files.pythonhosted.org/packages/d0/90/19df9916927a85c89d3fe2aa037a01b1e99818dea5ba0e2db116173f3bf0/django-mirage-field-0.0.3.tar.gz" } ] }