netbox-plugin-dns 1.0b1__py3-none-any.whl → 1.0.1__py3-none-any.whl

netbox_dns/models/nameserver.py

@@ -55,7 +55,7 @@ class NameServer(NetBoxModel):
     def get_absolute_url(self):
         return reverse("plugins:netbox_dns:nameserver", kwargs={"pk": self.pk})
 
-    def clean(self):
+    def clean(self, *args, **kwargs):
         try:
             self.name = normalize_name(self.name)
         except NameFormatError as exc:
@@ -74,6 +74,8 @@ class NameServer(NetBoxModel):
                 }
             ) from None
 
+        super().clean(*args, **kwargs)
+
     def save(self, *args, **kwargs):
         self.full_clean()
 

netbox_dns/models/record.py

@@ -11,11 +11,10 @@ from django.urls import reverse
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
+from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
 from utilities.choices import ChoiceSet
 
-from netbox.plugins.utils import get_plugin_config
-
 from netbox_dns.fields import AddressField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -24,6 +23,7 @@ from netbox_dns.utilities import (
 from netbox_dns.validators import (
     validate_fqdn,
     validate_extended_hostname,
+    validate_domain_name,
 )
 
 # +
@@ -234,8 +234,8 @@ class Record(NetBoxModel):
         if self.type != RecordTypeChoices.CNAME:
             return None
 
-        zone = dns_name.from_text(self.zone.name)
-        value_fqdn = dns_name.from_text(self.value, origin=zone)
+        _zone = dns_name.from_text(self.zone.name)
+        value_fqdn = dns_name.from_text(self.value, origin=_zone)
 
         return value_fqdn.to_text()
 
@@ -287,12 +287,14 @@ class Record(NetBoxModel):
                 dns_name.from_text(self.ptr_record.zone.rfc2317_parent_zone.name)
             )
 
+        return None
+
     @property
     def ptr_zone(self):
         if self.type == RecordTypeChoices.A:
             ptr_zone = (
                 zone.Zone.objects.filter(
-                    self.zone.view_filter,
+                    view=self.zone.view,
                     rfc2317_prefix__net_contains=self.value,
                 )
                 .order_by("rfc2317_prefix__net_mask_length")
@@ -304,7 +306,7 @@ class Record(NetBoxModel):
 
         ptr_zone = (
             zone.Zone.objects.filter(
-                self.zone.view_filter, arpa_network__net_contains=self.value
+                view=self.zone.view, arpa_network__net_contains=self.value
             )
             .order_by("arpa_network__net_mask_length")
             .last()
@@ -319,7 +321,7 @@ class Record(NetBoxModel):
             ptr_zone is None
             or self.disable_ptr
             or not self.is_active
-            or self.name == "*"
+            or self.name.startswith("*")
         ):
             if self.ptr_record is not None:
                 with transaction.atomic():
@@ -418,10 +420,8 @@ class Record(NetBoxModel):
                     self.rfc2317_cname_record.save(save_zone_serial=save_zone_serial)
 
                     return
-                else:
-                    self.remove_from_rfc2317_cname_record(
-                        save_zone_serial=save_zone_serial
-                    )
+
+                self.remove_from_rfc2317_cname_record(save_zone_serial=save_zone_serial)
 
             rfc2317_cname_record = Record.objects.filter(
                 name=cname_name,
@@ -462,14 +462,14 @@ class Record(NetBoxModel):
 
     def validate_name(self):
         try:
-            zone = dns_name.from_text(self.zone.name, origin=dns_name.root)
+            _zone = dns_name.from_text(self.zone.name, origin=dns_name.root)
             name = dns_name.from_text(self.name, origin=None)
-            fqdn = dns_name.from_text(self.name, origin=zone)
+            fqdn = dns_name.from_text(self.name, origin=_zone)
 
-            zone.to_unicode()
+            _zone.to_unicode()
             name.to_unicode()
 
-            self.name = name.relativize(zone).to_text()
+            self.name = name.relativize(_zone).to_text()
             self.fqdn = fqdn.to_text()
 
         except dns.exception.DNSException as exc:
@@ -479,7 +479,7 @@ class Record(NetBoxModel):
                 }
             )
 
-        if not fqdn.is_subdomain(zone):
+        if not fqdn.is_subdomain(_zone):
             raise ValidationError(
                 {
                     "name": f"{self.name} is not a name in {self.zone.name}",
@@ -487,7 +487,7 @@ class Record(NetBoxModel):
             )
 
         if self.type not in get_plugin_config(
-            "netbox_dns", "tolerate_non_rfc1035_types", default=list()
+            "netbox_dns", "tolerate_non_rfc1035_types", default=[]
         ):
             try:
                 validate_extended_hostname(
@@ -497,7 +497,7 @@ class Record(NetBoxModel):
                         in get_plugin_config(
                             "netbox_dns",
                             "tolerate_leading_underscore_types",
-                            default=list(),
+                            default=[],
                         )
                     ),
                 )
@@ -509,18 +509,16 @@ class Record(NetBoxModel):
                 ) from None
 
     def validate_value(self):
-        if self.type in (RecordTypeChoices.PTR):
+        def _validate_idn(name):
             try:
-                validate_fqdn(self.value)
-            except ValidationError as exc:
+                name.to_unicode()
+            except dns_name.IDNAException as exc:
                 raise ValidationError(
-                    {
-                        "value": exc,
-                    }
+                    f"{name.to_text()} is not a valid IDN: {exc}."
                 ) from None
 
         try:
-            rdata.from_text(RecordClassChoices.IN, self.type, self.value)
+            rr = rdata.from_text(RecordClassChoices.IN, self.type, self.value)
         except dns.exception.SyntaxError as exc:
             raise ValidationError(
                 {
@@ -528,6 +526,59 @@ class Record(NetBoxModel):
                 }
             ) from None
 
+        try:
+            match self.type:
+                case RecordTypeChoices.CNAME:
+                    _validate_idn(rr.target)
+                    validate_domain_name(
+                        rr.target.to_text(),
+                        always_tolerant=True,
+                        allow_empty_label=True,
+                    )
+
+                case (
+                    RecordTypeChoices.DNAME
+                    | RecordTypeChoices.NS
+                    | RecordTypeChoices.HTTPS
+                    | RecordTypeChoices.SRV
+                    | RecordTypeChoices.SVCB
+                ):
+                    _validate_idn(rr.target)
+                    validate_domain_name(rr.target.to_text(), always_tolerant=True)
+
+                case RecordTypeChoices.PTR | RecordTypeChoices.NSAP_PTR:
+                    _validate_idn(rr.target)
+                    validate_fqdn(rr.target.to_text(), always_tolerant=True)
+
+                case RecordTypeChoices.MX | RecordTypeChoices.RT | RecordTypeChoices.KX:
+                    _validate_idn(rr.exchange)
+                    validate_domain_name(rr.exchange.to_text(), always_tolerant=True)
+
+                case RecordTypeChoices.NSEC:
+                    _validate_idn(rr.next)
+                    validate_domain_name(rr.next.to_text(), always_tolerant=True)
+
+                case RecordTypeChoices.RP:
+                    _validate_idn(rr.mbox)
+                    validate_domain_name(rr.mbox.to_text(), always_tolerant=True)
+                    _validate_idn(rr.txt)
+                    validate_domain_name(rr.txt.to_text(), always_tolerant=True)
+
+                case RecordTypeChoices.NAPTR:
+                    _validate_idn(rr.replacement)
+                    validate_extended_hostname(
+                        rr.replacement.to_text(), always_tolerant=True
+                    )
+
+                case RecordTypeChoices.PX:
+                    _validate_idn(rr.map822)
+                    validate_domain_name(rr.map822.to_text(), always_tolerant=True)
+                    _validate_idn(rr.mapx400)
+                    validate_domain_name(rr.mapx400.to_text(), always_tolerant=True)
+
+        except ValidationError as exc:
+            raise ValidationError({"value": exc}) from None
+
     def check_unique_record(self):
         if not get_plugin_config("netbox_dns", "enforce_unique_records", False):
             return
@@ -695,6 +746,8 @@ class Record(NetBoxModel):
                     }
                 ) from None
 
+        super().clean(*args, **kwargs)
+
     def save(
         self,
         *args,
@@ -732,9 +785,9 @@ class Record(NetBoxModel):
 
         super().save(*args, **kwargs)
 
-        zone = self.zone
-        if self.type != RecordTypeChoices.SOA and zone.soa_serial_auto:
-            zone.update_serial(save_zone_serial=save_zone_serial)
+        _zone = self.zone
+        if self.type != RecordTypeChoices.SOA and _zone.soa_serial_auto:
+            _zone.update_serial(save_zone_serial=save_zone_serial)
 
     def delete(self, *args, save_zone_serial=True, **kwargs):
         if self.rfc2317_cname_record:
@@ -745,16 +798,17 @@ class Record(NetBoxModel):
 
         super().delete(*args, **kwargs)
 
-        zone = self.zone
-        if zone.soa_serial_auto:
-            zone.update_serial(save_zone_serial=save_zone_serial)
+        _zone = self.zone
+        if _zone.soa_serial_auto:
+            _zone.update_serial(save_zone_serial=save_zone_serial)
 
 
 @register_search
 class RecordIndex(SearchIndex):
     model = Record
     fields = (
-        ("name", 100),
+        ("fqdn", 100),
+        ("name", 120),
         ("value", 150),
         ("zone", 200),
         ("type", 200),

netbox_dns/models/view.py

@@ -1,8 +1,11 @@
 from django.db import models
 from django.urls import reverse
+from django.core.exceptions import ValidationError
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
+from netbox.context import current_request
+from utilities.exceptions import AbortRequest
 
 
 class View(NetBoxModel):
@@ -14,6 +17,9 @@ class View(NetBoxModel):
         max_length=200,
         blank=True,
     )
+    default_view = models.BooleanField(
+        default=False,
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -24,6 +30,10 @@ class View(NetBoxModel):
 
     clone_fields = ["name", "description"]
 
+    @classmethod
+    def get_default_view(cls):
+        return cls.objects.get(default_view=True)
+
     def get_absolute_url(self):
         return reverse("plugins:netbox_dns:view", kwargs={"pk": self.pk})
 
@@ -33,6 +43,49 @@ class View(NetBoxModel):
     class Meta:
         ordering = ("name",)
 
+    def delete(self, *args, **kwargs):
+        if self.default_view:
+            if current_request.get() is not None:
+                raise AbortRequest("The default view cannot be deleted")
+
+            raise ValidationError("The default view cannot be deleted")
+
+        super().delete(*args, **kwargs)
+
+    def clean(self, *args, old_state=None, **kwargs):
+        if self.pk is None:
+            return
+
+        old_state = View.objects.get(pk=self.pk)
+
+        if (
+            old_state.default_view
+            and not self.default_view
+            and not View.objects.filter(default_view=True).exclude(pk=self.pk).exists()
+        ):
+            raise ValidationError(
+                {
+                    "default_view": "Please select a different view as default view to change this setting!"
+                }
+            )
+
+        super().clean(*args, **kwargs)
+
+    def save(self, *args, **kwargs):
+        self.clean()
+
+        old_state = None if self.pk is None else View.objects.get(pk=self.pk)
+
+        super().save(*args, **kwargs)
+
+        if (old_state is None and self.default_view) or (
+            old_state is not None and self.default_view and not old_state.default_view
+        ):
+            other_views = View.objects.filter(default_view=True).exclude(pk=self.pk)
+            for view in other_views:
+                view.default_view = False
+                view.save()
+
 
 @register_search
 class ViewIndex(SearchIndex):

netbox_dns/models/zone.py

@@ -15,15 +15,15 @@ from django.db.models import Q, Max, ExpressionWrapper, BooleanField
 from django.urls import reverse
 from django.db.models.signals import m2m_changed
 from django.dispatch import receiver
+from django.conf import settings
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
+from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
 from utilities.choices import ChoiceSet
 from ipam.models import IPAddress
 
-from netbox.plugins.utils import get_plugin_config
-
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -37,9 +37,11 @@ from netbox_dns.validators import (
 )
 
 # +
-# This is a hack designed to break cyclic imports between Record and Zone
+# This is a hack designed to break cyclic imports between View, Record and Zone
 # -
 import netbox_dns.models.record as record
+import netbox_dns.models.view as view
+import netbox_dns.models.nameserver as nameserver
 
 
 class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
@@ -81,8 +83,7 @@ class Zone(NetBoxModel):
     view = models.ForeignKey(
         to="View",
         on_delete=models.PROTECT,
-        blank=True,
-        null=True,
+        null=False,
     )
     name = models.CharField(
         max_length=255,
@@ -285,11 +286,20 @@ class Zone(NetBoxModel):
             except dns_name.IDNAException:
                 name = self.name
 
-        if self.view:
+        if not self.view.default_view:
             return f"[{self.view}] {name}"
 
         return str(name)
 
+    @staticmethod
+    def get_defaults():
+        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")
+        }
+
     @property
     def display_name(self):
         return name_to_unicode(self.name)
@@ -317,11 +327,11 @@ class Zone(NetBoxModel):
 
     def get_rfc2317_parent_zone(self):
         if not self.is_rfc2317_zone:
-            return
+            return None
 
         return (
             Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains=self.rfc2317_prefix,
             )
             .order_by("arpa_network__net_mask_length")
@@ -342,12 +352,6 @@ class Zone(NetBoxModel):
             )
         )
 
-    @property
-    def view_filter(self):
-        if self.view is None:
-            return Q(view__isnull=True)
-        return Q(view=self.view)
-
     def record_count(self, managed=False):
         return record.Record.objects.filter(zone=self, managed=managed).count()
 
@@ -417,19 +421,15 @@ class Zone(NetBoxModel):
         if not nameservers:
             ns_errors.append(f"No nameservers are configured for zone {self}")
 
-        for nameserver in nameservers:
-            name = dns_name.from_text(nameserver.name, origin=None)
+        for _nameserver in nameservers:
+            name = dns_name.from_text(_nameserver.name, origin=None)
             parent = name.parent()
 
             if len(parent) < 2:
                 continue
 
-            view_condition = (
-                Q(view__isnull=True) if self.view is None else Q(view_id=self.view.pk)
-            )
-
             try:
-                ns_zone = Zone.objects.get(view_condition, name=parent.to_text())
+                ns_zone = Zone.objects.get(view_id=self.view.pk, name=parent.to_text())
             except ObjectDoesNotExist:
                 continue
 
@@ -437,7 +437,7 @@ class Zone(NetBoxModel):
             address_records = record.Record.objects.filter(
                 Q(zone=ns_zone),
                 Q(status__in=record.Record.ACTIVE_STATUS_LIST),
-                Q(Q(name=f"{nameserver.name}.") | Q(name=relative_name)),
+                Q(Q(name=f"{_nameserver.name}.") | Q(name=relative_name)),
                 Q(
                     Q(type=record.RecordTypeChoices.A)
                     | Q(type=record.RecordTypeChoices.AAAA)
@@ -446,11 +446,23 @@ class Zone(NetBoxModel):
 
             if not address_records:
                 ns_warnings.append(
-                    f"Nameserver {nameserver.name} does not have an active address record in zone {ns_zone}"
+                    f"Nameserver {_nameserver.name} does not have an active address record in zone {ns_zone}"
                 )
 
         return ns_warnings, ns_errors
 
+    def check_soa_serial_increment(self, old_serial, new_serial):
+        MAX_SOA_SERIAL_INCREMENT = 2**31 - 1
+        SOA_SERIAL_WRAP = 2**32
+
+        if old_serial is None:
+            return
+
+        if (new_serial - old_serial) % SOA_SERIAL_WRAP > MAX_SOA_SERIAL_INCREMENT:
+            raise ValidationError(
+                {"soa_serial": f"soa_serial must not decrease for zone {self.name}."}
+            )
+
     def get_auto_serial(self):
         records = record.Record.objects.filter(zone_id=self.pk).exclude(
             type=record.RecordTypeChoices.SOA
@@ -492,19 +504,6 @@ class Zone(NetBoxModel):
     def network_from_name(self):
         return arpa_to_prefix(self.name)
 
-    def check_name_conflict(self):
-        if self.view is None:
-            if (
-                Zone.objects.exclude(pk=self.pk)
-                .filter(name=self.name.rstrip("."), view__isnull=True)
-                .exists()
-            ):
-                raise ValidationError(
-                    {
-                        "name": f"A zone with name {self.name} and no view already exists."
-                    }
-                )
-
     def update_rfc2317_parent_zone(self):
         if not self.is_rfc2317_zone:
             return
@@ -555,8 +554,33 @@ class Zone(NetBoxModel):
             ptr_zone.save_soa_serial()
             ptr_zone.update_soa_record()
 
+    def clean_fields(self, exclude=None):
+        defaults = settings.PLUGINS_CONFIG.get("netbox_dns")
+
+        if self.view_id is None:
+            self.view_id = view.View.get_default_view().pk
+
+        for field, value in self.get_defaults().items():
+            if getattr(self, field) in (None, ""):
+                if value not in (None, ""):
+                    setattr(self, field, value)
+
+        if self.soa_mname_id is None:
+            default_soa_mname = defaults.get("zone_soa_mname")
+            try:
+                self.soa_mname = nameserver.NameServer.objects.get(
+                    name=default_soa_mname
+                )
+            except nameserver.NameServer.DoesNotExist:
+                raise ValidationError(
+                    f"Default soa_mname instance {default_soa_mname} does not exist"
+                )
+
+        super().clean_fields(exclude=exclude)
+
     def clean(self, *args, **kwargs):
-        self.check_name_conflict()
+        if self.soa_ttl is None:
+            self.soa_ttl = self.default_ttl
 
         try:
             self.name = normalize_name(self.name)
@@ -576,6 +600,8 @@ class Zone(NetBoxModel):
                 }
             ) from None
 
+        if self.soa_rname in (None, ""):
+            raise ValidationError("soa_rname not set and no default value defined")
         try:
             dns_name.from_text(self.soa_rname, origin=dns_name.root)
             validate_fqdn(self.soa_rname)
@@ -586,12 +612,29 @@ class Zone(NetBoxModel):
                 }
             ) from None
 
-        if self.soa_serial is None and not self.soa_serial_auto:
-            raise ValidationError(
-                {
-                    "soa_serial": f"soa_serial is not defined and soa_serial_auto is disabled for zone {self.name}."
-                }
-            )
+        if not self.soa_serial_auto:
+            if self.soa_serial is None:
+                raise ValidationError(
+                    {
+                        "soa_serial": f"soa_serial is not defined and soa_serial_auto is disabled for zone {self.name}."
+                    }
+                )
+
+        if self.pk is not None:
+            old_zone = Zone.objects.get(pk=self.pk)
+            if not self.soa_serial_auto:
+                self.check_soa_serial_increment(old_zone.soa_serial, self.soa_serial)
+            else:
+                try:
+                    self.check_soa_serial_increment(
+                        old_zone.soa_serial, self.get_auto_serial()
+                    )
+                except ValidationError:
+                    raise ValidationError(
+                        {
+                            "soa_serial_auto": f"Enabling soa_serial_auto would decrease soa_serial for zone {self.name}."
+                        }
+                    )
 
         if self.is_reverse_zone:
             self.arpa_network = self.network_from_name
@@ -619,7 +662,7 @@ class Zone(NetBoxModel):
                 self.rfc2317_parent_zone = None
 
             overlapping_zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 rfc2317_prefix__net_overlap=self.rfc2317_prefix,
                 active=True,
             ).exclude(pk=self.pk)
@@ -635,6 +678,8 @@ class Zone(NetBoxModel):
             self.rfc2317_parent_managed = False
             self.rfc2317_parent_zone = None
 
+        super().clean(*args, **kwargs)
+
     def save(self, *args, **kwargs):
         self.full_clean()
 
@@ -659,7 +704,7 @@ class Zone(NetBoxModel):
             new_zone or name_changed or view_changed or status_changed
         ) and self.is_reverse_zone:
             zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains_or_equals=self.arpa_network,
             )
             address_records = record.Record.objects.filter(
@@ -695,7 +740,7 @@ class Zone(NetBoxModel):
             or rfc2317_changed
         ) and self.is_rfc2317_zone:
             zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains=self.rfc2317_prefix,
             )
             address_records = record.Record.objects.filter(

netbox_dns/signals/ipam_coupling.py

@@ -5,6 +5,7 @@ from rest_framework.exceptions import PermissionDenied as APIPermissionDenied
 
 from netbox.signals import post_clean
 from netbox.context import current_request
+from netbox.plugins.utils import get_plugin_config
 from ipam.models import IPAddress
 
 from netbox_dns.models import Zone
@@ -18,8 +19,6 @@ from netbox_dns.utilities.ipam_coupling import (
     DNSPermissionDenied,
 )
 
-from netbox.plugins.utils import get_plugin_config
-
 
 @receiver(post_clean, sender=IPAddress)
 def ip_address_check_permissions_save(instance, **kwargs):

netbox_dns/tables/view.py

@@ -10,9 +10,19 @@ class ViewTable(TenancyColumnsMixin, NetBoxTable):
     name = tables.Column(
         linkify=True,
     )
+    default_view = tables.Column(
+        verbose_name="Default View",
+    )
     tags = TagColumn(url_name="plugins:netbox_dns:view_list")
 
     class Meta(NetBoxTable.Meta):
         model = View
-        fields = ("name", "description", "tenant", "tenant_group", "tags")
-        default_columns = ("name",)
+        fields = (
+            "name",
+            "default_view",
+            "description",
+            "tenant",
+            "tenant_group",
+            "tags",
+        )
+        default_columns = ("name", "default_view")

netbox_dns/template_content.py

@@ -117,7 +117,7 @@ class RelatedDNSObjects(PluginTemplateExtension):
         )
 
 
-template_extensions = list()
+template_extensions = []
 
 if version.parse(settings.VERSION) < version.parse("3.7.0"):
     template_extensions.append(RelatedDNSObjects)

netbox_dns/templates/netbox_dns/record.html

@@ -56,7 +56,7 @@
                     <td><a href="{% url 'plugins:netbox_dns:zone_records' pk=object.zone.pk %}">{{ object.zone }}</a></td>
                     {% endif %}
                 </tr>
-                {% if not object.managed %}
+                {% if not object.managed or object.tenant %}
                 <tr>
                     <th scope="row">Tenant</th>
                     <td>