netbox-plugin-dns 1.1.3__py3-none-any.whl → 1.1.5__py3-none-any.whl

netbox_dns/models/record_template.py

@@ -133,17 +133,17 @@ class RecordTemplate(NetBoxModel):
                     {
                         "record_name": exc,
                     }
-                ) from None
+                )
 
     def validate_value(self):
         try:
-            validate_record_value(self.type, self.value)
+            validate_record_value(self)
         except ValidationError as exc:
-            raise ValidationError({"value": exc}) from None
+            raise ValidationError({"value": exc})
 
     def matching_records(self, zone):
-        return Record.objects.filter(
-            zone=zone, name=self.record_name, type=self.type, value=self.value
+        return zone.record_set.filter(
+            name=self.record_name, type=self.type, value=self.value
         )
 
     def create_record(self, zone):

netbox_dns/models/view.py

@@ -2,7 +2,6 @@ from django.db import models
 from django.urls import reverse
 from django.core.exceptions import ValidationError
 from django.utils.translation import gettext_lazy as _
-from django.utils.translation import pgettext_lazy as _p
 
 from netbox.models import NetBoxModel
 from netbox.models.features import ContactsMixin
@@ -77,8 +76,8 @@ class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         return str(self.name)
 
     class Meta:
-        verbose_name = _p("DNS", "View")
-        verbose_name_plural = _p("DNS", "Views")
+        verbose_name = _("View")
+        verbose_name_plural = _("Views")
 
         ordering = ("name",)
 

netbox_dns/models/zone.py

@@ -12,12 +12,12 @@ from django.core.validators import (
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.db import models, transaction
 from django.db.models import Q, Max, ExpressionWrapper, BooleanField
-from django.urls import reverse
+from django.db.models.functions import Length
 from django.db.models.signals import m2m_changed
+from django.urls import reverse
 from django.dispatch import receiver
 from django.conf import settings
 from django.utils.translation import gettext_lazy as _
-from django.utils.translation import pgettext_lazy as _p
 
 from netbox.models import NetBoxModel
 from netbox.models.features import ContactsMixin
@@ -35,6 +35,7 @@ from netbox_dns.utilities import (
     arpa_to_prefix,
     name_to_unicode,
     normalize_name,
+    get_parent_zone_names,
     NameFormatError,
 )
 from netbox_dns.validators import (
@@ -53,6 +54,9 @@ __all__ = (
     "ZoneIndex",
 )
 
+ZONE_ACTIVE_STATUS_LIST = get_plugin_config("netbox_dns", "zone_active_status")
+RECORD_ACTIVE_STATUS_LIST = get_plugin_config("netbox_dns", "record_active_status")
+
 
 class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
     """
@@ -65,15 +69,13 @@ class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
             .get_queryset()
             .annotate(
                 active=ExpressionWrapper(
-                    Q(status__in=Zone.ACTIVE_STATUS_LIST), output_field=BooleanField()
+                    Q(status__in=ZONE_ACTIVE_STATUS_LIST), output_field=BooleanField()
                 )
             )
         )
 
 
 class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
-    ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
-
     def __init__(self, *args, **kwargs):
         kwargs.pop("template", None)
 
@@ -83,7 +85,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         self._ip_addresses_checked = False
 
     view = models.ForeignKey(
-        verbose_name=_p("DNS", "View"),
+        verbose_name=_("View"),
         to="View",
         on_delete=models.PROTECT,
         null=False,
@@ -297,13 +299,27 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
         return str(name)
 
+    @property
+    def fqdn(self):
+        return f"{self.name}."
+
     @staticmethod
     def get_defaults():
+        default_fields = (
+            "zone_default_ttl",
+            "zone_soa_ttl",
+            "zone_soa_serial",
+            "zone_soa_refresh",
+            "zone_soa_retry",
+            "zone_soa_expire",
+            "zone_soa_minimum",
+            "zone_soa_rname",
+        )
+
         return {
             field[5:]: value
             for field, value in settings.PLUGINS_CONFIG.get("netbox_dns").items()
-            if field.startswith("zone_")
-            and field not in ("zone_soa_mname", "zone_nameservers")
+            if field in default_fields
         }
 
     @property
@@ -337,7 +353,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
     @property
     def is_active(self):
-        return self.status in Zone.ACTIVE_STATUS_LIST
+        return self.status in ZONE_ACTIVE_STATUS_LIST
 
     @property
     def is_reverse_zone(self):
@@ -352,10 +368,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             return None
 
         return (
-            Zone.objects.filter(
-                view=self.view,
-                arpa_network__net_contains=self.rfc2317_prefix,
-            )
+            self.view.zone_set.filter(arpa_network__net_contains=self.rfc2317_prefix)
             .order_by("arpa_network__net_mask_length")
             .last()
         )
@@ -376,25 +389,73 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
     @property
     def child_zones(self):
-        return Zone.objects.filter(
-            name__iregex=rf"^[^.]+\.{re.escape(self.name)}$", view=self.view
+        return self.view.zone_set.filter(
+            name__iregex=rf"^[^.]+\.{re.escape(self.name)}$"
         )
 
+    @property
+    def descendant_zones(self):
+        return self.view.zone_set.filter(name__endswith=f".{self.name}")
+
     @property
     def parent_zone(self):
-        parent_name = (
-            dns_name.from_text(self.name).parent().relativize(dns_name.root).to_text()
-        )
         try:
-            return Zone.objects.get(name=parent_name, view=self.view)
-        except Zone.DoesNotExist:
+            return self.view.zone_set.get(name=get_parent_zone_names(self.name)[-1])
+        except (Zone.DoesNotExist, IndexError):
             return None
 
-    def record_count(self, managed=False):
-        return Record.objects.filter(zone=self, managed=managed).count()
+    @property
+    def ancestor_zones(self):
+        return (
+            self.view.zone_set.annotate(name_length=Length("name"))
+            .filter(name__in=get_parent_zone_names(self.name))
+            .order_by("name_length")
+        )
 
-    def rfc2317_child_zone_count(self):
-        return Zone.objects.filter(rfc2317_parent_zone=self).count()
+    @property
+    def delegation_records(self):
+        descendant_zone_names = [
+            f"{name}." for name in self.descendant_zones.values_list("name", flat=True)
+        ]
+
+        ns_records = (
+            self.record_set.filter(type=RecordTypeChoices.NS)
+            .exclude(fqdn=self.fqdn)
+            .filter(fqdn__in=descendant_zone_names)
+        )
+        ns_values = [record.value_fqdn for record in ns_records]
+
+        return (
+            ns_records
+            | self.record_set.filter(type=RecordTypeChoices.DS)
+            | self.record_set.filter(
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
+                fqdn__in=ns_values,
+            )
+        )
+
+    @property
+    def ancestor_delegation_records(self):
+        ancestor_zones = self.ancestor_zones
+
+        ns_records = Record.objects.filter(
+            type=RecordTypeChoices.NS, zone__in=ancestor_zones, fqdn=self.fqdn
+        )
+        ns_values = [record.value_fqdn for record in ns_records]
+
+        ds_records = Record.objects.filter(
+            type=RecordTypeChoices.DS, zone__in=ancestor_zones, fqdn=self.fqdn
+        )
+
+        return (
+            ns_records
+            | ds_records
+            | Record.objects.filter(
+                zone__in=ancestor_zones,
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
+                fqdn__in=ns_values,
+            )
+        )
 
     def update_soa_record(self):
         soa_name = "@"
@@ -472,9 +533,8 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 continue
 
             relative_name = name.relativize(parent).to_text()
-            address_records = Record.objects.filter(
-                Q(zone=ns_zone),
-                Q(status__in=Record.ACTIVE_STATUS_LIST),
+            address_records = ns_zone.record_set.filter(
+                Q(status__in=RECORD_ACTIVE_STATUS_LIST),
                 Q(Q(name=f"{_nameserver.name}.") | Q(name=relative_name)),
                 Q(Q(type=RecordTypeChoices.A) | Q(type=RecordTypeChoices.AAAA)),
             )
@@ -630,7 +690,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 {
                     "name": str(exc),
                 }
-            ) from None
+            )
 
         try:
             validate_domain_name(self.name, zone_name=True)
@@ -639,7 +699,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 {
                     "name": exc,
                 }
-            ) from None
+            )
 
         if self.soa_rname in (None, ""):
             raise ValidationError(_("soa_rname not set and no default value defined"))
@@ -651,7 +711,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 {
                     "soa_rname": exc,
                 }
-            ) from None
+            )
 
         if not self.soa_serial_auto:
             if self.soa_serial is None:
@@ -735,8 +795,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             else:
                 self.rfc2317_parent_zone = None
 
-            overlapping_zones = Zone.objects.filter(
-                view=self.view,
+            overlapping_zones = self.view.zone_set.filter(
                 rfc2317_prefix__net_overlap=self.rfc2317_prefix,
                 active=True,
             ).exclude(pk=self.pk)
@@ -769,9 +828,8 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         if (
             changed_fields is None or {"name", "view", "status"} & changed_fields
         ) and self.is_reverse_zone:
-            zones = Zone.objects.filter(
-                view=self.view,
-                arpa_network__net_contains_or_equals=self.arpa_network,
+            zones = self.view.zone_set.filter(
+                arpa_network__net_contains_or_equals=self.arpa_network
             )
             address_records = Record.objects.filter(
                 Q(ptr_record__isnull=True) | Q(ptr_record__zone__in=zones),
@@ -800,9 +858,8 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             or {"name", "view", "status", "rfc2317_prefix", "rfc2317_parent_managed"}
             & changed_fields
         ) and self.is_rfc2317_zone:
-            zones = Zone.objects.filter(
-                view=self.view,
-                arpa_network__net_contains=self.rfc2317_prefix,
+            zones = self.view.zone_set.filter(
+                arpa_network__net_contains=self.rfc2317_prefix
             )
             address_records = Record.objects.filter(
                 Q(ptr_record__isnull=True)
@@ -883,7 +940,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 cname_zone.update_soa_record()
 
             rfc2317_child_zones = list(
-                self.rfc2317_child_zones.all().values_list("pk", flat=True)
+                self.rfc2317_child_zones.values_list("pk", flat=True)
             )
 
             ipam_ip_addresses = list(

netbox_dns/signals/ipam_dnssync.py

@@ -63,7 +63,7 @@ def ipam_dnssync_ipaddress_post_clean(instance, **kwargs):
                     {
                         "dns_name": _(
                             "Unique DNS records are enforced and there is already "
-                            "an active IP address {address} with DNS name {name}. Plesase choose "
+                            "an active IP address {address} with DNS name {name}. Please choose "
                             "a different name or disable record creation for this IP address."
                         ).format(address=instance.address, name=instance.dns_name)
                     }

netbox_dns/tables/record.py

@@ -1,7 +1,6 @@
 import django_tables2 as tables
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
-from django.utils.translation import pgettext_lazy as _p
 
 
 from netbox.tables import (
@@ -20,6 +19,7 @@ __all__ = (
     "RecordTable",
     "ManagedRecordTable",
     "RelatedRecordTable",
+    "DelegationRecordTable",
 )
 
 
@@ -29,7 +29,7 @@ class RecordBaseTable(TenancyColumnsMixin, NetBoxTable):
         linkify=True,
     )
     view = tables.Column(
-        verbose_name=_p("DNS", "View"),
+        verbose_name=_("View"),
         accessor="zone__view",
         linkify=True,
     )
@@ -162,3 +162,15 @@ class RelatedRecordTable(RecordBaseTable):
             "type",
             "value",
         )
+
+
+class DelegationRecordTable(RecordBaseTable):
+    class Meta(NetBoxTable.Meta):
+        model = Record
+        fields = ()
+        default_columns = (
+            "name",
+            "zone",
+            "type",
+            "value",
+        )

netbox_dns/tables/zone.py

@@ -1,6 +1,5 @@
 import django_tables2 as tables
 from django.utils.translation import gettext_lazy as _
-from django.utils.translation import pgettext_lazy as _p
 
 from netbox.tables import (
     ChoiceFieldColumn,
@@ -21,7 +20,7 @@ class ZoneTable(TenancyColumnsMixin, NetBoxTable):
         linkify=True,
     )
     view = tables.Column(
-        verbose_name=_p("DNS", "View"),
+        verbose_name=_("View"),
         linkify=True,
     )
     soa_mname = tables.Column(

netbox_dns/template_content.py

@@ -1,8 +1,12 @@
+import django_tables2 as tables
+
 from django.conf import settings
 from django.urls import reverse
 
 from netbox.plugins.utils import get_plugin_config
 from netbox.plugins import PluginTemplateExtension
+from utilities.tables import register_table_column
+from ipam.tables import IPAddressTable
 
 from netbox_dns.models import Record
 from netbox_dns.choices import RecordTypeChoices
@@ -114,8 +118,20 @@ class IPRelatedDNSRecords(PluginTemplateExtension):
         )
 
 
+address_records = tables.ManyToManyColumn(
+    verbose_name="DNS Address Records",
+    accessor="netbox_dns_records",
+    linkify_item=True,
+    transform=lambda obj: (
+        obj.fqdn.rstrip(".")
+        if obj.zone.view.default_view
+        else f"[{obj.zone.view.name}] {obj.fqdn.rstrip('.')}"
+    ),
+)
+
 if not settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
     template_extensions = [RelatedDNSRecords, RelatedDNSViews]
+    register_table_column(address_records, "address_records", IPAddressTable)
 else:
     template_extensions = []
 

netbox_dns/templates/netbox_dns/record.html

@@ -43,6 +43,12 @@
                     <th scope="row">{% trans "Name" %}</th>
                     <td style="word-break:break-all;">{{ object.name }}</td>
                 </tr>
+                {% if mask_warning %}
+                <tr class="text-warning">
+                    <th scope="row">{% trans "Warning" %}</th>
+                    <td>{{ mask_warning }}</td>
+                </tr>
+                {% endif %}
                 {% if unicode_name %}
                 <tr>
                     <th scope="row">{% trans "IDN" %}</th>
@@ -76,6 +82,12 @@
                     <th scope="row">{% trans "Value" %}</th>
                     <td style="word-break:break-all;">{{ object.value }}</td>
                 </tr>
+                {% if cname_warning %}
+                <tr class="text-warning">
+                    <th scope="row">{% trans "Warning" %}</th>
+                    <td>{{ cname_warning }}</td>
+                </tr>
+                {% endif %}
                 {% if unicode_value %}
                 <tr>
                     <th scope="row">{% trans "Unicode Value" %}</th>

netbox_dns/templates/netbox_dns/view.html

@@ -5,7 +5,7 @@
     <div class="row">
         <div class="col col-md-6">
             <div class="card">
-                <h5 class="card-header">{% trans "View" context "DNS" %}</h5>
+                <h5 class="card-header">{% trans "View" %}</h5>
                 <table class="table table-hover attr-table">
                     <tr>
                         <th scope="row">{% trans "Name" %}</th>

netbox_dns/templates/netbox_dns/zone/delegation_record.html

@@ -0,0 +1,18 @@
+{% extends 'netbox_dns/zone/base.html' %}
+{% load helpers %}
+{% load render_table from django_tables2 %}
+{% load perms %}
+
+{% block content %}
+    {% include 'inc/table_controls_htmx.html' with table_modal="DelegationRecordTable_config" %}
+    <div class="card">
+        <div class="htmx-container table-responsive" id="object_list">
+            {% include 'htmx/table.html' %}
+        </div>
+    </div>
+{% endblock %}
+
+{% block modals %}
+    {{ block.super }}
+    {% table_config_form table %}
+{% endblock modals %}

netbox_dns/templates/netbox_dns/zone.html

@@ -25,7 +25,7 @@
                     </tr>
                 {% endif %}
                 <tr>
-                    <th scope="row">{% trans "View" context "DNS" %}</th>
+                    <th scope="row">{% trans "View" %}</th>
                     <td>{{ object.view|linkify }}</td>
                 </tr>
                 {% if object.description %}

netbox_dns/utilities/__init__.py

@@ -1,2 +1,3 @@
+from .dns import *
 from .conversions import *
 from .ipam_dnssync import *

netbox_dns/utilities/dns.py

@@ -0,0 +1,12 @@
+from dns import name as dns_name
+
+
+__all__ = ("get_parent_zone_names",)
+
+
+def get_parent_zone_names(name, min_labels=1, include_self=False):
+    fqdn = dns_name.from_text(name)
+    return [
+        fqdn.split(i)[1].to_text().rstrip(".")
+        for i in range(min_labels + 1, len(fqdn.labels) + include_self)
+    ]

netbox_dns/utilities/ipam_dnssync.py

@@ -12,6 +12,8 @@ from ipam.models import IPAddress, Prefix
 
 from netbox_dns.choices import RecordStatusChoices
 
+from .dns import get_parent_zone_names
+
 
 __all__ = (
     "get_zones",
@@ -85,15 +87,12 @@ def get_zones(ip_address, view=None, old_zone=None):
     min_labels = settings.PLUGINS_CONFIG["netbox_dns"].get(
         "dnssync_minimum_zone_labels", 2
     )
-    fqdn = dns_name.from_text(ip_address.dns_name)
-    zone_name_candidates = [
-        fqdn.split(i)[1].to_text().rstrip(".")
-        for i in range(min_labels + 1, len(fqdn.labels) + 1)
-    ]
 
     zones = Zone.objects.filter(
         view__in=views,
-        name__in=zone_name_candidates,
+        name__in=get_parent_zone_names(
+            ip_address.dns_name, min_labels=min_labels, include_self=True
+        ),
         active=True,
     )
 
@@ -194,9 +193,7 @@ def update_dns_records(ip_address, view=None, force=False):
                     updated = True
 
         zones = Zone.objects.filter(pk__in=[zone.pk for zone in zones]).exclude(
-            pk__in=set(
-                ip_address.netbox_dns_records.all().values_list("zone", flat=True)
-            )
+            pk__in=set(ip_address.netbox_dns_records.values_list("zone", flat=True))
         )
 
     for zone in zones:
@@ -213,18 +210,18 @@ def update_dns_records(ip_address, view=None, force=False):
 
 
 def delete_dns_records(ip_address, view=None):
-    deleted = False
-
     if view is None:
         address_records = ip_address.netbox_dns_records.all()
     else:
         address_records = ip_address.netbox_dns_records.filter(zone__view=view)
 
+    if not address_records.exists():
+        return False
+
     for record in address_records:
         record.delete()
-        deleted = True
 
-    return deleted
+    return True
 
 
 def get_views_by_prefix(prefix):

netbox_dns/validators/dns_value.py

@@ -1,5 +1,8 @@
-import dns
+import re
+import textwrap
+
 from dns import rdata, name as dns_name
+from dns.exception import SyntaxError
 
 from django.core.exceptions import ValidationError
 from django.utils.translation import gettext as _
@@ -11,11 +14,12 @@ from netbox_dns.validators import (
     validate_generic_name,
 )
 
+MAX_TXT_LENGTH = 255
 
 __all__ = ("validate_record_value",)
 
 
-def validate_record_value(record_type, value):
+def validate_record_value(record):
     def _validate_idn(name):
         try:
             name.to_unicode()
@@ -26,16 +30,53 @@ def validate_record_value(record_type, value):
                 )
             )
 
+    def _split_text_value(value):
+        # +
+        # Text values longer than 255 characters need to be broken up for TXT and
+        # SPF records.
+        # First, in case they had been split into separate strings, reassemble the
+        # original (long) value, then split it into chunks of a maximum length of
+        # 255 (preferably at word boundaries), and then build a sequence of partial
+        # strings enclosed in double quotes and separated by space.
+        #
+        # See https://datatracker.ietf.org/doc/html/rfc4408#section-3.1.3 for details.
+        # -
+        raw_value = "".join(re.findall(r'"([^"]+)"', value))
+        if not raw_value:
+            raw_value = value
+
+        return " ".join(
+            f'"{part}"'
+            for part in textwrap.wrap(raw_value, MAX_TXT_LENGTH, drop_whitespace=False)
+        )
+
+    if record.type in (RecordTypeChoices.TXT, RecordTypeChoices.SPF):
+        if not (record.value.isascii() and record.value.isprintable()):
+            raise ValidationError(
+                _(
+                    "Record value {value} for a type {type} record is not a printable ASCII string."
+                ).format(value=record.value, type=record.type)
+            )
+
+        if len(record.value) <= MAX_TXT_LENGTH:
+            return
+
+        try:
+            rr = rdata.from_text(RecordClassChoices.IN, record.type, record.value)
+        except SyntaxError as exc:
+            if str(exc) == "string too long":
+                record.value = _split_text_value(record.value)
+
     try:
-        rr = rdata.from_text(RecordClassChoices.IN, record_type, value)
-    except dns.exception.SyntaxError as exc:
+        rr = rdata.from_text(RecordClassChoices.IN, record.type, record.value)
+    except SyntaxError as exc:
         raise ValidationError(
             _(
                 "Record value {value} is not a valid value for a {type} record: {error}."
-            ).format(value=value, type=record_type, error=exc)
+            ).format(value=record.value, type=record.type, error=exc)
         )
 
-    match record_type:
+    match record.type:
         case RecordTypeChoices.CNAME:
             _validate_idn(rr.target)
             validate_domain_name(

netbox_dns/views/nameserver.py

@@ -36,7 +36,7 @@ class NameServerListView(generic.ObjectListView):
 
 
 class NameServerView(generic.ObjectView):
-    queryset = NameServer.objects.all().prefetch_related("zones")
+    queryset = NameServer.objects.prefetch_related("zones")
 
     def get_extra_context(self, request, instance):
         name = dns_name.from_text(instance.name)
@@ -85,7 +85,7 @@ class NameServerContactsView(ObjectContactsView):
 
 @register_model_view(NameServer, "zones")
 class NameServerZoneListView(generic.ObjectChildrenView):
-    queryset = NameServer.objects.all().prefetch_related("zones")
+    queryset = NameServer.objects.prefetch_related("zones")
     child_model = Zone
     table = ZoneTable
     filterset = ZoneFilterSet
@@ -105,7 +105,7 @@ class NameServerZoneListView(generic.ObjectChildrenView):
 
 @register_model_view(NameServer, "soa_zones")
 class NameServerSOAZoneListView(generic.ObjectChildrenView):
-    queryset = NameServer.objects.all().prefetch_related("zones_soa")
+    queryset = NameServer.objects.prefetch_related("zones_soa")
     child_model = Zone
     table = ZoneTable
     filterset = ZoneFilterSet