django-x509 1.2

DJANGO_X509_DEFAULT_CERT_VALIDITY

创建新的 x509 证书时的默认有效期（天数）。

DJANGO_X509_DEFAULT_CA_VALIDITY

创建新的证书颁发机构时的默认有效期（天数）。

DJANGO_X509_DEFAULT_KEY_LENGTH

新 CA 和新证书的默认密钥长度。

必须是以下值之一

• 512

• 1024

• 2048

• 4096

DJANGO_X509_DEFAULT_DIGEST_ALGORITHM

新 CA 和新证书的默认摘要算法。

必须是以下值之一

• sha1

• sha224

• sha256

• sha384

• sha512

DJANGO_X509_CA_BASIC_CONSTRAINTS_CRITICAL

在创建新的 CA 时，是否必须将 basicConstraint x509 扩展标记为“关键”。

DJANGO_X509_CA_BASIC_CONSTRAINTS_PATHLEN

创建新的 CA 时使用的 basicConstraint x509 扩展的 pathLenConstraint 的值。

当此值为正 int 时，它表示在有效的认证路径中可能跟随生成的证书的非自签发中间证书的最大数量。

将此值设置为 None 以避免施加任何限制。

DJANGO_X509_CA_KEYUSAGE_CRITICAL

是否将 keyUsage x509 扩展标记为“关键”以用于新的 CA。

DJANGO_X509_CA_KEYUSAGE_VALUE

新 CA 的 keyUsage x509 扩展的值。

DJANGO_X509_CERT_KEYUSAGE_CRITICAL

是否将 keyUsage x509 扩展标记为“关键”以用于新的终端实体证书。

DJANGO_X509_CERT_KEYUSAGE_VALUE

新终端实体证书的 keyUsage x509 扩展的值。

DJANGO_X509_CRL_PROTECTED

是否应使用身份验证保护下载证书吊销列表的视图。

1. 初始化您的自定义模块

您需要做的第一件事是创建一个新的django应用程序，该应用程序将包含您自己的django-x509版本。

django应用程序只是一个python包（一个python脚本目录），在以下示例中，我们将此django应用程序称为myx509，但您可以根据需要命名。

django-admin startapp myx509

请注意，上述命令必须在目录中调用，该目录可在您的PYTHON_PATH中可用，以便您可以将结果导入到项目中。

现在您需要将myx509添加到您的settings.py中的INSTALLED_APPS，并确保已删除django_x509。

INSTALLED_APPS = [
    # ... other apps ...
    # 'django_x509'  <-- comment out or delete this line
    "myx509"
]

有关如何使用django项目和django应用程序的更多信息，请参阅django文档。

2. 安装 django-x509 及 openwisp-utils

安装（并将其添加到项目的需求中）

pip install django-x509 openwisp-utils

3. 添加 EXTENDED_APPS

将以下内容添加到您的settings.py

EXTENDED_APPS = ["django_x509"]

4. 添加 openwisp_utils.staticfiles.DependencyFinder

将openwisp_utils.staticfiles.DependencyFinder添加到您的settings.py中的STATICFILES_FINDERS。

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

5. 添加 openwisp_utils.loaders.DependencyLoader

将openwisp_utils.loaders.DependencyLoader添加到您的settings.py中的TEMPLATES。

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",
            ],
        },
    }
]

6. 继承 AppConfig 类

请参阅测试项目示例应用程序中的以下文件

• sample_x509/__init__.py.

• sample_x509/apps.py.

您必须在项目中复制并修改这些代码。

有关AppConfig概念的更多信息，请参阅django文档中的“应用程序”部分。

7. 创建您的自定义模型

这里我们提供了一个如何扩展django-x509基模型的示例。我们添加了一个简单的“详细信息”字段来展示修改。

from django.db import models
from django_x509.base.models import AbstractCa, AbstractCert


class DetailsModel(models.Model):
    details = models.CharField(max_length=64, blank=True, null=True)

    class Meta:
        abstract = True


class Ca(DetailsModel, AbstractCa):
    """
    Concrete Ca model
    """

    class Meta(AbstractCa.Meta):
        abstract = False


class Cert(DetailsModel, AbstractCert):
    """
    Concrete Cert model
    """

    class Meta(AbstractCert.Meta):
        abstract = False

您可以在类似的方式中在您的models.py文件中添加字段。

注意：有关如何使用、扩展或开发模型的疑问，请参阅django文档中的“模型”部分。

8. 添加 swapper 配置

创建模型后，将以下内容添加到您的settings.py

# Setting models for swapper module
DJANGO_X509_CA_MODEL = "myx509.Ca"
DJANGO_X509_CERT_MODEL = "myx509.Cert"

将myx509替换为步骤1中选择的名称。

9. 创建数据库迁移

创建并应用数据库迁移

./manage.py makemigrations
./manage.py migrate

有关更多信息，请参阅django文档中的“迁移”部分。

10. 创建管理员界面

参考示例应用程序的admin.py文件。

要向管理员引入更改，您可以通过以下两种主要方式之一进行操作，以下将描述这些方式。

注意：有关django管理员的工作方式或如何自定义的更多信息，请参阅django文档中的“django管理员站点”部分。

from django_x509.admin import CaAdmin, CertAdmin

CaAdmin.list_display.insert(
    1, "my_custom_field"
)  # <-- your custom change example
CertAdmin.list_display.insert(
    1, "my_custom_field"
)  # <-- your custom change example

from django.contrib import admin
from swapper import load_model

from django_x509.base.admin import AbstractCaAdmin, AbstractCertAdmin

Ca = load_model("django_x509", "Ca")
Cert = load_model("django_x509", "Cert")


class CertAdmin(AbstractCertAdmin):
    pass
    # add your changes here


class CaAdmin(AbstractCaAdmin):
    pass
    # add your changes here


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

11. 创建根 URL 配置

请参考测试项目中的 urls.py 文件。

有关 django 中 URL 配置的更多信息，请参阅 django 文档中的“URL 分派器”部分。

12. 导入自动化测试

在基于此模块开发自定义应用程序时，导入并运行基本测试也是一个好主意，这样您可以确保您引入的更改不会破坏 django-x509 的某些现有功能。

如果您需要添加破坏性更改，您可以覆盖基类中定义的测试以测试您自己的行为。

from django.test import TestCase
from django_x509.tests.base import TestX509Mixin
from django_x509.tests.test_admin import (
    ModelAdminTests as BaseModelAdminTests,
)
from django_x509.tests.test_ca import TestCa as BaseTestCa
from django_x509.tests.test_cert import TestCert as BaseTestCert


class ModelAdminTests(BaseModelAdminTests):
    app_label = "myx509"


class TestCert(BaseTestCert):
    pass


class TestCa(BaseTestCa):
    pass


del BaseModelAdminTests
del BaseTestCa
del BaseTestCert

现在，您可以使用以下命令运行测试

# the --parallel flag is optional
./manage.py test --parallel myx509

将myx509替换为步骤1中选择的名称。

有关 django 中自动化测试的更多信息，请参阅 “Django 测试”。