Implement DatePGPPublicKeyField and DateTimePGPPublicKeyField (#57) (#58)

* Fixes #57: Implemented DatePGPPublicKeyField and DateTimePGPPublicKeyField

Author: peterfarrell

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Updated out-dated requirements (latest versions of Flake8 and pycodestyle 
 are incompatible with each other)
 * Updated README with better explanations of the fields
+* Implemented DatePGPPublicKeyField and DateTimePGPPublicKeyField
 
 ## 2.1.1
 

README.md

@@ -43,13 +43,25 @@ Supported PGP public key fields are:
  - `EmailPGPPublicKeyField`
  - `IntegerPGPPublicKeyField`
  - `TextPGPPublicKeyField`
+ - `DatePGPPublicKeyField`
+ - `DateTimePGPPublicKeyField`
 
 Public key encryption creates a token generated with a public key to
 encrypt the data and a private key to decrypt it.
 
 Public and private keys can be set in settings with `PUBLIC_PGP_KEY` and
 `PRIVATE_PGP_KEY`.
 
+N.B. `DatePGPPublicKeyField` and `DateTimePGPPublicKeyField` only support the following lookups:
+
+- `__exact`
+- `__gt`
+- `__gte`
+- `__lt`
+- `__lte`
+
+There is no support for `__range` yet (SQL `BETWEEN`). Pull requests are welcome.
+
 ##### Generate GPG keys.
 
 The public key is going to encrypt the message and the private key will be
@@ -93,7 +105,7 @@ N.B. `DatePGPSymmetricKeyField` and `DateTimePGPSymmetricKeyField` only support
 - `__lt`
 - `__lte`
 
-There is no support for `__range` yet (SQL `BETWEEN`).
+There is no support for `__range` yet (SQL `BETWEEN`). Pull requests are welcome.
 
 ### Django settings
 
@@ -141,8 +153,13 @@ class MyModel(models.Model):
     hmac_field = fields.TextHMACField()
     hmac_with_original_field = fields.TextHMACField(original='pgp_sym_field')
 
+    email_pgp_pub_field = fields.EmailPGPPublicKeyField()
     integer_pgp_pub_field = fields.IntegerPGPPublicKeyField()
     pgp_pub_field = fields.TextPGPPublicKeyField()
+    date_pgp_pub_field = fields.DatePGPPublicKeyField()
+    datetime_pgp_pub_field = fields.DateTimePGPPublicKeyField()
+    
+    email_pgp_sym_field = fields.EmailPGPSymmetricKeyField()
     integer_pgp_sym_field = fields.IntegerPGPSymmetricKeyField()
     pgp_sym_field = fields.TextPGPSymmetricKeyField()
     date_pgp_sym_field = fields.DatePGPSymmetricKeyField()

pgcrypto/admin.py

@@ -1,4 +1,4 @@
-class PGPAdmin(object):
+class PGPAdmin(object):  # pragma: no cover
 
     def get_queryset(self, request):
         """Skip any auto decryption when ORM calls are from the admin."""

pgcrypto/aggregates.py

@@ -50,7 +50,7 @@ class EncryptionBase(Aggregate):
     """Base class to add a custom aggregate method to a query."""
 
     def add_to_query(self, query, alias, col, source, is_summary):
-        """Add the aggregate to the query.
+        """Add the aggregate to the query. This method will be removed in Django 1.10.
 
         `alias` is `{self.lookup}__decrypt` where 'decrypt' is `self.name.lower()`.
 
@@ -83,6 +83,20 @@ class PGPSymmetricKeyAggregate(PGPSymmetricKeySQL, EncryptionBase):
     name = 'decrypted'
 
 
+class DatePGPPublicKeyAggregate(EncryptionBase):
+    """PGP public key based aggregation.
+
+    `pgp_sym_encrypt` is a pgcrypto functions, encrypts the field's value
+    with a key.
+    """
+    name = 'decrypted'
+    sql = PGPPublicKeySQL
+    function = 'pgp_pub_decrypt'
+    template = "cast(%(function)s(%(field)s, dearmor('{}')) AS DATE)".format(
+        settings.PRIVATE_PGP_KEY,
+    )
+
+
 class DatePGPSymmetricKeyAggregate(EncryptionBase):
     """PGP symmetric key based aggregation.
 
@@ -97,6 +111,20 @@ class DatePGPSymmetricKeyAggregate(EncryptionBase):
     )
 
 
+class DateTimePGPPublicKeyAggregate(EncryptionBase):
+    """PGP public key based aggregation.
+
+    `pgp_sym_encrypt` is a pgcrypto functions, encrypts the field's value
+    with a key.
+    """
+    name = 'decrypted'
+    sql = PGPPublicKeySQL
+    function = 'pgp_pub_decrypt'
+    template = "cast(%(function)s(%(field)s, dearmor('{}')) AS TIMESTAMP)".format(
+        settings.PRIVATE_PGP_KEY,
+    )
+
+
 class DateTimePGPSymmetricKeyAggregate(EncryptionBase):
     """PGP symmetric key based aggregation.
 

pgcrypto/fields.py

@@ -9,21 +9,33 @@
     PGP_SYM_ENCRYPT_SQL,
 )
 from pgcrypto.lookups import (
-    DateEXACT,
-    DateGT,
-    DateGTE,
-    DateLT,
-    DateLTE,
-    DateTimeEXACT,
-    DateTimeGT,
-    DateTimeGTE,
-    DateTimeLT,
-    DateTimeLTE,
+    DatePGPPublicKeyEXACT,
+    DatePGPPublicKeyGT,
+    DatePGPPublicKeyGTE,
+    DatePGPPublicKeyLT,
+    DatePGPPublicKeyLTE,
+    DatePGPSymmetricKeyEXACT,
+    DatePGPSymmetricKeyGT,
+    DatePGPSymmetricKeyGTE,
+    DatePGPSymmetricKeyLT,
+    DatePGPSymmetricKeyLTE,
+    DateTimePGPPublicKeyEXACT,
+    DateTimePGPPublicKeyGT,
+    DateTimePGPPublicKeyGTE,
+    DateTimePGPPublicKeyLT,
+    DateTimePGPPublicKeyLTE,
+    DateTimePGPSymmetricKeyEXACT,
+    DateTimePGPSymmetricKeyGT,
+    DateTimePGPSymmetricKeyGTE,
+    DateTimePGPSymmetricKeyLT,
+    DateTimePGPSymmetricKeyLTE,
     DigestLookup,
     HMACLookup,
 )
 from pgcrypto.mixins import (
+    DatePGPPublicKeyFieldMixin,
     DatePGPSymmetricKeyFieldMixin,
+    DateTimePGPPublicKeyFieldMixin,
     DateTimePGPSymmetricKeyFieldMixin,
     EmailPGPPublicKeyFieldMixin,
     EmailPGPSymmetricKeyFieldMixin,
@@ -64,6 +76,32 @@ class TextPGPPublicKeyField(PGPPublicKeyFieldMixin, models.TextField):
     encrypt_sql = PGP_PUB_ENCRYPT_SQL
 
 
+class DatePGPPublicKeyField(DatePGPPublicKeyFieldMixin, models.TextField):
+    """Date PGP public key encrypted field for postgres."""
+    encrypt_sql = PGP_PUB_ENCRYPT_SQL
+    cast_sql = 'cast(%s as DATE)'
+
+
+DatePGPPublicKeyField.register_lookup(DatePGPPublicKeyEXACT)
+DatePGPPublicKeyField.register_lookup(DatePGPPublicKeyGT)
+DatePGPPublicKeyField.register_lookup(DatePGPPublicKeyGTE)
+DatePGPPublicKeyField.register_lookup(DatePGPPublicKeyLT)
+DatePGPPublicKeyField.register_lookup(DatePGPPublicKeyLTE)
+
+
+class DateTimePGPPublicKeyField(DateTimePGPPublicKeyFieldMixin, models.TextField):
+    """DateTime PGP public key encrypted field for postgres."""
+    encrypt_sql = PGP_PUB_ENCRYPT_SQL
+    cast_sql = 'cast(%s as TIMESTAMP)'
+
+
+DateTimePGPPublicKeyField.register_lookup(DateTimePGPPublicKeyEXACT)
+DateTimePGPPublicKeyField.register_lookup(DateTimePGPPublicKeyGT)
+DateTimePGPPublicKeyField.register_lookup(DateTimePGPPublicKeyGTE)
+DateTimePGPPublicKeyField.register_lookup(DateTimePGPPublicKeyLT)
+DateTimePGPPublicKeyField.register_lookup(DateTimePGPPublicKeyLTE)
+
+
 class EmailPGPSymmetricKeyField(EmailPGPSymmetricKeyFieldMixin, models.EmailField):
     """Email PGP symmetric key encrypted field."""
     encrypt_sql = PGP_SYM_ENCRYPT_SQL
@@ -85,11 +123,11 @@ class DatePGPSymmetricKeyField(DatePGPSymmetricKeyFieldMixin, models.TextField):
     cast_sql = 'cast(%s as DATE)'
 
 
-DatePGPSymmetricKeyField.register_lookup(DateEXACT)
-DatePGPSymmetricKeyField.register_lookup(DateGT)
-DatePGPSymmetricKeyField.register_lookup(DateGTE)
-DatePGPSymmetricKeyField.register_lookup(DateLT)
-DatePGPSymmetricKeyField.register_lookup(DateLTE)
+DatePGPSymmetricKeyField.register_lookup(DatePGPSymmetricKeyEXACT)
+DatePGPSymmetricKeyField.register_lookup(DatePGPSymmetricKeyGT)
+DatePGPSymmetricKeyField.register_lookup(DatePGPSymmetricKeyGTE)
+DatePGPSymmetricKeyField.register_lookup(DatePGPSymmetricKeyLT)
+DatePGPSymmetricKeyField.register_lookup(DatePGPSymmetricKeyLTE)
 
 
 class DateTimePGPSymmetricKeyField(DateTimePGPSymmetricKeyFieldMixin, models.TextField):
@@ -98,8 +136,8 @@ class DateTimePGPSymmetricKeyField(DateTimePGPSymmetricKeyFieldMixin, models.Tex
     cast_sql = 'cast(%s as TIMESTAMP)'
 
 
-DateTimePGPSymmetricKeyField.register_lookup(DateTimeEXACT)
-DateTimePGPSymmetricKeyField.register_lookup(DateTimeGT)
-DateTimePGPSymmetricKeyField.register_lookup(DateTimeGTE)
-DateTimePGPSymmetricKeyField.register_lookup(DateTimeLT)
-DateTimePGPSymmetricKeyField.register_lookup(DateTimeLTE)
+DateTimePGPSymmetricKeyField.register_lookup(DateTimePGPSymmetricKeyEXACT)
+DateTimePGPSymmetricKeyField.register_lookup(DateTimePGPSymmetricKeyGT)
+DateTimePGPSymmetricKeyField.register_lookup(DateTimePGPSymmetricKeyGTE)
+DateTimePGPSymmetricKeyField.register_lookup(DateTimePGPSymmetricKeyLT)
+DateTimePGPSymmetricKeyField.register_lookup(DateTimePGPSymmetricKeyLTE)