chiark / gitweb /
a222db0bab52ca5853035853abc89c1a606a3a2f
[chiark-utils.git] / scripts / named-conf
1 #!/usr/bin/perl -w
2
3 use strict;
4 use IO::File;
5 use Data::Dumper;
6
7 use vars qw($quis
8             $mode $doall
9             $etcfile $where
10             $debug $needglue $localonly $verbosity);
11
12 $quis= $0; $quis =~ s,.*/,,;
13
14 $mode= '';
15 $doall= 0;
16 $etcfile= "/etc/bind/chiark-conf-gen.zones";
17 $where= '<built-in>';
18 $debug= 0;
19 $needglue= 2;
20 $localonly= 0;
21 $verbosity= 1;
22
23 use vars qw($dig_owner $dig_type $dig_rdata);
24
25 while (@ARGV && $ARGV[0] =~ m/^\-/) {
26     $_= shift @ARGV;
27     if (s/^\-\-//) {
28         last if m/^$/;
29         if (m/^(yes|no|force)$/) { m/^./; $mode= $&; }
30         elsif (m/^all$/) { $doall=1; }
31         elsif (m/^config$/) { $etcfile= loarg(); $where= '--config option'; }
32         elsif (m/^glueless$/) { $needglue--; }
33         elsif (m/^localonly$/) { $localonly=1; }
34         elsif (m/^quiet$/) { $verbosity=0; }
35         elsif (m/^verbose$/) { $verbosity=2; }
36         else { usageerr("unknown option --$_"); }
37     } else {
38         s/^\-//;
39         last if m/^$/;
40         while (m/^./) {
41             if (s/^[ynf]//) { $mode=$&; }
42             elsif (s/^A//) { $doall=1; }
43             elsif (s/^C//) { $etcfile= soarg(); $where= '-C option'; }
44             elsif (s/^D//) { $debug++; }
45             elsif (s/^g//) { $needglue--; }
46             elsif (s/^l//) { $localonly=1; }
47             elsif (s/^q//) { $verbosity=0; }
48             elsif (s/^v//) { $verbosity=2; }
49             else { usageerr("unknown option -$&"); }
50         }
51     }
52 }
53
54 sub loarg() { usageerr("missing option value") if !@ARGV; return shift @ARGV; }
55 sub soarg() { my ($rv); $rv=$_; $_=''; return length $rv ? $rv : loarg(); }
56
57 usageerr("-g may be specified at most twice") if $needglue<0;
58 usageerr("-D may be specified at most twice") if $debug>2;
59 usageerr("must specify either -f|-y|-n or zones (and not both)")
60     if !!$mode == !!@ARGV;
61
62 sub usageerr ($) {
63     die
64 "$_[0]
65 usage: named-conf-regen [-rvq] -f|-y|-n|<zone>...\n".
66 "operation modes:\n".
67 " -f --force   install without checking\n".
68 " -y --yes     check and install\n".
69 " -n --no      check only\n".
70 "additional options:\n".
71 " -q --quiet   no output for OK zones\n".
72 " -v --verbose extra verbose\n";
73 }
74
75 cfg_fail("config filename $etcfile should have been absolute path of a file")
76     unless $etcfile =~ m,^/, && $etcfile !~ m,/$,;
77
78 use vars qw($default_dir);
79 $default_dir= $etcfile;
80 $default_dir =~ s,/[^/]+$,,;
81
82 use vars qw($slave_dir $slave_prefix $slave_suffix);
83 $slave_dir= 'slave';
84 $slave_prefix= '';
85 $slave_suffix= '';
86
87 use vars qw(@self_ns @self_soa);
88 @self_ns= @self_soa= ();
89
90 use vars qw(%zone_cfg @zone_cfg_list);
91 %zone_cfg= ();
92 @zone_cfg_list= ();
93
94 use vars qw($output $default_output %output_contents);
95 $output= '';
96 $default_output= '';
97 %output_contents= ();
98
99 use vars qw($check $install);
100 $check= $mode !~ m/^f/;
101 $install= $mode =~ m/^[yf]/;
102
103 read_config($etcfile);
104 debug_dump('@zone_cfg_list %zone_cfg');
105 process_zones($mode ? @zone_cfg_list : @ARGV);
106 debug_dump('%output_contents');
107
108 exit 0;
109
110 #-------------------- configuration reading
111
112 sub cfg_fail ($) { die "$quis: $where:\n $_[0]\n"; }
113
114 sub read_config ($) {
115     my ($if) = @_;
116     my ($fh,$z,@self, $dir,$prefix,$suffix,$lprefix,$lsuffix);
117     local ($_);
118
119     $fh= new IO::File $if,'r' or cfg_fail("open $if:\n $!");
120     for (;;) {
121         if (!defined($_= <$fh>)) {
122             cfg_fail("read config file $if:\n $!") if $fh->error();
123             last;
124         }
125         $where= "$if:$.";
126         s/^\s+//; chomp; s/\s+$//;
127         next if m/^\#/;
128         last if m/^end$/;
129         next unless m/\S/;
130         if (m/^self(\-ns|\-soa|)\s+(\S.*\S)/) {
131             @self= split /\s+/, $2;
132             @self_ns= @self if $1 ne '-soa';
133             @self_soa= @self if $1 ne '-ns';
134         } elsif (m/^self\-addr\s+([0-9. \t]+)/) {
135             @self_addr= split /\s+/, $2;
136         } elsif (m/^primary\-dir([*?]?)\s+(\S+)((?:\s+(\S+))?:\s+(\S+))?$/) {
137             ($mod, $dir, $prefix, $suffix) = ($1,qualify($2),$3,$4);
138             $suffix= '_db' if !defined $suffix;
139             $prefix= '' if !defined $prefix;
140             opendir D, $dir or cfg_fail("open primary-dir $dir:\n $!");
141             $lprefix= length $prefix; $lsuffix= length $suffix;
142             while (defined($_= readdir D)) {
143                 next if m/^\./ && !$lprefix;
144                 next unless length > $lprefix+$lsuffix;
145                 next unless substr($_,0,$lprefix) eq $prefix;
146                 next unless substr($_,length($_)-$lsuffix) eq $suffix;
147                 $z= substr($_,$lprefix,length($_)-($lprefix+$lsuffix));
148                 zone_conf($z,'primary',"p$mod","$dir/$_");
149             }
150             closedir D or cfg_fail("close primary-dir $dir:\n $!");
151         } elsif (m/^primary([*?]?)\s+(\S+)\s+(\S+)$/) {
152             zone_conf($2,'primary',"p$1",qualify($3));
153         } elsif (m/^published([*?]?)\s+(\S+)\s+([0-9.\t]+)$/) {
154             zone_conf($2,'published',"s$1",'',$3);
155         } elsif (m/^stealth([*?]?)\s+(\S+)\s+([0-9. \t]+)$/) {
156             zone_conf($2,'stealth',"u$1",'',split /\s+/, $3);
157         } elsif (m/^slave\-dir\s+(\S+)((?:\s+(\S+))?:\s+(\S+))?$/) {
158             ($slave_dir, $slave_prefix, $slave_suffix) = (qualify($1),$2,$3);
159         } elsif (m/^output\s+bind8\+(\S+)$/) {
160             cfg_fail("default output may not apply to only some zones")
161                 if @zone_cfg_list && length $default_output;
162             set_output(qualify($1));
163         } elsif (m/^include\s+(\S+)$/) {
164             read_config($1);
165         } else {
166             cfg_fail("unknown configuration directive".
167                      " or incorrect syntax or arguments");
168         }
169     }
170     $fh->close or cfg_fail("close config file $if:\n $!");
171 }
172
173 sub qualify ($) {
174     my ($i) = @_;
175     $i= "$default_dir/$i" unless $i =~ m,^/,;
176     return $i;
177 }
178
179 sub zone_conf ($$$@) {
180     my ($zone,$style,$s,$file,@servers) = @_;
181     $file= qualify("$slave_dir/$slave_prefix".$zone.$slave_suffix)
182         unless length $file;
183     if (!length $output) {
184         $default_output= qualify('chiark-conf-gen.bind8')
185             unless length $default_output;
186         set_output($default_output);
187     }
188     cfg_fail("redefined zone $zone") if exists $zone_cfg{$zone};
189     $zone_cfg{$zone}{'file'}= $file;
190     $zone_cfg{$zone}{'style_p'}= $style.$mod;
191     $zone_cfg{$zone}{'s'}= $s; # p)rimary s)econdary u)npublished f)oreign
192     $zone_cfg{$zone}{'servers'}= [ @servers ];
193     $zone_cfg{$zone}{'self_soa'}= [ @self_soa ];
194     $zone_cfg{$zone}{'self_ns'}= [ @self_ns ];
195     $zone_cfg{$zone}{'output'}= $output;
196     push @zone_cfg_list, $zone;
197 }
198
199 sub set_output($) {
200     my ($newout) = @_;
201     $output= $newout;
202     $output_contents{$output}= '';
203 }
204
205
206 #-------------------- checking
207
208 use vars qw($zone $cfg $warnings);
209 $warnings= 0;
210
211 sub progress ($) {
212     return if !$verbosity;
213     print "$_[0]\n";
214 }
215
216 sub verbose ($) {
217     return if $verbosity<2;
218     print "    $_[0]\n";
219 }
220
221 sub process_zones (@) {
222     my (@zones) = @_;
223     local ($zone,$cfg);
224
225     foreach $zone (@zones) {
226         $cfg= $zone_cfg{$zone} || {
227             'style_p' => 'foreign',
228             's' => 'f',
229             'servers' => [ ],
230             };
231         progress(sprintf "%-40s %s", $zone, $$cfg{'style_p'});
232         if ($check && ($doall || $cfg{'s'} !~ m/\?/)) {
233             eval {
234                 if ($localonly && $cfg->{'s'} =~ m/f/) {
235                     zone_warning("foreign zone specified with -l");
236                 } elsif ($cfg->{'s'} =~ m/\*/ ||
237                          ($localonly && $cfg->{'s'} !~ m/p/)) {
238                     zone_check_local();
239                 } else {
240                     zone_check_full();
241                 }
242             };
243             zone_warning("checks failed: $@") if length $@;
244         }
245         zone_output() if $install;
246     }
247     print STDERR "$quis: $warnings warnings\n" or die $!
248         if $warnings;
249 }
250
251 sub zone_warning ($) {
252     my ($w) = @_;
253     $w =~ s/\n$//;
254     $w =~ s,\n, // ,g;
255     print STDERR "$zone: warning: $w\n" or die $!;
256     $warnings++;
257 }
258
259 sub zone_warnmore ($) {
260     print STDERR " $_[0]\n" or die $!;
261 }
262
263 use vars qw(%delgs); # $delgs{$nameserver_list} = [ $whosaidandwhy ]
264 use vars qw(%auths); # $auths{$nameserver_list} = [ $whosaidandwhy ]
265 use vars qw(%glue);  # $glue{$name}{$addr_list} = [ $whosaidandwhy ]
266 use vars qw(%soas);  # $soa{"$origin $serial"} = [ $whosaidandwhy ]
267 use vars qw(%addr_is_ok %gluelesswarned);
268 use vars qw(@to_check); # ($addr,$whyask,$is_auth,$glueless_ok, ...)
269 use vars qw(@to_check_soa); # ($addr,$whyask, ...)
270
271 sub zone_check_full () {
272     zone_reset();
273     zone_investigate();
274     zone_consistency();
275     zone_servers_ok();
276 }
277
278 sub zone_reset() {
279     %delgs= %auths= %glue= %soas= %gluelesswarned= %addr_is_ok= ();
280     @to_check= @to_check_soa= ();
281 }
282
283 sub zone_investigate() {
284     my ($super_zone, @super_nsnames,
285         $super_ns, @super_ns_addrs, $s, $wa, $is_auth,
286         %nsrrset_checked, %soa_checked, $addr, $glueless_ok, $rcode);
287
288     $super_zone= $zone;
289     for (;;) {
290         debug_trace("zone $zone superzone $super_zone");
291         $super_zone =~ s/^[^.]+\.// or die "no superzone ? ($super_zone)\n";
292         ($rcode,@super_nsnames)= lookup($super_zone,'ns-','06');
293         last if !$rcode;
294     }
295     for $super_ns (@super_nsnames) {
296         $super_ns= lc $super_ns;
297         ($rcode,@super_ns_addrs)= lookup($super_ns,'a','0');
298         foreach $addr (@super_ns_addrs) {
299             push @to_check,
300                  $addr,
301                  "$super_ns, server for $super_zone",
302                  0, 0;
303         }
304     }
305     for (;;) {
306         # We do these in order so that we always do NS RRset checks on
307         # nameservers that came from other NS RRsets first; otherwise
308         # we might set nsrrset_checked due to a glueless_ok check,
309         # and then not check for gluefulness later.
310         debug_dump('@to_check @to_check_soa');
311         if (($addr,$wa,$is_auth,$glueless_ok,@to_check) = @to_check) {
312             push @to_check_soa, $addr, $wa if $is_auth;
313             next if $nsrrset_checked{$addr}++;
314             zone_check_nsrrset($addr, "[$addr] $wa",
315                                $is_auth, $glueless_ok);
316         } elsif (($addr,$wa,@to_check_soa) = @to_check_soa) {
317             next if $soa_checked{$addr}++;
318             zone_check_soa($addr,"[$addr] $wa");
319         } else {
320             last;
321         }
322     }
323 }
324
325 sub zone_check_nsrrset ($$$$) {
326     my ($uaddr,$ww, $is_auth, $glueless_ok) = @_;
327     my (@s, $s, %s2g, @glue, $glue, $delgs_or_auths);
328     verbose("checking delegation by $ww");
329     dig(sub {
330         if ($dig_type eq 'ns' && $dig_owner eq $zone) {
331             $s2g{lc $dig_rdata} = [ ];
332         } elsif ($dig_type eq 'a' && exists $s2g{$dig_owner}) {
333             push @to_check,
334                  $dig_rdata,
335                  "$dig_owner, in glue from $ww",
336                  1, 0;
337             zone_server_addr($dig_rdata,$dig_owner,"NS [$uaddr]");
338             push @{ $s2g{$dig_owner} }, $dig_rdata;
339         }
340     },
341              $zone,'ns',$uaddr);
342     if (!%s2g) { zone_warning("unable to find NS RRset at $ww"); return; }
343     elsif (keys %s2g == 1) { zone_warning("only one nameserver at $ww"); }
344     @s= sort keys %s2g;
345     foreach $s (@s) {
346         @glue= @{ $s2g{$s} };
347         if (!@glue) {
348             zone_warning("glueless NS $s,".
349                          ($needglue<=1 ? " (eg)" : "").
350                          " from $ww")
351                 unless $glueless_ok || !$needglue ||
352                        ($needglue<=1 && $gluelesswarned{$s}++);
353             next;
354         }
355         $glue= join ' ', sort @glue;
356         push @{ $glue{$s}{$glue} }, $ww;
357     }
358     $s= join ' ', @s;
359     $delgs_or_auths= $is_auth ? \%auths : \%delgs;
360     push @{ $delgs_or_auths->{$s} }, $ww;
361 }
362
363 sub zone_server_addr ($$$$) {
364     my ($addr,$name,$ww,$is_soa) = @_;
365     $addr_is_ok{$addr}= "$name ($ww)"
366         if $is_soa || $cfg{'s'} =~ m/u/;
367     zone_warning("configured as stealth but we [$addr]".
368                  " are published ($name $ww)")
369         if $cfg->{'s'} =~ m/u/ && grep { $_ eq $addr } @self_addr;
370 }
371
372 sub zone_check_soa ($$) {
373     my ($uaddr,$ww) = @_;
374     my ($lame,$origin,$got,$rcode,@soa_addrs,$soa_addr);
375     verbose("checking service at $ww");
376     $lame= 'dead or lame';
377     dig(sub {
378         if ($dig_type eq 'flags:') {
379             $lame= $dig_rdata =~ m/ aa / ? '' : 'lame';
380         } elsif ($dig_type eq 'soa' && $dig_owner eq $zone && !$lame) {
381             die "several SOAs ? $ww" if defined $origin;
382             $got= $dig_rdata;
383             $got =~ m/^(\S+) \d+/ or die "$got ?";
384             $origin= $1;
385         }
386     },
387              $zone,'soa',$uaddr);
388     $lame= 'broken' if !$lame && !defined $origin;
389     if ($lame) { zone_warning("$lame server $ww"); return; }
390     push @{ $soas{$got} }, $ww;
391     ($rcode,@soa_addrs)= lookup($origin,'a','0');
392     foreach $soa_addr (@soa_addrs) {
393         zone_server_addr($addr,$origin,"SOA [$uaddr]"
394         push @to_check,
395              $soa_addr,
396              "$origin, SOA ORIGIN from $ww";
397     }
398 }
399
400 sub zone_consistency() {
401     my ($d, $org_ser, $origin, $a, $h);
402     zone_consistency_set('delegations',\%delgs);
403     foreach $d (keys %delgs) { delete $auths{$d}; }
404     zone_consistency_set('zone nameserver rrset',\%auths);
405     foreach $h (keys %glue) {
406         zone_consistency_set("glue for $h", $glue{$h});
407     }
408     zone_consistency_set("SOA ORIGIN and SERIAL",\%soas);
409     if ($cfg->{'s'} =~ m/p/) {
410         foreach $org_ser (keys %soas) {
411             $org_ser =~ m/^(\S+) \d+$/ or die "$org_ser ?";
412             $origin= $1;
413             next if grep { $_ eq $origin } @self_soa;
414             zone_warning("our name (@self_soa) not in SOA ORIGIN $origin,".
415                          " eg from ".((values %{ $soas{$org_ser} })[1]));
416         }
417     }
418 }
419
420 sub zone_servers_ok () {
421     my ($showok);
422     if (%addr_is_ok) {
423         $showok= 0;
424         foreach $a (@{ $cfg->{'servers'} }) {
425             next if exists $addr_is_ok{$a};
426             zone_warning("we slave from $a"); $showok=1;
427         }
428         if ($showok) {
429             foreach $a (keys %addr_is_ok) {
430                 zone_warnmore("permitted master [$a] $addr_is_ok{$a}");
431             }
432         }
433     }
434 }
435
436 sub zone_consistency_set ($%) {
437     my ($msg,$set) = @_;
438     my ($d,$o);
439     if (keys(%$set) > 1) {
440         zone_warning("inconsistent $msg:");
441         foreach $d (keys %$set) {
442             foreach $o (@{ $set->{$d} }) { zone_warnmore(" $d from $o"); }
443         }
444     }
445 }
446
447 sub zone_check_local () {
448     zone_reset();
449     zone_servers_simplefind();
450     zone_servers_ok();
451 }
452
453 sub zone_servers_simplefind () {
454     my ($rcode,@nsnames,$ns,@soas,$origin);
455
456     ($rcode,@nsnames)= lookup($zone,'ns-','0');
457     foreach $ns (@nsnames) { zone_server_simple($ns,'NS'); }
458
459     ($rcode,@soas)= lookup($zone,'soa','0');
460     die "multiple SOA RRs in set!  @soas ?" if @soas!=1;
461     $soas[0] =~ m/^(\S+)\s/ or die "SOA ? $_";
462     zone_server_simple(domain_canon($1),'SOA');
463 }
464
465 sub zone_server_simple ($$) {
466     my ($name,$why) = @_;
467     my ($rcode,@addrs,$addr);
468     ($rcode,@addrs)= lookup($name,'a','0');
469     foreach $addr (@addrs) { zone_server_addr($addr,$name,$why); }
470 }
471
472 #-------------------- outputting
473
474 sub zone_output () {
475     $output_contents{$$cfg{'output'}}.=
476         sprintf(<<'END',
477 zone "%s" {
478     type %s;
479     file "%s";
480 };
481 END
482                 $zone,
483                 $$cfg{'s'} =~ m/p/ ? 'master' : 'slave',
484                 $$cfg{'file'});
485 }
486
487
488 #-------------------- general utilities
489
490 sub debug_dump ($) {
491     my ($vn);
492     return unless $debug>1;
493     local $Data::Dumper::Terse=1;
494     foreach $vn (split /\s+/, $_[0]) {
495         print "$vn := ", eval "Dumper(\\$vn)";
496     }
497 }
498
499 sub debug_trace ($) {
500     return unless $debug;
501     print "D $_[0]\n";
502 }
503
504 sub lookup ($$$) {
505     my ($domain,$type,$okrcodes) = @_;
506     my ($c,$h,@result);
507     debug_trace("lookup ==> (->$okrcodes) $domain $type");
508     $h= new IO::Handle;
509
510     defined($c= open $h, "-|") or die "$quis: fork adnshost:\n $!\n";
511     if (!$c) {
512         exec 'adnshost','-Fi','+Do','+Dt','+Dc','-Cf',"-t$type",
513              '-',"$domain.";
514         die "$quis: exec adnshost:\n $!\n";
515     }
516     @result= $h->getlines();
517     $h->error and die "$quis: read from adnshost:\n $!\n";
518     chomp @result;
519     $!=0; $h->close;
520     die "$quis: lookup -t$type $domain $okrcodes failed $? $!\n"
521         if $! or $?>6 or index($okrcodes,$?)<0;
522     debug_trace("lookup <== $? @result");
523     return ($?,@result);
524 }
525
526
527 sub dig (&$$$) {
528     my ($eachrr, $qowner,$qtype,$qaddr) = @_;
529     # also pseudo-rr with type `flags:'
530     my ($h,$inmid,$irdata,$c);
531     local ($_);
532
533     debug_trace("dig ==> \@$qaddr $qowner $qtype");
534
535     $h= new IO::Handle;
536     defined($c= open $h, "-|") or die "$quis: fork dig:\n $!\n";
537     if (!$c) {
538         open STDERR, ">&STDOUT" or die $!;
539         exec ('dig',
540               '+nodef','+nosea','+nodebug','+norecurse',
541               "\@$qaddr",'-t',$qtype,$qowner);
542         die "$quis: exec dig:\n $!\n";
543     }
544     $inmid='';
545     for (;;) {
546         if (!defined($_= $h->getline())) {
547             $h->error() and die "$quis: read from dig:\n $!\n";
548             last;
549         }
550         chomp;
551         if (length $inmid) {
552             s/^\s+/ / or die "$inmid // $_ ?";
553             s/\;.*$//;
554             $_= $inmid.$_;
555             $inmid='';
556             s/$/ \(/ unless s/\s*\)\s*$//;
557         }
558         if (s/\s*\(\s*$//) { $inmid= $_; next; }
559         if (m/^\;\; flags\:( [-0-9a-z ]+)\;/) {
560             $dig_owner=''; $dig_type='flags:'; $dig_rdata= "$1 ";
561             debug_trace("dig  f: $dig_rdata");
562             &$eachrr;
563         } elsif (m/^\;/) {
564         } elsif (!m/\S/) {
565         } elsif (m/^([-.0-9a-z]+)\s+\d\w+\s+in\s+([a-z]+)\s+(\S.*)/i) {
566             $dig_owner=domain_canon($1); $dig_type=lc $2; $irdata=$3;
567             if ($dig_type eq 'a') {
568                 $irdata =~ m/^[.0-9]+$/ or die "$irdata ?";
569                 $dig_rdata= $&;
570             } elsif ($dig_type eq 'ns') {
571                 $irdata =~ m/^[-.0-9a-z]+$/i or die "bad nameserver $irdata ?";
572                 $dig_rdata= domain_canon($irdata);
573             } elsif ($dig_type eq 'soa') {
574                 $irdata =~ m/^([-.0-9a-z]+)\s+.*\s+(\d+)(?:\s+\d\w+){4}$/i
575                     or die "bad SOA $irdata ?";
576                 $dig_rdata= domain_canon($1).' '.$2;
577             } else {
578                 debug_trace("ignoring uknown RR type $dig_type");
579                 next;
580             }
581             debug_trace("dig  $dig_owner $dig_type $dig_rdata");
582             &$eachrr;
583         } else {
584             debug_trace("ignoring unknown dig output $_");
585         }
586     }
587     $h->close;
588     debug_trace("dig <== gave $?");
589 }
590
591 sub domain_canon ($) {
592     local ($_) = @_;
593     s/(.)\.$/$1/;
594     die "domain $_ ?" unless m/^[0-9a-z]/i;
595     return lc $_;
596 }