modified: pyproject.toml
Fix paths after restructuring renamed: netbox_dns_bridge/management/commands/export-dns-zone.py -> netbox_dns_bridge/management/commands/dns-export-zone.py renamed: netbox_dns_bridge/management/commands/export-all-dns-zones.py -> netbox_dns_bridge/management/commands/dns-export-zones.py Unify command naming scheme new file: netbox_dns_bridge/migrations/0001_initial.py Adds the missing migration. Since the plugin was renamed this is also an opportunity to merge all changes into a single migration. renamed: netbox_dns_bridge/service/transfer/catalog_zone_manager.py -> netbox_dns_bridge/catalog_zone_manager.py renamed: netbox_dns_bridge/service/transfer/dns_server.py -> netbox_dns_bridge/dns_server.py new file: netbox_dns_bridge/management/commands/dns-settings.py modified: netbox_dns_bridge/management/commands/dns-transfer-endpoint.py renamed: netbox_dns_bridge/service/transfer/request_handler.py -> netbox_dns_bridge/request_handler.py deleted: netbox_dns_bridge/service/transfer/__init__.py Another restructure to simplify code re-use. New command dns-settings added to allow setting of catalog zone serial. This will be needed to migrate from previous versions.
This commit is contained in:
sven authored and 
Sven Luthi committed
1 parent
5f48472ba4
commit
f713719543
10 files changed
+106
-16
No files matched your search
@@ -0,0 +1,231 @@
|
||||
import logging
|
||||
import threading
|
||||
import dns.query
|
||||
import dns.message
|
||||
import dns.tsigkeyring
|
||||
import dns.name
|
||||
import dns.zone
|
||||
import dns.rdatatype
|
||||
import dns.rdataclass
|
||||
import dns.rdtypes
|
||||
import dns.exception
|
||||
import dns.renderer
|
||||
from netbox_dns.models import Zone
|
||||
from netbox_dns.choices import ZoneStatusChoices
|
||||
from netbox_dns_bridge.models import IntegerKeyValueSetting, CatalogZoneMemberIdentifier
|
||||
from uuid import uuid4
|
||||
from base64 import b32encode
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
_LOCK = threading.Lock()
|
||||
_SERIAL_MAX = 0xFFFFFFFF
|
||||
_SERIAL_OBJ = None
|
||||
_PREVIOUS_LAST_ZONE_UPDATE = None
|
||||
|
||||
def init() -> None:
|
||||
_init_serial()
|
||||
_create_missing_member_identifiers()
|
||||
|
||||
# Following function loads the last serial from the DB. No return value
|
||||
# but it sets the setting "catalog_serial" or terminates the plugin on failure.
|
||||
def _init_serial() -> None:
|
||||
global _SERIAL_OBJ
|
||||
|
||||
try:
|
||||
_SERIAL_OBJ = IntegerKeyValueSetting.objects.get(
|
||||
key="catalog-zone-soa-serial"
|
||||
)
|
||||
logger.debug(
|
||||
f"Catalog zone SOA serial number {_SERIAL_OBJ.value} loaded from database"
|
||||
)
|
||||
except IntegerKeyValueSetting.DoesNotExist:
|
||||
_SERIAL_OBJ = IntegerKeyValueSetting.objects.create(
|
||||
key="catalog-zone-soa-serial", value=1
|
||||
)
|
||||
logger.debug(
|
||||
f"Catalog zone SOA serial number was not set in the database. Set to {_SERIAL_OBJ.value}"
|
||||
)
|
||||
|
||||
def _set_serial(new_serial: int) -> bool:
|
||||
global _SERIAL_OBJ
|
||||
|
||||
if (0 < new_serial < _SERIAL_MAX):
|
||||
_SERIAL_OBJ.value = new_serial
|
||||
_SERIAL_OBJ.save()
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
def _increment_serial() -> None:
|
||||
if not _set_serial( _SERIAL_OBJ.value + 1 ):
|
||||
logger.warning(
|
||||
f"Failed to incremenet catalog serial {_SERIAL_OBJ.value}. Will overflow serial back to 1"
|
||||
)
|
||||
_set_serial(1)
|
||||
logger.debug(
|
||||
f"Catalog zone SOA serial number incremented to {_SERIAL_OBJ.value}"
|
||||
)
|
||||
|
||||
# If a zone has no catz identifier yet, create it:
|
||||
def _create_missing_member_identifiers() -> None:
|
||||
existing_zone_ids = CatalogZoneMemberIdentifier.objects.values_list(
|
||||
"zone_id", flat=True
|
||||
)
|
||||
|
||||
missing_zones = Zone.objects.exclude(id__in=existing_zone_ids)
|
||||
|
||||
new_objects = [
|
||||
CatalogZoneMemberIdentifier(
|
||||
zone=zone,
|
||||
name=_generate_member_identifier(),
|
||||
)
|
||||
for zone in missing_zones
|
||||
]
|
||||
|
||||
for identifier in new_objects:
|
||||
logger.debug(f"Zone {identifier.zone} has no catz member identifier. Creating...")
|
||||
|
||||
CatalogZoneMemberIdentifier.objects.bulk_create(
|
||||
new_objects,
|
||||
ignore_conflicts=False,
|
||||
)
|
||||
|
||||
|
||||
def create_zone(name, view_name) -> dns.zone.Zone:
|
||||
global _PREVIOUS_LAST_ZONE_UPDATE
|
||||
# Synchronize following across threads as TCP and UDP listener both use it.
|
||||
with _LOCK:
|
||||
latest_zone = (
|
||||
Zone.objects.filter(status=ZoneStatusChoices.STATUS_ACTIVE)
|
||||
.order_by("-last_updated")
|
||||
.first()
|
||||
)
|
||||
|
||||
last_zone_update = getattr(latest_zone, "last_updated", None)
|
||||
|
||||
# Check if there was a zone updated since last call
|
||||
# If no zone was found previously then this will be false since (None != None) = False
|
||||
if _PREVIOUS_LAST_ZONE_UPDATE != last_zone_update:
|
||||
if last_zone_update is not None:
|
||||
logger.debug(
|
||||
f"Zone {latest_zone.name} was updated in view {latest_zone.view.name}"
|
||||
)
|
||||
# Setting previous last zone update for next iteration:
|
||||
_PREVIOUS_LAST_ZONE_UPDATE = last_zone_update
|
||||
_increment_serial()
|
||||
|
||||
# Zone origin
|
||||
origin = dns.name.from_text(name, dns.name.root)
|
||||
|
||||
# Create a new empty zone
|
||||
zone = dns.zone.Zone(origin)
|
||||
zone.rdclass = dns.rdataclass.IN
|
||||
|
||||
# get zones from netbox
|
||||
nb_zones = Zone.objects.filter(
|
||||
view__name=view_name, status=ZoneStatusChoices.STATUS_ACTIVE
|
||||
).select_related("catz_identifier")
|
||||
|
||||
ptr_base = dns.name.from_text("zones", origin)
|
||||
|
||||
for nb_zone in nb_zones:
|
||||
ttl = 0
|
||||
qname = dns.name.from_text(nb_zone.name, dns.name.root)
|
||||
|
||||
# Create PTR record
|
||||
#p_name = f"zid-{nb_zone.id:09d}"
|
||||
p_name = nb_zone.catz_identifier.name
|
||||
|
||||
ptr_name = dns.name.from_text(p_name, ptr_base)
|
||||
if not ptr_name.is_subdomain(origin):
|
||||
raise ValueError(
|
||||
"Catalog zone member identifier {ptr_name.to_text()} not a subdomain"
|
||||
)
|
||||
rdata = dns.rdata.from_text(
|
||||
dns.rdataclass.IN, dns.rdatatype.PTR, qname.to_text()
|
||||
)
|
||||
rdataset = zone.find_rdataset(ptr_name, dns.rdatatype.PTR, create=True)
|
||||
rdataset.add(rdata, ttl)
|
||||
|
||||
# Configure DNSSec Policy for member Zone if DNSSec is enabled
|
||||
if nb_zone.dnssec_policy:
|
||||
# Configure policy
|
||||
rid = dns.name.from_text("group", ptr_name)
|
||||
policy_name = nb_zone.dnssec_policy.name.rstrip(" ")
|
||||
group_name = f"dnssec-policy-{policy_name}"
|
||||
rdata = dns.rdata.from_text(
|
||||
dns.rdataclass.IN, dns.rdatatype.TXT, group_name
|
||||
)
|
||||
rdataset = zone.find_rdataset(rid, dns.rdatatype.TXT, create=True)
|
||||
rdataset.add(rdata, ttl)
|
||||
|
||||
## Configure dnssec status for member zone
|
||||
# status = str(1 if nb_zone.dnssec_policy else 0)
|
||||
# rid = dns.name.from_text("enabled.dnssec.ext", ptr_name)
|
||||
# rdata = dns.rdata.from_text(dns.rdataclass.IN, dns.rdatatype.TXT, status)
|
||||
# rdataset = zone.find_rdataset(rid, dns.rdatatype.TXT, create=True)
|
||||
# rdataset.add(rdata, ttl)
|
||||
|
||||
# SOA Record components
|
||||
ttl = 0
|
||||
rclass = dns.rdataclass.IN
|
||||
rtype = dns.rdatatype.SOA
|
||||
mname = dns.name.from_text("invalid", dns.name.root)
|
||||
rname = dns.name.from_text("invalid", dns.name.root)
|
||||
serial = _SERIAL_OBJ.value
|
||||
refresh = 60
|
||||
retry = 10
|
||||
expire = 1209600
|
||||
minimum = 0
|
||||
|
||||
# Create SOA rdata object
|
||||
soa_rdata = dns.rdata.from_text(
|
||||
rclass,
|
||||
rtype,
|
||||
f"{mname} {rname} {serial} {refresh} {retry} {expire} {minimum}",
|
||||
)
|
||||
|
||||
# Create Rdataset and add the RDATA to it
|
||||
soa_rdataset = dns.rdataset.Rdataset(rclass, rtype)
|
||||
soa_rdataset.add(soa_rdata, ttl)
|
||||
|
||||
# Add to the origin node in the zone
|
||||
node = zone.find_node(origin, create=True)
|
||||
node.rdatasets.append(soa_rdataset)
|
||||
|
||||
# NS record for catz.
|
||||
ns_name = dns.name.from_text("invalid", dns.name.root)
|
||||
ns_rdata = dns.rdata.from_text(
|
||||
dns.rdataclass.IN, dns.rdatatype.NS, str(ns_name)
|
||||
)
|
||||
ns_rdataset = dns.rdataset.Rdataset(dns.rdataclass.IN, dns.rdatatype.NS)
|
||||
ns_rdataset.add(ns_rdata, 0)
|
||||
|
||||
# Add to node (catz. is the origin)
|
||||
ns_node = zone.find_node(origin, create=True)
|
||||
ns_node.rdatasets.append(ns_rdataset)
|
||||
|
||||
# TXT record for version.catz.
|
||||
version_name = dns.name.from_text(
|
||||
"version", origin
|
||||
) # relative to origin "catz."
|
||||
txt_rdata = dns.rdata.from_text(dns.rdataclass.IN, dns.rdatatype.TXT, '"2"')
|
||||
|
||||
txt_rdataset = dns.rdataset.Rdataset(dns.rdataclass.IN, dns.rdatatype.TXT)
|
||||
txt_rdataset.add(txt_rdata, 0)
|
||||
|
||||
# Add to node version.catz.
|
||||
txt_node = zone.find_node(version_name, create=True)
|
||||
txt_node.rdatasets.append(txt_rdataset)
|
||||
|
||||
return zone
|
||||
|
||||
def _generate_member_identifier() -> None:
|
||||
return b32encode(uuid4().bytes)[0:26].lower().decode('UTF-8')
|
||||
|
||||
def update_member_identifier(zone: Zone) -> None:
|
||||
CatalogZoneMemberIdentifier.objects.update_or_create(
|
||||
zone=zone,
|
||||
defaults={"name": _generate_member_identifier},
|
||||
)
|
||||
Reference in new issue
Block a user