zone.py

   1 # Copyright (c) 2014, Ralf Jung <post@ralfj.de>
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are met:
   6 #
   7 # 1. Redistributions of source code must retain the above copyright notice, this
   8 #    list of conditions and the following disclaimer.
   9 # 2. Redistributions in binary form must reproduce the above copyright notice,
  10 #    this list of conditions and the following disclaimer in the documentation
  11 #    and/or other materials provided with the distribution.
  12 #
  13 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  14 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  17 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  20 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23
  24 import re, datetime
  25 #from typing import *
  26
  27
  28 second = 1
  29 minute = 60*second
  30 hour = 60*minute
  31 day = 24*hour
  32 week = 7*day
  33
  34 REGEX_label = r'[a-zA-Z90-9]([a-zA-Z90-9-]{0,61}[a-zA-Z90-9])?' # max. 63 characters; must not start or end with hyphen
  35 REGEX_ipv4  = r'^\d{1,3}(\.\d{1,3}){3}$'
  36 REGEX_ipv6  = r'^[a-fA-F0-9]{1,4}(:[a-fA-F0-9]{1,4}){7}$'
  37
  38 def check_label(label: str) -> str:
  39     label = str(label)
  40     pattern = r'^{0}$'.format(REGEX_label)
  41     if re.match(pattern, label):
  42         return label
  43     raise Exception(label+" is not a valid label")
  44
  45 def check_hostname(name: str) -> str:
  46     name = str(name)
  47     # check hostname for validity
  48     pattern = r'^{0}(\.{0})*\.?$'.format(REGEX_label)
  49     if re.match(pattern, name):
  50         return name
  51     raise Exception(name+" is not a valid hostname")
  52
  53 def check_hex(data: str) -> str:
  54     data = str(data)
  55     if re.match('^[a-fA-F0-9]+$', data):
  56         return data
  57     raise Exception(data+" is not valid hex data")
  58
  59 def check_ipv4(address: str) -> str:
  60     address = str(address)
  61     if re.match(REGEX_ipv4, address):
  62         return address
  63     raise Exception(address+" is not a valid IPv4 address")
  64
  65 def check_ipv6(address: str) -> str:
  66     address = str(address)
  67     if re.match(REGEX_ipv6, address):
  68         return address
  69     raise Exception(address+" is not a valid IPv6 address")
  70
  71 def time(time: int) -> str:
  72     if time == 0:
  73         return "0"
  74     elif time % week == 0:
  75         return str(time//week)+"w"
  76     elif time % day == 0:
  77         return str(time//day)+"d"
  78     elif time % hour == 0:
  79         return str(time//hour)+"h"
  80     elif time % minute == 0:
  81         return str(time//minute)+"m"
  82     else:
  83         return str(time)
  84
  85 def column_widths(datas: 'Sequence', widths: 'Sequence[int]'):
  86     assert len(datas) == len(widths)+1, "There must be as one more data points as widths"
  87     result = ""
  88     width_sum = 0
  89     for data, width in zip(datas, widths): # will *not* cover the last point
  90         result += str(data)+" " # add data point, and a minimal space
  91         width_sum += width
  92         if len(result) < width_sum: # add padding
  93             result += (width_sum - len(result))*" "
  94     # last data point
  95     return result+str(datas[-1])
  96
  97
  98 ## Enums
  99 class Protocol:
 100     TCP = 'tcp'
 101     UDP = 'udp'
 102
 103 class Algorithm:
 104     RSA_SHA256 = 8
 105
 106 class Digest:
 107     SHA1 = 1
 108     SHA256 = 2
 109
 110
 111 ## Record types
 112 class A:
 113     def __init__(self, address: str) -> None:
 114         self._address = check_ipv4(address)
 115
 116     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 117         return zone.RR(owner, 'A', self._address)
 118
 119
 120 class AAAA:
 121     def __init__(self, address: str) -> None:
 122         self._address = check_ipv6(address)
 123
 124     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 125         return zone.RR(owner, 'AAAA', self._address)
 126
 127
 128 class MX:
 129     def __init__(self, name: str, prio: int = 10) -> None:
 130         self._priority = int(prio)
 131         self._name = check_hostname(name)
 132
 133     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 134         return zone.RR(owner, 'MX', '{0} {1}'.format(self._priority, zone.abs_hostname(self._name)))
 135
 136
 137 class SRV:
 138     def __init__(self, protocol: str, service: str, name: str, port: int, prio: int, weight: int) -> None:
 139         self._service = check_label(service)
 140         self._protocol = check_label(protocol)
 141         self._priority = int(prio)
 142         self._weight = int(weight)
 143         self._port = int(port)
 144         self._name = check_hostname(name)
 145
 146     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 147         return zone.RR('_{0}._{1}.{2}'.format(self._service, self._protocol, owner), 'SRV',
 148                        '{0} {1} {2} {3}'.format(self._priority, self._weight, self._port, zone.abs_hostname(self._name)))
 149
 150
 151 class TLSA:
 152     class Usage:
 153         CA = 0 # certificate must pass the usual CA check, with the CA specified by the TLSA record
 154         EndEntity_PlusCAs = 1 # the certificate must match the TLSA record *and* pass the usual CA check
 155         TrustAnchor = 2 # the certificate must pass a check with the TLSA record giving the (only) trust anchor
 156         EndEntity = 3 # the certificate must match the TLSA record
 157
 158     class Selector:
 159         Full = 0
 160         SubjectPublicKeyInfo = 1
 161
 162     class MatchingType:
 163         Exact = 0
 164         SHA256 = 1
 165         SHA512 = 2
 166
 167     def __init__(self, protocol: str, port: int, usage: int, selector: int, matching_type: int, data: str) -> None:
 168         self._port = int(port)
 169         self._protocol = str(protocol)
 170         self._usage = int(usage)
 171         self._selector = int(selector)
 172         self._matching_type = int(matching_type)
 173         self._data = check_hex(data)
 174
 175     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 176         return zone.RR('_{0}._{1}.{2}'.format(self._port, self._protocol, owner), 'TLSA', '{0} {1} {2} {3}'.format(self._usage, self._selector, self._matching_type, self._data))
 177
 178
 179 class CNAME:
 180     def __init__(self, name: str) -> None:
 181         self._name = check_hostname(name)
 182
 183     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 184         return zone.RR(owner, 'CNAME', zone.abs_hostname(self._name))
 185
 186
 187 class NS:
 188     def __init__(self, name: str) -> None:
 189         self._name = check_hostname(name)
 190
 191     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 192         return zone.RR(owner, 'NS', zone.abs_hostname(self._name))
 193
 194
 195 class DS:
 196     def __init__(self, tag: int, alg: int, digest: int, key: str) -> None:
 197         self._tag = int(tag)
 198         self._key = check_hex(key)
 199         self._alg = int(alg)
 200         self._digest = int(digest)
 201
 202     def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
 203         return zone.RR(owner, 'DS', '{0} {1} {2} {3}'.format(self._tag, self._alg, self._digest, self._key))
 204
 205 ## Higher-level classes
 206 class Name:
 207     def __init__(self, *records: 'List[Any]') -> None:
 208         self._records = records
 209
 210     def generate_rrs(self, owner: str, zone: 'Zone') -> 'Iterator':
 211         for record in self._records:
 212             # this could still be a list
 213             if isinstance(record, list):
 214                 for subrecord in record:
 215                     yield subrecord.generate_rr(owner, zone)
 216             else:
 217                 yield record.generate_rr(owner, zone)
 218
 219
 220 def CName(name: str) -> Name:
 221     return Name(CNAME(name))
 222
 223
 224 def Delegation(name: str) -> Name:
 225     return Name(NS(name))
 226
 227
 228 def SecureDelegation(name: str, tag: int, alg: int, digest: int, key: str) -> Name:
 229     return Name(NS(name), DS(tag, alg, digest, key))
 230
 231
 232 class Zone:
 233     def __init__(self, name: str, serialfile: str, mail: str, NS: 'List[str]', TTLs: 'Dict[str, int]',
 234                  secondary_refresh: int, secondary_retry: int, secondary_expire: int,
 235                  domains: 'Dict[str, Any]') -> None:
 236         if not name.endswith('.'): raise Exception("Expected an absolute hostname")
 237         self._name = check_hostname(name)
 238         self._serialfile = serialfile
 239
 240         if not mail.endswith('.'): raise Exception("Mail must be absolute, end with a dot")
 241         atpos = mail.find('@')
 242         if atpos < 0 or atpos > mail.find('.'): raise Exception("Mail must contain an @ before the first dot")
 243         self._mail = check_hostname(mail.replace('@', '.', 1))
 244         self._NS = list(map(check_hostname, NS))
 245         if '' not in TTLs: raise Exception("Must give a default TTL with empty key")
 246         self._TTLs = TTLs
 247
 248         self._refresh = secondary_refresh
 249         self._retry = secondary_retry
 250         self._expire = secondary_expire
 251
 252         self._domains = domains
 253
 254     def getTTL(self, recordType: str) -> str:
 255         return self._TTLs.get(recordType, self._TTLs[''])
 256
 257     def RR(self, owner: str, recordType: str, data: str) -> str:
 258         '''generate given RR, in textual representation'''
 259         assert re.match(r'^[A-Z]+$', recordType), "got invalid record type"
 260         return column_widths((self.abs_hostname(owner), time(self.getTTL(recordType)), recordType, data), (32, 8, 8))
 261
 262     def abs_hostname(self, name):
 263         if name == '.' or name == '@':
 264             return self._name
 265         if name.endswith('.'):
 266             return name
 267         return name+"."+self._name
 268
 269     def inc_serial(self) -> int:
 270         # get serial
 271         cur_serial = 0
 272         try:
 273             with open(self._serialfile) as f:
 274                 cur_serial = int(f.read())
 275         except (OSError, IOError): # FileNotFoundError has been added in Python 3.3
 276             pass
 277         # increment serial
 278         cur_serial += 1
 279         # save serial
 280         with open(self._serialfile, 'w') as f:
 281             f.write(str(cur_serial))
 282         # be done
 283         return cur_serial
 284
 285     def generate_rrs(self) -> 'Iterator':
 286         # SOA record
 287         serial = self.inc_serial()
 288         yield self.RR(self._name, 'SOA',
 289                       ('{NS} {mail} {serial} {refresh} {retry} {expire} {NX_TTL}'+
 290                       ' ; primns mail serial refresh retry expire NX_TTL').format(
 291                           NS=self.abs_hostname(self._NS[0]), mail=self._mail, serial=serial,
 292                           refresh=time(self._refresh), retry=time(self._retry), expire=time(self._expire),
 293                           NX_TTL=time(self.getTTL('NX')))
 294                       )
 295         # NS records
 296         for name in self._NS:
 297             yield NS(name).generate_rr(self._name, self)
 298         # all the rest
 299         for name in sorted(self._domains.keys(), key=lambda s: list(reversed(s.split('.')))):
 300             for rr in self._domains[name].generate_rrs(name, self):
 301                 yield rr
 302
 303     def write(self) -> None:
 304         print(";; {0} zone file, generated by zonemaker <https://www.ralfj.de/projects/zonemaker> on {1}".format(self._name, datetime.datetime.now()))
 305         for rr in self.generate_rrs():
 306             print(rr)