django-x509 0.6.2

DJANGO_X509_DEFAULT_CERT_VALIDITY

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

DJANGO_X509_DEFAULT_CA_VALIDITY

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

DJANGO_X509_DEFAULT_KEY_LENGTH

Default key length for new CAs and new certificates.

Must be one of the following values:

• 512

• 1024

• 2048

• 4096

DJANGO_X509_DEFAULT_DIGEST_ALGORITHM

Default digest algorithm for new CAs and new certificates.

Must be one of the following values:

• sha1

• sha224

• sha256

• sha384

• sha512

DJANGO_X509_CA_BASIC_CONSTRAINTS_CRITICAL

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

DJANGO_X509_CA_BASIC_CONSTRAINTS_PATHLEN

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.

DJANGO_X509_CA_KEYUSAGE_CRITICAL

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

DJANGO_X509_CA_KEYUSAGE_VALUE

Value of the keyUsage x509 extension for new CAs.

DJANGO_X509_CERT_KEYUSAGE_CRITICAL

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

DJANGO_X509_CERT_KEYUSAGE_VALUE

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

DJANGO_X509_CRL_PROTECTED

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

1. Install openwisp-utils

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

pip install openwisp-utils

2. Add EXTENDED_APPS

Add the following to your settings.py:

EXTENDED_APPS = ('django_x509',)

3. Add openwisp_utils.staticfiles.DependencyFinder

Add openwisp_utils.staticfiles.DependencyFinder to STATICFILES_FINDERS in your settings.py:

STATICFILES_FINDERS = [
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    'openwisp_utils.staticfiles.DependencyFinder',
]

4. Add openwisp_utils.loaders.DependencyLoader

Add openwisp_utils.loaders.DependencyLoader to TEMPLATES in your settings.py:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'OPTIONS': {
            'loaders': [
                'django.template.loaders.filesystem.Loader',
                'django.template.loaders.app_directories.Loader',
                'openwisp_utils.loaders.DependencyLoader',
            ],
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    }
]

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.

# models.py 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...
        pass


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

    class Meta(AbstractCert.Meta):
        abstract = False

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

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.

# admin.py 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
    pass


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


admin.site.register(Ca, CaAdmin)
admin.site.register(Cert, CertAdmin)