netbox-ddns 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

netbox_ddns/__init__.py

@@ -1,4 +1,4 @@
-VERSION = '1.3.0'
+VERSION = '1.5.0'
 
 try:
     from netbox.plugins import PluginConfig
@@ -13,7 +13,7 @@ class NetBoxDDNSConfig(PluginConfig):
     verbose_name = 'Dynamic DNS'
     version = VERSION
     min_version = '4.0.0'
-    max_version = '4.0.999'
+    max_version = '4.2.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

@@ -0,0 +1,35 @@
+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, 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())
+
+    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')
+
+
+class ReverseZoneSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = ReverseZone
+        fields = ('name', 'prefix', 'ttl', 'server')

netbox_ddns/api/urls.py

@@ -0,0 +1,10 @@
+from netbox.api.routers import NetBoxRouter
+from . import views
+
+
+app_name = 'netbox_ddns'
+
+router = NetBoxRouter()
+router.register('extra-dns-name', views.ExtraDNSNameViewSet)
+
+urlpatterns = router.urls

netbox_ddns/api/views.py

@@ -0,0 +1,11 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+from ..filtersets import ExtraDNSNameFilterSet
+from ..models import ExtraDNSName
+from .serializers import ExtraDNSNameSerializer
+
+
+class ExtraDNSNameViewSet(NetBoxModelViewSet):
+    queryset = ExtraDNSName.objects.all()
+    serializer_class = ExtraDNSNameSerializer
+    filterset_class = ExtraDNSNameFilterSet
+

netbox_ddns/filtersets.py

@@ -0,0 +1,30 @@
+import django_filters
+
+from netbox.filtersets import NetBoxModelFilterSet
+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', name='Server'),
+        FieldSet('tsig_key_name', 'tsig_algorithm', "tsig_key", name='Authentication'),
+    )
+
+    class Meta:
+        model = Server
+        fields = ('server', 'server_port', '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/0009_alter_dnsstatus_id_alter_extradnsname_id_and_more.py

@@ -0,0 +1,38 @@
+# Generated by Django 5.0.9 on 2024-11-11 17:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_ddns', '0008_server_server_port'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dnsstatus',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False),
+        ),
+        migrations.AlterField(
+            model_name='extradnsname',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False),
+        ),
+        migrations.AlterField(
+            model_name='reversezone',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False),
+        ),
+        migrations.AlterField(
+            model_name='server',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False),
+        ),
+        migrations.AlterField(
+            model_name='zone',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False),
+        ),
+    ]

netbox_ddns/migrations/0010_extradnsname_created_extradnsname_custom_field_data_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.0.9 on 2024-11-11 17:14
+
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0121_customfield_related_object_filter'),
+        ('netbox_ddns', '0009_alter_dnsstatus_id_alter_extradnsname_id_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='extradnsname',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='extradnsname',
+            name='custom_field_data',
+            field=models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder),
+        ),
+        migrations.AddField(
+            model_name='extradnsname',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='extradnsname',
+            name='tags',
+            field=taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag'),
+        ),
+    ]

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/models.py

@@ -4,6 +4,7 @@ import logging
 import socket
 from django.core.exceptions import ValidationError
 from django.db import models
+from django.db.models import Q
 from django.db.models.functions import Length
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
@@ -12,11 +13,13 @@ from dns import rcode
 from dns.tsig import HMAC_MD5, HMAC_SHA1, HMAC_SHA224, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512
 from netaddr import IPNetwork, ip
 from typing import Optional
-
+from netbox.models import NetBoxModel
 from ipam.fields import IPNetworkField
 from ipam.models import IPAddress
+from utilities.querysets import RestrictedQuerySet
 from .utils import normalize_fqdn
-from .validators import HostnameAddressValidator, HostnameValidator, validate_base64, MinValueValidator, MaxValueValidator
+from .validators import HostnameAddressValidator, HostnameValidator, validate_base64, MinValueValidator, \
+    MaxValueValidator
 
 logger = logging.getLogger('netbox_ddns')
 
@@ -62,7 +65,7 @@ def get_rcode_display(code):
         return _('Unknown response: {}').format(code)
 
 
-class Server(models.Model):
+class Server(NetBoxModel):
     server = models.CharField(
         verbose_name=_('DDNS Server'),
         max_length=255,
@@ -111,12 +114,12 @@ class Server(models.Model):
         # Ensure trailing dots from domain-style fields
         self.tsig_key_name = normalize_fqdn(self.tsig_key_name.lower().rstrip('.'))
 
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:server', args=[self.pk])
+
     @property
     def address(self) -> Optional[str]:
-        addrinfo = socket.getaddrinfo(self.server, self.server_port, proto=socket.IPPROTO_UDP)
-        for family, _, _, _, sockaddr in addrinfo:
-            if family in (socket.AF_INET, socket.AF_INET6) and sockaddr[0]:
-                return sockaddr[0]
+        return socket.gethostbyname(self.server)
 
     def create_update(self, zone: str) -> dns.update.Update:
         return dns.update.Update(
@@ -129,7 +132,7 @@ class Server(models.Model):
         )
 
 
-class ZoneQuerySet(models.QuerySet):
+class ZoneQuerySet(RestrictedQuerySet):
     def find_for_dns_name(self, dns_name: str) -> Optional['Zone']:
         # Generate all possible zones
         zones = []
@@ -141,7 +144,7 @@ class ZoneQuerySet(models.QuerySet):
         return self.filter(name__in=zones).order_by(Length('name').desc()).first()
 
 
-class Zone(models.Model):
+class Zone(NetBoxModel):
     name = models.CharField(
         verbose_name=_('zone name'),
         max_length=255,
@@ -167,6 +170,28 @@ class Zone(models.Model):
     def __str__(self):
         return self.name
 
+    def get_managed_ip_address(self):
+        # Find all more-specific zones
+        more_specifics = Zone.objects.filter(name__endswith=self.name).exclude(pk=self.pk)
+
+        # Find all IPAddress objects in this self but not in the more-specifics
+        ip_addresses = IPAddress.objects.filter(Q(dns_name__endswith=self.name) |
+                                                Q(dns_name__endswith=self.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('.')))
+        return ip_addresses
+
+    def get_managed_extra_dns_name(self):
+        # Find all more-specific zones
+        more_specifics = Zone.objects.filter(name__endswith=self.name).exclude(pk=self.pk)
+
+        # Find all ExtraDNSName objects in this zone but not in the more-specifics
+        extra_names = ExtraDNSName.objects.filter(name__endswith=self.name)
+        for more_specific in more_specifics:
+            extra_names = extra_names.exclude(name__endswith=more_specific.name)
+        return extra_names
+
     def clean(self):
         # Ensure trailing dots from domain-style fields
         self.name = normalize_fqdn(self.name)
@@ -174,8 +199,11 @@ class Zone(models.Model):
     def get_updater(self):
         return self.server.create_update(self.name)
 
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:zone', args=[self.pk])
+
 
-class ReverseZoneQuerySet(models.QuerySet):
+class ReverseZoneQuerySet(RestrictedQuerySet):
     def find_for_address(self, address: ip.IPAddress) -> Optional['ReverseZone']:
         # Find the zone, if any
         zones = list(ReverseZone.objects.filter(prefix__net_contains=address))
@@ -186,7 +214,7 @@ class ReverseZoneQuerySet(models.QuerySet):
         return zones[-1]
 
 
-class ReverseZone(models.Model):
+class ReverseZone(NetBoxModel):
     prefix = IPNetworkField(
         verbose_name=_('prefix'),
         unique=True,
@@ -214,7 +242,19 @@ class ReverseZone(models.Model):
         verbose_name_plural = _('reverse zones')
 
     def __str__(self):
-        return f'for {self.prefix}'
+        return f'{self.prefix}'
+
+    def get_managed_ip_address(self):
+        # Find all more-specific zones
+        more_specifics = ReverseZone.objects.filter(prefix__net_contained=self.prefix).exclude(pk=self.pk)
+        # Find all IPAddress objects in this zone but not in the more-specifics
+        ip_addresses = IPAddress.objects.filter(address__net_contained_or_equal=self.prefix)
+        for more_specific in more_specifics:
+            ip_addresses = ip_addresses.exclude(address__net_contained_or_equal=more_specific.prefix)
+        return ip_addresses
+
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:reversezone', args=[self.pk])
 
     def record_name(self, address: ip.IPAddress):
         record_name = self.name
@@ -325,7 +365,7 @@ class DNSStatus(models.Model):
         return format_html('<span style="color:{colour}">{output}</span', colour=colour, output=output)
 
 
-class ExtraDNSName(models.Model):
+class ExtraDNSName(NetBoxModel):
     ip_address = models.ForeignKey(
         to=IPAddress,
         verbose_name=_('IP address'),
@@ -367,7 +407,7 @@ class ExtraDNSName(models.Model):
         return self.name
 
     def get_absolute_url(self):
-        return reverse('plugins:netbox_ddns:extradnsname_edit', args=[self.ip_address.pk, self.pk])
+        return reverse('plugins:netbox_ddns:extradnsname', args=[self.pk])
 
     def clean(self):
         # Ensure trailing dots from domain-style fields