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

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/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/record.py

@@ -39,9 +39,7 @@ class RecordListView(generic.ObjectListView):
 
 
 class ManagedRecordListView(generic.ObjectListView):
-    queryset = Record.objects.filter(managed=True).prefetch_related(
-        "zone", "address_record"
-    )
+    queryset = Record.objects.prefetch_related("ipam_ip_address", "address_record")
     filterset = RecordFilterSet
     filterset_form = RecordFilterForm
     table = ManagedRecordTable
@@ -92,11 +90,11 @@ class RecordView(generic.ObjectView):
                 zone=parent_zone,
             )
             cname_records = cname_records.union(
-                set(
+                {
                     record
                     for record in parent_cname_records
                     if record.value_fqdn == instance.fqdn
-                )
+                }
             )
 
         if cname_records:

netbox_dns/views/registration_contact.py

@@ -0,0 +1,94 @@
+from django.db.models import Q
+
+from netbox.views import generic
+
+from utilities.views import ViewTab, register_model_view
+
+from netbox_dns.models import RegistrationContact, Zone
+from netbox_dns.filtersets import RegistrationContactFilterSet, ZoneFilterSet
+from netbox_dns.forms import (
+    RegistrationContactForm,
+    RegistrationContactFilterForm,
+    RegistrationContactImportForm,
+    RegistrationContactBulkEditForm,
+)
+from netbox_dns.tables import RegistrationContactTable, ZoneTable
+
+
+__all__ = (
+    "RegistrationContactView",
+    "RegistrationContactEditView",
+    "RegistrationContactListView",
+    "RegistrationContactDeleteView",
+    "RegistrationContactBulkImportView",
+    "RegistrationContactBulkEditView",
+    "RegistrationContactBulkDeleteView",
+)
+
+
+class RegistrationContactView(generic.ObjectView):
+    queryset = RegistrationContact.objects.all()
+
+
+class RegistrationContactListView(generic.ObjectListView):
+    queryset = RegistrationContact.objects.all()
+    table = RegistrationContactTable
+    filterset = RegistrationContactFilterSet
+    filterset_form = RegistrationContactFilterForm
+
+
+class RegistrationContactEditView(generic.ObjectEditView):
+    queryset = RegistrationContact.objects.all()
+    form = RegistrationContactForm
+    default_return_url = "plugins:netbox_dns:registrationcontact_list"
+
+
+class RegistrationContactDeleteView(generic.ObjectDeleteView):
+    queryset = RegistrationContact.objects.all()
+    default_return_url = "plugins:netbox_dns:registrationcontact_list"
+
+
+class RegistrationContactBulkImportView(generic.BulkImportView):
+    queryset = RegistrationContact.objects.all()
+    model_form = RegistrationContactImportForm
+    table = RegistrationContactTable
+    default_return_url = "plugins:netbox_dns:registrationcontact_list"
+
+
+class RegistrationContactBulkEditView(generic.BulkEditView):
+    queryset = RegistrationContact.objects.all()
+    filterset = RegistrationContactFilterSet
+    table = RegistrationContactTable
+    form = RegistrationContactBulkEditForm
+
+
+class RegistrationContactBulkDeleteView(generic.BulkDeleteView):
+    queryset = RegistrationContact.objects.all()
+    table = RegistrationContactTable
+
+
+@register_model_view(RegistrationContact, "zones")
+class RegistrationContactZoneListView(generic.ObjectChildrenView):
+    queryset = RegistrationContact.objects.all().prefetch_related(
+        "zone_set", "admin_c_zones", "tech_c_zones", "billing_c_zones"
+    )
+    child_model = Zone
+    table = ZoneTable
+    filterset = ZoneFilterSet
+    template_name = "netbox_dns/zone/child.html"
+    hide_if_empty = True
+
+    tab = ViewTab(
+        label="Zones",
+        permission="netbox_dns.view_zone",
+        badge=lambda obj: len(obj.zones),
+        hide_if_empty=True,
+    )
+
+    def get_children(self, request, parent):
+        return Zone.objects.filter(
+            Q(registrant=parent)
+            | Q(admin_c=parent)
+            | Q(tech_c=parent)
+            | Q(billing_c=parent)
+        )

netbox_dns/views/view.py

@@ -2,11 +2,19 @@ from utilities.views import ViewTab, register_model_view
 
 from netbox.views import generic
 from tenancy.views import ObjectContactsView
+from ipam.models import Prefix
 
 from netbox_dns.models import View, Zone
 from netbox_dns.filtersets import ViewFilterSet, ZoneFilterSet
-from netbox_dns.forms import ViewForm, ViewFilterForm, ViewImportForm, ViewBulkEditForm
+from netbox_dns.forms import (
+    ViewForm,
+    ViewFilterForm,
+    ViewImportForm,
+    ViewBulkEditForm,
+    ViewPrefixEditForm,
+)
 from netbox_dns.tables import ViewTable, ZoneTable
+from netbox_dns.utilities import get_views_by_prefix
 
 
 __all__ = (
@@ -17,6 +25,7 @@ __all__ = (
     "ViewBulkImportView",
     "ViewBulkEditView",
     "ViewBulkDeleteView",
+    "ViewPrefixEditView",
 )
 
 
@@ -61,6 +70,22 @@ class ViewBulkDeleteView(generic.BulkDeleteView):
     table = ViewTable
 
 
+class ViewPrefixEditView(generic.ObjectEditView):
+    queryset = Prefix.objects.all()
+    form = ViewPrefixEditForm
+    template_name = "netbox_dns/view/prefix.html"
+
+    def get_extra_context(self, request, instance):
+        parents = instance.get_parents()
+        if parents:
+            return {
+                "inherited_views": get_views_by_prefix(parents.last()),
+                "inherited_from": parents.filter(netbox_dns_views__isnull=False).last(),
+            }
+
+        return {}
+
+
 @register_model_view(View, "zones")
 class ViewZoneListView(generic.ObjectChildrenView):
     queryset = View.objects.all().prefetch_related("zone_set")

{netbox_plugin_dns-1.0.7.dist-info → netbox_plugin_dns-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 1.0.7
+Version: 1.1.0
 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: