netbox-plugin-dns 1.1.0b5__tar.gz → 1.1.0b7__tar.gz

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 1.1.0b5
+Version: 1.1.0b7
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Home-page: https://github.com/peteeckel/netbox-plugin-dns
 License: MIT
@@ -48,6 +48,7 @@ The main focus of the plugin is to ensure the quality of the data stored in it.
 * Validation of record types such as CNAME and singletons, to ensure DNS zone validity
 * Support for [RFC 2317](https://datatracker.ietf.org/doc/html/rfc2317) delegation of PTR zones for IPv4 subnets longer than 24 bits
 * Templating for zones and records enables faster creations of zones with given boilerplate object relations, such as name servers, tags, tenants or registration information, or records like standard SPF or MX records that are the same for a subset of zones
+* IPAM DNSsync can be used to automatically create address and pointer records for IP addresses by assigning prefixes to DNS views. When an IP address has a DNS name assigned and there are zones with matching names in the DNS views linked to the IP address' prefix, a matching DNS record will be created in these zones
 
 Other main features include:
 

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/README.md

@@ -28,6 +28,7 @@ The main focus of the plugin is to ensure the quality of the data stored in it.
 * Validation of record types such as CNAME and singletons, to ensure DNS zone validity
 * Support for [RFC 2317](https://datatracker.ietf.org/doc/html/rfc2317) delegation of PTR zones for IPv4 subnets longer than 24 bits
 * Templating for zones and records enables faster creations of zones with given boilerplate object relations, such as name servers, tags, tenants or registration information, or records like standard SPF or MX records that are the same for a subset of zones
+* IPAM DNSsync can be used to automatically create address and pointer records for IP addresses by assigning prefixes to DNS views. When an IP address has a DNS name assigned and there are zones with matching names in the DNS views linked to the IP address' prefix, a matching DNS record will be created in these zones
 
 Other main features include:
 

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/__init__.py

@@ -5,7 +5,7 @@ from ipam.choices import IPAddressStatusChoices
 
 from netbox_dns.choices import RecordTypeChoices
 
-__version__ = "1.1.0b5"
+__version__ = "1.1.0b7"
 
 
 class DNSConfig(PluginConfig):
@@ -32,6 +32,7 @@ class DNSConfig(PluginConfig):
             IPAddressStatusChoices.STATUS_SLAAC,
         ],
         "dnssync_conflict_deactivate": False,
+        "dnssync_minimum_zone_labels": 2,
         "tolerate_characters_in_zone_labels": "",
         "tolerate_underscores_in_labels": False,
         "tolerate_underscores_in_hostnames": False,  # Deprecated, will be removed in 1.2.0

netbox_plugin_dns-1.1.0b7/netbox_dns/management/commands/rebuild_dnssync.py

@@ -0,0 +1,18 @@
+from django.core.management.base import BaseCommand
+
+from ipam.models import IPAddress
+
+from netbox_dns.utilities import update_dns_records
+
+
+class Command(BaseCommand):
+    help = "Rebuild DNSsync relationships between IP addresses and records"
+
+    def handle(self, *model_names, **options):
+        ip_addresses = IPAddress.objects.all()
+        for ip_address in ip_addresses:
+            if options.get("verbosity") >= 2:
+                self.stdout.write(
+                    f"Updating DNS records for IP Address {ip_address}, VRF {ip_address.vrf}"
+                )
+            update_dns_records(ip_address)

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/models/record.py

@@ -493,20 +493,33 @@ class Record(ObjectModificationMixin, NetBoxModel):
             **data,
         )
 
+    def update_fqdn(self, zone=None):
+        if zone is None:
+            zone = self.zone
+
+        _zone = dns_name.from_text(zone.name, origin=dns_name.root)
+        name = dns_name.from_text(self.name, origin=None)
+        fqdn = dns_name.from_text(self.name, origin=_zone)
+
+        if not fqdn.is_subdomain(_zone):
+            raise ValidationError(
+                {
+                    "name": f"{self.name} is not a name in {zone.name}",
+                }
+            )
+
+        _zone.to_unicode()
+        name.to_unicode()
+
+        self.name = name.relativize(_zone).to_text()
+        self.fqdn = fqdn.to_text()
+
     def validate_name(self, new_zone=None):
         if new_zone is None:
             new_zone = self.zone
 
         try:
-            _zone = dns_name.from_text(new_zone.name, origin=dns_name.root)
-            name = dns_name.from_text(self.name, origin=None)
-            fqdn = dns_name.from_text(self.name, origin=_zone)
-
-            _zone.to_unicode()
-            name.to_unicode()
-
-            self.name = name.relativize(_zone).to_text()
-            self.fqdn = fqdn.to_text()
+            self.update_fqdn(zone=new_zone)
 
         except dns.exception.DNSException as exc:
             raise ValidationError(
@@ -515,13 +528,6 @@ class Record(ObjectModificationMixin, NetBoxModel):
                 }
             )
 
-        if not fqdn.is_subdomain(_zone):
-            raise ValidationError(
-                {
-                    "name": f"{self.name} is not a name in {new_zone.name}",
-                }
-            )
-
         if self.type not in get_plugin_config(
             "netbox_dns", "tolerate_non_rfc1035_types", default=[]
         ):
@@ -613,6 +619,11 @@ class Record(ObjectModificationMixin, NetBoxModel):
         if not get_plugin_config("netbox_dns", "enforce_unique_rrset_ttl", False):
             return
 
+        if self.ipam_ip_address is not None and get_plugin_config(
+            "netbox_dns", "dnssync_conflict_deactivate", False
+        ):
+            return
+
         if self.type == RecordTypeChoices.PTR and self.managed:
             return
 

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/models/zone.py

@@ -3,6 +3,7 @@ from math import ceil
 from datetime import datetime
 
 from dns import name as dns_name
+from dns.exception import DNSException
 from dns.rdtypes.ANY import SOA
 from dns.exception import DNSException
 
@@ -37,6 +38,7 @@ from netbox_dns.utilities import (
 )
 from netbox_dns.validators import (
     validate_fqdn,
+    validate_rname,
     validate_domain_name,
 )
 from netbox_dns.mixins import ObjectModificationMixin
@@ -78,6 +80,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         super().__init__(*args, **kwargs)
 
         self._soa_serial_dirty = False
+        self._ip_addresses_checked = False
 
     view = models.ForeignKey(
         to="View",
@@ -280,7 +283,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         else:
             try:
                 name = dns_name.from_text(self.name, origin=None).to_unicode()
-            except dns_name.IDNAException:
+            except DNSException:
                 name = self.name
 
         try:
@@ -308,6 +311,14 @@ class Zone(ObjectModificationMixin, NetBoxModel):
     def soa_serial_dirty(self, soa_serial_dirty):
         self._soa_serial_dirty = soa_serial_dirty
 
+    @property
+    def ip_addresses_checked(self):
+        return self._ip_addresses_checked
+
+    @ip_addresses_checked.setter
+    def ip_addresses_checked(self, ip_addresses_checked):
+        self._ip_addresses_checked = ip_addresses_checked
+
     @property
     def display_name(self):
         return name_to_unicode(self.name)
@@ -621,7 +632,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             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)
+            validate_rname(self.soa_rname)
         except (DNSException, ValidationError) as exc:
             raise ValidationError(
                 {
@@ -653,24 +664,26 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                         }
                     )
 
-            if old_zone.name != self.name or old_zone.view != self.view:
-                for ip_address in get_ip_addresses_by_zone(self):
-                    try:
-                        check_dns_records(ip_address, zone=self)
-                    except ValidationError as exc:
-                        raise ValidationError(exc.messages)
-
+            if (
+                not self.ip_addresses_checked
+                and old_zone.name != self.name
+                or old_zone.view != self.view
+            ):
                 ip_addresses = IPAddress.objects.filter(
                     netbox_dns_records__in=self.record_set.filter(
                         ipam_ip_address__isnull=False
                     )
                 )
-                for ip_address in ip_addresses:
+                ip_addresses |= get_ip_addresses_by_zone(self)
+
+                for ip_address in ip_addresses.distinct():
                     try:
                         check_dns_records(ip_address, zone=self)
                     except ValidationError as exc:
                         raise ValidationError(exc.messages)
 
+                self.ip_addresses_checked = True
+
         if self.is_reverse_zone:
             self.arpa_network = self.network_from_name
 
@@ -785,12 +798,13 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
         elif changed_fields is not None and {"name", "view", "status"} & changed_fields:
             for address_record in self.record_set.filter(
-                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA)
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
+                ipam_ip_address__isnull=True,
             ):
                 address_record.save(update_fields=["ptr_record"])
 
         if changed_fields is not None and "name" in changed_fields:
-            for _record in self.record_set.all():
+            for _record in self.record_set.filter(ipam_ip_address__isnull=True):
                 _record.save(
                     update_fields=["fqdn"],
                     save_zone_serial=False,
@@ -799,13 +813,14 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 )
 
         if changed_fields is None or {"name", "view"} & changed_fields:
-            update_ip_addresses = IPAddress.objects.filter(
-                pk__in=self.record_set.filter(
+            ip_addresses = IPAddress.objects.filter(
+                netbox_dns_records__in=self.record_set.filter(
                     ipam_ip_address__isnull=False
-                ).values_list("ipam_ip_address", flat=True)
+                )
             )
-            update_ip_addresses |= get_ip_addresses_by_zone(self)
-            for ip_address in update_ip_addresses:
+            ip_addresses |= get_ip_addresses_by_zone(self)
+
+            for ip_address in ip_addresses.distinct():
                 update_dns_records(ip_address)
 
         self.save_soa_serial()
@@ -848,7 +863,9 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                     netbox_dns_records__in=self.record_set.filter(
                         ipam_ip_address__isnull=False
                     )
-                ).values_list("pk", flat=True)
+                )
+                .distinct()
+                .values_list("pk", flat=True)
             )
 
             super().delete(*args, **kwargs)

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/signals/ipam_dnssync.py

@@ -215,6 +215,10 @@ def ipam_dnssync_view_prefix_changed(**kwargs):
         return
 
     check_view = action != "post_remove"
+
+    ip_addresses = IPAddress.objects.none()
     for prefix in Prefix.objects.filter(pk__in=kwargs.get("pk_set")):
-        for ip_address in get_ip_addresses_by_prefix(prefix, check_view=check_view):
-            update_dns_records(ip_address)
+        ip_addresses |= get_ip_addresses_by_prefix(prefix, check_view=check_view)
+
+    for ip_address in ip_addresses.distinct():
+        update_dns_records(ip_address)

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/tables/record.py

@@ -1,5 +1,4 @@
 import django_tables2 as tables
-from django_tables2.utils import Accessor
 from django.utils.html import format_html
 
 
@@ -9,7 +8,6 @@ from netbox.tables import (
     TagColumn,
     ActionsColumn,
 )
-from ipam.lookups import Host, Inet
 from tenancy.tables import TenancyColumnsMixin
 
 from netbox_dns.models import Record

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/utilities/ipam_dnssync.py

@@ -44,7 +44,7 @@ def _get_assigned_views(ip_address):
 
 def _get_record_status(ip_address):
     return (
-        RecordStatusChoices.STATE_ACTIVE
+        RecordStatusChoices.STATUS_ACTIVE
         if ip_address.status
         in settings.PLUGINS_CONFIG["netbox_dns"].get(
             "dnssync_ipaddress_active_status", []
@@ -59,6 +59,20 @@ def _valid_entry(ip_address, zone):
     ).is_subdomain(dns_name.from_text(zone.name))
 
 
+def _match_data(ip_address, record):
+    cf_disable_ptr = ip_address.custom_field_data.get(
+        "ipaddress_dns_record_disable_ptr"
+    )
+
+    return (
+        record.fqdn.rstrip(".") == ip_address.dns_name.rstrip(".")
+        and record.value == str(ip_address.address.ip)
+        and record.status == _get_record_status(ip_address)
+        and record.ttl == ip_address.custom_field_data.get("ipaddress_dns_record_ttl")
+        and (cf_disable_ptr is None or record.disable_ptr == cf_disable_ptr)
+    )
+
+
 def get_zones(ip_address, view=None, old_zone=None):
     if view is None:
         views = _get_assigned_views(ip_address)
@@ -68,9 +82,13 @@ def get_zones(ip_address, view=None, old_zone=None):
     else:
         views = [view]
 
+    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(3, len(fqdn.labels))
+        fqdn.split(i)[1].to_text().rstrip(".")
+        for i in range(min_labels + 1, len(fqdn.labels))
     ]
 
     zones = _zone.Zone.objects.filter(
@@ -104,11 +122,7 @@ def check_dns_records(ip_address, zone=None, view=None):
 
         if ip_address.pk is not None:
             for record in ip_address.netbox_dns_records.filter(zone__in=zones):
-                if (
-                    record.fqdn != ip_address.dns_name
-                    or record.value != ip_address.address.ip
-                    or record.status != _get_record_status(ip_address)
-                ):
+                if not _match_data(ip_address, record):
                     record.update_from_ip_address(ip_address)
 
                     if record is not None:
@@ -117,9 +131,7 @@ def check_dns_records(ip_address, zone=None, view=None):
             zones = _zone.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:
@@ -155,15 +167,14 @@ def update_dns_records(ip_address):
 
     if ip_address.pk is not None:
         for record in ip_address.netbox_dns_records.all():
-            if record.zone not in zones:
+            if record.zone not in zones or ip_address.custom_field_data.get(
+                "ipaddress_dns_disabled"
+            ):
                 record.delete()
                 continue
 
-            if (
-                record.fqdn != ip_address.dns_name
-                or record.value != ip_address.address.ip
-                or record.status != _get_record_status(ip_address)
-            ):
+            record.update_fqdn()
+            if not _match_data(ip_address, record):
                 record.update_from_ip_address(ip_address)
 
                 if record is not None:
@@ -217,7 +228,9 @@ def get_ip_addresses_by_prefix(prefix, check_view=True):
         vrf=prefix.vrf, address__net_host_contained=prefix.prefix
     )
 
-    for exclude_child in prefix.get_children().filter(netbox_dns_views__isnull=False):
+    for exclude_child in (
+        prefix.get_children().filter(netbox_dns_views__isnull=False).distinct()
+    ):
         queryset = queryset.exclude(
             vrf=exclude_child.vrf,
             address__net_host_contained=exclude_child.prefix,
@@ -258,9 +271,11 @@ def get_ip_addresses_by_zone(zone):
     are the IPAddress objects in prefixes assigned to the same view, if the
     'dns_name' attribute of the IPAddress object ends in the zone's name.
     """
-    queryset = get_ip_addresses_by_view(zone.view)
+    queryset = get_ip_addresses_by_view(zone.view).filter(
+        dns_name__regex=rf"\.{re.escape(zone.name)}\.?$"
+    )
 
-    return queryset.filter(dns_name__regex=rf"\.{re.escape(zone.name)}\.?$")
+    return queryset
 
 
 def check_record_permission(add=True, change=True, delete=True):

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/validators/dns_name.py

@@ -7,6 +7,7 @@ from netbox.plugins.utils import get_plugin_config
 
 __all__ = (
     "validate_fqdn",
+    "validate_rname",
     "validate_generic_name",
     "validate_domain_name",
 )
@@ -57,6 +58,14 @@ def validate_fqdn(name, always_tolerant=False):
         raise ValidationError(f"{name} is not a valid fully qualified DNS host name")
 
 
+def validate_rname(name, always_tolerant=False):
+    label, zone_label = _get_label(always_tolerant=always_tolerant)
+    regex = rf"^(\*|{label})(\\\.{label})*(\.{zone_label}){{2,}}\.?$"
+
+    if not re.match(regex, name, flags=re.IGNORECASE) or _has_invalid_double_dash(name):
+        raise ValidationError(f"{name} is not a valid RNAME")
+
+
 def validate_generic_name(
     name, tolerate_leading_underscores=False, always_tolerant=False
 ):

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/netbox_dns/views/record.py

@@ -1,10 +1,6 @@
 from dns import name as dns_name
 
-from django.db.models import F, Q, Case, When, OuterRef, Subquery
-
 from netbox.views import generic
-from ipam.fields import IPAddressField
-from ipam.models import IPAddress
 
 from netbox_dns.filtersets import RecordFilterSet
 from netbox_dns.forms import (

{netbox_plugin_dns-1.1.0b5 → netbox_plugin_dns-1.1.0b7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "netbox-plugin-dns"
-version = "1.1.0b5"
+version = "1.1.0b7"
 description = "NetBox DNS is a NetBox plugin for managing DNS data."
 authors = ["Peter Eckel <pete@netbox-dns.org>"]
 homepage = "https://github.com/peteeckel/netbox-plugin-dns"