5030e9c8b9279e975d7de72cfcd4d8bb7b2361a4
[zonemaker.git] / 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}){1,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_base64(data: str) -> str:
60     data = str(data)
61     if re.match('^[a-zA-Z0-9+/=]+$', data):
62         return data
63     raise Exception(data+" is not valid hex data")
64
65
66 def check_ipv4(address: str) -> str:
67     address = str(address)
68     if re.match(REGEX_ipv4, address):
69         return address
70     raise Exception(address+" is not a valid IPv4 address")
71
72 def check_ipv6(address: str) -> str:
73     address = str(address)
74     if re.match(REGEX_ipv6, address):
75         return address
76     raise Exception(address+" is not a valid IPv6 address")
77
78 def time(time: int) -> str:
79     if time == 0:
80         return "0"
81     elif time % week == 0:
82         return str(time//week)+"w"
83     elif time % day == 0:
84         return str(time//day)+"d"
85     elif time % hour == 0:
86         return str(time//hour)+"h"
87     elif time % minute == 0:
88         return str(time//minute)+"m"
89     else:
90         return str(time)
91
92 def column_widths(datas: 'Sequence', widths: 'Sequence[int]'):
93     assert len(datas) == len(widths)+1, "There must be one more data points as there are widths"
94     result = ""
95     width_sum = 0
96     for data, width in zip(datas, widths): # will *not* cover the last point
97         result += str(data)+" " # add data point, and a minimal space
98         width_sum += width
99         if len(result) < width_sum: # add padding
100             result += (width_sum - len(result))*" "
101     # last data point
102     return result+str(datas[-1])
103
104 def concatenate(root, path):
105     if path == '' or root == '':
106         raise Exception("Empty domain name is not valid")
107     if path == '@':
108         return root
109     if root == '@' or path.endswith('.'):
110         return path
111     return path+"."+root
112
113
114 ## Enums
115 class Protocol:
116     TCP = 'tcp'
117     UDP = 'udp'
118
119 class Algorithm:
120     RSA_SHA256 = 8
121
122 class Digest:
123     SHA1 = 1
124     SHA256 = 2
125
126
127 ## Resource records
128 class RR:
129     def __init__(self, path, recordType, data):
130         '''<path> can be relative or absolute.'''
131         assert re.match(r'^[A-Z]+$', recordType), "got invalid record type"
132         self.path = path
133         self.recordType = recordType
134         self.data = data
135         self.TTL = None
136     
137     def mapPath(self, f):
138         '''Run the path through f. Returns self, for nicer chaining.'''
139         self.path = f(self.path)
140         return self
141     
142     def relativize(self, root):
143         return self.mapPath(lambda path: concatenate(root, path))
144     
145     def mapTTL(self, f):
146         '''Run the current TTL and the recordType through f.'''
147         self.TTL = f(self.TTL, self.recordType)
148         return self
149     
150     def __str__(self):
151         return column_widths((self.path, time(self.TTL), self.recordType, self.data), (8*3, 8, 8))
152
153 ## Record types
154 class A:
155     def __init__(self, address: str) -> None:
156         self._address = check_ipv4(address)
157     
158     def generate_rr(self):
159         return RR('@', 'A', self._address)
160
161
162 class AAAA:
163     def __init__(self, address: str) -> None:
164         self._address = check_ipv6(address)
165     
166     def generate_rr(self):
167         return RR('@', 'AAAA', self._address)
168
169
170 class MX:
171     def __init__(self, name: str, prio: int = 10) -> None:
172         self._priority = int(prio)
173         self._name = check_hostname(name)
174     
175     def generate_rr(self):
176         return RR('@', 'MX', '{0} {1}'.format(self._priority, self._name))
177
178
179 class TXT:
180     def __init__(self, text: str) -> None:
181         # test for bad characters
182         for c in ('\n', '\r', '\t'):
183             if c in text:
184                 raise Exception("TXT record {0} contains invalid character")
185         # escape text
186         for c in ('\\', '\"'):
187             text = text.replace(c, '\\'+c)
188         self._text = text
189     
190     def generate_rr(self):
191         return RR('@', 'TXT', '"{0}"'.format(self._text))
192
193
194 class DKIM(TXT): # helper class to treat DKIM more antively
195     class Version:
196         DKIM1 = "DKIM1"
197     
198     class Algorithm:
199         RSA = "rsa"
200     
201     def __init__(self, selector, version, alg, key):
202         self._selector = check_label(selector)
203         version = check_label(version)
204         alg = check_label(alg)
205         key = check_base64(key)
206         super().__init__("v={0}; k={1}; p={2}".format(version, alg, key))
207     
208     def generate_rr(self):
209         return super().generate_rr().relativize('{}._domainkey'.format(self._selector))
210
211
212 class SRV:
213     def __init__(self, protocol: str, service: str, name: str, port: int, prio: int, weight: int) -> None:
214         self._service = check_label(service)
215         self._protocol = check_label(protocol)
216         self._priority = int(prio)
217         self._weight = int(weight)
218         self._port = int(port)
219         self._name = check_hostname(name)
220     
221     def generate_rr(self):
222         return RR('_{}._{}'.format(self._service, self._protocol), 'SRV',
223                        '{} {} {} {}'.format(self._priority, self._weight, self._port, self._name))
224
225
226 class TLSA:
227     class Usage:
228         CA = 0 # certificate must pass the usual CA check, with the CA specified by the TLSA record
229         EndEntity_PlusCAs = 1 # the certificate must match the TLSA record *and* pass the usual CA check
230         TrustAnchor = 2 # the certificate must pass a check with the TLSA record giving the (only) trust anchor
231         EndEntity = 3 # the certificate must match the TLSA record
232
233     class Selector:
234         Full = 0
235         SubjectPublicKeyInfo = 1
236     
237     class MatchingType:
238         Exact = 0
239         SHA256 = 1
240         SHA512 = 2
241     
242     def __init__(self, protocol: str, port: int, usage: int, selector: int, matching_type: int, data: str) -> None:
243         self._port = int(port)
244         self._protocol = str(protocol)
245         self._usage = int(usage)
246         self._selector = int(selector)
247         self._matching_type = int(matching_type)
248         self._data = check_hex(data)
249     
250     def generate_rr(self):
251         return RR('_{}._{}'.format(self._port, self._protocol), 'TLSA', '{} {} {} {}'.format(self._usage, self._selector, self._matching_type, self._data))
252
253
254 class CNAME:
255     def __init__(self, name: str) -> None:
256         self._name = check_hostname(name)
257     
258     def generate_rr(self):
259         return RR('@', 'CNAME', self._name)
260
261
262 class NS:
263     def __init__(self, name: str) -> None:
264         self._name = check_hostname(name)
265     
266     def generate_rr(self):
267         return RR('@', 'NS', self._name)
268
269
270 class DS:
271     def __init__(self, tag: int, alg: int, digest: int, key: str) -> None:
272         self._tag = int(tag)
273         self._key = check_hex(key)
274         self._alg = int(alg)
275         self._digest = int(digest)
276     
277     def generate_rr(self):
278         return RR('@', 'DS', '{} {} {} {}'.format(self._tag, self._alg, self._digest, self._key))
279
280 ## Higher-level classes
281 class Name:
282     def __init__(self, *records: 'List[Any]') -> None:
283         self._records = records
284     
285     def generate_rrs(self):
286         for record in self._records:
287             # this could still be a list
288             if isinstance(record, list):
289                 for subrecord in record:
290                     yield subrecord.generate_rr()
291             else:
292                 yield record.generate_rr()
293
294
295 def CName(name: str) -> Name:
296     return Name(CNAME(name))
297
298
299 def Delegation(name: str, *names) -> Name:
300     return Name(NS(name), list(map(NS, names)))
301
302
303 def SecureDelegation(name: str, tag: int, alg: int, digest: int, key: str) -> Name:
304     return Name(NS(name), DS(tag, alg, digest, key))
305
306
307 class Zone:
308     def __init__(self, name: str, serialfile: str, mail: str, NS: 'List[str]', TTLs: 'Dict[str, int]',
309                  secondary_refresh: int, secondary_retry: int, secondary_expire: int,
310                  domains: 'Dict[str, Any]') -> None:
311         if not name.endswith('.'): raise Exception("Expected an absolute hostname")
312         self._name = check_hostname(name)
313         self._serialfile = serialfile
314         
315         if not mail.endswith('.'): raise Exception("Mail must be absolute, end with a dot")
316         atpos = mail.find('@')
317         if atpos < 0 or atpos > mail.find('.'): raise Exception("Mail must contain an @ before the first dot")
318         self._mail = check_hostname(mail.replace('@', '.', 1))
319         self._NS = list(map(check_hostname, NS))
320         if '' not in TTLs: raise Exception("Must give a default TTL with empty key")
321         self._TTLs = TTLs
322         
323         self._refresh = secondary_refresh
324         self._retry = secondary_retry
325         self._expire = secondary_expire
326         
327         self._domains = domains
328     
329     def getTTL(self, TTL: int, recordType: str) -> int:
330         if TTL is not None: return TTL
331         # TTL is None, so get a global default
332         return int(self._TTLs.get(recordType, self._TTLs['']))
333     
334     def inc_serial(self) -> int:
335         # get serial
336         cur_serial = 0
337         try:
338             with open(self._serialfile) as f:
339                 cur_serial = int(f.read())
340         except (OSError, IOError): # FileNotFoundError has been added in Python 3.3
341             pass
342         # increment serial
343         cur_serial += 1
344         # save serial
345         with open(self._serialfile, 'w') as f:
346             f.write(str(cur_serial))
347         # be done
348         return cur_serial
349     
350     @staticmethod
351     def generate_rrs_from_dict(root, domains):
352         for name in sorted(domains.keys(), key=lambda s: s.split('.')):
353             if name.endswith('.'):
354                 raise Exception("You are trying to add a record outside of your zone. This is not supported. Use '@' for the zone root.")
355             domain = domains[name]
356             name = concatenate(root, name)
357             if isinstance(domain, dict):
358                 for rr in Zone.generate_rrs_from_dict(name, domain):
359                     yield rr
360             else:
361                 for rr in domain.generate_rrs():
362                     yield rr.relativize(name)
363     
364     def generate_rrs(self) -> 'Iterator':
365         # SOA record
366         serial = self.inc_serial()
367         yield RR('@', 'SOA',
368                       ('{NS} {mail} {serial} {refresh} {retry} {expire} {NX_TTL}'+
369                       ' ; primns mail serial refresh retry expire NX_TTL').format(
370                           NS=self._NS[0], mail=self._mail, serial=serial,
371                           refresh=time(self._refresh), retry=time(self._retry), expire=time(self._expire),
372                           NX_TTL=time(self.getTTL(None, 'NX')))
373                       )
374         # NS records
375         for name in self._NS:
376             yield NS(name).generate_rr()
377         # all the rest
378         for rr in Zone.generate_rrs_from_dict('@', self._domains):
379             yield rr
380     
381     def write(self) -> None:
382         print(";; {} zone file, generated by zonemaker <https://www.ralfj.de/projects/zonemaker> on {}".format(self._name, datetime.datetime.now()))
383         print("$ORIGIN {}".format(self._name))
384         for rr in map(lambda rr: rr.mapTTL(self.getTTL), self.generate_rrs()):
385             print(rr)