Skip to main content

Reusable django app to generate and manage x509 certificates

Project description Requirements Status

Simple reusable django app implementing x509 PKI certificates management.

Want to help OpenWISP? Find out how to help us grow here.

Current features

  • CA generation
  • Import existing CAs
  • End entity certificate generation
  • Import existing certificates
  • Certificate revocation
  • CRL view (public or protected)
  • Possibility to specify x509 extensions on each certificate
  • Random serial numbers based on uuid4 integers (see why is this a good idea)

Project goals

  • provide a simple and reusable x509 PKI management django app
  • provide abstract models that can be imported and extended in larger django projects


  • Python 2.7 or Python >= 3.4
  • OpenSSL

Install stable version from pypi

Install from pypi:

pip install django-x509

Install development version

Install tarball:

pip install

Alternatively you can install via pip using git:

pip install -e git+git://

If you want to contribute, install your cloned fork:

git clone<your_fork>/django-x509.git
cd django-x509
python develop

Setup (integrate in an existing django project)

Add django_x509 to INSTALLED_APPS:

    # other apps

Add the URLs to your main

urlpatterns = [
    # ... other urls in your project ...

    # django-x509 urls
    # keep the namespace argument unchanged
    url(r'^', include('django_x509.urls', namespace='x509')),

Then run:

./ migrate

Installing for development

Install sqlite:

sudo apt-get install sqlite3 libsqlite3-dev

Install your forked repo:

git clone git://<your_fork>/django-x509
cd django-x509/
python develop

Install test requirements:

pip install -r requirements-test.txt

Create database:

cd tests/
./ migrate
./ createsuperuser

Launch development server:

./ runserver

You can access the admin interface at

Run tests with:


Install and run on docker

Build from docker file:

sudo docker build -t openwisp/djangox509 .

Run the docker container:

sudo docker run -it -p 8000:8000 openwisp/djangox509



type: int
default: 365

Default validity period (in days) when creating new x509 certificates.


type: int
default: 3650

Default validity period (in days) when creating new Certification Authorities.


type: int
default: 2048

Default key length for new CAs and new certificates.

Must be one of the following values:

  • 512
  • 1024
  • 2048
  • 4096


type: str
default: sha256

Default digest algorithm for new CAs and new certificates.

Must be one of the following values:

  • sha1
  • sha224
  • sha256
  • sha384
  • sha512


type: bool
default: True

Whether the basicConstraint x509 extension must be flagged as critical when creating new CAs.


type: int or None
default: 0

Value of the pathLenConstraint of basicConstraint x509 extension used when creating new CAs.

When this value is a positive int it represents the maximum number of non-self-issued intermediate certificates that may follow the generated certificate in a valid certification path.

Set this value to None to avoid imposing any limit.


type: bool
default: True

Whether the keyUsage x509 extension should be flagged as “critical” for new CAs.


type: str
default: cRLSign, keyCertSign

Value of the keyUsage x509 extension for new CAs.


type: bool
default: False

Whether the keyUsage x509 extension should be flagged as “critical” for new end-entity certificates.


type: str
default: digitalSignature, keyEncipherment

Value of the keyUsage x509 extension for new end-entity certificates.


type: bool
default: False

Whether the view for downloading Certificate Revocation Lists should be protected with authentication or not.

Extending django-x509

django-x509 provides a set of models and admin classes which can be imported, extended and reused by third party apps.

To extend django-x509, you MUST NOT add it to settings.INSTALLED_APPS, but you must create your own app (which goes into settings.INSTALLED_APPS), import the base classes from django-x509 and add your customizations.

In order to help django find the static files and templates of django-x509, you need to perform the steps described below.

1. Install openwisp-utils

Install (and add to the requirement of your project) openwisp-utils:

pip install openwisp-utils


Add the following to your

EXTENDED_APPS = ('django_x509',)

3. Add openwisp_utils.staticfiles.DependencyFinder

Add openwisp_utils.staticfiles.DependencyFinder to STATICFILES_FINDERS in your


4. Add openwisp_utils.loaders.DependencyLoader

Add openwisp_utils.loaders.DependencyLoader to TEMPLATES in your

        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'OPTIONS': {
            'loaders': [
            'context_processors': [

Extending models

This example provides an example of how to extend the base models of django-x509 by adding a relation to another django model named Organization.

# of your app
from django.db import models
from django_x509.base.models import AbstractCa, AbstractCert

# the model ``organizations.Organization`` is omitted for brevity
# if you are curious to see a real implementation, check out django-organizations

class OrganizationMixin(models.Model):
    organization = models.ForeignKey('organizations.Organization')

    class Meta:
        abstract = True

class Ca(OrganizationMixin, AbstractCa):
    class Meta(AbstractCa.Meta):
        abstract = False

    def clean(self):
        # your own validation logic here...

class Cert(OrganizationMixin, AbstractCert):
    ca = models.ForeignKey(Ca)

    class Meta(AbstractCert.Meta):
        abstract = False

    def clean(self):
        # your own validation logic here...

Extending the admin

Following the previous Organization example, you can avoid duplicating the admin code by importing the base admin classes and registering your models with.

# of your app
from django.contrib import admin

from django_x509.base.admin import CaAdmin as BaseCaAdmin
from django_x509.base.admin import CertAdmin as BaseCertAdmin

from .models import Ca, Cert

class CaAdmin(BaseCaAdmin):
    # extend/modify the default behaviour here

class CertAdmin(BaseCertAdmin):
    # extend/modify the default behaviour here
    pass, CaAdmin), CertAdmin)


Please read the OpenWISP contributing guidelines and also keep in mind the following:

  1. Announce your intentions in the OpenWISP Mailing List
  2. Fork this repo and install it
  3. Follow PEP8, Style Guide for Python Code
  4. Write code
  5. Write tests for your code
  6. Ensure all tests pass
  7. Ensure test coverage does not decrease
  8. Document your changes
  9. Send pull request





Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_x509-0.4.1-py2.py3-none-any.whl (35.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3
django-x509-0.4.1.tar.gz (31.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page