netbox-plugin-dns 1.3b1__tar.gz → 1.3.1__tar.gz

{netbox_plugin_dns-1.3b1/netbox_plugin_dns.egg-info → netbox_plugin_dns-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-plugin-dns
-Version: 1.3b1
+Version: 1.3.1
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Author-email: Peter Eckel <pete@netbox-dns.org>
 Project-URL: Homepage, https://github.com/peteeckel/netbox-plugin-dns
@@ -8,7 +8,7 @@ Project-URL: Documentation, https://github.com/peteeckel/netbox-plugin-dns/blob/
 Project-URL: Repository, https://github.com/peteeckel/netbox-plugin-dns
 Project-URL: Issues, https://github.com/peteeckel/netbox-plugin-dns/issues
 Keywords: netbox,netbox-plugin,dns
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -52,6 +52,7 @@ The main focus of the plugin is to ensure the quality of the data stored in it.
 * 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
+* DNSSEC support for storing configuration data relevant to DNSSEC operation in NetBox DNS
 
 Other main features include:
 

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/README.md

@@ -35,6 +35,7 @@ The main focus of the plugin is to ensure the quality of the data stored in it.
 * 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
+* DNSSEC support for storing configuration data relevant to DNSSEC operation in NetBox DNS
 
 Other main features include:
 

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/__init__.py

@@ -4,7 +4,7 @@ from django.core.exceptions import ImproperlyConfigured
 from netbox.plugins import PluginConfig
 from netbox.plugins.utils import get_plugin_config
 
-__version__ = "1.3-beta1"
+__version__ = "1.3.1"
 
 
 def _check_list(setting):
@@ -16,7 +16,7 @@ class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = _("NetBox DNS")
     description = _("NetBox plugin for DNS data")
-    min_version = "4.2.0"
+    min_version = "4.3.0"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"
@@ -72,6 +72,7 @@ class DNSConfig(PluginConfig):
             "RRSIG",
         ],
         "filter_record_types+": [],
+        "filter_record_types-": [],
         "custom_record_types": [],
         "record_active_status": ["active"],
         "dnssync_disabled": False,

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/nested_serializers.py

@@ -17,19 +17,19 @@ __all__ = (
 
 
 class NestedZoneSerializer(WritableNestedSerializer):
-    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
+    class Meta:
+        model = Zone
 
-        return representation
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "view",
+            "status",
+            "active",
+            "rfc2317_prefix",
+        )
 
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
@@ -47,27 +47,25 @@ class NestedZoneSerializer(WritableNestedSerializer):
         allow_null=True,
     )
 
-    class Meta:
-        model = Zone
-        fields = [
-            "id",
-            "url",
-            "display",
-            "name",
-            "view",
-            "status",
-            "active",
-            "rfc2317_prefix",
-        ]
+    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):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:zonetemplate-detail"
-    )
 
+class NestedZoneTemplateSerializer(WritableNestedSerializer):
     class Meta:
         model = ZoneTemplate
+
         fields = (
             "id",
             "url",
@@ -76,25 +74,16 @@ class NestedZoneTemplateSerializer(WritableNestedSerializer):
             "description",
         )
 
-
-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"),
-    )
-    active = serializers.BooleanField(
-        required=False,
-        read_only=True,
-        allow_null=True,
+        view_name="plugins-api:netbox_dns-api:zonetemplate-detail"
     )
 
+
+class NestedRecordSerializer(WritableNestedSerializer):
     class Meta:
         model = Record
-        fields = [
+
+        fields = (
             "id",
             "url",
             "display",
@@ -106,16 +95,27 @@ class NestedRecordSerializer(WritableNestedSerializer):
             "zone",
             "managed",
             "active",
-        ]
-
+        )
 
-class NestedRecordTemplateSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
+        view_name="plugins-api:netbox_dns-api:record-detail"
     )
+    zone = NestedZoneSerializer(
+        many=False,
+        required=False,
+        help_text=_("Zone the record belongs to"),
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+        allow_null=True,
+    )
+
 
+class NestedRecordTemplateSerializer(WritableNestedSerializer):
     class Meta:
         model = RecordTemplate
+
         fields = (
             "id",
             "url",
@@ -129,14 +129,15 @@ class NestedRecordTemplateSerializer(WritableNestedSerializer):
             "description",
         )
 
-
-class NestedDNSSECPolicySerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
+        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
     )
 
+
+class NestedDNSSECPolicySerializer(WritableNestedSerializer):
     class Meta:
         model = DNSSECPolicy
+
         fields = (
             "id",
             "url",
@@ -145,3 +146,7 @@ class NestedDNSSECPolicySerializer(WritableNestedSerializer):
             "description",
             "status",
         )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/dnssec_key_template.py

@@ -14,21 +14,9 @@ __all__ = ("DNSSECKeyTemplateSerializer",)
 
 
 class DNSSECKeyTemplateSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:dnsseckeytemplate-detail"
-    )
-    lifetime = TimePeriodField(required=False, allow_null=True)
-    policies = NestedDNSSECPolicySerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        default=None,
-        help_text=_("Policies using this Key Template"),
-    )
-    tenant = TenantSerializer(required=False, allow_null=True)
-
     class Meta:
         model = DNSSECKeyTemplate
+
         fields = (
             "id",
             "url",
@@ -46,6 +34,7 @@ class DNSSECKeyTemplateSerializer(NetBoxModelSerializer):
             "custom_fields",
             "tenant",
         )
+
         brief_fields = (
             "id",
             "url",
@@ -57,3 +46,23 @@ class DNSSECKeyTemplateSerializer(NetBoxModelSerializer):
             "key_size",
             "description",
         )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:dnsseckeytemplate-detail"
+    )
+    lifetime = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    policies = NestedDNSSECPolicySerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Policies using this Key Template"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/dnssec_policy.py

@@ -15,47 +15,9 @@ __all__ = ("DNSSECPolicySerializer",)
 
 
 class DNSSECPolicySerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
-    )
-    key_templates = DNSSECKeyTemplateSerializer(
-        nested=True,
-        many=True,
-        read_only=False,
-        required=False,
-        default=None,
-        help_text=_("Key templates assigned to the policy"),
-    )
-    dnskey_ttl = TimePeriodField(required=False, allow_null=True)
-    purge_keys = TimePeriodField(required=False, allow_null=True)
-    publish_safety = TimePeriodField(required=False, allow_null=True)
-    retire_safety = TimePeriodField(required=False, allow_null=True)
-    signatures_jitter = TimePeriodField(required=False, allow_null=True)
-    signatures_refresh = TimePeriodField(required=False, allow_null=True)
-    signatures_validity = TimePeriodField(required=False, allow_null=True)
-    signatures_validity_dnskey = TimePeriodField(required=False, allow_null=True)
-    max_zone_ttl = TimePeriodField(required=False, allow_null=True)
-    zone_propagation_delay = TimePeriodField(required=False, allow_null=True)
-    parent_ds_ttl = TimePeriodField(required=False, allow_null=True)
-    parent_propagation_delay = TimePeriodField(required=False, allow_null=True)
-    zones = NestedZoneSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        default=None,
-        help_text=_("Zones this policy is assigned to"),
-    )
-    zone_templates = NestedZoneTemplateSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        default=None,
-        help_text=_("Zone templates this policy is assigned to"),
-    )
-    tenant = TenantSerializer(required=False, allow_null=True)
-
     class Meta:
         model = DNSSECPolicy
+
         fields = (
             "id",
             "url",
@@ -90,7 +52,94 @@ class DNSSECPolicySerializer(NetBoxModelSerializer):
             "custom_fields",
             "tenant",
         )
-        brief_fields = ("id", "url", "display", "name", "description", "status")
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "status",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
+    )
+    key_templates = DNSSECKeyTemplateSerializer(
+        nested=True,
+        many=True,
+        read_only=False,
+        required=False,
+        default=None,
+        help_text=_("Key templates assigned to the policy"),
+    )
+    dnskey_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    purge_keys = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    publish_safety = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    retire_safety = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_jitter = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_refresh = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_validity = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_validity_dnskey = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    max_zone_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    zone_propagation_delay = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    parent_ds_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    parent_propagation_delay = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Zones this policy is assigned to"),
+    )
+    zone_templates = NestedZoneTemplateSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Zone templates this policy is assigned to"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
 
     def create(self, validated_data):
         dnssec_key_templates = validated_data.pop("key_templates", None)

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/nameserver.py

@@ -13,20 +13,9 @@ __all__ = ("NameServerSerializer",)
 
 
 class NameServerSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
-    )
-    zones = NestedZoneSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        default=None,
-        help_text=_("Zones served by the authoritative nameserver"),
-    )
-    tenant = TenantSerializer(required=False, allow_null=True)
-
     class Meta:
         model = NameServer
+
         fields = (
             "id",
             "url",
@@ -40,4 +29,27 @@ class NameServerSerializer(NetBoxModelSerializer):
             "custom_fields",
             "tenant",
         )
-        brief_fields = ("id", "url", "display", "name", "description")
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:nameserver-detail"
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Zones served by the authoritative nameserver"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/record.py

@@ -15,43 +15,6 @@ __all__ = ("RecordSerializer",)
 
 
 class RecordSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:record-detail"
-    )
-    ttl = TimePeriodField(required=False, allow_null=True)
-    ptr_record = NestedRecordSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text=_("PTR record generated from an address"),
-    )
-    address_record = NestedRecordSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text=_("Address record defining the PTR"),
-    )
-    zone = NestedZoneSerializer(
-        many=False,
-        required=False,
-        help_text=_("Zone the record belongs to"),
-    )
-    active = serializers.BooleanField(
-        required=False,
-        read_only=True,
-    )
-    ipam_ip_address = IPAddressSerializer(
-        nested=True,
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text=_("IPAddress linked to the record"),
-    )
-    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
-
     class Meta:
         model = Record
         fields = (
@@ -72,13 +35,14 @@ class RecordSerializer(NetBoxModelSerializer):
             "managed",
             "disable_ptr",
             "ptr_record",
-            "address_record",
+            "address_records",
             "active",
             "custom_fields",
             "tenant",
             "ipam_ip_address",
             "absolute_value",
         )
+
         brief_fields = (
             "id",
             "url",
@@ -94,3 +58,47 @@ class RecordSerializer(NetBoxModelSerializer):
             "managed",
             "active",
         )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:record-detail"
+    )
+    ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    ptr_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text=_("PTR record related to an address"),
+    )
+    address_records = NestedRecordSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text=_("Address records related to the PTR"),
+    )
+    zone = NestedZoneSerializer(
+        many=False,
+        required=False,
+        help_text=_("Zone the record belongs to"),
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+    )
+    ipam_ip_address = IPAddressSerializer(
+        nested=True,
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text=_("IPAddress linked to the record"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/record_template.py

@@ -14,20 +14,9 @@ __all__ = ("RecordTemplateSerializer",)
 
 
 class RecordTemplateSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
-    )
-    ttl = TimePeriodField(required=False, allow_null=True)
-    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
-    zone_templates = NestedZoneTemplateSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        help_text=_("Zone templates using the record template"),
-    )
-
     class Meta:
         model = RecordTemplate
+
         fields = (
             "id",
             "url",
@@ -47,6 +36,7 @@ class RecordTemplateSerializer(NetBoxModelSerializer):
             "tenant",
             "zone_templates",
         )
+
         brief_fields = (
             "id",
             "url",
@@ -59,3 +49,22 @@ class RecordTemplateSerializer(NetBoxModelSerializer):
             "ttl",
             "description",
         )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
+    )
+    ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+    zone_templates = NestedZoneTemplateSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        help_text=_("Zone templates using the record template"),
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/registrar.py

@@ -9,12 +9,9 @@ __all__ = ("RegistrarSerializer",)
 
 
 class RegistrarSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
-    )
-
     class Meta:
         model = Registrar
+
         fields = (
             "id",
             "url",
@@ -31,4 +28,16 @@ class RegistrarSerializer(NetBoxModelSerializer):
             "last_updated",
             "custom_fields",
         )
-        brief_fields = ("id", "url", "display", "name", "description", "iana_id")
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "iana_id",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrar-detail"
+    )

{netbox_plugin_dns-1.3b1 → netbox_plugin_dns-1.3.1}/netbox_dns/api/serializers_/registration_contact.py

@@ -9,12 +9,9 @@ __all__ = ("RegistrationContactSerializer",)
 
 
 class RegistrationContactSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrationcontact-detail"
-    )
-
     class Meta:
         model = RegistrationContact
+
         fields = (
             "id",
             "url",
@@ -37,4 +34,15 @@ class RegistrationContactSerializer(NetBoxModelSerializer):
             "last_updated",
             "custom_fields",
         )
-        brief_fields = ("id", "url", "display", "name", "description", "contact_id")
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "contact_id",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrationcontact-detail"
+    )