Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coldmind/django-postgres-pgpfields
PGP encrypted fields, which are encrypted by the pgcrypto postgres extension.
https://github.com/coldmind/django-postgres-pgpfields
Last synced: 24 days ago
JSON representation
PGP encrypted fields, which are encrypted by the pgcrypto postgres extension.
- Host: GitHub
- URL: https://github.com/coldmind/django-postgres-pgpfields
- Owner: coldmind
- License: mit
- Archived: true
- Created: 2015-07-09T21:21:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-03T18:18:00.000Z (over 7 years ago)
- Last Synced: 2024-11-15T21:49:07.569Z (27 days ago)
- Language: Python
- Size: 172 KB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - django-postgres-pgpfields - PGP encrypted fields, which are encrypted by the pgcrypto postgres extension. (Python)
README
# django-postgres-pgpfields [](https://travis-ci.org/coldmind/django-postgres-pgpfields?branch=master)
Inspired by and partially forked https://github.com/incuna/django-pgcrypto-fields.
Improved to have ability to decrypt at select time instead of
generating dozens of requests when serializing big amount of data.
Also more useful fields was added here.
`django-postgres-pgpfields` is a `Django` collection of fields,
which are encrypted by PGP keys using `pgcrypto` extenstion
of PostgreSQL.
#### Requirements
- python 2.7 or 3.4
- postgres with installed `pgcrypto` extension
- working public and private PGP keys
#### Installation
```
pip install django-postgres-pgpfields
```
or install it directly from github.
#### Configuration
Define next in `settings.py`:
```python
PGPFIELDS_PUBLIC_KEY = "your public key here"
PGPFIELDS_PRIVATE_KEY = "your privatekey here"
```
Optional settings:
```python
# Add 'django_postgres_pgpfields' to INSTALLED_APPS to create
# the extension for pgcrypto (it is located in a migration).
INSTALLED_APPS = (
...
'django_postgres_pgpfields',
...
)
# If you want to bypass raising exception
# when accessing non-decrypted field.
PGPFIELDS_BYPASS_NON_DECRYPTED_FIELD_EXCEPTION = False
# Since django versions <1.8 have no support of
# Manager.use_in_migrations, you can bypass raising exception
# when accessing non-decrypted field inside some migration.
PGPFIELDS_BYPASS_FIELD_EXCEPTION_IN_MIGRATIONS = False
```
#### Usage
List of available fields.
- `TextPGPPublicKeyField`
- `EmailPGPPublicKeyField`
- `IntegerPGPPublicKeyField`
- `DatePGPPublicKeyField`
- `NullBooleanPGPPublicKeyField`
Fields are located at `django_postgres_pgpfields.fields`.
Your data will be automatically encrypted by using any of
encrypted fields. To have ability to decrypt data, you **must**
define the `django_postgres_pgpfields.managers.PGPEncryptedManager`
manager in your model.
It is not necessary to override default django manager, but if
you will try access encrypted field, when data was obtained not by
`PGPEncryptedManager`, `ValueError` will be raised (if not bypassed
by settings).