netbox-plugin-dns 1.2.5__py3-none-any.whl → 1.2.7b2__py3-none-any.whl

netbox_dns/migrations/0015_dnssec.py

@@ -0,0 +1,168 @@
+# Generated by Django 5.1.6 on 2025-03-04 12:09
+
+import django.db.models.deletion
+import netbox_dns.fields.choice_array
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("extras", "0122_charfield_null_choices"),
+        ("netbox_dns", "0014_alter_unique_constraints_lowercase"),
+        ("tenancy", "0017_natural_ordering"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="DNSSECKeyTemplate",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("name", models.CharField(max_length=255)),
+                ("description", models.CharField(blank=True, max_length=200)),
+                ("type", models.CharField(max_length=3)),
+                ("lifetime", models.PositiveIntegerField(blank=True, null=True)),
+                ("algorithm", models.CharField()),
+                ("key_size", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "tenant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="netbox_dns_dnssec_key_templates",
+                        to="tenancy.tenant",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "DNSSEC Key Template",
+                "verbose_name_plural": "DNSSEC Key Templates",
+                "ordering": ("name",),
+                "unique_together": {("name", "type")},
+            },
+        ),
+        migrations.CreateModel(
+            name="DNSSECPolicy",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=200)),
+                ("dnskey_ttl", models.PositiveIntegerField(blank=True, null=True)),
+                ("purge_keys", models.PositiveIntegerField(blank=True, null=True)),
+                ("publish_safety", models.PositiveIntegerField(blank=True, null=True)),
+                ("retire_safety", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "signatures_jitter",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                (
+                    "signatures_refresh",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                (
+                    "signatures_validity",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                (
+                    "signatures_validity_dnskey",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                ("max_zone_ttl", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "zone_propagation_delay",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                ("create_cdnskey", models.BooleanField(default=True)),
+                (
+                    "cds_digest_types",
+                    netbox_dns.fields.choice_array.ChoiceArrayField(
+                        base_field=models.CharField(),
+                        blank=True,
+                        default=list,
+                        null=True,
+                        size=None,
+                    ),
+                ),
+                ("parent_ds_ttl", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "parent_propagation_delay",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                ("use_nsec3", models.BooleanField(default=True)),
+                (
+                    "nsec3_iterations",
+                    models.PositiveIntegerField(blank=True, null=True),
+                ),
+                ("nsec3_opt_out", models.BooleanField(default=False)),
+                ("nsec3_salt_size", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "key_templates",
+                    models.ManyToManyField(
+                        blank=True,
+                        related_name="policies",
+                        to="netbox_dns.dnsseckeytemplate",
+                    ),
+                ),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "tenant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="netbox_dns_dnssec_policy",
+                        to="tenancy.tenant",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "DNSSEC Policy",
+                "verbose_name_plural": "DNSSEC Policies",
+                "ordering": ("name",),
+            },
+        ),
+    ]

netbox_dns/migrations/0016_dnssec_policy_status.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.7 on 2025-03-09 18:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_dns", "0015_dnssec"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="dnssecpolicy",
+            name="status",
+            field=models.CharField(default="active"),
+        ),
+    ]

netbox_dns/migrations/0017_dnssec_policy_zone_zone_template.py

@@ -0,0 +1,41 @@
+# Generated by Django 5.1.6 on 2025-03-10 15:40
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_dns", "0016_dnssec_policy_status"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="zone",
+            name="dnssec_policy",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="zones",
+                to="netbox_dns.dnssecpolicy",
+            ),
+        ),
+        migrations.AddField(
+            model_name="zone",
+            name="inline_signing",
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AddField(
+            model_name="zonetemplate",
+            name="dnssec_policy",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="zone_templates",
+                to="netbox_dns.dnssecpolicy",
+            ),
+        ),
+    ]

netbox_dns/models/__init__.py

@@ -6,3 +6,5 @@ from .registration_contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *
+from .dnssec_key_template import *
+from .dnssec_policy import *

netbox_dns/models/dnssec_key_template.py

@@ -0,0 +1,114 @@
+from django.db import models
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+from netbox.models import NetBoxModel
+from netbox.search import SearchIndex, register_search
+from netbox.models.features import ContactsMixin
+
+from netbox_dns.choices import (
+    DNSSECKeyTemplateTypeChoices,
+    DNSSECKeyTemplateAlgorithmChoices,
+    DNSSECKeyTemplateKeySizeChoices,
+)
+from netbox_dns.validators import validate_key_template
+
+
+__all__ = (
+    "DNSSECKeyTemplate",
+    "DNSSECKeyTemplateIndex",
+)
+
+
+class DNSSECKeyTemplate(ContactsMixin, NetBoxModel):
+    name = models.CharField(
+        verbose_name=_("Name"),
+        max_length=255,
+    )
+    description = models.CharField(
+        verbose_name=_("Description"),
+        max_length=200,
+        blank=True,
+    )
+
+    type = models.CharField(
+        verbose_name=_("Type"),
+        choices=DNSSECKeyTemplateTypeChoices,
+        max_length=3,
+        blank=False,
+        null=False,
+    )
+    lifetime = models.PositiveIntegerField(
+        verbose_name=_("Lifetime"),
+        blank=True,
+        null=True,
+    )
+    algorithm = models.CharField(
+        verbose_name=_("Algorithm"),
+        choices=DNSSECKeyTemplateAlgorithmChoices,
+        blank=False,
+        null=False,
+    )
+    key_size = models.PositiveIntegerField(
+        verbose_name=_("Key Size"),
+        choices=DNSSECKeyTemplateKeySizeChoices,
+        blank=True,
+        null=True,
+    )
+
+    tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="netbox_dns_dnssec_key_templates",
+        blank=True,
+        null=True,
+    )
+
+    clone_fields = (
+        "description",
+        "type",
+        "lifetime",
+        "algorithm",
+        "key_size",
+        "tenant",
+    )
+
+    class Meta:
+        verbose_name = _("DNSSEC Key Template")
+        verbose_name_plural = _("DNSSEC Key Templates")
+        unique_together = (
+            "name",
+            "type",
+        )
+
+        ordering = ("name",)
+
+    def __str__(self):
+        return f"{str(self.name)} [{self.type}]"
+
+    # TODO: Remove in version 1.3.0 (NetBox #18555)
+    def get_absolute_url(self):
+        return reverse("plugins:netbox_dns:dnsseckeytemplate", kwargs={"pk": self.pk})
+
+    def get_type_color(self):
+        return DNSSECKeyTemplateTypeChoices.colors.get(self.type)
+
+    def clean(self, *args, **kwargs):
+        super().clean(*args, **kwargs)
+
+        validate_key_template(self)
+
+    def save(self, *args, **kwargs):
+        validate_key_template(self)
+
+        super().save(*args, **kwargs)
+
+
+@register_search
+class DNSSECKeyTemplateIndex(SearchIndex):
+    model = DNSSECKeyTemplate
+    fields = (
+        ("name", 100),
+        ("description", 500),
+    )

netbox_dns/models/dnssec_policy.py

@@ -0,0 +1,201 @@
+from django.db import models
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+from netbox.models import NetBoxModel
+from netbox.search import SearchIndex, register_search
+from netbox.models.features import ContactsMixin
+from netbox.plugins.utils import get_plugin_config
+
+from netbox_dns.choices import DNSSECPolicyDigestChoices, DNSSECPolicyStatusChoices
+from netbox_dns.fields import ChoiceArrayField
+
+
+__all__ = (
+    "DNSSECPolicy",
+    "DNSSECPolicyIndex",
+)
+
+
+class DNSSECPolicy(ContactsMixin, NetBoxModel):
+    name = models.CharField(
+        verbose_name=_("Name"),
+        max_length=255,
+        unique=True,
+    )
+    description = models.CharField(
+        verbose_name=_("Description"),
+        max_length=200,
+        blank=True,
+    )
+    status = models.CharField(
+        verbose_name=_("Status"),
+        choices=DNSSECPolicyStatusChoices,
+        default=DNSSECPolicyStatusChoices.STATUS_ACTIVE,
+        blank=False,
+        null=False,
+    )
+
+    key_templates = models.ManyToManyField(
+        verbose_name=_("Key Templates"),
+        to="DNSSECKeyTemplate",
+        related_name="policies",
+        blank=True,
+    )
+    dnskey_ttl = models.PositiveIntegerField(
+        verbose_name=_("DNSKEY TTL"),
+        blank=True,
+        null=True,
+    )
+    purge_keys = models.PositiveIntegerField(
+        verbose_name=_("Purge Keys"),
+        blank=True,
+        null=True,
+    )
+    publish_safety = models.PositiveIntegerField(
+        verbose_name=_("Publish Safety"),
+        blank=True,
+        null=True,
+    )
+    retire_safety = models.PositiveIntegerField(
+        verbose_name=_("Retire Safety"),
+        blank=True,
+        null=True,
+    )
+    signatures_jitter = models.PositiveIntegerField(
+        verbose_name=_("Signatures Jitter"),
+        blank=True,
+        null=True,
+    )
+    signatures_refresh = models.PositiveIntegerField(
+        verbose_name=_("Signatures Refresh"),
+        blank=True,
+        null=True,
+    )
+    signatures_validity = models.PositiveIntegerField(
+        verbose_name=_("Signatures Validity"),
+        blank=True,
+        null=True,
+    )
+    signatures_validity_dnskey = models.PositiveIntegerField(
+        verbose_name=_("Signatures Validity for DNSKEY"),
+        blank=True,
+        null=True,
+    )
+    max_zone_ttl = models.PositiveIntegerField(
+        verbose_name=_("Max Zone TTL"),
+        blank=True,
+        null=True,
+    )
+    zone_propagation_delay = models.PositiveIntegerField(
+        verbose_name=_("Zone Propagation Delay"),
+        blank=True,
+        null=True,
+    )
+
+    create_cdnskey = models.BooleanField(
+        verbose_name=_("Create CDNSKEY"),
+        null=False,
+        default=True,
+    )
+    cds_digest_types = ChoiceArrayField(
+        base_field=models.CharField(
+            choices=DNSSECPolicyDigestChoices,
+        ),
+        verbose_name=_("CDS Digest Types"),
+        blank=True,
+        null=True,
+        default=list,
+    )
+    parent_ds_ttl = models.PositiveIntegerField(
+        verbose_name=_("Parent DS TTL"),
+        blank=True,
+        null=True,
+    )
+    parent_propagation_delay = models.PositiveIntegerField(
+        verbose_name=_("Parent Propagation Delay"),
+        blank=True,
+        null=True,
+    )
+
+    use_nsec3 = models.BooleanField(
+        verbose_name=_("Use NSEC3"),
+        null=False,
+        default=True,
+    )
+    nsec3_iterations = models.PositiveIntegerField(
+        verbose_name=_("NSEC3 Iterations"),
+        blank=True,
+        null=True,
+    )
+    nsec3_opt_out = models.BooleanField(
+        verbose_name=_("NSEC3 Opt-Out"),
+        blank=False,
+        null=False,
+        default=False,
+    )
+    nsec3_salt_size = models.PositiveIntegerField(
+        verbose_name=_("NSEC3 Salt Size"),
+        blank=True,
+        null=True,
+    )
+
+    tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="netbox_dns_dnssec_policy",
+        blank=True,
+        null=True,
+    )
+
+    clone_fields = (
+        "name",
+        "key_templates",
+        "description",
+        "tenant",
+    )
+
+    class Meta:
+        verbose_name = _("DNSSEC Policy")
+        verbose_name_plural = _("DNSSEC Policies")
+
+        ordering = ("name",)
+
+    def __str__(self):
+        return str(self.name)
+
+    def get_status_color(self):
+        return DNSSECPolicyStatusChoices.colors.get(self.status)
+
+    # TODO: Remove in version 1.3.0 (NetBox #18555)
+    def get_absolute_url(self):
+        return reverse("plugins:netbox_dns:dnssecpolicy", kwargs={"pk": self.pk})
+
+    @property
+    def purge_keys_value(self):
+        return self.purge_keys if self.purge_keys is not None else 776000
+
+    @property
+    def publish_safety_value(self):
+        return self.publish_safety if self.publish_safety is not None else 3600
+
+    def get_effective_value(self, attribute):
+        default_value = get_plugin_config("netbox_dns", f"dnssec_{attribute}", None)
+
+        if not hasattr(self, attribute):
+            raise AttributeError(f"DNSSECPolicy does not have attribute {attribute}")
+
+        if (value := getattr(self, attribute)) is None:
+            return default_value
+
+        return value
+
+
+@register_search
+class DNSSECPolicyIndex(SearchIndex):
+    model = DNSSECPolicy
+    fields = (
+        ("name", 100),
+        ("description", 500),
+    )

netbox_dns/models/zone.py

@@ -97,6 +97,11 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         max_length=255,
         db_collation="natural_sort",
     )
+    description = models.CharField(
+        verbose_name=_("Description"),
+        max_length=200,
+        blank=True,
+    )
     status = models.CharField(
         verbose_name=_("Status"),
         max_length=50,
@@ -170,25 +175,19 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         help_text=_("Automatically generate the SOA serial number"),
         default=True,
     )
-    description = models.CharField(
-        verbose_name=_("Description"),
-        max_length=200,
-        blank=True,
-    )
-    arpa_network = NetworkField(
-        verbose_name=_("ARPA Network"),
-        help_text=_("Network related to a reverse lookup zone (.arpa)"),
-        blank=True,
-        null=True,
-    )
-    tenant = models.ForeignKey(
-        verbose_name=_("Tenant"),
-        to="tenancy.Tenant",
+    dnssec_policy = models.ForeignKey(
+        verbose_name=_("DNSSEC Policy"),
+        to="DNSSECPolicy",
         on_delete=models.PROTECT,
-        related_name="netbox_dns_zones",
+        related_name="zones",
         blank=True,
         null=True,
     )
+    inline_signing = models.BooleanField(
+        verbose_name=_("Inline Signing"),
+        help_text=_("Use inline signing for DNSSEC"),
+        default=True,
+    )
     registrar = models.ForeignKey(
         verbose_name=_("Registrar"),
         to="Registrar",
@@ -255,12 +254,27 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         blank=True,
         null=True,
     )
+    arpa_network = NetworkField(
+        verbose_name=_("ARPA Network"),
+        help_text=_("Network related to a reverse lookup zone (.arpa)"),
+        blank=True,
+        null=True,
+    )
+    tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="netbox_dns_zones",
+        blank=True,
+        null=True,
+    )
 
     objects = ZoneManager()
 
     clone_fields = (
         "view",
         "name",
+        "description",
         "status",
         "nameservers",
         "default_ttl",
@@ -271,7 +285,6 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         "soa_retry",
         "soa_expire",
         "soa_minimum",
-        "description",
         "tenant",
     )
 

netbox_dns/models/zone_template.py

@@ -55,11 +55,11 @@ class ZoneTemplate(NetBoxModel):
         related_name="zone_templates",
         blank=True,
     )
-    tenant = models.ForeignKey(
-        verbose_name=_("Tenant"),
-        to="tenancy.Tenant",
+    dnssec_policy = models.ForeignKey(
+        verbose_name=_("DNSSEC Policy"),
+        to="DNSSECPolicy",
         on_delete=models.SET_NULL,
-        related_name="+",
+        related_name="zone_templates",
         blank=True,
         null=True,
     )
@@ -103,28 +103,38 @@ class ZoneTemplate(NetBoxModel):
         blank=True,
         null=True,
     )
+    tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
+        to="tenancy.Tenant",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
 
     clone_fields = (
         "description",
         "nameservers",
         "record_templates",
-        "tenant",
+        "dnssec_policy",
         "registrar",
         "registrant",
         "admin_c",
         "tech_c",
         "billing_c",
+        "tenant",
     )
 
     template_fields = (
         "soa_mname",
         "soa_rname",
-        "tenant",
+        "dnssec_policy",
         "registrar",
         "registrant",
         "admin_c",
         "tech_c",
         "billing_c",
+        "tenant",
     )
 
     class Meta: