Skip to content
Auditing Utilities for Django+CouchDBKit
Python HTML JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
auditcare
.gitignore
MANIFEST.in
README.rst
__init__.py
requirements.txt
setup.py

README.rst

Dimagi Auditcare

A set of simple auditing tools for Dimagi's CommCareHQ and its related technologies.

All audits events inherit from the AuditEvent model which contains some basic audit information.

What It does

  • Log Views (NavigationEventAudit)
    • Directly with a view decorator
    • Centrally with a middelware and a settings parameter listing the fully qualified view names
  • Centrally log model saves (ModelActionAudit) via attaching signals from a settings parameter

  • Uses threadlocals for accessing the user in said signals

  • Login/Logout and failed login attempts (AccessAudit)

Requirements

Auditcare relies on dimagi-utils and couchdbkit

Usage

To turn on auditing, you'll need to add a few settings to your settings.py file.

To your INSTALLED_APPS, add the 'auditcare' app.

To setup couchdb, you need to use dimagi's convention for connecting to CouchDB. Specifically:

settings.COUCH_SERVER_ROOT='127.0.0.1:5984'

COUCH_USERNAME = 'foo'

COUCH_PASSWORD = 'bar'

COUCH_DATABASE_NAME = 'foobardb'

COUCHDB_APPS = ['auditcare', ...]

####### Couch Forms & Couch DB Kit Settings ####### def get_server_url(server_root, username, password):

if username and password:
return "http://%(user)s:%(pass)s@%(server)s" %
{"user": username,
"pass": password, "server": server_root }
else:
return "http://%(server)s" % {"server": server_root }

COUCH_SERVER = get_server_url(COUCH_SERVER_ROOT, COUCH_USERNAME, COUCH_PASSWORD)

COUCH_DATABASE = "%(server)s/%(database)s" % {"server": COUCH_SERVER, "database": COUCH_DATABASE_NAME }

View Audits

To your MIDDLEWARE_CLASSES, add 'auditcare.middleware.AuditMiddleware', to the END of the list.

Add an array, AUDIT_VIEWS = []. The elements of this list should be the fully qualified viewnames of the views you want to log and audit.

Login/Logout Events

By default the django standard login/logout views will be audited. In order for unit tests to pass, the url path /accounts/login (The default login url) will be overrided via a url. Calling a reverse to django.contrib.auth.views.login will not trigger auditing due to the way in which monkeypatching interferes with unit tests with reverse()

Model Saves

By default, the setting AUDIT_DJANGO_USER is set to True, you will need to explicitly set it to false.

For django models you want to audit the save event of, add the fully qualified model name to the AUDIT_MODEL_SAVE array.

This auditing application also audits the save events of couchdbkit Document models too.

You can also audit the admin views by specifying specific AUDIT_ADMIN_VIEWS = []. If this setting is not in the settings variable, it'll default to auditing ALL admin views.

Finally, to get it all working, be sure to add the auditcare app to your couchdbkit setup for django.

Adding your own AuditEvent

  1. Make a new model that inherits from AuditEvent
  2. Make a classmethod for generating the audit event
  3. Attach the auditevent to the AuditEvent manager (this will allow simple access to the audit methods without needing to import your namespaces)
Something went wrong with that request. Please try again.