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

netbox_dns/__init__.py

@@ -1,71 +1,136 @@
-import sys
+from django.utils.translation import gettext_lazy as _
+from django.core.exceptions import ImproperlyConfigured
 
-from extras.plugins import PluginConfig
+from netbox.plugins import PluginConfig
+from netbox.plugins.utils import get_plugin_config
 
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
+__version__ = "1.4.7"
 
-__version__ = "0.21.4"
+
+def _check_list(setting):
+    if not isinstance(get_plugin_config("netbox_dns", setting), list):
+        raise ImproperlyConfigured(f"{setting} must be a list")
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
-    verbose_name = "NetBox DNS"
-    description = "NetBox plugin for DNS data"
-    min_version = "3.5.0"
+    verbose_name = _("NetBox DNS")
+    description = _("NetBox plugin for DNS data")
+    min_version = "4.3.2"
+    max_version = "4.4.99"
     version = __version__
     author = "Peter Eckel"
-    author_email = "pe-netbox-plugin-dns@hindenburgring.com"
-    middleware = ["netbox_dns.middleware.IpamCouplingMiddleware"]
+    author_email = "pete@netbox-dns.org"
     required_settings = []
     default_settings = {
         "zone_default_ttl": 86400,
-        "zone_soa_serial_auto": True,
+        "zone_soa_ttl": 86400,
         "zone_soa_serial": 1,
-        "zone_soa_refresh": 172800,
+        "zone_soa_refresh": 43200,
         "zone_soa_retry": 7200,
-        "zone_soa_expire": 2592000,
+        "zone_soa_expire": 2419200,
         "zone_soa_minimum": 3600,
-        "feature_ipam_coupling": False,
-        "tolerate_underscores_in_hostnames": False,
+        "zone_active_status": ["active", "dynamic"],
+        "zone_expiration_warning_days": 30,
+        "filter_record_types": [
+            # Obsolete or experimental RRTypes
+            "A6",  # RFC 6563: Historic
+            "AFSDB",  # RFC 5864: Obsolete
+            "APL",  # RFC 3123: Experimental
+            "AVC",  # https://www.iana.org/assignments/dns-parameters/AVC/avc-completed-template
+            "GPOS",  # RFC 1712: Experimental
+            "KEY",  # RFC 3755: Obsolete
+            "L32",  # RFC 6742: Experimental
+            "L64",  # RFC 6742: Experimental
+            "LP",  # RFC 6742: Experimental
+            "MB",  # RFC 2505: Unlikely to ever be adopted
+            "MD",  # RFC 973: Obsolete
+            "MF",  # RFC 973: Obsolete
+            "MG",  # RFC 2505: Unlikely to ever be adopted
+            "MINFO",  # RFC 2505: Unlikely to ever be adopted
+            "MR",  # RFC 2505: Unlikely to ever be adopted
+            "NID",  # RFC 6742: Experimental
+            "NINFO",  # Application expired
+            "NULL",  # RFC 1035: Obsolete
+            "NXT",  # RFC 3755: Obsolete
+            "SIG",  # RFC 3755: Obsolete
+            "SPF",  # RFC 7208: Obsolete
+            "WKS",  # RFC 1127: Not recommended
+            # RRTypes with no current use by any notable application
+            # (see https://en.wikipedia.org/wiki/List_of_DNS_record_types)
+            "RP",
+            "ISDN",
+            "RT",
+            "X25",
+            "NSAP",
+            "NSAP_PTR",
+            "PX",
+            "TYPE0",  # Reserved
+            "UNSPEC",  # Reserved
+            # DNSSEC RRTypes that are usually not manually maintained
+            "NSEC",
+            "NSEC3",
+            "RRSIG",
+        ],
+        "filter_record_types+": [],
+        "filter_record_types-": [],
+        "custom_record_types": [],
+        "record_active_status": ["active"],
+        "dnssync_disabled": False,
+        "dnssync_ipaddress_active_status": ["active", "dhcp", "slaac"],
+        "dnssync_conflict_deactivate": False,
+        "dnssync_minimum_zone_labels": 2,
+        "tolerate_characters_in_zone_labels": "",
+        "tolerate_underscores_in_labels": False,
         "tolerate_leading_underscore_types": [
-            "TXT",
+            "CNAME",
+            "DNAME",
             "SRV",
+            "SVCB",
+            "TLSA",
+            "TXT",
         ],
         "tolerate_non_rfc1035_types": [],
         "enable_root_zones": False,
-        "enforce_unique_records": False,
+        "enforce_unique_records": True,
+        "enforce_unique_rrset_ttl": True,
+        "menu_name": "DNS",
+        "top_level_menu": True,
+        "convert_names_to_lowercase": False,
+        "dnssec_purge_keys": 7776000,  # P90D
+        "dnssec_publish_safety": 3600,  # PT1H
+        "dnssec_retire_safety": 3600,  # PT1H
+        "dnssec_signatures_jitter": 43200,  # PT12H
+        "dnssec_signatures_refresh": 432000,  # P5D
+        "dnssec_signatures_validity": 1209600,  # P14D
+        "dnssec_signatures_validity_dnskey": 1209600,  # P14D
+        "dnssec_max_zone_ttl": 86400,  # P1D
+        "dnssec_zone_propagation_delay": 300,  # PT5M
+        "dnssec_parent_ds_ttl": 86400,  # P1D
+        "dnssec_parent_propagation_delay": 3600,  # PT1H
+        "dnssec_dnskey_ttl": 3600,  # PT1H
     }
     base_url = "netbox-dns"
 
     def ready(self):
-        #
-        # Check if required custom fields exist for IPAM coupling
-        #
-        if get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-            from extras.models import CustomField
-            from ipam.models import IPAddress
-            from django.contrib.contenttypes.models import ContentType
+        super().ready()
 
-            objtype = ContentType.objects.get_for_model(IPAddress)
-            required_cf = ("ipaddress_dns_record_name", "ipaddress_dns_zone_id")
+        import netbox_dns.signals.dnssec  # noqa: F401
 
-            if CustomField.objects.filter(
-                name__in=required_cf, content_types=objtype
-            ).count() < len(required_cf):
-                print(
-                    "WARNING: 'feature_ipam_coupling' is enabled, but the required"
-                    " custom fields for IPAM DNS coupling are missing. Please run"
-                    " the Django management command 'setup_coupling' to create the"
-                    " custom fields.",
-                    file=sys.stderr,
-                )
+        if not get_plugin_config("netbox_dns", "dnssync_disabled"):
+            import netbox_dns.signals.ipam_dnssync  # noqa: F401
+            import netbox_dns.tables.ipam_dnssync  # noqa: F401
 
-        super().ready()
+        for setting in (
+            "zone_active_status",
+            "record_active_status",
+            "dnssync_ipaddress_active_status",
+            "tolerate_leading_underscore_types",
+            "filter_record_types",
+            "filter_record_types+",
+            "custom_record_types",
+        ):
+            _check_list(setting)
 
 
 #

netbox_dns/api/field_serializers.py

@@ -0,0 +1,25 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+
+from netbox_dns.utilities import iso8601_to_int
+
+__all__ = ("TimePeriodField",)
+
+
+class TimePeriodField(serializers.IntegerField):
+    default_error_messages = {
+        "invalid": _(
+            "Enter a positive integer or an ISO8601 duration (W, M and Y are not supported)."
+        ),
+    }
+
+    def to_internal_value(self, data):
+        try:
+            return iso8601_to_int(data)
+        except TypeError:
+            raise serializers.ValidationError(
+                "Enter a valid integer or ISO 8601 duration (W, M and Y are not supported)."
+            )
+
+    def to_representation(self, value):
+        return value

netbox_dns/api/nested_serializers.py

@@ -1,35 +1,46 @@
+from django.utils.translation import gettext as _
 from rest_framework import serializers
 
 from netbox.api.serializers import WritableNestedSerializer
 
-from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
+from netbox_dns.models import Zone, Record, ZoneTemplate, RecordTemplate, DNSSECPolicy
+from netbox_dns.api.serializers_.view import ViewSerializer
 
 
-#
-# Views
-#
-class NestedViewSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:view-detail"
-    )
+__all__ = (
+    "NestedZoneSerializer",
+    "NestedRecordSerializer",
+    "NestedZoneTemplateSerializer",
+    "NestedRecordTemplateSerializer",
+    "NestedDNSSECPolicySerializer",
+)
+
 
+class NestedZoneSerializer(WritableNestedSerializer):
     class Meta:
-        model = View
-        fields = ["id", "url", "display", "name"]
+        model = Zone
 
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "view",
+            "status",
+            "active",
+            "rfc2317_prefix",
+        )
 
-#
-# Zones
-#
-class NestedZoneSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
     )
-    view = NestedViewSerializer(
+    view = ViewSerializer(
+        nested=True,
         many=False,
         required=False,
         read_only=True,
-        help_text="View the zone belongs to",
+        help_text=_("View the zone belongs to"),
     )
     active = serializers.BooleanField(
         required=False,
@@ -37,35 +48,65 @@ class NestedZoneSerializer(WritableNestedSerializer):
         allow_null=True,
     )
 
+    def to_representation(self, instance):
+        # +
+        # Workaround for the problem that the serializer does not return the
+        # annotation "active" when called with "many=False". See issue
+        # https://github.com/peteeckel/netbox-plugin-dns/issues/132
+        #
+        # TODO: Investigate root cause, probably in DRF.
+        # -
+        representation = super().to_representation(instance)
+        if representation.get("active") is None:
+            representation["active"] = instance.is_active
+
+        return representation
+
+
+class NestedZoneTemplateSerializer(WritableNestedSerializer):
     class Meta:
-        model = Zone
-        fields = ["id", "url", "display", "name", "view", "status", "active"]
+        model = ZoneTemplate
 
+        fields = (
+            "id",
+            "url",
+            "name",
+            "display",
+            "display_url",
+            "description",
+        )
 
-#
-# Nameservers
-#
-class NestedNameServerSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
+        view_name="plugins-api:netbox_dns-api:zonetemplate-detail"
     )
 
+
+class NestedRecordSerializer(WritableNestedSerializer):
     class Meta:
-        model = NameServer
-        fields = ["id", "url", "display", "name"]
+        model = Record
 
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "type",
+            "name",
+            "value",
+            "status",
+            "ttl",
+            "zone",
+            "managed",
+            "active",
+        )
 
-#
-# Records
-#
-class NestedRecordSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:record-detail"
     )
     zone = NestedZoneSerializer(
         many=False,
         required=False,
-        help_text="Zone the record belongs to",
+        help_text=_("Zone the record belongs to"),
     )
     active = serializers.BooleanField(
         required=False,
@@ -73,43 +114,45 @@ class NestedRecordSerializer(WritableNestedSerializer):
         allow_null=True,
     )
 
+
+class NestedRecordTemplateSerializer(WritableNestedSerializer):
     class Meta:
-        model = Record
-        fields = [
+        model = RecordTemplate
+
+        fields = (
             "id",
             "url",
             "display",
+            "display_url",
             "type",
             "name",
+            "record_name",
             "value",
             "status",
             "ttl",
-            "zone",
-            "active",
-        ]
+            "description",
+        )
 
-
-#
-# Registrars
-#
-class NestedRegistrarSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
+        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
     )
 
+
+class NestedDNSSECPolicySerializer(WritableNestedSerializer):
     class Meta:
-        model = Registrar
-        fields = ["display", "id", "url", "name", "iana_id"]
+        model = DNSSECPolicy
 
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "status",
+            "inline_signing",
+        )
 
-#
-# Contacts
-#
-class NestedContactSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
+        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
     )
-
-    class Meta:
-        model = Contact
-        fields = ["display", "id", "url", "name", "contact_id"]