Add a new module for better ensuring privacy of user data.

Review Request #9893 — Created April 25, 2018 and submitted


This introduces djblets.privacy, a new module designed for more easily
ensuring protection of private user data, helping Django applications to
meet GDPR compliance and to otherwise help with the management and
safe-keeping of user data.

This initial version of the module focuses on consent tracking, giving
users control over operations or processing of data. It's designed to
allow applications (and even extensions) to dynamically register things
that require consent, to check if the user granted/denied that consent,
to (later) present options for consent, and to keep an audit log for
later proof. For now, only the backend is in place, with UI helpers
coming later.

This lives almost exclusively within the djblets.privacy.consent
module (with models living in djblets.privacy.models). There are a few

  • Consent: An enum containing values to represent whether
    consent was given or denied, or simply not set yet.

  • ConsentRequirement: Represents a part of a product that requires
    consent. This can be instantiated with a unique ID, displayable name
    and description, and an optional URL for learning more about the
    requirement (useful for linking to privacy policies or documentation).

  • ConsentRequirementsRegistry: Used to register, track, and look up
    ConsentRequirement instances.

  • ConsentData: An object for store consent and consent-related
    information (timestamp, source of where the consent was given, and
    additional data to include), for serializing or deserializing.

  • BaseConsentTracker/DatabaseConsentTracker: Used to record if
    consent was given or denied for a requirement, check that consent on
    demand, and for keeping an audit log for helping to later document and
    prove when users set, denied, or revoked consent. By default,
    DatabaseConsentTracker (which stores the data in the database) is
    used, but projects can make use of custom ones for storing the audit
    data in other locations outside the database.

With this module, it will be very easy to start enforcing user control
of the processing of data without a lot of additional work.

Future changes will build on this to offer standard UI for consent
management and redacting of personal information before sending to

Unit tests pass.

Built the docs and checked for build and generation errors.

  • 0
  • 0
  • 15
  • 1
  • 16
Description From Last Updated
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.


    1. Thanks for the review!

  2. djblets/privacy/consent/ (Diff revision 2)

    On Python2, UNSET will literally be 0, but using enum, it will be a Consent object with a value attribute = 0.

    Is this difference in behaviour going to cause issues?

    enum.Enum also provides default __str__ etc impls, which this will lack.

    1. We're comparing the objects directly (we're not serializing the values) so I think it will be fine.

      I might introduce a dependency on enum34, but am hesitant to do it in this change.

  3. djblets/privacy/consent/ (Diff revision 2)

    Instead of doing this pattern (which I know I started), should we do the following?

        'key': 'value',

    Also, should we just have this defined on the class (as default_errors)?

    1. Probably to both.

      I have some other thoughts on improving errors, but perhaps a topic for another day.

  4. djblets/privacy/consent/ (Diff revision 2)

    Is it cool that we use PII here? Should this be hash(email)?

    1. It is cool because of consent audit tracking responsibilities, but I was thinking about this earlier and agree, we should use a hash. Planning to update this change later today with a few additional changes.

  2. djblets/privacy/consent/ (Diff revision 3)

    Needs a module docstring.

  2. docs/djblets/glossary.rst (Diff revision 5)

    Let's say "EU" residents instead of "European"

  1. Ship It!
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-1.0.x (e42d0d1)