netbox-ddns 1.4.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

netbox_ddns/__init__.py

@@ -1,4 +1,4 @@
-VERSION = '1.4.0'
+VERSION = '1.7.0'
 
 try:
     from netbox.plugins import PluginConfig
@@ -12,8 +12,8 @@ class NetBoxDDNSConfig(PluginConfig):
     name = 'netbox_ddns'
     verbose_name = 'Dynamic DNS'
     version = VERSION
-    min_version = '4.0.0'
-    max_version = '4.1.999'
+    min_version = '4.4.0'
+    max_version = '4.5.999'
     author = 'Sander Steffann'
     author_email = 'sander@steffann.nl'
     description = 'Dynamic DNS Connector for NetBox'

netbox_ddns/admin.py

@@ -1,156 +0,0 @@
-import logging
-
-from django.contrib import admin, messages
-from django.contrib.admin.filters import SimpleListFilter
-from django.contrib.admin.options import ModelAdmin
-from django.db.models import QuerySet
-from django.db.models.query_utils import Q
-from django.http.request import HttpRequest
-from django.utils.translation import gettext_lazy as _
-
-from ipam.models import IPAddress
-from netbox.admin import admin_site
-from netbox_ddns.models import DNSStatus, ExtraDNSName
-from .background_tasks import dns_create
-from .models import ReverseZone, Server, Zone
-from .utils import normalize_fqdn
-
-logger = logging.getLogger('netbox_ddns')
-
-
-class IPFamilyFilter(SimpleListFilter):
-    title = _('Prefix family')
-    parameter_name = 'family'
-
-    def lookups(self, request: HttpRequest, model_admin: ModelAdmin):
-        return (
-            ('ipv4', _('IPv4')),
-            ('ipv6', _('IPv6')),
-        )
-
-    def queryset(self, request: HttpRequest, queryset: QuerySet):
-        if self.value() == 'ipv4':
-            return queryset.filter(prefix__family=4)
-        if self.value() == 'ipv6':
-            return queryset.filter(prefix__family=6)
-
-
-class ZoneInlineAdmin(admin.TabularInline):
-    model = Zone
-
-
-class ReverseZoneInlineAdmin(admin.TabularInline):
-    model = ReverseZone
-
-
-@admin.register(Server, site=admin_site)
-class ServerAdmin(admin.ModelAdmin):
-    list_display = ('server', 'server_port', 'tsig_key_name', 'tsig_algorithm')
-    inlines = [
-        ZoneInlineAdmin,
-        ReverseZoneInlineAdmin,
-    ]
-
-
-@admin.register(Zone, site=admin_site)
-class ZoneAdmin(admin.ModelAdmin):
-    list_display = ('name', 'ttl', 'server')
-    actions = [
-        'update_all_records'
-    ]
-
-    def update_all_records(self, request: HttpRequest, queryset: QuerySet):
-        for zone in queryset:
-            counter = 0
-
-            # Find all more-specific zones
-            more_specifics = Zone.objects.filter(name__endswith=zone.name).exclude(pk=zone.pk)
-
-            # Find all IPAddress objects in this zone but not in the more-specifics
-            ip_addresses = IPAddress.objects.filter(Q(dns_name__endswith=zone.name) |
-                                                    Q(dns_name__endswith=zone.name.rstrip('.')))
-            for more_specific in more_specifics:
-                ip_addresses = ip_addresses.exclude(Q(dns_name__endswith=more_specific.name) |
-                                                    Q(dns_name__endswith=more_specific.name.rstrip('.')))
-
-            for ip_address in ip_addresses:
-                new_address = ip_address.address.ip
-                new_dns_name = normalize_fqdn(ip_address.dns_name)
-
-                if new_dns_name:
-                    status, created = DNSStatus.objects.get_or_create(ip_address=ip_address)
-
-                    dns_create.delay(
-                        dns_name=new_dns_name,
-                        address=new_address,
-                        status=status,
-                        reverse=False,
-                    )
-
-                    counter += 1
-
-            # Find all ExtraDNSName objects in this zone but not in the more-specifics
-            extra_names = ExtraDNSName.objects.filter(name__endswith=zone.name)
-            for more_specific in more_specifics:
-                extra_names = extra_names.exclude(name__endswith=more_specific.name)
-
-            for extra in extra_names:
-                new_address = extra.ip_address.address.ip
-                new_dns_name = extra.name
-
-                dns_create.delay(
-                    dns_name=new_dns_name,
-                    address=new_address,
-                    status=extra,
-                    reverse=False,
-                )
-
-                counter += 1
-
-            messages.info(request, _("Updating {count} forward records in {name}").format(count=counter,
-                                                                                          name=zone.name))
-
-
-@admin.register(ReverseZone, site=admin_site)
-class ReverseZoneAdmin(admin.ModelAdmin):
-    list_display = ('prefix', 'name', 'ttl', 'server')
-    list_filter = [IPFamilyFilter]
-    actions = [
-        'update_all_records'
-    ]
-
-    def update_all_records(self, request: HttpRequest, queryset: QuerySet):
-        for zone in queryset:
-            counter = 0
-
-            # Find all more-specific zones
-            more_specifics = ReverseZone.objects.filter(prefix__net_contained=zone.prefix).exclude(pk=zone.pk)
-
-            # Find all IPAddress objects in this zone but not in the more-specifics
-            ip_addresses = IPAddress.objects.filter(address__net_contained_or_equal=zone.prefix)
-            for more_specific in more_specifics:
-                ip_addresses = ip_addresses.exclude(address__net_contained_or_equal=more_specific.prefix)
-
-            for ip_address in ip_addresses:
-                new_address = ip_address.address.ip
-                new_dns_name = normalize_fqdn(ip_address.dns_name)
-
-                if new_dns_name:
-                    status, created = DNSStatus.objects.get_or_create(ip_address=ip_address)
-
-                    dns_create.delay(
-                        dns_name=new_dns_name,
-                        address=new_address,
-                        status=status,
-                        forward=False,
-                    )
-
-                    counter += 1
-
-            messages.info(request, _("Updating {count} reverse records in {name}").format(count=counter,
-                                                                                          name=zone.name))
-
-
-@admin.register(ExtraDNSName, site=admin_site)
-class ExtraDNSNameAdmin(admin.ModelAdmin):
-    pass

netbox_ddns/api/serializers.py

@@ -2,16 +2,34 @@ from rest_framework import serializers
 from rest_framework.relations import PrimaryKeyRelatedField
 from ipam.models import IPAddress
 from netbox.api.serializers import NetBoxModelSerializer
-from ..models import ExtraDNSName
+from ..models import ExtraDNSName, Server, Zone, ReverseZone
 
 
 class ExtraDNSNameSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name='plugins-api:netbox_ddns-api:extradnsname-detail'
     )
-    ip_address = PrimaryKeyRelatedField(queryset=IPAddress.objects.all(),)
+    ip_address = PrimaryKeyRelatedField(queryset=IPAddress.objects.all())
 
     class Meta:
         model = ExtraDNSName
         fields = ('id', 'ip_address', 'name', 'url')
         read_only_fields = ('id', 'url')
+
+
+class ServerSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = Server
+        fields = ('server', 'server_port', 'tsig_key_name', 'tsig_algorithm', "tsig_key")
+
+
+class ZoneSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = Zone
+        fields = ('name', 'ttl', 'server', 'protocol')
+
+
+class ReverseZoneSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = ReverseZone
+        fields = ('name', 'prefix', 'ttl', 'server')

netbox_ddns/api/views.py

@@ -8,3 +8,4 @@ class ExtraDNSNameViewSet(NetBoxModelViewSet):
     queryset = ExtraDNSName.objects.all()
     serializer_class = ExtraDNSNameSerializer
     filterset_class = ExtraDNSNameFilterSet
+

netbox_ddns/background_tasks.py

@@ -9,7 +9,7 @@ from django_rq import job
 from dns import rcode
 from netaddr import ip
 
-from netbox_ddns.models import ACTION_CREATE, ACTION_DELETE, DNSStatus, RCODE_NO_ZONE, ReverseZone, Zone
+from netbox_ddns.models import ACTION_CREATE, ACTION_DELETE, DNSStatus, RCODE_NO_ZONE, ReverseZone, Zone, Protocol
 from netbox_ddns.utils import get_soa
 
 logger = logging.getLogger('netbox_ddns')
@@ -28,6 +28,17 @@ def status_update(output: List[str], operation: str, response) -> None:
     output.append(message)
 
 
+def send_dns_update(update, server, protocol):
+    """Send DNS update via TCP or UDP. Returns response or None on unknown protocol."""
+    if protocol == Protocol.TCP:
+        return dns.query.tcp(update, server.address, port=server.server_port)
+    elif protocol == Protocol.UDP:
+        return dns.query.udp(update, server.address, port=server.server_port)
+    else:
+        logger.error(f"Unknown protocol {protocol} for server {server}")
+        return None
+
+
 def create_forward(dns_name: str, address: ip.IPAddress, status: Optional[DNSStatus], output: List[str]):
     if status:
         status.forward_action = ACTION_CREATE
@@ -38,6 +49,7 @@ def create_forward(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
 
         # Check the SOA, we don't want to write to a parent zone if it has delegated authority
         soa = get_soa(zone.name)
+        protocol = zone.server.protocol
         if soa == zone.name:
             record_type = 'A' if address.version == 4 else 'AAAA'
             update = zone.server.create_update(zone.name)
@@ -47,7 +59,9 @@ def create_forward(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
                 record_type,
                 str(address)
             )
-            response = dns.query.udp(update, zone.server.address, port=zone.server.server_port)
+            response = send_dns_update(update, zone.server, protocol)
+            if response is None:
+                return
             status_update(output, f'Adding {dns_name} {record_type} {address}', response)
             if status:
                 status.forward_rcode = response.rcode()
@@ -72,6 +86,7 @@ def delete_forward(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
 
         # Check the SOA, we don't want to write to a parent zone if it has delegated authority
         soa = get_soa(zone.name)
+        protocol = zone.server.protocol
         if soa == zone.name:
             record_type = 'A' if address.version == 4 else 'AAAA'
             update = zone.server.create_update(zone.name)
@@ -80,7 +95,9 @@ def delete_forward(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
                 record_type,
                 str(address)
             )
-            response = dns.query.udp(update, zone.server.address, port=zone.server.server_port)
+            response = send_dns_update(update, zone.server, protocol)
+            if response is None:
+                return
             status_update(output, f'Deleting {dns_name} {record_type} {address}', response)
             if status:
                 status.forward_rcode = response.rcode()
@@ -106,6 +123,7 @@ def create_reverse(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
 
         # Check the SOA, we don't want to write to a parent zone if it has delegated authority
         soa = get_soa(record_name)
+        protocol = zone.server.protocol
         if soa == zone.name:
             update = zone.server.create_update(zone.name)
             update.add(
@@ -114,7 +132,9 @@ def create_reverse(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
                 'ptr',
                 dns_name
             )
-            response = dns.query.udp(update, zone.server.address, port=zone.server.server_port)
+            response = send_dns_update(update, zone.server, protocol)
+            if response is None:
+                return
             status_update(output, f'Adding {record_name} PTR {dns_name}', response)
             if status:
                 status.reverse_rcode = response.rcode()
@@ -140,6 +160,7 @@ def delete_reverse(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
 
         # Check the SOA, we don't want to write to a parent zone if it has delegated authority
         soa = get_soa(record_name)
+        protocol = zone.server.protocol
         if soa == zone.name:
             update = zone.server.create_update(zone.name)
             update.delete(
@@ -147,7 +168,9 @@ def delete_reverse(dns_name: str, address: ip.IPAddress, status: Optional[DNSSta
                 'ptr',
                 dns_name
             )
-            response = dns.query.udp(update, zone.server.address, port=zone.server.server_port)
+            response = send_dns_update(update, zone.server, protocol)
+            if response is None:
+                return
             status_update(output, f'Deleting {record_name} PTR {dns_name}', response)
             if status:
                 status.reverse_rcode = response.rcode()

netbox_ddns/filtersets.py

@@ -1,8 +1,30 @@
+import django_filters
+
 from netbox.filtersets import NetBoxModelFilterSet
-from .models import ExtraDNSName
+from .models import ExtraDNSName, Server, Zone, ReverseZone
 
 
 class ExtraDNSNameFilterSet(NetBoxModelFilterSet):
     class Meta:
         model = ExtraDNSName
         fields = ('id', 'name', 'ip_address', 'forward_rcode')
+
+
+class ServerFilterSet(NetBoxModelFilterSet):
+    class Meta:
+        model = Server
+        fields = ('id', 'server', 'server_port', 'tsig_key_name', 'tsig_algorithm', "tsig_key")
+
+
+class ZoneFilterSet(NetBoxModelFilterSet):
+    class Meta:
+        model = Zone
+        fields = ('id', 'name', 'ttl', 'server')
+
+
+class ReverseZoneFilterSet(NetBoxModelFilterSet):
+    prefix = django_filters.CharFilter(lookup_expr='icontains')
+
+    class Meta:
+        model = ReverseZone
+        fields = ('id', 'name', 'prefix', 'ttl', 'server')

netbox_ddns/forms.py

@@ -1,9 +1,60 @@
-from django import forms
+from django.forms import IntegerField
 
-from netbox_ddns.models import ExtraDNSName
+from ipam.models import IPAddress
+from netbox.forms import NetBoxModelForm, NetBoxModelBulkEditForm
+from netbox_ddns.models import ExtraDNSName, Server, Zone, ReverseZone
+from utilities.forms.fields import DynamicModelChoiceField
+from utilities.forms.rendering import FieldSet
 
 
-class ExtraDNSNameEditForm(forms.ModelForm):
+class ReverseZoneForm(NetBoxModelForm):
+    class Meta:
+        model = ReverseZone
+        fields = ('prefix', 'name', 'ttl', 'server')
+
+
+class ZoneForm(NetBoxModelForm):
+    class Meta:
+        model = Zone
+        fields = ('name', 'ttl', 'server')
+
+
+class ZoneBulkEditForm(NetBoxModelBulkEditForm):
+    model = Zone
+
+    ttl = IntegerField(
+        min_value=1,
+        required=False
+    )
+    server = DynamicModelChoiceField(
+        queryset=Server.objects.all(),
+        required=False
+    )
+
+
+class ServerForm(NetBoxModelForm):
+    fieldsets = (
+        FieldSet('server', 'server_port', 'protocol', name='Server'),
+        FieldSet('tsig_key_name', 'tsig_algorithm', "tsig_key", name='Authentication'),
+    )
+
+    class Meta:
+        model = Server
+        fields = ('server', 'server_port', 'protocol', 'tsig_key_name', 'tsig_algorithm', "tsig_key")
+
+
+class ExtraDNSNameIPAddressForm(NetBoxModelForm):
     class Meta:
         model = ExtraDNSName
         fields = ['name']
+
+
+class ExtraDNSNameForm(NetBoxModelForm):
+    ip_address = DynamicModelChoiceField(
+        queryset=IPAddress.objects.all(),
+        required=True
+    )
+
+    class Meta:
+        model = ExtraDNSName
+        fields = ['name', "ip_address"]

netbox_ddns/migrations/0011_server_created_server_custom_field_data_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.0.9 on 2025-01-08 11:03
+
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0122_charfield_null_choices'),
+        ('netbox_ddns', '0010_extradnsname_created_extradnsname_custom_field_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='server',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='server',
+            name='custom_field_data',
+            field=models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder),
+        ),
+        migrations.AddField(
+            model_name='server',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='server',
+            name='tags',
+            field=taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag'),
+        ),
+    ]

netbox_ddns/migrations/0012_zone_created_zone_custom_field_data_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.0.9 on 2025-01-08 18:46
+
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0122_charfield_null_choices'),
+        ('netbox_ddns', '0011_server_created_server_custom_field_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='zone',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='zone',
+            name='custom_field_data',
+            field=models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder),
+        ),
+        migrations.AddField(
+            model_name='zone',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='zone',
+            name='tags',
+            field=taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag'),
+        ),
+    ]

netbox_ddns/migrations/0013_reversezone_created_reversezone_custom_field_data_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.0.9 on 2025-01-08 19:51
+
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0122_charfield_null_choices'),
+        ('netbox_ddns', '0012_zone_created_zone_custom_field_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='reversezone',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='reversezone',
+            name='custom_field_data',
+            field=models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder),
+        ),
+        migrations.AddField(
+            model_name='reversezone',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='reversezone',
+            name='tags',
+            field=taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag'),
+        ),
+    ]

netbox_ddns/migrations/0014_alter_extradnsname_name.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.2.5 on 2025-09-01 09:17
+
+import netbox_ddns.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_ddns', '0013_reversezone_created_reversezone_custom_field_data_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='extradnsname',
+            name='name',
+            field=models.CharField(max_length=255, validators=[netbox_ddns.validators.DNSNameValidator()]),
+        ),
+    ]

netbox_ddns/migrations/0015_server_protocol.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.6 on 2025-10-01 14:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_ddns', '0014_alter_extradnsname_name'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='server',
+            name='protocol',
+            field=models.CharField(default='udp', max_length=3),
+        ),
+    ]