license: BSD
[zonemaker.git] / zonemaker / zone.py
index 35363ff6c207db8208af574a623b22bc5e1a682c..b543d31c3c6d0456491519e2c21296f88b953271 100644 (file)
@@ -1,6 +1,32 @@
-import re
-from ipaddress import IPv4Address, IPv6Address
-from typing import List, Dict, Any, Iterator, Tuple, Sequence
+# Copyright (c) 2014, Ralf Jung <post@ralfj.de>
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer. 
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# 
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies, 
+# either expressed or implied, of the FreeBSD Project.
+
+import re, datetime
+#from typing import *
 
 
 second = 1
@@ -10,14 +36,18 @@ day = 24*hour
 week = 7*day
 
 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
+REGEX_ipv4  = r'^\d{1,3}(\.\d{1,3}){3}$'
+REGEX_ipv6  = r'^[a-fA-F0-9]{1,4}(:[a-fA-F0-9]{1,4}){7}$'
 
 def check_label(label: str) -> str:
+    label = str(label)
     pattern = r'^{0}$'.format(REGEX_label)
     if re.match(pattern, label):
         return label
     raise Exception(label+" is not a valid label")
 
 def check_hostname(name: str) -> str:
+    name = str(name)
     # check hostname for validity
     pattern = r'^{0}(\.{0})*\.?$'.format(REGEX_label)
     if re.match(pattern, name):
@@ -25,10 +55,23 @@ def check_hostname(name: str) -> str:
     raise Exception(name+" is not a valid hostname")
 
 def check_hex(data: str) -> str:
+    data = str(data)
     if re.match('^[a-fA-F0-9]+$', data):
         return data
     raise Exception(data+" is not valid hex data")
 
+def check_ipv4(address: str) -> str:
+    address = str(address)
+    if re.match(REGEX_ipv4, address):
+        return address
+    raise Exception(address+" is not a valid IPv4 address")
+
+def check_ipv6(address: str) -> str:
+    address = str(address)
+    if re.match(REGEX_ipv6, address):
+        return address
+    raise Exception(address+" is not a valid IPv6 address")
+
 def time(time: int) -> str:
     if time == 0:
         return "0"
@@ -43,7 +86,7 @@ def time(time: int) -> str:
     else:
         return str(time)
 
-def column_widths(datas: Sequence, widths: Sequence[int]):
+def column_widths(datas: 'Sequence', widths: 'Sequence[int]'):
     assert len(datas) == len(widths)+1, "There must be as one more data points as widths"
     result = ""
     width_sum = 0
@@ -72,17 +115,17 @@ class Digest:
 ## Record types
 class A:
     def __init__(self, address: str) -> None:
-        self._address = IPv4Address(address)
+        self._address = check_ipv4(address)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'A', self._address)
 
 
 class AAAA:
     def __init__(self, address: str) -> None:
-        self._address = IPv6Address(address)
+        self._address = check_ipv6(address)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'AAAA', self._address)
 
 
@@ -91,7 +134,7 @@ class MX:
         self._priority = int(prio)
         self._name = check_hostname(name)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'MX', '{0} {1}'.format(self._priority, zone.abs_hostname(self._name)))
 
 
@@ -104,7 +147,7 @@ class SRV:
         self._port = int(port)
         self._name = check_hostname(name)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR('_{0}._{1}.{2}'.format(self._service, self._protocol, owner), 'SRV',
                        '{0} {1} {2} {3}'.format(self._priority, self._weight, self._port, zone.abs_hostname(self._name)))
 
@@ -133,7 +176,7 @@ class TLSA:
         self._matching_type = int(matching_type)
         self._data = check_hex(data)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         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))
 
 
@@ -141,7 +184,7 @@ class CNAME:
     def __init__(self, name: str) -> None:
         self._name = check_hostname(name)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'CNAME', zone.abs_hostname(self._name))
 
 
@@ -149,7 +192,7 @@ class NS:
     def __init__(self, name: str) -> None:
         self._name = check_hostname(name)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'NS', zone.abs_hostname(self._name))
 
 
@@ -160,15 +203,15 @@ class DS:
         self._alg = int(alg)
         self._digest = int(digest)
     
-    def generate_rr(self, owner: str, zone: 'Zone') -> Any:
+    def generate_rr(self, owner: str, zone: 'Zone') -> 'Any':
         return zone.RR(owner, 'DS', '{0} {1} {2} {3}'.format(self._tag, self._alg, self._digest, self._key))
 
 ## Higher-level classes
 class Name:
-    def __init__(self, *records: List[Any]) -> None:
+    def __init__(self, *records: 'List[Any]') -> None:
         self._records = records
     
-    def generate_rrs(self, owner: str, zone: 'Zone') -> Iterator:
+    def generate_rrs(self, owner: str, zone: 'Zone') -> 'Iterator':
         for record in self._records:
             # this could still be a list
             if isinstance(record, list):
@@ -191,44 +234,34 @@ def SecureDelegation(name: str, tag: int, alg: int, digest: int, key: str) -> Na
 
 
 class Zone:
-    def __init__(self, name: str, serialfile: str, dbfile: str, mail: str, NS: List[str],
+    def __init__(self, name: str, serialfile: str, mail: str, NS: 'List[str]', TTLs: 'Dict[str, int]',
                  secondary_refresh: int, secondary_retry: int, secondary_expire: int,
-                 NX_TTL: int = None, A_TTL: int = None, other_TTL: int = None,
-                 domains: Dict[str, Any] = {}) -> None:
-        self._serialfile = serialfile
-        self._dbfile = dbfile
-        
+                 domains: 'Dict[str, Any]') -> None:
         if not name.endswith('.'): raise Exception("Expected an absolute hostname")
         self._name = check_hostname(name)
+        self._serialfile = serialfile
+        
         if not mail.endswith('.'): raise Exception("Mail must be absolute, end with a dot")
         atpos = mail.find('@')
         if atpos < 0 or atpos > mail.find('.'): raise Exception("Mail must contain an @ before the first dot")
         self._mail = check_hostname(mail.replace('@', '.', 1))
         self._NS = list(map(check_hostname, NS))
+        if '' not in TTLs: raise Exception("Must give a default TTL with empty key")
+        self._TTLs = TTLs
         
         self._refresh = secondary_refresh
         self._retry = secondary_retry
         self._expire = secondary_expire
         
-        if other_TTL is None: raise Exception("Must give other_TTL")
-        self._NX_TTL = NX_TTL
-        self._A_TTL = self._AAAA_TTL = A_TTL
-        self._other_TTL = other_TTL
-        
         self._domains = domains
     
+    def getTTL(self, recordType: str) -> str:
+        return self._TTLs.get(recordType, self._TTLs[''])
+    
     def RR(self, owner: str, recordType: str, data: str) -> str:
         '''generate given RR, in textual representation'''
         assert re.match(r'^[A-Z]+$', recordType), "got invalid record type"
-        # figure out TTL
-        attrname = "_"+recordType+"_TTL"
-        TTL = None # type: int
-        if hasattr(self, attrname):
-            TTL = getattr(self, attrname)
-        if TTL is None:
-            TTL = self._other_TTL
-        # be done
-        return column_widths((self.abs_hostname(owner), time(TTL), recordType, data), (32, 8, 8))
+        return column_widths((self.abs_hostname(owner), time(self.getTTL(recordType)), recordType, data), (32, 8, 8))
     
     def abs_hostname(self, name):
         if name == '.' or name == '@':
@@ -243,7 +276,7 @@ class Zone:
         try:
             with open(self._serialfile) as f:
                 cur_serial = int(f.read())
-        except FileNotFoundError:
+        except (OSError, IOError): # FileNotFoundError has been added in Python 3.3
             pass
         # increment serial
         cur_serial += 1
@@ -253,7 +286,7 @@ class Zone:
         # be done
         return cur_serial
     
-    def generate_rrs(self) -> Iterator:
+    def generate_rrs(self) -> 'Iterator':
         # SOA record
         serial = self.inc_serial()
         yield self.RR(self._name, 'SOA',
@@ -261,7 +294,7 @@ class Zone:
                       ' ; primns mail serial refresh retry expire NX_TTL').format(
                           NS=self.abs_hostname(self._NS[0]), mail=self._mail, serial=serial,
                           refresh=time(self._refresh), retry=time(self._retry), expire=time(self._expire),
-                          NX_TTL=time(self._NX_TTL))
+                          NX_TTL=time(self.getTTL('NX')))
                       )
         # NS records
         for name in self._NS:
@@ -272,7 +305,6 @@ class Zone:
                 yield rr
     
     def write(self) -> None:
-        with open(self._dbfile, 'w') as f:
-            for rr in self.generate_rrs():
-                f.write(rr+"\n")
-                print(rr)
+        print(";; {0} zone file, generated by zonemaker <https://www.ralfj.de/projects/zonemaker> on {1}".format(self._name, datetime.datetime.now()))
+        for rr in self.generate_rrs():
+            print(rr)