netbox-plugin-dns 0.21.4__py3-none-any.whl → 1.4.7__py3-none-any.whl

netbox_dns/models/zone_template.py

@@ -0,0 +1,209 @@
+from dns import name as dns_name
+from dns.exception import DNSException
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from django.core.exceptions import ValidationError
+from django.contrib.postgres.fields import ArrayField
+
+from netbox.models import NetBoxModel
+from netbox.search import SearchIndex, register_search
+
+from netbox_dns.validators import validate_rname
+
+
+__all__ = (
+    "ZoneTemplate",
+    "ZoneTemplateIndex",
+)
+
+
+class ZoneTemplate(NetBoxModel):
+    class Meta:
+        verbose_name = _("Zone Template")
+        verbose_name_plural = _("Zone Templates")
+
+        ordering = ("name",)
+
+    clone_fields = (
+        "description",
+        "nameservers",
+        "record_templates",
+        "soa_mname",
+        "soa_rname",
+        "dnssec_policy",
+        "parental_agents",
+        "registrar",
+        "registrant",
+        "admin_c",
+        "tech_c",
+        "billing_c",
+        "tenant",
+    )
+
+    template_fields = (
+        "soa_mname",
+        "soa_rname",
+        "dnssec_policy",
+        "parental_agents",
+        "registrar",
+        "registrant",
+        "admin_c",
+        "tech_c",
+        "billing_c",
+        "tenant",
+    )
+
+    def __str__(self):
+        return str(self.name)
+
+    name = models.CharField(
+        verbose_name=_("Template Name"),
+        unique=True,
+        max_length=200,
+        db_collation="natural_sort",
+    )
+    description = models.CharField(
+        verbose_name=_("Description"),
+        max_length=200,
+        blank=True,
+    )
+    nameservers = models.ManyToManyField(
+        verbose_name=_("Nameservers"),
+        to="NameServer",
+        related_name="+",
+        blank=True,
+    )
+    soa_mname = models.ForeignKey(
+        verbose_name=_("SOA MName"),
+        to="NameServer",
+        related_name="+",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    soa_rname = models.CharField(
+        verbose_name=_("SOA RName"),
+        max_length=255,
+        blank=True,
+    )
+    record_templates = models.ManyToManyField(
+        verbose_name=_("Record Templates"),
+        to="RecordTemplate",
+        related_name="zone_templates",
+        blank=True,
+    )
+    dnssec_policy = models.ForeignKey(
+        verbose_name=_("DNSSEC Policy"),
+        to="DNSSECPolicy",
+        on_delete=models.SET_NULL,
+        related_name="zone_templates",
+        blank=True,
+        null=True,
+    )
+    parental_agents = ArrayField(
+        base_field=models.GenericIPAddressField(
+            protocol="both",
+        ),
+        blank=True,
+        null=True,
+        default=list,
+    )
+    registrar = models.ForeignKey(
+        verbose_name=_("Registrar"),
+        to="Registrar",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    registrant = models.ForeignKey(
+        verbose_name=_("Registrant"),
+        to="RegistrationContact",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    admin_c = models.ForeignKey(
+        verbose_name=_("Administrative Contact"),
+        to="RegistrationContact",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    tech_c = models.ForeignKey(
+        verbose_name=_("Technical Contact"),
+        to="RegistrationContact",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    billing_c = models.ForeignKey(
+        verbose_name=_("Billing Contact"),
+        to="RegistrationContact",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
+        to="tenancy.Tenant",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+
+    def apply_to_zone_data(self, data):
+        fields_changed = False
+        for field in self.template_fields:
+            if data.get(field) in (None, "") and getattr(self, field) not in (None, ""):
+                fields_changed = True
+                data[field] = getattr(self, field)
+
+        return fields_changed
+
+    def apply_to_zone_relations(self, zone):
+        if not zone.nameservers.all() and self.nameservers.all():
+            zone.nameservers.set(self.nameservers.all())
+
+        if not zone.tags.all() and self.tags.all():
+            zone.tags.set(self.tags.all())
+
+        self.create_records(zone)
+
+    def create_records(self, zone):
+        for record_template in self.record_templates.all():
+            record_template.create_record(zone=zone)
+
+    def clean(self, *args, **kwargs):
+        if self.soa_rname:
+            try:
+                dns_name.from_text(self.soa_rname, origin=dns_name.root)
+                validate_rname(self.soa_rname)
+            except (DNSException, ValidationError) as exc:
+                raise ValidationError(
+                    {
+                        "soa_rname": exc,
+                    }
+                )
+
+
+@register_search
+class ZoneTemplateIndex(SearchIndex):
+    model = ZoneTemplate
+
+    fields = (
+        ("name", 100),
+        ("tenant", 300),
+        ("registrar", 300),
+        ("registrant", 300),
+        ("admin_c", 300),
+        ("tech_c", 300),
+        ("billing_c", 300),
+        ("description", 500),
+    )

netbox_dns/navigation.py

@@ -1,165 +1,265 @@
-from extras.plugins import PluginMenuButton, PluginMenuItem
-from extras.plugins import PluginMenu
-from utilities.choices import ButtonColorChoices
+from django.utils.translation import gettext_lazy as _
+
+from netbox.plugins import PluginMenuButton, PluginMenuItem, PluginMenu
+from netbox.plugins.utils import get_plugin_config
+
+menu_name = get_plugin_config("netbox_dns", "menu_name")
+top_level_menu = get_plugin_config("netbox_dns", "top_level_menu")
 
 view_menu_item = PluginMenuItem(
     link="plugins:netbox_dns:view_list",
-    link_text="Views",
+    link_text=_("Views"),
     permissions=["netbox_dns.view_view"],
     buttons=(
         PluginMenuButton(
             "plugins:netbox_dns:view_add",
-            "Add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_view"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:view_import",
-            "Import",
+            "plugins:netbox_dns:view_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_view"],
         ),
     ),
 )
 
-zone_menu_item = PluginMenuItem(
-    link="plugins:netbox_dns:zone_list",
-    link_text="Zones",
-    permissions=["netbox_dns.view_zone"],
+nameserver_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:nameserver_list",
+    link_text=_("Nameservers"),
+    permissions=["netbox_dns.view_nameserver"],
     buttons=(
         PluginMenuButton(
-            "plugins:netbox_dns:zone_add",
-            "Add",
+            "plugins:netbox_dns:nameserver_add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
-            permissions=["netbox_dns.add_zone"],
+            permissions=["netbox_dns.add_nameserver"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:zone_import",
-            "Import",
+            "plugins:netbox_dns:nameserver_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
-            permissions=["netbox_dns.add_zone"],
+            permissions=["netbox_dns.add_nameserver"],
         ),
     ),
 )
 
-nameserver_menu_item = PluginMenuItem(
-    link="plugins:netbox_dns:nameserver_list",
-    link_text="Nameservers",
-    permissions=["netbox_dns.view_nameserver"],
+zone_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:zone_list",
+    link_text=_("Zones"),
+    permissions=["netbox_dns.view_zone"],
     buttons=(
         PluginMenuButton(
-            "plugins:netbox_dns:nameserver_add",
-            "Add",
+            "plugins:netbox_dns:zone_add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
-            permissions=["netbox_dns.add_nameserver"],
+            permissions=["netbox_dns.add_zone"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:nameserver_import",
-            "Import",
+            "plugins:netbox_dns:zone_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
-            permissions=["netbox_dns.add_nameserver"],
+            permissions=["netbox_dns.add_zone"],
         ),
     ),
 )
 
 record_menu_item = PluginMenuItem(
     link="plugins:netbox_dns:record_list",
-    link_text="Records",
+    link_text=_("Records"),
     permissions=["netbox_dns.view_record"],
     buttons=(
         PluginMenuButton(
             "plugins:netbox_dns:record_add",
-            "Add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_record"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:record_import",
-            "Import",
+            "plugins:netbox_dns:record_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_record"],
         ),
     ),
 )
 
 managed_record_menu_item = PluginMenuItem(
-    link="plugins:netbox_dns:managed_record_list",
-    link_text="Managed Records",
+    link="plugins:netbox_dns:record_list_managed",
+    link_text=_("Managed Records"),
     permissions=["netbox_dns.view_record"],
 )
 
+zonetemplate_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:zonetemplate_list",
+    link_text=_("Zone Templates"),
+    permissions=["netbox_dns.view_zonetemplate"],
+    buttons=(
+        PluginMenuButton(
+            "plugins:netbox_dns:zonetemplate_add",
+            _("Add"),
+            "mdi mdi-plus-thick",
+            permissions=["netbox_dns.add_zonetemplate"],
+        ),
+        PluginMenuButton(
+            "plugins:netbox_dns:zonetemplate_bulk_import",
+            _("Import"),
+            "mdi mdi-upload",
+            permissions=["netbox_dns.add_zonetemplate"],
+        ),
+    ),
+)
+
+recordtemplate_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:recordtemplate_list",
+    link_text=_("Record Templates"),
+    permissions=["netbox_dns.view_recordtemplate"],
+    buttons=(
+        PluginMenuButton(
+            "plugins:netbox_dns:recordtemplate_add",
+            _("Add"),
+            "mdi mdi-plus-thick",
+            permissions=["netbox_dns.add_recordtemplate"],
+        ),
+        PluginMenuButton(
+            "plugins:netbox_dns:recordtemplate_bulk_import",
+            _("Import"),
+            "mdi mdi-upload",
+            permissions=["netbox_dns.add_recordtemplate"],
+        ),
+    ),
+)
+
+dnsseckeytemplate_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:dnsseckeytemplate_list",
+    link_text=_("DNSSEC Key Templates"),
+    permissions=["netbox_dns.view_dnsseckeytemplate"],
+    buttons=(
+        PluginMenuButton(
+            "plugins:netbox_dns:dnsseckeytemplate_add",
+            _("Add"),
+            "mdi mdi-plus-thick",
+            permissions=["netbox_dns.add_dnsseckeytemplate"],
+        ),
+        PluginMenuButton(
+            "plugins:netbox_dns:dnsseckeytemplate_bulk_import",
+            _("Import"),
+            "mdi mdi-upload",
+            permissions=["netbox_dns.add_dnsseckeytemplate"],
+        ),
+    ),
+)
+
+dnssecpolicy_menu_item = PluginMenuItem(
+    link="plugins:netbox_dns:dnssecpolicy_list",
+    link_text=_("DNSSEC Policies"),
+    permissions=["netbox_dns.view_dnssecpolicy"],
+    buttons=(
+        PluginMenuButton(
+            "plugins:netbox_dns:dnssecpolicy_add",
+            _("Add"),
+            "mdi mdi-plus-thick",
+            permissions=["netbox_dns.add_dnssecpolicy"],
+        ),
+        PluginMenuButton(
+            "plugins:netbox_dns:dnssecpolicy_bulk_import",
+            _("Import"),
+            "mdi mdi-upload",
+            permissions=["netbox_dns.add_dnssecpolicy"],
+        ),
+    ),
+)
+
 registrar_menu_item = PluginMenuItem(
     link="plugins:netbox_dns:registrar_list",
-    link_text="Registrars",
+    link_text=_("Registrars"),
     permissions=["netbox_dns.view_registrar"],
     buttons=(
         PluginMenuButton(
             "plugins:netbox_dns:registrar_add",
-            "Add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_registrar"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:registrar_import",
-            "Import",
+            "plugins:netbox_dns:registrar_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_registrar"],
         ),
     ),
 )
 
 contact_menu_item = PluginMenuItem(
-    link="plugins:netbox_dns:contact_list",
-    link_text="Contacts",
-    permissions=["netbox_dns.view_contact"],
+    link="plugins:netbox_dns:registrationcontact_list",
+    link_text=_("Registration Contacts"),
+    permissions=["netbox_dns.view_registrationcontact"],
     buttons=(
         PluginMenuButton(
-            "plugins:netbox_dns:contact_add",
-            "Add",
+            "plugins:netbox_dns:registrationcontact_add",
+            _("Add"),
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
-            permissions=["netbox_dns.add_contact"],
+            permissions=["netbox_dns.add_registrationcontact"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:contact_import",
-            "Import",
+            "plugins:netbox_dns:registrationcontact_bulk_import",
+            _("Import"),
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
-            permissions=["netbox_dns.add_contact"],
+            permissions=["netbox_dns.add_registrationcontact"],
         ),
     ),
 )
 
-menu = PluginMenu(
-    label="NetBox DNS",
-    groups=(
-        (
-            "DNS Configuration",
+
+if top_level_menu:
+    menu = PluginMenu(
+        label=menu_name,
+        groups=(
             (
-                view_menu_item,
-                zone_menu_item,
-                nameserver_menu_item,
-                record_menu_item,
-                managed_record_menu_item,
+                _("DNS Configuration"),
+                (
+                    view_menu_item,
+                    nameserver_menu_item,
+                    zone_menu_item,
+                    record_menu_item,
+                    managed_record_menu_item,
+                ),
+            ),
+            (
+                _("Templates"),
+                (
+                    zonetemplate_menu_item,
+                    recordtemplate_menu_item,
+                ),
             ),
-        ),
-        (
-            "Domain Registration",
             (
-                registrar_menu_item,
-                contact_menu_item,
+                _("DNSSEC"),
+                (
+                    dnsseckeytemplate_menu_item,
+                    dnssecpolicy_menu_item,
+                ),
+            ),
+            (
+                _("Domain Registration"),
+                (
+                    registrar_menu_item,
+                    contact_menu_item,
+                ),
             ),
         ),
-    ),
-    icon_class="mdi mdi-dns",
-)
+        icon_class="mdi mdi-dns",
+    )
+else:
+    menu_items = (
+        view_menu_item,
+        zone_menu_item,
+        nameserver_menu_item,
+        record_menu_item,
+        managed_record_menu_item,
+        dnsseckeytemplate_menu_item,
+        dnssecpolicy_menu_item,
+        registrar_menu_item,
+        contact_menu_item,
+    )

netbox_dns/signals/dnssec.py

@@ -0,0 +1,32 @@
+from django.dispatch import receiver
+from django.db.models.signals import m2m_changed
+from django.core.exceptions import ValidationError
+
+from netbox.context import current_request
+from utilities.exceptions import AbortRequest
+
+from netbox_dns.validators import validate_key_template_assignment
+
+from netbox_dns.models import DNSSECPolicy, DNSSECKeyTemplate
+
+
+@receiver(m2m_changed, sender=DNSSECPolicy.key_templates.through)
+def dnssec_policy_key_templates_changed(action, instance, pk_set, **kwargs):
+    request = current_request.get()
+
+    key_templates = instance.key_templates.all()
+    match action:
+        case "pre_remove":
+            key_templates = key_templates.exclude(pk__in=pk_set)
+        case "pre_add":
+            key_templates |= DNSSECKeyTemplate.objects.filter(pk__in=pk_set)
+        case _:
+            return
+
+    try:
+        validate_key_template_assignment(key_templates)
+    except ValidationError as exc:
+        if request is not None:
+            raise AbortRequest(exc)
+        else:
+            raise exc