11 $debug $needglue $localonly $repeat $verbosity);
13 $quis= $0; $quis =~ s,.*/,,;
17 $etcfile= "/etc/bind/chiark-conf-gen.zones";
25 use vars qw($dig_owner $dig_type $dig_rdata);
27 while (@ARGV && $ARGV[0] =~ m/^\-/) {
31 if (m/^(yes|no|force)$/) { m/^./; $mode= $&; }
32 elsif (m/^all$/) { $doall=1; }
33 elsif (m/^config$/) { $etcfile= loarg(); $where= '--config option'; }
34 elsif (m/^glueless$/) { $needglue=0; }
35 elsif (m/^localonly$/) { $localonly=1; }
36 elsif (m/^quiet$/) { $verbosity=0; }
37 elsif (m/^repeat$/) { $repeat=1; }
38 elsif (m/^verbose$/) { $verbosity=2; }
39 else { usageerr("unknown option --$_"); }
44 if (s/^[ynf]//) { $mode=$&; }
45 elsif (s/^A//) { $doall=1; }
46 elsif (s/^C//) { $etcfile= soarg(); $where= '-C option'; }
47 elsif (s/^D//) { $debug++; }
48 elsif (s/^g//) { $needglue=0; }
49 elsif (s/^l//) { $localonly=1; }
50 elsif (s/^q//) { $verbosity=0; }
51 elsif (s/^r//) { $repeat=1; }
52 elsif (s/^v//) { $verbosity=2; }
53 else { usageerr("unknown option -$&"); }
58 sub loarg() { usageerr("missing option value") if !@ARGV; return shift @ARGV; }
59 sub soarg() { my ($rv); $rv=$_; $_=''; return length $rv ? $rv : loarg(); }
61 usageerr("-D may be specified at most twice") if $debug>2;
62 usageerr("must specify either -f|-y|-n or zones (and not both)")
63 if !!$mode == !!@ARGV;
68 usage: named-conf-regen [options] -f|-y|-n|<zone>...\n".
70 " -f --force install without checking\n".
71 " -y --yes check and install\n".
72 " -n --no check only\n".
73 "additional options:\n".
74 " -A --all report on zones marked ? (ones we know are broken)\n".
75 " -D debug $quis (does not help debug your DNS config)\n".
76 " -g --glueless do not warn about any glueless referrals (not recommended)\n".
77 " -l --localonly full checks only on zones which we primary\n".
78 " -q --quiet no output for OK zones\n".
79 " -r --repeat repeat warnings for all sources of imperfect data\n".
80 " -v --verbose extra verbose info about each zone\n".
81 " -C|--config <DIR/FILE use FILE as default config and DIR as default dir\n";
84 cfg_fail("config filename $etcfile should not be directory")
87 use vars qw($default_dir);
88 $default_dir= $etcfile =~ m,^.*/, ? $& : './';
90 use vars qw($slave_dir $slave_prefix $slave_suffix);
95 use vars qw(@self_ns @self_soa @self_addr @forbid_addr @conv_glueless);
96 @self_ns= @self_soa= @self_addr= @forbid_addr= ();
97 @conv_glueless= qw(in-addr.arpa ip6.arpa ip6.int);
99 use vars qw(%zone_cfg @zone_cfg_list);
103 use vars qw($output $default_output %output_contents);
106 %output_contents= ();
108 use vars qw($check $install);
109 $check= $mode !~ m/^f/;
110 $install= $mode =~ m/^[yf]/;
112 read_config($etcfile);
113 debug_dump('@zone_cfg_list %zone_cfg');
114 process_zones($mode ? @zone_cfg_list : @ARGV);
115 debug_dump('%output_contents');
116 output_files() if $install;
120 #-------------------- configuration reading
122 sub cfg_fail ($) { die "$quis: $where:\n $_[0]\n"; }
124 sub read_config ($) {
126 my ($fh,$z,@self,$before,
127 $mod,$dir,$prefix,$suffix,$subfile,$lprefix,$lsuffix,$zf);
130 $fh= new IO::File $if,'r' or cfg_fail("open $if:\n $!");
133 if (!defined($_= <$fh>)) {
134 cfg_fail("read config file $if:\n $!") if $fh->error();
138 if (s/\\$//) { $before.= $_; next; }
146 if (m/^self(\-ns|\-soa|)\s+(\S.*\S)/) {
147 @self= split /\s+/, $2;
148 @self_ns= @self if $1 ne '-soa';
149 @self_soa= @self if $1 ne '-ns';
150 } elsif (m/^serverless\-glueless\s+(\S.*\S)/) {
151 @conv_glueless= split /\s+/, $1;
152 } elsif (m/^self\-addr\s+([0-9. \t]+)/) {
153 @self_addr= split /\s+/, $1;
154 } elsif (m/^forbid\-addr(?:\s+([0-9. \t]+))?/) {
155 @forbid_addr= defined $1 ? split /\s+/, $1 : ();
159 (?: \s+ ([^/ \t]*) (?: (/.+) )?
162 ($mod, $dir, $prefix, $suffix, $subfile) =
163 ($1,qualify($2),$3,$4,$5);
164 $suffix= '' if !defined $suffix;
165 $subfile= '' if !defined $subfile;
166 $suffix= '_db' if !length $suffix && !length $subfile;
167 if (-d "$dir/$prefix") { $dir.='/'; $dir.=$prefix; $prefix=''; }
168 opendir D, $dir or cfg_fail("open primary-dir $dir:\n $!");
169 $lprefix= length $prefix; $lsuffix= length $suffix;
170 while (defined($_= readdir D)) {
171 next if m/^\./ && !$lprefix;
172 next unless length > $lprefix+$lsuffix;
173 next unless substr($_,0,$lprefix) eq $prefix;
174 next unless substr($_,length($_)-$lsuffix) eq $suffix;
175 $z= substr($_,$lprefix,length($_)-($lprefix+$lsuffix));
176 $zf= $dir.'/'.$prefix.$z.$suffix.$subfile;
178 next if length $subfile && $! == &ENOENT;
179 cfg_fail("cannot stat zonefile $zf:\n $!");
181 -f _ or cfg_fail("zonefile $zf is not a plain file");
182 zone_conf($z,'primary','p',$mod,$zf);
184 closedir D or cfg_fail("close primary-dir $dir:\n $!");
185 } elsif (m/^primary([*?]?)\s+(\S+)\s+(\S+)$/) {
186 zone_conf($2,'primary','p',$1,qualify($3));
187 } elsif (m/^published([*?]?)\s+(\S+)\s+([0-9.\t]+)$/) {
188 zone_conf($2,'published','s',$1,'',$3);
189 } elsif (m/^stealth([*?]?)\s+(\S+)\s+([0-9. \t]+)$/) {
190 zone_conf($2,'stealth','u',$1,'',split /\s+/, $3);
191 } elsif (m/^slave\-dir\s+(\S+)(?:(?:\s+(\S+))\s+(\S+))?$/) {
192 ($slave_dir, $slave_prefix, $slave_suffix) = (qualify($1),$2,$3);
193 $slave_prefix='' if !defined $slave_prefix;
194 $slave_suffix='' if !defined $slave_suffix;
195 } elsif (m/^output\s+bind8\+(\S+)$/) {
196 cfg_fail("default output may not apply to only some zones")
197 if @zone_cfg_list && length $default_output;
198 set_output(qualify($1));
199 } elsif (m/^include\s+(\S+)$/) {
202 cfg_fail("unknown configuration directive".
203 " or incorrect syntax or arguments:\n".
207 $fh->close or cfg_fail("close config file $if:\n $!");
212 $i= "$default_dir$i" unless $i =~ m,^/,;
216 sub zone_conf ($$$$$@) {
217 my ($zone,$style,$sabbr,$mod,$file,@servers) = @_;
219 $file= qualify("$slave_dir/$slave_prefix".$zone.$slave_suffix)
221 if (!length $output) {
222 $default_output= qualify('chiark-conf-gen.bind8')
223 unless length $default_output;
224 set_output($default_output);
226 cfg_fail("redefined zone $zone\n".
227 " earlier definition $zone_cfg{$zone}{'where'}")
228 if exists $zone_cfg{$zone};
229 $zone_cfg{$zone}{'where'}= $where;
230 $zone_cfg{$zone}{'file'}= $file;
231 $zone_cfg{$zone}{'style_p'}= $style.$mod;
232 $zone_cfg{$zone}{'s'}= $sabbr.$mod; # p)rimary s)econdary u)npub f)oreign
233 $zone_cfg{$zone}{'servers'}= [ @servers ];
234 foreach $sfx (qw(self_soa self_ns self_addr forbid_addr)) {
235 { no strict 'refs'; $aref= [ @$sfx ]; }
236 @$aref or cfg_fail("failed to specify $sfx before zone")
238 $zone_cfg{$zone}{$sfx}= $aref;
240 $zone_cfg{$zone}{'output'}= $output;
241 push @zone_cfg_list, $zone;
247 $output_contents{$output}= '';
251 #-------------------- checking
253 use vars qw($zone $cfg $warnings);
257 return if !$verbosity;
262 return if $verbosity<2;
266 sub process_zones (@) {
270 foreach $zone (@zones) {
272 $cfg= $zone_cfg{$zone} || {
273 'style_p' => 'foreign',
277 progress(sprintf "%-40s %s", $zone, $$cfg{'style_p'});
278 if ($check && ($doall || $cfg->{'s'} !~ m/\?/)) {
280 if ($localonly && $cfg->{'s'} =~ m/f/) {
281 zone_warning("foreign zone specified with -l",'');
282 } elsif ($cfg->{'s'} =~ m/\*/ ||
283 ($localonly && $cfg->{'s'} !~ m/p/)) {
289 zone_warning("checks failed: $@",'') if length $@;
291 $output_contents{$$cfg{'output'}} .= zone_output()
294 print STDERR "$quis: $warnings warnings\n" or die $!
298 use vars qw(%delgs); # $delgs{$nameserver_list} = [ $whosaidandwhy ]
299 use vars qw(%auths); # $auths{$nameserver_list} = [ $whosaidandwhy ]
300 use vars qw(%glue); # $glue{$name}{$addr_list} = [ $whosaidandwhy ]
301 use vars qw(%soas); # $soa{"$origin $serial"} = [ $whosaidandwhy ]
302 use vars qw(%addr_is_ok %warned);
303 use vars qw($delg_to_us);
304 use vars qw(@to_check); # ($addr,$whyask,$is_auth,$glueless_ok, ...)
305 use vars qw(@to_check_soa); # ($addr,$whyask, ...)
307 sub zone_warning ($$) {
311 return 0 if !$repeat && $warned{$w}++;
316 $w .= " ($o)" if length $o;
317 print STDERR "$zone: warning: $w\n" or die $!;
322 sub zone_warnmore ($) {
323 print STDERR "$zone: $_[0]\n" or die $!;
326 sub zone_check_full () {
333 %delgs= %auths= %glue= %soas= %warned= %addr_is_ok= ();
335 @to_check= @to_check_soa= ();
338 sub zone_investigate() {
339 my ($super_zone, @super_nsnames,
340 $super_ns, @super_ns_addrs, $s, $wa, $is_auth,
341 %nsrrset_checked, %soa_checked, $addr, $glueless_ok, $rcode);
345 debug_trace("zone $zone superzone $super_zone");
346 $super_zone =~ s/^[^.]+\.// or die "no superzone ? ($super_zone)\n";
347 ($rcode,@super_nsnames)= lookup($super_zone,'ns-','06');
350 for $super_ns (@super_nsnames) {
351 $super_ns= lc $super_ns;
352 ($rcode,@super_ns_addrs)= lookup($super_ns,'a','0');
353 foreach $addr (@super_ns_addrs) {
356 "$super_ns, server for $super_zone",
361 # We do these in order so that we always do NS RRset checks on
362 # nameservers that came from other NS RRsets first; otherwise
363 # we might set nsrrset_checked due to a glueless_ok check,
364 # and then not check for gluefulness later.
365 debug_dump('@to_check @to_check_soa');
366 if (($addr,$wa,$is_auth,$glueless_ok,@to_check) = @to_check) {
367 push @to_check_soa, $addr, $wa if $is_auth;
368 next if $nsrrset_checked{$addr}++;
369 zone_check_nsrrset($addr, $wa, $is_auth, $glueless_ok);
370 } elsif (($addr,$wa,@to_check_soa) = @to_check_soa) {
371 next if $soa_checked{$addr}++;
372 zone_check_soa($addr, $wa, "NS [$addr]");
379 sub zone_check_nsrrset ($$$$) {
380 my ($uaddr,$wa, $is_auth, $glueless_ok) = @_;
381 my (@s, $s, %s2g, @glue, $glue, $delgs_or_auths, $wwn, $ww);
383 verbose("checking delegation by $ww");
385 if ($dig_type eq 'ns' && $dig_owner eq $zone) {
386 $s2g{lc $dig_rdata} = [ ];
387 } elsif ($dig_type eq 'a' && exists $s2g{$dig_owner}) {
388 $wwn= "in glue from $ww";
389 push @to_check, $dig_rdata, "$dig_owner, $wwn", 1, 0;
390 zone_server_addr($dig_rdata,$dig_owner,$wwn,"NS [$uaddr]",0);
391 push @{ $s2g{$dig_owner} }, $dig_rdata;
396 zone_warning("unable to find NS RRset at [$uaddr]", $wa);
398 } elsif (keys %s2g == 1) {
399 zone_warning("only one nameserver ". (join '', keys %s2g),
404 $delg_to_us=1 if grep { $s eq $_ } @{ $cfg->{'self_ns'} };
405 @glue= @{ $s2g{$s} };
407 zone_warning("glueless NS $s", $ww)
408 unless $glueless_ok || !$needglue ||
409 grep { has_suffix_of($s,".$_"); } @conv_glueless;
412 $glue= join ' ', sort @glue;
413 push @{ $glue{$s}{$glue} }, $ww;
416 $delgs_or_auths= $is_auth ? \%auths : \%delgs;
417 push @{ $delgs_or_auths->{$s} }, $ww;
420 sub zone_server_addr ($$$$$) {
421 my ($addr,$name,$ww,$wwq,$is_soa) = @_;
423 debug_trace("zone_server_addr ".join '|',@_);
424 $addr_is_ok{$addr}= "$name ($wwq)"
425 if $is_soa || $cfg->{'s'} =~ m/u/;
426 foreach $cg (@conv_glueless) {
427 next unless has_suffix_of(".$name",".$cg");
428 zone_warning("nameserver [$addr] $name in serverless-glueless".
429 " namespace area $cg",
432 zone_warning("configured as stealth but we [$addr] $name are published",
434 if $cfg->{'s'} =~ m/u/ && grep { $_ eq $addr } @self_addr;
435 zone_warning("forbidden nameserver address [$addr] $name",$ww)
436 if grep { $_ eq $addr } @{ $cfg->{'forbid_addr'} };
438 my ($name_is_self, $addr_is_self);
439 $name_is_self= grep { $_ eq $name }
440 @{ $cfg->{$is_soa ? 'self_soa' : 'self_ns'} };
441 $addr_is_self= grep { $_ eq $addr }
442 @{ $cfg->{'self_addr'} };
443 if ($name_is_self && !$addr_is_self) {
444 zone_warning("our $name supplied with wrong address [$addr]", $ww);
446 if (!$name_is_self && $addr_is_self) {
447 zone_warning("we [$addr] are named in ".
448 ($is_soa ? "SOA" : "NS").
449 " by wrong name $name",
452 if (!$name_is_self && !$addr_is_self &&
453 $is_soa && $cfg->{'s'} =~ m/p/) {
454 zone_warning("SOA ORIGIN $name is not us (".
455 (join ' ', @{ $cfg->{'self_soa'} }).")", $ww);
457 $delg_to_us=1 if $addr_is_self && !$is_soa;
460 sub zone_check_soa ($$$) {
461 my ($uaddr,$wa,$waq) = @_;
462 my ($lame,$origin,$got,$rcode,@soa_addrs,$soa_addr,$ww,$wwn);
463 verbose("checking service at [$uaddr] $waq");
464 $lame= 'dead or lame';
467 if ($dig_type eq 'flags:') {
468 $lame= $dig_rdata =~ m/ aa / ? '' : 'lame';
469 } elsif ($dig_type eq 'soa' && $dig_owner eq $zone && !$lame) {
470 die "several SOAs ? $ww" if defined $origin;
472 $got =~ m/^(\S+) \d+/ or die "$got ?";
477 $lame= 'broken' if !$lame && !defined $origin;
478 if ($lame) { zone_warning("$lame server [$uaddr]",$wa); return; }
479 push @{ $soas{$got} }, $ww;
480 ($rcode,@soa_addrs)= lookup($origin,'a','0');
481 $wwn= "SOA ORIGIN from $ww";
482 foreach $soa_addr (@soa_addrs) {
483 zone_server_addr($soa_addr,$origin,$wwn,"SOA [$uaddr]",1);
484 push @to_check, $soa_addr, "$origin, $wwn";
488 sub zone_consistency() {
489 my ($d, $org_ser, $origin, $a, $h, $self_soa, $wa);
490 zone_consistency_set('delegations',\%delgs);
491 foreach $d (keys %delgs) { delete $auths{$d}; }
492 zone_consistency_set('zone nameserver rrset',\%auths);
493 foreach $h (keys %glue) {
494 zone_consistency_set("glue for $h", $glue{$h});
496 zone_consistency_set("SOA ORIGIN and SERIAL",\%soas);
497 $self_soa= $cfg->{'self_soa'};
500 sub zone_servers_ok () {
504 foreach $a (@{ $cfg->{'servers'} }) {
505 next if exists $addr_is_ok{$a};
506 zone_warning("we slave from [$a]",'')
510 foreach $a (keys %addr_is_ok) {
511 zone_warnmore("permitted master [$a] $addr_is_ok{$a}");
515 if ($cfg->{'s'} =~ m/s/ && !$delg_to_us) {
516 zone_warning("we are supposedly published secondary,".
517 " but not listed as a nameserver",'');
518 map { $fs{$_}=1 } keys(%delgs), keys(%auths);
519 zone_warnmore("servers are: ". join ' ', sort keys %fs);
523 sub zone_consistency_set ($%) {
526 if (keys(%$set) > 1) {
527 zone_warning("inconsistent $msg:",'');
528 foreach $d (keys %$set) {
529 foreach $o (@{ $set->{$d} }) { zone_warnmore(" $d from $o"); }
534 sub zone_check_local () {
535 zone_servers_simplefind();
539 sub zone_servers_simplefind () {
540 my ($rcode,@nsnames,$ns,@soas,$origin);
542 ($rcode,@nsnames)= lookup($zone,'ns-','0');
543 foreach $ns (@nsnames) { zone_server_simple($ns,'NS',0); }
545 ($rcode,@soas)= lookup($zone,'soa','0');
546 die "multiple SOA RRs in set! @soas ?" if @soas!=1;
547 $soas[0] =~ m/^(\S+)\s/ or die "SOA ? $_";
548 zone_server_simple(domain_canon($1,"lookup $zone SOA"),'SOA',1);
551 sub zone_server_simple ($$$) {
552 my ($name,$ww,$is_soa) = @_;
553 my ($rcode,@addrs,$addr);
554 ($rcode,@addrs)= lookup($name,'a','0');
555 foreach $addr (@addrs) { zone_server_addr($addr,$name,$ww,$ww,$is_soa); }
558 #-------------------- outputting
563 $o= "zone \"$zone\" {\n";
564 if ($$cfg{'s'} =~ m/p/) {
565 $o.= " type master;\n";
567 $o.= " type slave;\n".
569 foreach $m (@{ $$cfg{'servers'} }) { $o.= " $m;\n"; }
572 $o.= " file \"$$cfg{'file'}\";\n";
577 sub output_files () {
578 my ($fn,$ofn,$mfn,$l,$dir, $maxmode,$h,@to_install);
580 foreach $ofn (keys %output_contents) {
581 $fn= $ofn; $mfn= "output file $fn";
584 $! == &ENOENT or die "$quis: stat $mfn:\n $!\n";
588 $maxmode= (stat _)[2];
591 defined($l= readlink $fn)
592 or die "$quis: readlink $mfn:\n $!\n";
593 $dir= $fn =~ m,^.*/, ? $& : './';
594 $fn= "$dir$l" unless $l =~ m,^/,;
595 $mfn= "output file $fn (symlink target of $ofn)";
597 die "$quis: output file $mfn exists but is not a file".
598 " (or symlink to one)";
601 unlink "$fn.new" or $! == &ENOENT or
602 die "$quis: cannot clear out old .new version of $mfn:\n $!";
603 $h= new IO::File "$fn.new",'w',$maxmode
604 or die("$quis: create .new version of $mfn:\n $!");
606 "# generated by $quis, do not edit\n",
607 $output_contents{$ofn}
608 or die "$quis: write data to .new version of $mfn:\n $!";
610 or die "$quis: close .new version of $mfn:\n $!";
611 push @to_install, $fn,$mfn;
614 while (($fn,$mfn, @to_install) = @to_install) {
616 or die "$quis: install new version of $mfn:\n $!";
620 #-------------------- general utilities
624 return unless $debug>1;
625 local $Data::Dumper::Terse=1;
626 foreach $vn (split /\s+/, $_[0]) {
627 print "$vn := ", eval "Dumper(\\$vn)";
631 sub debug_trace ($) {
632 return unless $debug;
636 sub has_suffix_of ($$) {
637 my ($whole,$suffix) = @_;
638 return 0 if length $whole < length $suffix;
639 return 0 if substr($whole, length($whole) - length($suffix)) ne $suffix;
644 my ($domain,$type,$okrcodes) = @_;
646 debug_trace("lookup ==> (->$okrcodes) $domain $type");
649 defined($c= open $h, "-|") or die "$quis: fork adnshost:\n $!\n";
651 exec 'adnshost','-Fi','+Do','+Dt','+Dc','-Cf',"-t$type",
653 die "$quis: exec adnshost:\n $!\n";
655 @result= $h->getlines();
656 $h->error and die "$quis: read from adnshost:\n $!\n";
659 die "$quis: lookup -t$type $domain $okrcodes failed $? $! @result\n"
660 if $! or $?&255 or $?>1536 or index($okrcodes,$?>>8)<0;
661 debug_trace("lookup <== $? @result");
667 my ($eachrr, $qowner,$qtype,$qaddr) = @_;
668 # also pseudo-rr with type `flags:'
669 my ($h,$inmid,$irdata,$c,$digwhy);
672 debug_trace("dig ==> \@$qaddr $qowner $qtype");
675 defined($c= open $h, "-|") or die "$quis: fork dig:\n $!\n";
677 open STDERR, ">&STDOUT" or die $!;
679 '+nodef','+nosea','+nodebug','+norecurse',
680 "\@$qaddr",'-t',$qtype,$qowner);
681 die "$quis: exec dig:\n $!\n";
685 if (!defined($_= $h->getline())) {
686 $h->error() and die "$quis: read from dig:\n $!\n";
691 s/^\s+/ / or die "$inmid // $_ ?";
695 s/$/ \(/ unless s/\s*\)\s*$//;
697 if (s/\s*\(\s*$//) { $inmid= $_; next; }
698 $digwhy= "dig $qowner $qtype $qaddr \`$_'";
699 if (m/^\;\; flags\:( [-0-9a-z ]+)\;/) {
700 $dig_owner=''; $dig_type='flags:'; $dig_rdata= "$1 ";
701 debug_trace("dig f: $dig_rdata");
705 } elsif (m/^([-.0-9a-z]+)\s+\d\w+\s+in\s+([a-z]+)\s+(\S.*)/i) {
706 $dig_owner=domain_canon($1,$digwhy); $dig_type=lc $2; $irdata=$3;
707 if ($dig_type eq 'a') {
708 $irdata =~ m/^[.0-9]+$/ or die "$irdata ?";
710 } elsif ($dig_type eq 'ns') {
711 $irdata =~ m/^[-.0-9a-z]+$/i or die "bad nameserver $irdata ?";
712 $dig_rdata= domain_canon($irdata,$digwhy);
713 } elsif ($dig_type eq 'soa') {
714 $irdata =~ m/^([-.0-9a-z]+)\s+.*\s+(\d+)(?:\s+\d\w+){4}$/i
715 or die "bad SOA $irdata ?";
716 $dig_rdata= domain_canon($1,$digwhy).' '.$2;
718 debug_trace("ignoring uknown RR type $dig_type");
721 debug_trace("dig $dig_owner $dig_type $dig_rdata");
724 debug_trace("ignoring unknown dig output $_");
728 debug_trace("dig <== gave $?");
731 sub domain_canon ($$) {
734 return '.' if $i eq '.';
735 die "domain $i ($w) ?" unless $i =~ m/^[0-9a-z]/i;