netbox-plugin-dns 1.0.6__py3-none-any.whl → 1.1.0__py3-none-any.whl

netbox_dns/urls/zone.py

@@ -1,63 +1,25 @@
-from django.urls import path
+from django.urls import include, path
 
-from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+from utilities.urls import get_model_urls
 
-from netbox_dns.models import Zone
 from netbox_dns.views import (
-    ZoneListView,
     ZoneView,
-    ZoneDeleteView,
+    ZoneListView,
     ZoneEditView,
+    ZoneDeleteView,
     ZoneBulkImportView,
     ZoneBulkEditView,
     ZoneBulkDeleteView,
-    ZoneRecordListView,
-    ZoneManagedRecordListView,
-    ZoneRegistrationView,
-    ZoneRFC2317ChildZoneListView,
-    ZoneChildZoneListView,
 )
 
 zone_urlpatterns = [
+    path("zones/<int:pk>/", ZoneView.as_view(), name="zone"),
     path("zones/", ZoneListView.as_view(), name="zone_list"),
     path("zones/add/", ZoneEditView.as_view(), name="zone_add"),
+    path("zones/<int:pk>/edit/", ZoneEditView.as_view(), name="zone_edit"),
+    path("zones/<int:pk>/delete/", ZoneDeleteView.as_view(), name="zone_delete"),
     path("zones/import/", ZoneBulkImportView.as_view(), name="zone_import"),
     path("zones/edit/", ZoneBulkEditView.as_view(), name="zone_bulk_edit"),
     path("zones/delete/", ZoneBulkDeleteView.as_view(), name="zone_bulk_delete"),
-    path("zones/<int:pk>/", ZoneView.as_view(), name="zone"),
-    path("zones/<int:pk>/delete/", ZoneDeleteView.as_view(), name="zone_delete"),
-    path("zones/<int:pk>/edit/", ZoneEditView.as_view(), name="zone_edit"),
-    path("zones/<int:pk>/records/", ZoneRecordListView.as_view(), name="zone_records"),
-    path(
-        "zones/<int:pk>/managedrecords/",
-        ZoneManagedRecordListView.as_view(),
-        name="zone_managed_records",
-    ),
-    path(
-        "zones/<int:pk>/rfc2317childzones/",
-        ZoneRFC2317ChildZoneListView.as_view(),
-        name="zone_rfc2317_child_zones",
-    ),
-    path(
-        "zones/<int:pk>/childzones/",
-        ZoneChildZoneListView.as_view(),
-        name="zone_child_zones",
-    ),
-    path(
-        "zones/<int:pk>/registration/",
-        ZoneRegistrationView.as_view(),
-        name="zone_registration",
-    ),
-    path(
-        "zones/<int:pk>/journal/",
-        ObjectJournalView.as_view(),
-        name="zone_journal",
-        kwargs={"model": Zone},
-    ),
-    path(
-        "zones/<int:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="zone_changelog",
-        kwargs={"model": Zone},
-    ),
+    path("zones/<int:pk>/", include(get_model_urls("netbox_dns", "zone"))),
 ]

netbox_dns/urls/zone_template.py

@@ -1,21 +1,31 @@
-from django.urls import path
+from django.urls import include, path
 
-from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+from utilities.urls import get_model_urls
 
-from netbox_dns.models import ZoneTemplate
 from netbox_dns.views import (
-    ZoneTemplateListView,
     ZoneTemplateView,
-    ZoneTemplateDeleteView,
+    ZoneTemplateListView,
     ZoneTemplateEditView,
+    ZoneTemplateDeleteView,
     ZoneTemplateBulkImportView,
     ZoneTemplateBulkEditView,
     ZoneTemplateBulkDeleteView,
 )
 
 zonetemplate_urlpatterns = [
+    path("zonetemplates/<int:pk>/", ZoneTemplateView.as_view(), name="zonetemplate"),
     path("zonetemplates/", ZoneTemplateListView.as_view(), name="zonetemplate_list"),
     path("zonetemplates/add/", ZoneTemplateEditView.as_view(), name="zonetemplate_add"),
+    path(
+        "zonetemplates/<int:pk>/edit/",
+        ZoneTemplateEditView.as_view(),
+        name="zonetemplate_edit",
+    ),
+    path(
+        "zonetemplates/<int:pk>/delete/",
+        ZoneTemplateDeleteView.as_view(),
+        name="zonetemplate_delete",
+    ),
     path(
         "zonetemplates/import/",
         ZoneTemplateBulkImportView.as_view(),
@@ -31,27 +41,7 @@ zonetemplate_urlpatterns = [
         ZoneTemplateBulkDeleteView.as_view(),
         name="zonetemplate_bulk_delete",
     ),
-    path("zonetemplates/<int:pk>/", ZoneTemplateView.as_view(), name="zonetemplate"),
-    path(
-        "zonetemplates/<int:pk>/delete/",
-        ZoneTemplateDeleteView.as_view(),
-        name="zonetemplate_delete",
-    ),
-    path(
-        "zonetemplates/<int:pk>/edit/",
-        ZoneTemplateEditView.as_view(),
-        name="zonetemplate_edit",
-    ),
-    path(
-        "zonetemplates/<int:pk>/journal/",
-        ObjectJournalView.as_view(),
-        name="zonetemplate_journal",
-        kwargs={"model": ZoneTemplate},
-    ),
     path(
-        "zonetemplates/<int:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="zonetemplate_changelog",
-        kwargs={"model": ZoneTemplate},
+        "zonetemplates/<int:pk>/", include(get_model_urls("netbox_dns", "zonetemplate"))
     ),
 ]

netbox_dns/utilities/__init__.py

@@ -1,74 +1,2 @@
-import re
-
-from dns import name as dns_name
-from dns.exception import DNSException
-from netaddr import IPNetwork, AddrFormatError
-
-from netbox.plugins.utils import get_plugin_config
-
-
-class NameFormatError(Exception):
-    pass
-
-
-def arpa_to_prefix(arpa_name):
-    name = arpa_name.rstrip(".")
-
-    if name.endswith(".in-addr.arpa"):
-        address = ".".join(reversed(name.replace(".in-addr.arpa", "").split(".")))
-        mask = len(address.split(".")) * 8
-        address = address + (32 - mask) // 8 * ".0"
-
-        try:
-            return IPNetwork(f"{address}/{mask}")
-        except (AddrFormatError, ValueError):
-            return None
-
-    elif name.endswith("ip6.arpa"):
-        address = "".join(reversed(name.replace(".ip6.arpa", "").split(".")))
-        mask = len(address)
-        address = address + "0" * (32 - mask)
-
-        try:
-            return IPNetwork(
-                f"{':'.join([(address[i:i+4]) for i in range(0, 32, 4)])}/{mask*4}"
-            )
-        except AddrFormatError:
-            return None
-
-    else:
-        return None
-
-
-def name_to_unicode(name):
-    if name == "." and get_plugin_config("netbox_dns", "enable_root_zones"):
-        return "."
-
-    try:
-        return dns_name.from_text(name, origin=None).to_unicode()
-    except dns_name.IDNAException:
-        return name
-
-
-def value_to_unicode(value):
-    return re.sub(
-        r"xn--[0-9a-z-_.]*",
-        lambda x: name_to_unicode(x.group(0)),
-        value,
-        flags=re.IGNORECASE,
-    )
-
-
-def normalize_name(name):
-    if name == "." and get_plugin_config("netbox_dns", "enable_root_zones"):
-        return "."
-
-    try:
-        return (
-            dns_name.from_text(name, origin=dns_name.root)
-            .relativize(dns_name.root)
-            .to_text()
-        )
-
-    except DNSException as exc:
-        raise NameFormatError from exc
+from .conversions import *
+from .ipam_dnssync import *

netbox_dns/utilities/conversions.py

@@ -0,0 +1,83 @@
+import re
+
+from dns import name as dns_name
+from dns.exception import DNSException
+from netaddr import IPNetwork, AddrFormatError
+
+from netbox.plugins.utils import get_plugin_config
+
+
+__all__ = (
+    "NameFormatError",
+    "arpa_to_prefix",
+    "name_to_unicode",
+    "value_to_unicode",
+    "normalize_name",
+)
+
+
+class NameFormatError(Exception):
+    pass
+
+
+def arpa_to_prefix(arpa_name):
+    name = arpa_name.rstrip(".")
+
+    if name.endswith(".in-addr.arpa"):
+        address = ".".join(reversed(name.replace(".in-addr.arpa", "").split(".")))
+        mask = len(address.split(".")) * 8
+        address = address + (32 - mask) // 8 * ".0"
+
+        try:
+            return IPNetwork(f"{address}/{mask}")
+        except (AddrFormatError, ValueError):
+            return None
+
+    elif name.endswith("ip6.arpa"):
+        address = "".join(reversed(name.replace(".ip6.arpa", "").split(".")))
+        mask = len(address)
+        address = address + "0" * (32 - mask)
+
+        try:
+            return IPNetwork(
+                f"{':'.join([(address[i:i+4]) for i in range(0, 32, 4)])}/{mask*4}"
+            )
+        except AddrFormatError:
+            return None
+
+    else:
+        return None
+
+
+def name_to_unicode(name):
+    if name == "." and get_plugin_config("netbox_dns", "enable_root_zones"):
+        return "."
+
+    try:
+        return dns_name.from_text(name, origin=None).to_unicode()
+    except dns_name.IDNAException:
+        return name
+
+
+def value_to_unicode(value):
+    return re.sub(
+        r"xn--[0-9a-z-_.]*",
+        lambda x: name_to_unicode(x.group(0)),
+        value,
+        flags=re.IGNORECASE,
+    )
+
+
+def normalize_name(name):
+    if name == "." and get_plugin_config("netbox_dns", "enable_root_zones"):
+        return "."
+
+    try:
+        return (
+            dns_name.from_text(name, origin=dns_name.root)
+            .relativize(dns_name.root)
+            .to_text()
+        )
+
+    except DNSException as exc:
+        raise NameFormatError from exc

netbox_dns/utilities/ipam_dnssync.py

@@ -0,0 +1,295 @@
+import re
+
+from collections import defaultdict
+
+from dns import name as dns_name
+
+from django.conf import settings
+from django.db.models import Q
+
+from netbox.context import current_request
+from ipam.models import IPAddress, Prefix
+
+from netbox_dns.models import zone as _zone
+from netbox_dns.models import record as _record
+from netbox_dns.models import view as _view
+from netbox_dns.choices import RecordStatusChoices
+
+
+__all__ = (
+    "get_zones",
+    "check_dns_records",
+    "update_dns_records",
+    "delete_dns_records",
+    "get_views_by_prefix",
+    "get_ip_addresses_by_prefix",
+    "get_ip_addresses_by_view",
+    "get_ip_addresses_by_zone",
+    "check_record_permission",
+)
+
+
+def _get_assigned_views(ip_address):
+    longest_prefix = Prefix.objects.filter(
+        vrf=ip_address.vrf,
+        prefix__net_contains_or_equals=str(ip_address.address.ip),
+        netbox_dns_views__isnull=False,
+    ).last()
+
+    if longest_prefix is None:
+        return []
+
+    return longest_prefix.netbox_dns_views.all()
+
+
+def _get_record_status(ip_address):
+    return (
+        RecordStatusChoices.STATUS_ACTIVE
+        if ip_address.status
+        in settings.PLUGINS_CONFIG["netbox_dns"].get(
+            "dnssync_ipaddress_active_status", []
+        )
+        else RecordStatusChoices.STATUS_INACTIVE
+    )
+
+
+def _valid_entry(ip_address, zone):
+    return zone.view in _get_assigned_views(ip_address) and dns_name.from_text(
+        ip_address.dns_name
+    ).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)
+        if not views:
+            return []
+
+    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(min_labels + 1, len(fqdn.labels))
+    ]
+
+    zones = _zone.Zone.objects.filter(
+        view__in=views,
+        name__in=zone_name_candidates,
+        active=True,
+    )
+
+    zone_map = defaultdict(list)
+
+    if old_zone is not None:
+        zones = zones.exclude(pk=old_zone.pk)
+        if _valid_entry(ip_address, old_zone):
+            zone_map[old_zone.view].append(old_zone)
+
+    for zone in zones:
+        zone_map[zone.view].append(zone)
+
+    return [
+        sorted(zones_per_view, key=lambda x: len(x.name))[-1]
+        for zones_per_view in zone_map.values()
+    ]
+
+
+def check_dns_records(ip_address, zone=None, view=None):
+    if ip_address.dns_name == "":
+        return
+
+    if zone is None:
+        zones = get_zones(ip_address, view=view)
+
+        if ip_address.pk is not None:
+            for record in ip_address.netbox_dns_records.filter(zone__in=zones):
+                if not _match_data(ip_address, record):
+                    record.update_from_ip_address(ip_address)
+
+                    if record is not None:
+                        record.clean()
+
+            zones = _zone.Zone.objects.filter(
+                pk__in=[zone.pk for zone in zones]
+            ).exclude(
+                pk__in=set(ip_address.netbox_dns_records.values_list("zone", flat=True))
+            )
+
+        for zone in zones:
+            record = _record.Record.create_from_ip_address(
+                ip_address,
+                zone,
+            )
+
+            if record is not None:
+                record.clean()
+
+    if ip_address.pk is None:
+        return
+
+    try:
+        new_zone = get_zones(ip_address, old_zone=zone)[0]
+    except IndexError:
+        return
+
+    for record in ip_address.netbox_dns_records.filter(zone=zone):
+        record.update_from_ip_address(ip_address, new_zone)
+
+        if record is not None:
+            record.clean(new_zone=new_zone)
+
+
+def update_dns_records(ip_address):
+    if ip_address.dns_name == "":
+        delete_dns_records(ip_address)
+        return
+
+    zones = get_zones(ip_address)
+
+    if ip_address.pk is not None:
+        for record in ip_address.netbox_dns_records.all():
+            if record.zone not in zones or ip_address.custom_field_data.get(
+                "ipaddress_dns_disabled"
+            ):
+                record.delete()
+                continue
+
+            record.update_fqdn()
+            if not _match_data(ip_address, record):
+                record.update_from_ip_address(ip_address)
+
+                if record is not None:
+                    record.save()
+
+        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)
+            )
+        )
+
+    for zone in zones:
+        record = _record.Record.create_from_ip_address(
+            ip_address,
+            zone,
+        )
+
+        if record is not None:
+            record.save()
+
+
+def delete_dns_records(ip_address):
+    for record in ip_address.netbox_dns_records.all():
+        record.delete()
+
+
+def get_views_by_prefix(prefix):
+    if (views := prefix.netbox_dns_views.all()).exists():
+        return views
+
+    if (parent := prefix.get_parents().filter(netbox_dns_views__isnull=False)).exists():
+        return parent.last().netbox_dns_views.all()
+
+    return _view.View.objects.none()
+
+
+def get_ip_addresses_by_prefix(prefix, check_view=True):
+    """
+    Find all IPAddress objects that are in a given prefix, provided that prefix
+    is assigned to NetBox DNS view. IPAddress objects belonging to a sub-prefix
+    that is assigned to a NetBox DNS view itself are excluded, because the zones
+    that are relevant for them are depending on the view set of the sub-prefix.
+
+    If neither the prefix nor any parent prefix is assigned to a view, the list
+    of IPAddress objects returned is empty.
+    """
+    if check_view and not get_views_by_prefix(prefix):
+        return IPAddress.objects.none()
+
+    queryset = IPAddress.objects.filter(
+        vrf=prefix.vrf, address__net_host_contained=prefix.prefix
+    )
+
+    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,
+        )
+
+    return queryset
+
+
+def get_ip_addresses_by_view(view):
+    """
+    Find all IPAddress objects that are within prefixes that have a NetBox DNS
+    view assigned to them, or that inherit a view from their parent prefix.
+
+    Inheritance is defined recursively if the prefix is assigned to the view or
+    if it is a child prefix of the prefix that is not assigned to a view directly
+    or by inheritance.
+    """
+    queryset = IPAddress.objects.none()
+    for prefix in Prefix.objects.filter(netbox_dns_views__in=[view]):
+        sub_queryset = IPAddress.objects.filter(
+            vrf=prefix.vrf, address__net_host_contained=prefix.prefix
+        )
+        for exclude_child in prefix.get_children().exclude(
+            Q(netbox_dns_views__isnull=True) | Q(netbox_dns_views__in=[view])
+        ):
+            sub_queryset = sub_queryset.exclude(
+                vrf=exclude_child.vrf,
+                address__net_host_contained=exclude_child.prefix,
+            )
+        queryset |= sub_queryset
+
+    return queryset
+
+
+def get_ip_addresses_by_zone(zone):
+    """
+    Find all IPAddress objects that are relevant for a NetBox DNS zone. These
+    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).filter(
+        dns_name__regex=rf"\.{re.escape(zone.name)}\.?$"
+    )
+
+    return queryset
+
+
+def check_record_permission(add=True, change=True, delete=True):
+    checks = locals().copy()
+
+    request = current_request.get()
+
+    if request is None:
+        return True
+
+    return all(
+        (
+            request.user.has_perm(f"netbox_dns.{perm}_record")
+            for perm, check in checks.items()
+            if check
+        )
+    )

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_dns/views/__init__.py

@@ -2,7 +2,7 @@ from .view import *
 from .zone import *
 from .nameserver import *
 from .record import *
-from .contact import *
+from .registration_contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *

netbox_dns/views/nameserver.py

@@ -2,6 +2,7 @@ from dns import name as dns_name
 
 from netbox.views import generic
 from utilities.views import ViewTab, register_model_view
+from tenancy.views import ObjectContactsView
 
 from netbox_dns.filtersets import NameServerFilterSet, ZoneFilterSet
 from netbox_dns.forms import (
@@ -15,15 +16,13 @@ from netbox_dns.tables import NameServerTable, ZoneTable
 
 
 __all__ = (
-    "NameServerListView",
     "NameServerView",
+    "NameServerListView",
     "NameServerEditView",
     "NameServerDeleteView",
     "NameServerBulkEditView",
     "NameServerBulkImportView",
     "NameServerBulkDeleteView",
-    "NameServerZoneListView",
-    "NameServerSOAZoneListView",
 )
 
 
@@ -77,6 +76,11 @@ class NameServerBulkDeleteView(generic.BulkDeleteView):
     table = NameServerTable
 
 
+@register_model_view(NameServer, "contacts")
+class NameServerContactsView(ObjectContactsView):
+    queryset = NameServer.objects.all()
+
+
 @register_model_view(NameServer, "zones")
 class NameServerZoneListView(generic.ObjectChildrenView):
     queryset = NameServer.objects.all().prefetch_related("zones")