samba_dnsupdate: Always fill out the nameservers of a dns object.
[kai/samba-autobuild/.git] / source4 / scripting / bin / samba_dnsupdate
1 #!/usr/bin/env python
2 # vim: expandtab
3 #
4 # update our DNS names using TSIG-GSS
5 #
6 # Copyright (C) Andrew Tridgell 2010
7 #
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
21
22 import os
23 import fcntl
24 import sys
25 import tempfile
26 import subprocess
27
28 # ensure we get messages out immediately, so they get in the samba logs,
29 # and don't get swallowed by a timeout
30 os.environ['PYTHONUNBUFFERED'] = '1'
31
32 # forcing GMT avoids a problem in some timezones with kerberos. Both MIT
33 # heimdal can get mutual authentication errors due to the 24 second difference
34 # between UTC and GMT when using some zone files (eg. the PDT zone from
35 # the US)
36 os.environ["TZ"] = "GMT"
37
38 # Find right directory when running from source tree
39 sys.path.insert(0, "bin/python")
40
41 import samba
42 import optparse
43 from samba import getopt as options
44 from ldb import SCOPE_BASE
45 from samba import dsdb
46 from samba.auth import system_session
47 from samba.samdb import SamDB
48 from samba.dcerpc import netlogon, winbind
49
50 samba.ensure_third_party_module("dns", "dnspython")
51 import dns.resolver
52 import dns.exception
53
54 default_ttl = 900
55 am_rodc = False
56 error_count = 0
57
58 parser = optparse.OptionParser("samba_dnsupdate")
59 sambaopts = options.SambaOptions(parser)
60 parser.add_option_group(sambaopts)
61 parser.add_option_group(options.VersionOptions(parser))
62 parser.add_option("--verbose", action="store_true")
63 parser.add_option("--all-names", action="store_true")
64 parser.add_option("--all-interfaces", action="store_true")
65 parser.add_option("--use-file", type="string", help="Use a file, rather than real DNS calls")
66 parser.add_option("--update-list", type="string", help="Add DNS names from the given file")
67 parser.add_option("--update-cache", type="string", help="Cache database of already registered records")
68 parser.add_option("--fail-immediately", action='store_true', help="Exit on first failure")
69 parser.add_option("--no-credentials", dest='nocreds', action='store_true', help="don't try and get credentials")
70 parser.add_option("--no-substiutions", dest='nosubs', action='store_true', help="don't try and expands variables in file specified by --update-list")
71
72 creds = None
73 ccachename = None
74
75 opts, args = parser.parse_args()
76
77 if len(args) != 0:
78     parser.print_usage()
79     sys.exit(1)
80
81 lp = sambaopts.get_loadparm()
82
83 domain = lp.get("realm")
84 host = lp.get("netbios name")
85 if opts.all_interfaces:
86     all_interfaces = True
87 else:
88     all_interfaces = False
89
90 IPs = samba.interface_ips(lp, all_interfaces)
91 nsupdate_cmd = lp.get('nsupdate command')
92
93 if len(IPs) == 0:
94     print "No IP interfaces - skipping DNS updates"
95     sys.exit(0)
96
97 IP6s = []
98 IP4s = []
99 for i in IPs:
100     if i.find(':') != -1:
101         IP6s.append(i)
102     else:
103         IP4s.append(i)
104
105
106 if opts.verbose:
107     print "IPs: %s" % IPs
108
109
110 def get_credentials(lp):
111     """# get credentials if we haven't got them already."""
112     from samba import credentials
113     global ccachename, creds
114     if creds is not None:
115         return
116     creds = credentials.Credentials()
117     creds.guess(lp)
118     creds.set_machine_account(lp)
119     creds.set_krb_forwardable(credentials.NO_KRB_FORWARDABLE)
120     (tmp_fd, ccachename) = tempfile.mkstemp()
121     try:
122         creds.get_named_ccache(lp, ccachename)
123     except RuntimeError as e:
124         os.unlink(ccachename)
125         raise e
126
127
128 class dnsobj(object):
129     """an object to hold a parsed DNS line"""
130
131     def __init__(self, string_form):
132         list = string_form.split()
133         if len(list) < 3:
134             raise Exception("Invalid DNS entry %r" % string_form)
135         self.dest = None
136         self.port = None
137         self.ip = None
138         self.existing_port = None
139         self.existing_weight = None
140         self.type = list[0]
141         self.name = list[1]
142         self.nameservers = []
143         if self.type == 'SRV':
144             if len(list) < 4:
145                 raise Exception("Invalid DNS entry %r" % string_form)
146             self.dest = list[2]
147             self.port = list[3]
148         elif self.type in ['A', 'AAAA']:
149             self.ip   = list[2] # usually $IP, which gets replaced
150         elif self.type == 'CNAME':
151             self.dest = list[2]
152         elif self.type == 'NS':
153             self.dest = list[2]
154         else:
155             raise Exception("Received unexpected DNS reply of type %s: %s" % (self.type, string_form))
156
157     def __str__(self):
158         if self.type == "A":
159             return "%s %s %s" % (self.type, self.name, self.ip)
160         if self.type == "AAAA":
161             return "%s %s %s" % (self.type, self.name, self.ip)
162         if self.type == "SRV":
163             return "%s %s %s %s" % (self.type, self.name, self.dest, self.port)
164         if self.type == "CNAME":
165             return "%s %s %s" % (self.type, self.name, self.dest)
166         if self.type == "NS":
167             return "%s %s %s" % (self.type, self.name, self.dest)
168
169
170 def parse_dns_line(line, sub_vars):
171     """parse a DNS line from."""
172     if line.startswith("SRV _ldap._tcp.pdc._msdcs.") and not samdb.am_pdc():
173         # We keep this as compat to the dns_update_list of 4.0/4.1
174         if opts.verbose:
175             print "Skipping PDC entry (%s) as we are not a PDC" % line
176         return None
177     subline = samba.substitute_var(line, sub_vars)
178     if subline == '' or subline[0] == "#":
179         return None
180     return dnsobj(subline)
181
182
183 def hostname_match(h1, h2):
184     """see if two hostnames match."""
185     h1 = str(h1)
186     h2 = str(h2)
187     return h1.lower().rstrip('.') == h2.lower().rstrip('.')
188
189
190 def check_dns_name(d):
191     """check that a DNS entry exists."""
192     normalised_name = d.name.rstrip('.') + '.'
193     if opts.verbose:
194         print "Looking for DNS entry %s as %s" % (d, normalised_name)
195
196     if opts.use_file is not None:
197         try:
198             dns_file = open(opts.use_file, "r")
199         except IOError:
200             return False
201
202         for line in dns_file:
203             line = line.strip()
204             if line == '' or line[0] == "#":
205                 continue
206             if line.lower() == str(d).lower():
207                 return True
208         return False
209
210     resolver = dns.resolver.Resolver()
211
212     if d.nameservers != []:
213         resolver.nameservers = d.nameservers
214     else:
215         d.nameservers = resolver.nameservers
216
217     try:
218         ans = resolver.query(normalised_name, d.type)
219     except dns.exception.DNSException:
220         if opts.verbose:
221             print "Failed to find DNS entry %s" % d
222         return False
223     if d.type in ['A', 'AAAA']:
224         # we need to be sure that our IP is there
225         for rdata in ans:
226             if str(rdata) == str(d.ip):
227                 return True
228     elif d.type == 'CNAME':
229         for i in range(len(ans)):
230             if hostname_match(ans[i].target, d.dest):
231                 return True
232     elif d.type == 'NS':
233         for i in range(len(ans)):
234             if hostname_match(ans[i].target, d.dest):
235                 return True
236     elif d.type == 'SRV':
237         for rdata in ans:
238             if opts.verbose:
239                 print "Checking %s against %s" % (rdata, d)
240             if hostname_match(rdata.target, d.dest):
241                 if str(rdata.port) == str(d.port):
242                     return True
243                 else:
244                     d.existing_port     = str(rdata.port)
245                     d.existing_weight = str(rdata.weight)
246
247     if opts.verbose:
248         print "Failed to find matching DNS entry %s" % d
249
250     return False
251
252
253 def get_subst_vars(samdb):
254     """get the list of substitution vars."""
255     global lp, am_rodc
256     vars = {}
257
258     vars['DNSDOMAIN'] = samdb.domain_dns_name()
259     vars['DNSFOREST'] = samdb.forest_dns_name()
260     vars['HOSTNAME']  = samdb.host_dns_name()
261     vars['NTDSGUID']  = samdb.get_ntds_GUID()
262     vars['SITE']      = samdb.server_site_name()
263     res = samdb.search(base=samdb.get_default_basedn(), scope=SCOPE_BASE, attrs=["objectGUID"])
264     guid = samdb.schema_format_value("objectGUID", res[0]['objectGUID'][0])
265     vars['DOMAINGUID'] = guid
266
267     vars['IF_DC'] = ""
268     vars['IF_RWDC'] = "# "
269     vars['IF_RODC'] = "# "
270     vars['IF_PDC'] = "# "
271     vars['IF_GC'] = "# "
272     vars['IF_RWGC'] = "# "
273     vars['IF_ROGC'] = "# "
274     vars['IF_DNS_DOMAIN'] = "# "
275     vars['IF_RWDNS_DOMAIN'] = "# "
276     vars['IF_RODNS_DOMAIN'] = "# "
277     vars['IF_DNS_FOREST'] = "# "
278     vars['IF_RWDNS_FOREST'] = "# "
279     vars['IF_R0DNS_FOREST'] = "# "
280
281     am_rodc = samdb.am_rodc()
282     if am_rodc:
283         vars['IF_RODC'] = ""
284     else:
285         vars['IF_RWDC'] = ""
286
287     if samdb.am_pdc():
288         vars['IF_PDC'] = ""
289
290     # check if we "are DNS server"
291     res = samdb.search(base=samdb.get_config_basedn(),
292                    expression='(objectguid=%s)' % vars['NTDSGUID'],
293                    attrs=["options", "msDS-hasMasterNCs"])
294
295     if len(res) == 1:
296         if "options" in res[0]:
297             options = int(res[0]["options"][0])
298             if (options & dsdb.DS_NTDSDSA_OPT_IS_GC) != 0:
299                 vars['IF_GC'] = ""
300                 if am_rodc:
301                     vars['IF_ROGC'] = ""
302                 else:
303                     vars['IF_RWGC'] = ""
304
305         basedn = str(samdb.get_default_basedn())
306         forestdn = str(samdb.get_root_basedn())
307
308         if "msDS-hasMasterNCs" in res[0]:
309             for e in res[0]["msDS-hasMasterNCs"]:
310                 if str(e) == "DC=DomainDnsZones,%s" % basedn:
311                     vars['IF_DNS_DOMAIN'] = ""
312                     if am_rodc:
313                         vars['IF_RODNS_DOMAIN'] = ""
314                     else:
315                         vars['IF_RWDNS_DOMAIN'] = ""
316                 if str(e) == "DC=ForestDnsZones,%s" % forestdn:
317                     vars['IF_DNS_FOREST'] = ""
318                     if am_rodc:
319                         vars['IF_RODNS_FOREST'] = ""
320                     else:
321                         vars['IF_RWDNS_FOREST'] = ""
322
323     return vars
324
325
326 def call_nsupdate(d, op="add"):
327     """call nsupdate for an entry."""
328     global ccachename, nsupdate_cmd, krb5conf
329
330     assert(op in ["add", "delete"])
331
332     if opts.verbose:
333         print "Calling nsupdate for %s (%s)" % (d, op)
334
335     if opts.use_file is not None:
336         try:
337             rfile = open(opts.use_file, 'r+')
338         except IOError:
339             # Perhaps create it
340             rfile = open(opts.use_file, 'w+')
341             # Open it for reading again, in case someone else got to it first
342             rfile = open(opts.use_file, 'r+')
343         fcntl.lockf(rfile, fcntl.LOCK_EX)
344         (file_dir, file_name) = os.path.split(opts.use_file)
345         (tmp_fd, tmpfile) = tempfile.mkstemp(dir=file_dir, prefix=file_name, suffix="XXXXXX")
346         wfile = os.fdopen(tmp_fd, 'a')
347         rfile.seek(0)
348         for line in rfile:
349             if op == "delete":
350                 l = parse_dns_line(line, {})
351                 if str(l).lower() == str(d).lower():
352                     continue
353             wfile.write(line)
354         if op == "add":
355             wfile.write(str(d)+"\n")
356         os.rename(tmpfile, opts.use_file)
357         fcntl.lockf(rfile, fcntl.LOCK_UN)
358         return
359
360     normalised_name = d.name.rstrip('.') + '.'
361
362     (tmp_fd, tmpfile) = tempfile.mkstemp()
363     f = os.fdopen(tmp_fd, 'w')
364     if d.nameservers != []:
365         f.write('server %s\n' % d.nameservers[0])
366     if d.type == "A":
367         f.write("update %s %s %u A %s\n" % (op, normalised_name, default_ttl, d.ip))
368     if d.type == "AAAA":
369         f.write("update %s %s %u AAAA %s\n" % (op, normalised_name, default_ttl, d.ip))
370     if d.type == "SRV":
371         if op == "add" and d.existing_port is not None:
372             f.write("update delete %s SRV 0 %s %s %s\n" % (normalised_name, d.existing_weight,
373                                                            d.existing_port, d.dest))
374         f.write("update %s %s %u SRV 0 100 %s %s\n" % (op, normalised_name, default_ttl, d.port, d.dest))
375     if d.type == "CNAME":
376         f.write("update %s %s %u CNAME %s\n" % (op, normalised_name, default_ttl, d.dest))
377     if d.type == "NS":
378         f.write("update %s %s %u NS %s\n" % (op, normalised_name, default_ttl, d.dest))
379     if opts.verbose:
380         f.write("show\n")
381     f.write("send\n")
382     f.close()
383
384     global error_count
385     if ccachename:
386         os.environ["KRB5CCNAME"] = ccachename
387     try:
388         cmd = nsupdate_cmd[:]
389         cmd.append(tmpfile)
390         env = {}
391         if krb5conf:
392             env["KRB5_CONFIG"] = krb5conf
393         if ccachename:
394             env["KRB5CCNAME"] = ccachename
395         ret = subprocess.call(cmd, shell=False, env=env)
396         if ret != 0:
397             if opts.fail_immediately:
398                 if opts.verbose:
399                     print("Failed update with %s" % tmpfile)
400                 sys.exit(1)
401             error_count = error_count + 1
402             if opts.verbose:
403                 print("Failed nsupdate: %d" % ret)
404     except Exception, estr:
405         if opts.fail_immediately:
406             sys.exit(1)
407         error_count = error_count + 1
408         if opts.verbose:
409             print("Failed nsupdate: %s : %s" % (str(d), estr))
410     os.unlink(tmpfile)
411
412
413
414 def rodc_dns_update(d, t, op):
415     '''a single DNS update via the RODC netlogon call'''
416     global sub_vars
417
418     assert(op in ["add", "delete"])
419
420     if opts.verbose:
421         print "Calling netlogon RODC update for %s" % d
422
423     typemap = {
424         netlogon.NlDnsLdapAtSite       : netlogon.NlDnsInfoTypeNone,
425         netlogon.NlDnsGcAtSite         : netlogon.NlDnsDomainNameAlias,
426         netlogon.NlDnsDsaCname         : netlogon.NlDnsDomainNameAlias,
427         netlogon.NlDnsKdcAtSite        : netlogon.NlDnsInfoTypeNone,
428         netlogon.NlDnsDcAtSite         : netlogon.NlDnsInfoTypeNone,
429         netlogon.NlDnsRfc1510KdcAtSite : netlogon.NlDnsInfoTypeNone,
430         netlogon.NlDnsGenericGcAtSite  : netlogon.NlDnsDomainNameAlias
431         }
432
433     w = winbind.winbind("irpc:winbind_server", lp)
434     dns_names = netlogon.NL_DNS_NAME_INFO_ARRAY()
435     dns_names.count = 1
436     name = netlogon.NL_DNS_NAME_INFO()
437     name.type = t
438     name.dns_domain_info_type = typemap[t]
439     name.priority = 0
440     name.weight   = 0
441     if d.port is not None:
442         name.port = int(d.port)
443     if op == "add":
444         name.dns_register = True
445     else:
446         name.dns_register = False
447     dns_names.names = [ name ]
448     site_name = sub_vars['SITE'].decode('utf-8')
449
450     global error_count
451
452     try:
453         ret_names = w.DsrUpdateReadOnlyServerDnsRecords(site_name, default_ttl, dns_names)
454         if ret_names.names[0].status != 0:
455             print("Failed to set DNS entry: %s (status %u)" % (d, ret_names.names[0].status))
456             error_count = error_count + 1
457     except RuntimeError, reason:
458         print("Error setting DNS entry of type %u: %s: %s" % (t, d, reason))
459         error_count = error_count + 1
460
461     if error_count != 0 and opts.fail_immediately:
462         sys.exit(1)
463
464
465 def call_rodc_update(d, op="add"):
466     '''RODCs need to use the netlogon API for nsupdate'''
467     global lp, sub_vars
468
469     assert(op in ["add", "delete"])
470
471     # we expect failure for 3268 if we aren't a GC
472     if d.port is not None and int(d.port) == 3268:
473         return
474
475     # map the DNS request to a netlogon update type
476     map = {
477         netlogon.NlDnsLdapAtSite       : '_ldap._tcp.${SITE}._sites.${DNSDOMAIN}',
478         netlogon.NlDnsGcAtSite         : '_ldap._tcp.${SITE}._sites.gc._msdcs.${DNSDOMAIN}',
479         netlogon.NlDnsDsaCname         : '${NTDSGUID}._msdcs.${DNSFOREST}',
480         netlogon.NlDnsKdcAtSite        : '_kerberos._tcp.${SITE}._sites.dc._msdcs.${DNSDOMAIN}',
481         netlogon.NlDnsDcAtSite         : '_ldap._tcp.${SITE}._sites.dc._msdcs.${DNSDOMAIN}',
482         netlogon.NlDnsRfc1510KdcAtSite : '_kerberos._tcp.${SITE}._sites.${DNSDOMAIN}',
483         netlogon.NlDnsGenericGcAtSite  : '_gc._tcp.${SITE}._sites.${DNSFOREST}'
484         }
485
486     for t in map:
487         subname = samba.substitute_var(map[t], sub_vars)
488         if subname.lower() == d.name.lower():
489             # found a match - do the update
490             rodc_dns_update(d, t, op)
491             return
492     if opts.verbose:
493         print("Unable to map to netlogon DNS update: %s" % d)
494
495
496 # get the list of DNS entries we should have
497 if opts.update_list:
498     dns_update_list = opts.update_list
499 else:
500     dns_update_list = lp.private_path('dns_update_list')
501
502 if opts.update_cache:
503     dns_update_cache = opts.update_cache
504 else:
505     dns_update_cache = lp.private_path('dns_update_cache')
506
507 # use our private krb5.conf to avoid problems with the wrong domain
508 # bind9 nsupdate wants the default domain set
509 krb5conf = lp.private_path('krb5.conf')
510 os.environ['KRB5_CONFIG'] = krb5conf
511
512 file = open(dns_update_list, "r")
513
514 if opts.nosubs:
515     sub_vars = {}
516 else:
517     samdb = SamDB(url=lp.samdb_url(), session_info=system_session(), lp=lp)
518
519     # get the substitution dictionary
520     sub_vars = get_subst_vars(samdb)
521
522 # build up a list of update commands to pass to nsupdate
523 update_list = []
524 dns_list = []
525 cache_list = []
526 delete_list = []
527
528 dup_set = set()
529 cache_set = set()
530
531 rebuild_cache = False
532 try:
533     cfile = open(dns_update_cache, 'r+')
534 except IOError:
535     # Perhaps create it
536     cfile = open(dns_update_cache, 'w+')
537     # Open it for reading again, in case someone else got to it first
538     cfile = open(dns_update_cache, 'r+')
539 fcntl.lockf(cfile, fcntl.LOCK_EX)
540 for line in cfile:
541     line = line.strip()
542     if line == '' or line[0] == "#":
543         continue
544     c = parse_dns_line(line, {})
545     if c is None:
546         continue
547     if str(c) not in cache_set:
548         cache_list.append(c)
549         cache_set.add(str(c))
550
551 # read each line, and check that the DNS name exists
552 for line in file:
553     line = line.strip()
554     if line == '' or line[0] == "#":
555         continue
556     d = parse_dns_line(line, sub_vars)
557     if d is None:
558         continue
559     if d.type == 'A' and len(IP4s) == 0:
560         continue
561     if d.type == 'AAAA' and len(IP6s) == 0:
562         continue
563     if str(d) not in dup_set:
564         dns_list.append(d)
565         dup_set.add(str(d))
566
567 # now expand the entries, if any are A record with ip set to $IP
568 # then replace with multiple entries, one for each interface IP
569 for d in dns_list:
570     if d.ip != "$IP":
571         continue
572     if d.type == 'A':
573         d.ip = IP4s[0]
574         for i in range(len(IP4s)-1):
575             d2 = dnsobj(str(d))
576             d2.ip = IP4s[i+1]
577             dns_list.append(d2)
578     if d.type == 'AAAA':
579         d.ip = IP6s[0]
580         for i in range(len(IP6s)-1):
581             d2 = dnsobj(str(d))
582             d2.ip = IP6s[i+1]
583             dns_list.append(d2)
584
585 # now check if the entries already exist on the DNS server
586 for d in dns_list:
587     found = False
588     for c in cache_list:
589         if str(c).lower() == str(d).lower():
590             found = True
591             break
592     if not found:
593         rebuild_cache = True
594     if opts.all_names or not check_dns_name(d):
595         update_list.append(d)
596
597 for c in cache_list:
598     found = False
599     for d in dns_list:
600         if str(c).lower() == str(d).lower():
601             found = True
602             break
603     if found:
604         continue
605     rebuild_cache = True
606     if not opts.all_names and not check_dns_name(c):
607         continue
608     delete_list.append(c)
609
610 if len(delete_list) == 0 and len(update_list) == 0 and not rebuild_cache:
611     if opts.verbose:
612         print "No DNS updates needed"
613     sys.exit(0)
614
615 # get our krb5 creds
616 if len(delete_list) != 0 or len(update_list) != 0:
617     if not opts.nocreds:
618         get_credentials(lp)
619
620 # ask nsupdate to delete entries as needed
621 for d in delete_list:
622     if am_rodc:
623         if d.name.lower() == domain.lower():
624             continue
625         if not d.type in [ 'A', 'AAAA' ]:
626             call_rodc_update(d, op="delete")
627         else:
628             call_nsupdate(d, op="delete")
629     else:
630         call_nsupdate(d, op="delete")
631
632 # ask nsupdate to add entries as needed
633 for d in update_list:
634     if am_rodc:
635         if d.name.lower() == domain.lower():
636             continue
637         if not d.type in [ 'A', 'AAAA' ]:
638             call_rodc_update(d)
639         else:
640             call_nsupdate(d)
641     else:
642         call_nsupdate(d)
643
644 if rebuild_cache:
645     (file_dir, file_name) = os.path.split(dns_update_cache)
646     (tmp_fd, tmpfile) = tempfile.mkstemp(dir=file_dir, prefix=file_name, suffix="XXXXXX")
647     wfile = os.fdopen(tmp_fd, 'a')
648     for d in dns_list:
649         wfile.write(str(d)+"\n")
650     os.rename(tmpfile, dns_update_cache)
651 fcntl.lockf(cfile, fcntl.LOCK_UN)
652
653 # delete the ccache if we created it
654 if ccachename is not None:
655     os.unlink(ccachename)
656
657 if error_count != 0:
658     print("Failed update of %u entries" % error_count)
659 sys.exit(error_count)