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

netbox_dns/templates/netbox_dns/view.html

@@ -10,6 +10,10 @@
                         <th scope="row">Name</th>
                         <td>{{ object.name }}</td>
                     </tr>
+                    <tr>
+                        <th scope="row">Default View</th>
+                        <td>{% checkmark object.default_view %}</td>
+                    </tr>
                     {% if object.description %}
                     <tr>
                         <th scope="row">Description</th>

netbox_dns/templates/netbox_dns/zone.html

@@ -20,7 +20,6 @@
                         <td>{{ unicode_name }}</td>
                     </tr>
                 {% endif %}
-                {% if object.view %}
                 <tr>
                     <th scope="row">View</th>
                     <td>
@@ -29,7 +28,6 @@
                         </a>
                     </td>
                 </tr>
-                {% endif %}
                 {% if object.description %}
                 <tr>
                     <th scope="row">Description</th>
@@ -116,11 +114,11 @@
                     <td>{{ object.soa_ttl }}</td>
                 </tr>
                 <tr>
-                    <th scope="row">Primary Nameserver</th>
+                    <th scope="row">MName</th>
                     <td><a href="{% url 'plugins:netbox_dns:nameserver' pk=object.soa_mname.pk %}">{{ object.soa_mname }}</a></td>
                 </tr>
                 <tr>
-                    <th scope="row">Responsible</th>
+                    <th scope="row">RName</th>
                     <td>{{ object.soa_rname }}</td>
                 </tr>
                 {% if object.soa_serial_auto %}

netbox_dns/urls/__init__.py

@@ -0,0 +1,17 @@
+from .contact import contact_urlpatterns
+from .nameserver import nameserver_urlpatterns
+from .record import record_urlpatterns
+from .registrar import registrar_urlpatterns
+from .view import view_urlpatterns
+from .zone import zone_urlpatterns
+
+app_name = "netbox_dns"
+
+urlpatterns = (
+    contact_urlpatterns
+    + nameserver_urlpatterns
+    + record_urlpatterns
+    + registrar_urlpatterns
+    + view_urlpatterns
+    + zone_urlpatterns
+)

netbox_dns/urls/contact.py

@@ -0,0 +1,51 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Contact
+from netbox_dns.views import (
+    ContactListView,
+    ContactView,
+    ContactDeleteView,
+    ContactEditView,
+    ContactBulkImportView,
+    ContactBulkEditView,
+    ContactBulkDeleteView,
+    ContactZoneListView,
+)
+
+contact_urlpatterns = [
+    path("contacts/", ContactListView.as_view(), name="contact_list"),
+    path("contacts/add/", ContactEditView.as_view(), name="contact_add"),
+    path("contacts/import/", ContactBulkImportView.as_view(), name="contact_import"),
+    path("contacts/edit/", ContactBulkEditView.as_view(), name="contact_bulk_edit"),
+    path(
+        "contacts/delete/",
+        ContactBulkDeleteView.as_view(),
+        name="contact_bulk_delete",
+    ),
+    path("contacts/<int:pk>/", ContactView.as_view(), name="contact"),
+    path("contacts/<int:pk>/edit/", ContactEditView.as_view(), name="contact_edit"),
+    path(
+        "contacts/<int:pk>/delete/",
+        ContactDeleteView.as_view(),
+        name="contact_delete",
+    ),
+    path(
+        "contacts/<int:pk>/zones/",
+        ContactZoneListView.as_view(),
+        name="contact_zones",
+    ),
+    path(
+        "contacts/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="contact_journal",
+        kwargs={"model": Contact},
+    ),
+    path(
+        "contacts/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="contact_changelog",
+        kwargs={"model": Contact},
+    ),
+]

netbox_dns/urls/nameserver.py

@@ -0,0 +1,69 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import NameServer
+from netbox_dns.views import (
+    NameServerListView,
+    NameServerView,
+    NameServerEditView,
+    NameServerDeleteView,
+    NameServerBulkImportView,
+    NameServerBulkEditView,
+    NameServerBulkDeleteView,
+    NameServerZoneListView,
+    NameServerSOAZoneListView,
+)
+
+nameserver_urlpatterns = [
+    path("nameservers/", NameServerListView.as_view(), name="nameserver_list"),
+    path("nameservers/add/", NameServerEditView.as_view(), name="nameserver_add"),
+    path(
+        "nameservers/import/",
+        NameServerBulkImportView.as_view(),
+        name="nameserver_import",
+    ),
+    path(
+        "nameservers/edit/",
+        NameServerBulkEditView.as_view(),
+        name="nameserver_bulk_edit",
+    ),
+    path(
+        "nameservers/delete/",
+        NameServerBulkDeleteView.as_view(),
+        name="nameserver_bulk_delete",
+    ),
+    path("nameservers/<int:pk>/", NameServerView.as_view(), name="nameserver"),
+    path(
+        "nameservers/<int:pk>/edit",
+        NameServerEditView.as_view(),
+        name="nameserver_edit",
+    ),
+    path(
+        "nameservers/<int:pk>/delete",
+        NameServerDeleteView.as_view(),
+        name="nameserver_delete",
+    ),
+    path(
+        "nameservers/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="nameserver_journal",
+        kwargs={"model": NameServer},
+    ),
+    path(
+        "nameservers/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="nameserver_changelog",
+        kwargs={"model": NameServer},
+    ),
+    path(
+        "nameservers/<int:pk>/zones/",
+        NameServerZoneListView.as_view(),
+        name="nameserver_zones",
+    ),
+    path(
+        "nameservers/<int:pk>/soazones/",
+        NameServerSOAZoneListView.as_view(),
+        name="nameserver_soa_zones",
+    ),
+]

netbox_dns/urls/record.py

@@ -0,0 +1,41 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Record
+from netbox_dns.views import (
+    RecordListView,
+    RecordView,
+    RecordEditView,
+    RecordDeleteView,
+    RecordBulkImportView,
+    RecordBulkEditView,
+    RecordBulkDeleteView,
+    ManagedRecordListView,
+)
+
+record_urlpatterns = [
+    path("records/", RecordListView.as_view(), name="record_list"),
+    path("records/add/", RecordEditView.as_view(), name="record_add"),
+    path("records/import/", RecordBulkImportView.as_view(), name="record_import"),
+    path("records/edit/", RecordBulkEditView.as_view(), name="record_bulk_edit"),
+    path("records/delete/", RecordBulkDeleteView.as_view(), name="record_bulk_delete"),
+    path("records/<int:pk>/", RecordView.as_view(), name="record"),
+    path("records/<int:pk>/edit/", RecordEditView.as_view(), name="record_edit"),
+    path("records/<int:pk>/delete/", RecordDeleteView.as_view(), name="record_delete"),
+    path(
+        "records/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="record_journal",
+        kwargs={"model": Record},
+    ),
+    path(
+        "records/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="record_changelog",
+        kwargs={"model": Record},
+    ),
+    path(
+        "managedrecords/", ManagedRecordListView.as_view(), name="managed_record_list"
+    ),
+]

netbox_dns/urls/registrar.py

@@ -0,0 +1,63 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Registrar
+from netbox_dns.views import (
+    RegistrarListView,
+    RegistrarView,
+    RegistrarDeleteView,
+    RegistrarEditView,
+    RegistrarBulkImportView,
+    RegistrarBulkEditView,
+    RegistrarBulkDeleteView,
+    RegistrarZoneListView,
+)
+
+registrar_urlpatterns = [
+    path("registrars/", RegistrarListView.as_view(), name="registrar_list"),
+    path("registrars/add/", RegistrarEditView.as_view(), name="registrar_add"),
+    path(
+        "registrars/import/",
+        RegistrarBulkImportView.as_view(),
+        name="registrar_import",
+    ),
+    path(
+        "registrars/edit/",
+        RegistrarBulkEditView.as_view(),
+        name="registrar_bulk_edit",
+    ),
+    path(
+        "registrars/delete/",
+        RegistrarBulkDeleteView.as_view(),
+        name="registrar_bulk_delete",
+    ),
+    path("registrars/<int:pk>/", RegistrarView.as_view(), name="registrar"),
+    path(
+        "registrars/<int:pk>/edit/",
+        RegistrarEditView.as_view(),
+        name="registrar_edit",
+    ),
+    path(
+        "registrars/<int:pk>/delete/",
+        RegistrarDeleteView.as_view(),
+        name="registrar_delete",
+    ),
+    path(
+        "registrars/<int:pk>/zones/",
+        RegistrarZoneListView.as_view(),
+        name="registrar_zones",
+    ),
+    path(
+        "registrars/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="registrar_journal",
+        kwargs={"model": Registrar},
+    ),
+    path(
+        "registrars/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="registrar_changelog",
+        kwargs={"model": Registrar},
+    ),
+]

netbox_dns/urls/view.py

@@ -0,0 +1,39 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import View
+from netbox_dns.views import (
+    ViewListView,
+    ViewView,
+    ViewDeleteView,
+    ViewEditView,
+    ViewBulkImportView,
+    ViewBulkEditView,
+    ViewBulkDeleteView,
+    ViewZoneListView,
+)
+
+view_urlpatterns = [
+    path("views/", ViewListView.as_view(), name="view_list"),
+    path("views/add/", ViewEditView.as_view(), name="view_add"),
+    path("views/import/", ViewBulkImportView.as_view(), name="view_import"),
+    path("views/edit/", ViewBulkEditView.as_view(), name="view_bulk_edit"),
+    path("views/delete/", ViewBulkDeleteView.as_view(), name="view_bulk_delete"),
+    path("views/<int:pk>/", ViewView.as_view(), name="view"),
+    path("views/<int:pk>/edit/", ViewEditView.as_view(), name="view_edit"),
+    path("views/<int:pk>/delete/", ViewDeleteView.as_view(), name="view_delete"),
+    path("views/<int:pk>/zones/", ViewZoneListView.as_view(), name="view_zones"),
+    path(
+        "views/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="view_journal",
+        kwargs={"model": View},
+    ),
+    path(
+        "views/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="view_changelog",
+        kwargs={"model": View},
+    ),
+]

netbox_dns/urls/zone.py

@@ -0,0 +1,57 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Zone
+from netbox_dns.views import (
+    ZoneListView,
+    ZoneView,
+    ZoneDeleteView,
+    ZoneEditView,
+    ZoneBulkImportView,
+    ZoneBulkEditView,
+    ZoneBulkDeleteView,
+    ZoneRecordListView,
+    ZoneManagedRecordListView,
+    ZoneRegistrationView,
+    ZoneRFC2317ChildZoneListView,
+)
+
+zone_urlpatterns = [
+    path("zones/", ZoneListView.as_view(), name="zone_list"),
+    path("zones/add/", ZoneEditView.as_view(), name="zone_add"),
+    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>/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},
+    ),
+]

netbox_dns/validators/dns_name.py

@@ -14,19 +14,25 @@ def has_invalid_double_dash(name):
     return bool(re.findall(r"\b(?!xn)..--", name, re.IGNORECASE))
 
 
-def validate_fqdn(name):
-    if get_plugin_config("netbox_dns", "tolerate_underscores_in_hostnames"):
+def validate_fqdn(name, always_tolerant=False):
+    if always_tolerant or get_plugin_config(
+        "netbox_dns", "tolerate_underscores_in_hostnames"
+    ):
         regex = rf"^(\*|{TOLERANT_LABEL})(\.{TOLERANT_LABEL})+\.?$"
     else:
         regex = rf"^(\*|{LABEL})(\.{LABEL})+\.?$"
 
     if not re.match(regex, name, flags=re.IGNORECASE) or has_invalid_double_dash(name):
-        raise ValidationError("Not a valid fully qualified DNS host name")
+        raise ValidationError(f"{name} is not a valid fully qualified DNS host name")
 
 
-def validate_extended_hostname(name, tolerate_leading_underscores=False):
-    if tolerate_leading_underscores:
-        if get_plugin_config("netbox_dns", "tolerate_underscores_in_hostnames"):
+def validate_extended_hostname(
+    name, tolerate_leading_underscores=False, always_tolerant=False
+):
+    if always_tolerant or tolerate_leading_underscores:
+        if always_tolerant or get_plugin_config(
+            "netbox_dns", "tolerate_underscores_in_hostnames"
+        ):
             regex = rf"^([*@]|(\*\.)?{TOLERANT_LEADING_UNDERSCORE_LABEL}(\.{TOLERANT_LEADING_UNDERSCORE_LABEL})*\.?)$"
         else:
             regex = rf"^([*@]|(\*\.)?{LEADING_UNDERSCORE_LABEL}(\.{LEADING_UNDERSCORE_LABEL})*\.?)$"
@@ -36,17 +42,24 @@ def validate_extended_hostname(name, tolerate_leading_underscores=False):
         regex = rf"^([*@]|(\*\.)?{LABEL}(\.{LABEL})*\.?)$"
 
     if not re.match(regex, name, flags=re.IGNORECASE) or has_invalid_double_dash(name):
-        raise ValidationError("Not a valid DNS host name")
+        raise ValidationError(f"{name} is not a valid DNS host name")
 
 
-def validate_domain_name(name):
-    if name == "." and get_plugin_config("netbox_dns", "enable_root_zones"):
+def validate_domain_name(name, always_tolerant=False, allow_empty_label=False):
+    if name == "@" and allow_empty_label:
         return
 
-    if get_plugin_config("netbox_dns", "tolerate_underscores_in_hostnames"):
+    if name == "." and (
+        always_tolerant or get_plugin_config("netbox_dns", "enable_root_zones")
+    ):
+        return
+
+    if always_tolerant or get_plugin_config(
+        "netbox_dns", "tolerate_underscores_in_hostnames"
+    ):
         regex = rf"^{TOLERANT_LABEL}(\.{TOLERANT_LABEL})*\.?$"
     else:
         regex = rf"^{LABEL}(\.{LABEL})*\.?$"
 
     if not re.match(regex, name, flags=re.IGNORECASE) or has_invalid_double_dash(name):
-        raise ValidationError("Not a valid DNS domain name")
+        raise ValidationError(f"{name} is not a valid DNS domain name")

netbox_dns/views/record.py

@@ -1,8 +1,5 @@
 from dns import name as dns_name
 
-from django.db.models import Q
-from django.db.models.functions import Length
-
 from netbox.views import generic
 
 from netbox_dns.filtersets import RecordFilterSet
@@ -42,21 +39,10 @@ class RecordView(generic.ObjectView):
 
     def get_value_records(self, instance):
         value_fqdn = dns_name.from_text(instance.value_fqdn)
-        value_zone_names = [
-            value_fqdn.split(length)[1].to_text().rstrip(".")
-            for length in range(2, len(value_fqdn) + 1)
-        ]
 
-        value_zone = (
-            Zone.objects.filter(instance.zone.view_filter, name__in=value_zone_names)
-            .order_by(Length("name").desc())
-            .first()
+        cname_targets = Record.objects.filter(
+            zone__view=instance.zone.view, fqdn=value_fqdn
         )
-        if not value_zone:
-            return None
-
-        value_name = value_fqdn.relativize(dns_name.from_text(value_zone.name))
-        cname_targets = Record.objects.filter(zone=value_zone, name=value_name)
 
         if cname_targets:
             return RelatedRecordTable(
@@ -66,14 +52,11 @@ class RecordView(generic.ObjectView):
         return None
 
     def get_cname_records(self, instance):
-        view_filter = (
-            Q(zone__view__isnull=True)
-            if instance.zone.view is None
-            else Q(zone__view=instance.zone.view)
-        )
         cname_records = set(
             Record.objects.filter(
-                view_filter, value=instance.fqdn, type=RecordTypeChoices.CNAME
+                zone__view=instance.zone.view,
+                value=instance.fqdn,
+                type=RecordTypeChoices.CNAME,
             )
         )
 
@@ -84,12 +67,14 @@ class RecordView(generic.ObjectView):
         ]
 
         parent_zones = Zone.objects.filter(
-            instance.zone.view_filter, name__in=parent_zone_names
+            view=instance.zone.view, name__in=parent_zone_names
         )
 
         for parent_zone in parent_zones:
             parent_cname_records = Record.objects.filter(
-                view_filter, type=RecordTypeChoices.CNAME, zone=parent_zone
+                zone__view=instance.zone.view,
+                type=RecordTypeChoices.CNAME,
+                zone=parent_zone,
             )
             cname_records = cname_records.union(
                 set(

{netbox_plugin_dns-1.0b1.dist-info → netbox_plugin_dns-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 1.0b1
+Version: 1.0.1
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Home-page: https://github.com/peteeckel/netbox-plugin-dns
 License: MIT
@@ -8,18 +8,18 @@ Keywords: netbox,netbox-plugin,dns
 Author: Peter Eckel
 Author-email: pete@netbox-dns.org
 Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: dnspython (>=2.2.1,<3.0.0)
+Requires-Dist: dnspython (>=2.6.1,<3.0.0)
 Project-URL: Repository, https://github.com/peteeckel/netbox-plugin-dns
 Description-Content-Type: text/markdown
 
 # NetBox DNS
-The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, current and conforming to the relevant RFCs.
+The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, up-to-date and compliant with to the relevant RFCs.
 
 <div align="center">
 <a href="https://pypi.org/project/netbox-plugin-dns/"><img src="https://img.shields.io/pypi/v/netbox-plugin-dns" alt="PyPi"/></a>
@@ -34,16 +34,30 @@ The NetBox DNS plugin enables NetBox to manage operational DNS data such as name
 <a href="https://pepy.tech/project/netbox-plugin-dns"><img alt="Downloads/Month" src="https://static.pepy.tech/badge/netbox-plugin-dns/week"></a>
 </div>
 
-## Features
+## Objectives
+NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.
 
-* Manage name servers, zones and records
-* Automatically generate SOA and NS records for zones
-* Automatically create and update PTR records for IPv4 and IPv6 address records
-* Organize DNS zones in views for split horizon DNS and multi-site deployments
-* Manage domain registrar and registrant information for domains related to zones
-* Manage RFC2317 reverse zones for IPv4 prefixes with a network mask length longer than 24 bits
+The plugin stores information about DNS name servers, DNS views and zones, and DNS records, making it a data source for automatic provisioning of DNS instances. Registration information about DNS registrars and contacts for DNS domains can also be stored and associated with zones.
 
-NetBox DNS is using the standardized NetBox plugin interface, so it also takes advantage of the NetBox tagging and change log features.
+The main focus of the plugin is to ensure the quality of the data stored in it. To achieve this, there are many validation and automation mechanisms in place:
+
+* Validation of record names and values
+* Automatic maintenance of PTR records for IPv6 and IPv4 address records
+* Automatic generation of SOA records, optionally including the serial number of the zone data
+* 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
+
+Other main features include:
+
+* Support for BIND views, providing lightweight namespaces for zones
+* Support for IDN, including the validation of punycode names
+* Full support for the NetBox REST and GraphQL APIs
+* Support for all major NetBox features such as global search, tenancy, change logs, tagging, journaling etc.
+
+## Non-objectives
+In the same way as NetBox is not a network management application, NetBox DNS does not provide any functionality to manage specific name servers or DNS service providers or to generate input such as configuration and zone files for them. The focus is on the completeness and integrity of the data needed to run DNS zones, not on the peculiarities of a plethora of servers and services that actually use the data. This functionality is left to specialized integration tools, or in many cases it can be easily implemented using Ansible or similar tools based on NetBox DNS data. Example code for some simple use cases is provided.
+
+For integration with a large number of DNS server implementations integration tools like [octodns-netbox-dns](https://pypi.org/project/octodns-netbox-dns/) are available.
 
 ## Requirements
 
@@ -85,7 +99,7 @@ Full documentation on using plugins with NetBox: [Using Plugins - NetBox Documen
 
 ## Contribute
 
-Contributions are always welcome! Please see: [contributing guide](CONTRIBUTING.md)
+Contributions are always welcome! Please see the [Contribution Guidelines](CONTRIBUTING.md)
 
 ## Documentation