source: trunk/DNSDB.pm@ 769

Last change on this file since 769 was 768, checked in by Kris Deugau, 7 years ago

/trunk

Tighten some validation of numeric fields

  • TTL on all records
  • Distance, weight, and port for SRV, including a blurb about which field may have a bad character pasted
  • Property svn:keywords set to Date Rev Author Id
File size: 254.5 KB
RevLine 
[2]1# dns/trunk/DNSDB.pm
2# Abstraction functions for DNS administration
[262]3##
4# $Id: DNSDB.pm 768 2017-08-16 16:57:11Z kdeugau $
[752]5# Copyright 2008-2017 Kris Deugau <kdeugau@deepnet.cx>
[262]6#
7# This program is free software: you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation, either version 3 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program. If not, see <http://www.gnu.org/licenses/>.
19##
[2]20
21package DNSDB;
22
23use strict;
24use warnings;
25use Exporter;
26use DBI;
[33]27use Net::DNS;
[65]28use Crypt::PasswdMD5;
[559]29use Digest::MD5 qw(md5_hex);
[198]30use Net::SMTP;
[539]31use NetAddr::IP 4.027 qw(:lower);
[198]32use POSIX;
[368]33use Fcntl qw(:flock);
[543]34use Time::TAI64 qw(:tai64);
[368]35
[2]36use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
37
[561]38$VERSION = 1.3; ##VERSION##
[2]39@ISA = qw(Exporter);
40@EXPORT_OK = qw(
[279]41 &initGlobals &login &initActionLog
[489]42 &getPermissions &changePermissions &comparePermissions
[112]43 &changeGroup
[517]44 &connectDB &finish
[276]45 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
[383]46 &getZoneCount &getZoneList &getZoneLocation
[22]47 &addGroup &delGroup &getChildren &groupName
[314]48 &getGroupCount &getGroupList
[83]49 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
[326]50 &getUserCount &getUserList &getUserDropdown
[375]51 &addLoc &updateLoc &delLoc &getLoc
[370]52 &getLocCount &getLocList &getLocDropdown
[495]53 &getSOA &updateSOA &getRecLine &getRecList &getRecCount
[22]54 &addRec &updateRec &delRec
[323]55 &getLogCount &getLogEntries
[452]56 &getRevPattern
[225]57 &getTypelist
[254]58 &parentID
[117]59 &isParent
[452]60 &zoneStatus &getZonesByCIDR &importAXFR
[103]61 &export
[197]62 &mailNotify
[517]63 %typemap %reverse_typemap
[489]64 @permtypes $permlist %permchains
[2]65 );
66
[489]67@EXPORT = qw(%typemap %reverse_typemap @permtypes $permlist %permchains);
[2]68%EXPORT_TAGS = ( ALL => [qw(
[279]69 &initGlobals &login &initActionLog
[489]70 &getPermissions &changePermissions &comparePermissions
[112]71 &changeGroup
[517]72 &connectDB &finish
[276]73 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
[383]74 &getZoneCount &getZoneList &getZoneLocation
[22]75 &addGroup &delGroup &getChildren &groupName
[314]76 &getGroupCount &getGroupList
[83]77 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
[326]78 &getUserCount &getUserList &getUserDropdown
[375]79 &addLoc &updateLoc &delLoc &getLoc
[370]80 &getLocCount &getLocList &getLocDropdown
[495]81 &getSOA &updateSOA &getRecLine &getRecList &getRecCount
[22]82 &addRec &updateRec &delRec
[323]83 &getLogCount &getLogEntries
[452]84 &getRevPattern
[225]85 &getTypelist
[254]86 &parentID
[117]87 &isParent
[452]88 &zoneStatus &getZonesByCIDR &importAXFR
[103]89 &export
[197]90 &mailNotify
[517]91 %typemap %reverse_typemap
[489]92 @permtypes $permlist %permchains
[2]93 )]
94 );
95
96our $errstr = '';
[283]97our $resultstr = '';
[2]98
[66]99# Arguably defined wholly in the db, but little reason to change without supporting code changes
[370]100# group_view, user_view permissions? separate rDNS permission(s)?
[66]101our @permtypes = qw (
102 group_edit group_create group_delete
103 user_edit user_create user_delete
104 domain_edit domain_create domain_delete
[387]105 record_edit record_create record_delete record_locchg
[370]106 location_edit location_create location_delete location_view
[66]107 self_edit admin
108);
109our $permlist = join(',',@permtypes);
110
[390]111# Some permissions more or less require certain others.
112our %permchains = (
113 user_edit => 'self_edit',
114 location_edit => 'location_view',
115 location_create => 'location_view',
116 location_delete => 'location_view',
117 record_locchg => 'location_view',
118);
119
[2]120# DNS record type map and reverse map.
121# loaded from the database, from http://www.iana.org/assignments/dns-parameters
122our %typemap;
123our %reverse_typemap;
124
[228]125## (Semi)private variables
[278]126
[228]127# Hash of functions for validating record types. Filled in initGlobals() since
128# it relies on visibility flags from the rectypes table in the DB
129my %validators;
[128]130
[295]131# Entity-relationship reference hashes.
132my %par_tbl = (
133 group => 'groups',
134 user => 'users',
135 defrec => 'default_records',
136 defrevrec => 'default_rev_records',
137 domain => 'domains',
138 revzone => 'revzones',
139 record => 'records'
140 );
141my %id_col = (
142 group => 'group_id',
143 user => 'user_id',
144 defrec => 'record_id',
145 defrevrec => 'record_id',
146 domain => 'domain_id',
147 revzone => 'rdns_id',
[744]148 record => 'record_id',
[295]149 );
150my %par_col = (
151 group => 'parent_group_id',
152 user => 'group_id',
153 defrec => 'group_id',
154 defrevrec => 'group_id',
155 domain => 'group_id',
156 revzone => 'group_id',
157 record => 'domain_id'
158 );
159my %par_type = (
160 group => 'group',
161 user => 'group',
162 defrec => 'group',
163 defrevrec => 'group',
164 domain => 'group',
165 revzone => 'group',
166 record => 'domain'
167 );
[278]168
[2]169##
[465]170## Constructor and destructor
171##
172
173sub new {
174 my $this = shift;
175 my $class = ref($this) || $this;
176 my %args = @_;
[517]177
178 # Prepopulate a basic config. Note some of these *will* cause errors if left unset.
179 # note: add appropriate stanzas in __cfgload() to parse these
180 my %defconfig = (
[529]181 # The only configuration options not loadable from a config file.
182 configfile => "/etc/dnsdb/dnsdb.conf", ##CFG_LEAF##
[517]183
184 # Database connection info
185 dbname => 'dnsdb',
186 dbuser => 'dnsdb',
187 dbpass => 'secret',
188 dbhost => '',
189
190 # Email notice settings
191 mailhost => 'smtp.example.com',
192 mailnotify => 'dnsdb@example.com', # to
193 mailsender => 'dnsdb@example.com', # from
194 mailname => 'DNS Administration',
195 orgname => 'Example Corp',
196 domain => 'example.com',
197
198 # Template directory
199 templatedir => 'templates/',
200# fmeh. this is a real web path, not a logical internal one. hm..
201# cssdir => 'templates/',
202 sessiondir => 'session/',
203 exportcache => 'cache/',
[559]204 usecache => 1, # do we bother using the cache above?
[517]205
206 # Session params
207 timeout => '1h', # passed as-is to CGI::Session
208
209 # Other miscellanea
210 log_failures => 1, # log all evarthing by default
211 perpage => 15,
[559]212 maxfcgi => 10, # reasonable default?
[524]213 force_refresh => 1,
[542]214 lowercase => 0, # mangle as little as possible by default
[583]215 # show IPs and CIDR blocks as-is for reverse zones. valid values are
216 # 'none' (default, show natural IP or CIDR)
217 # 'zone' (zone name, wherever used)
218 # 'record' (IP or CIDR values in reverse record lists)
219 # 'all' (all IP values in any reverse zone view)
220 showrev_arpa => 'none',
[644]221 # Two options for template record expansion:
222 template_skip_0 => 0, # publish .0 by default
223 template_skip_255 => 0, # publish .255 by default
[708]224 # allow TXT records to be dealt with mostly automatically by DNS server?
225 autotxt => 1,
[517]226 );
227
228 # Config file parse calls.
229 # If we are passed a blank argument for $args{configfile},
230 # we should NOT parse the default config file - we will
231 # rely on hardcoded defaults OR caller-specified values.
232 # If we are passed a non-blank argument, parse that file.
233 # If no config file is specified, parse the default one.
234 my %siteconfig;
235 if (defined($args{configfile})) {
236 if ($args{configfile}) {
237 return if !__cfgload($args{configfile}, \%siteconfig);
238 }
239 } else {
240 return if !__cfgload($defconfig{configfile}, \%siteconfig);
[465]241 }
[517]242
243 # Assemble the object. Apply configuration hashes in order of precedence.
244 my $self = {
245 # Hardcoded defaults
246 %defconfig,
247 # Default config file OR caller-specified one, loaded above
248 %siteconfig,
249 # Caller-specified arguments
250 %args
251 };
[465]252 bless $self, $class;
[517]253
[524]254 # Several settings are booleans. Handle multiple possible ways of setting them.
[644]255 for my $boolopt ('log_failures', 'force_refresh', 'lowercase', 'usecache',
[708]256 'template_skip_0', 'template_skip_255', 'autotxt') {
[524]257 if ($self->{$boolopt} ne '1' && $self->{$boolopt} ne '0') {
258 # true/false, on/off, yes/no all valid.
259 if ($self->{$boolopt} =~ /^(?:true|false|t|f|on|off|yes|no)$/) {
260 if ($self->{$boolopt} =~ /(?:true|t|on|yes)/) {
261 $self->{$boolopt} = 1;
262 } else {
263 $self->{$boolopt} = 0;
264 }
265 } else {
[583]266 warn "Bad $boolopt setting $self->{$boolopt}, using default\n";
267 $self->{$boolopt} = $defconfig{$boolopt};
[524]268 }
269 }
270 }
271
[583]272 # Enum-ish option(s)
273 if (!grep /$self->{showrev_arpa}/, ('none','zone','record','all')) {
274 warn "Bad showrev_arpa setting $self->{showrev_arpa}, using default\n";
275 $self->{showrev_arpa} = 'none';
276 }
277
[517]278 # Try to connect to the DB, and initialize a number of handy globals.
[465]279 $self->{dbh} = connectDB($self->{dbname}, $self->{dbuser}, $self->{dbpass}, $self->{dbhost}) or return;
280 $self->initGlobals();
281
282 return $self;
283}
284
285sub DESTROY {
286 my $self = shift;
[517]287 $self->{dbh}->disconnect if $self->{dbh};
[465]288}
289
[495]290sub errstr { $DNSDB::errstr; }
291
[465]292##
[225]293## utility functions
[281]294##
295
296## DNSDB::_rectable()
[224]297# Takes default+rdns flags, returns appropriate table name
298sub _rectable {
299 my $def = shift;
300 my $rev = shift;
301
302 return 'records' if $def ne 'y';
303 return 'default_records' if $rev ne 'y';
304 return 'default_rev_records';
305} # end _rectable()
306
[281]307## DNSDB::_recparent()
[224]308# Takes default+rdns flags, returns appropriate parent-id column name
309sub _recparent {
310 my $def = shift;
311 my $rev = shift;
312
313 return 'group_id' if $def eq 'y';
314 return 'rdns_id' if $rev eq 'y';
315 return 'domain_id';
316} # end _recparent()
317
[281]318## DNSDB::_ipparent()
[226]319# Check an IP to be added in a reverse zone to see if it's really in the requested parent.
[466]320# Takes default and reverse flags, IP (fragment) to check, parent zone ID,
[226]321# and a reference to a NetAddr::IP object (also used to pass back a fully-reconstructed IP for
322# database insertion)
323sub _ipparent {
[466]324 my $self = shift;
325 my $dbh = $self->{dbh};
[226]326 my $defrec = shift;
327 my $revrec = shift;
328 my $val = shift;
329 my $id = shift;
330 my $addr = shift;
[224]331
[232]332 return if $revrec ne 'y'; # this sub not useful in forward zones
333
334 $$addr = NetAddr::IP->new($$val); #necessary?
335
[226]336 # subsub to split, reverse, and overlay an IP fragment on a netblock
337 sub __rev_overlay {
338 my $splitme = shift; # ':' or '.', m'lud?
339 my $parnet = shift;
340 my $val = shift;
341 my $addr = shift;
342
343 my $joinme = $splitme;
344 $splitme = '\.' if $splitme eq '.';
[232]345 my @working = reverse(split($splitme, $parnet->addr));
346 my @parts = reverse(split($splitme, $$val));
[226]347 for (my $i = 0; $i <= $#parts; $i++) {
348 $working[$i] = $parts[$i];
349 }
[232]350 my $checkme = NetAddr::IP->new(join($joinme, reverse(@working))) or return 0;
351 return 0 unless $checkme->within($parnet);
[226]352 $$addr = $checkme; # force "correct" IP to be recorded.
353 return 1;
354 }
355
356 my ($parstr) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id = ?", undef, ($id));
357 my $parnet = NetAddr::IP->new($parstr);
358
359 # Fail early on v6-in-v4 or v4-in-v6. We're not accepting these ATM.
[232]360 return 0 if $parnet->addr =~ /\./ && $$val =~ /:/;
361 return 0 if $parnet->addr =~ /:/ && $$val =~ /\./;
[226]362
[340]363 if ($$addr && ($$val =~ /^[\da-fA-F][\da-fA-F:]+[\da-fA-F]$/ || $$val =~ m|/\d+$|)) {
364 # the only case where NetAddr::IP's acceptance of legitimate IPs is "correct" is for a proper IPv6 address,
365 # or a netblock (only expected on templates)
[232]366 # the rest we have to restructure before fiddling. *sigh*
367 return 1 if $$addr->within($parnet);
368 } else {
[340]369 # We don't have a complete IP in $$val (yet)... unless we have a netblock
[232]370 if ($parnet->addr =~ /:/) {
371 $$val =~ s/^:+//; # gotta strip'em all...
[226]372 return __rev_overlay(':', $parnet, $val, $addr);
373 }
[232]374 if ($parnet->addr =~ /\./) {
375 $$val =~ s/^\.+//;
376 return __rev_overlay('.', $parnet, $val, $addr);
377 }
[226]378 # should be impossible to get here...
379 }
380 # ... and here.
381 # can't do nuttin' in forward zones
382} # end _ipparent()
383
[609]384## DNSDB::_maybeip()
385# Wrapper for quick "does this look like an IP address?" regex, so we don't make dumb copy-paste mistakes
386sub _maybeip {
387 my $izzit = shift; # reference
388 return 1 if $$izzit =~ m,^(?:[\d\./]+|[0-9a-fA-F:/]+)$,;
389}
390
[610]391## DNSDB::_inrev()
392# Check if a given "hostname" is within a given reverse zone
393# Takes a reference to the "hostname" and the reverse zone CIDR as a NetAddr::IP
394# Returns true/false. Sets $errstr on errors.
395sub _inrev {
396 my $self = shift;
397 my $dbh = $self->{dbh};
398 # References, since we might munge them
399 my $fq = shift;
400 my $zone = shift;
401
402 # set default error
403 $errstr = "$$fq not within $zone";
404
405 # Unlike forward zones, we will not coerce the data into the reverse zone - an A record
406 # in a reverse zone is already silly enough without appending a mess of 1.2.3.in-addr.arpa
407 # (or worse, 1.2.3.4.5.6.7.8.ip6.arpa) on the end of the nominal "hostname".
408 # We're also going to allow the "hostname" to be stored as .arpa or IP, because of
409 # non-IP FQDNs in .arpa
410 if ($$fq =~ /\.arpa$/) {
411 # "FQDN" could be any syntactically legitimate string, but it must be within the formal
412 # .arpa zone. Note we're not validating these for correct reverse-IP values.
413 # yes, we really need the v6 branch on the end here.
414 $zone = _ZONE($zone, 'ZONE', 'r', '.').($zone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
415 return unless $$fq =~ /$zone$/;
416 } else {
417 # in most cases we should be getting a real IP as the "FQDN" to test
418 my $addr = new NetAddr::IP $$fq if _maybeip($fq);
419
420 # "FQDN" should be a valid IP address. Normalize formatting if so.
421 if (!$addr) {
422 $errstr = "$$fq is not a valid IP address";
423 return;
424 }
425 return if !$zone->contains($addr);
426 ($$fq = $addr) =~ s{/(?:32|128)$}{};
427 }
428 return 1;
429} # end _inrev()
430
[281]431## DNSDB::_hostparent()
[232]432# A little different than _ipparent above; this tries to *find* the parent zone of a hostname
[466]433# Takes a hostname.
[281]434# Returns the domain ID of the parent domain if one was found.
[232]435sub _hostparent {
[466]436 my $self = shift;
437 my $dbh = $self->{dbh};
[232]438 my $hname = shift;
[347]439
440 $hname =~ s/^\*\.//; # this should be impossible to find in the domains table.
[232]441 my @hostbits = split /\./, $hname;
[349]442 my $sth = $dbh->prepare("SELECT count(*),domain_id FROM domains WHERE lower(domain) = lower(?) GROUP BY domain_id");
[232]443 foreach (@hostbits) {
444 $sth->execute($hname);
445 my ($found, $parid) = $sth->fetchrow_array;
446 if ($found) {
447 return $parid;
448 }
449 $hname =~ s/^$_\.//;
450 }
451} # end _hostparent()
[228]452
[281]453## DNSDB::_log()
454# Log an action
[466]455# Takes a log entry hash containing at least:
[282]456# group_id, log entry
[281]457# and optionally one or more of:
[744]458# domain_id, rdns_id, logparent
[282]459# The %userdata hash provides the user ID, username, and fullname
[744]460# Returns the log entry ID, mainly for use in bulk operations to allow a "parent" log entry
461# and a set of child entries (eg, domain add and the individual default-record-copy entries)
[281]462sub _log {
[466]463 my $self = shift;
464 my $dbh = $self->{dbh};
[281]465
466 my %args = @_;
467
468 $args{rdns_id} = 0 if !$args{rdns_id};
469 $args{domain_id} = 0 if !$args{domain_id};
[744]470 $args{logparent} = 0 if !$args{logparent};
[281]471
472##fixme: farm out the actual logging to different subs for file, syslog, internal, etc based on config
[517]473# if ($self->{log_channel} eq 'sql') {
[744]474 $dbh->do("INSERT INTO log (domain_id,rdns_id,group_id,logparent,entry,user_id,email,name) ".
475 "VALUES (?,?,?,?,?,?,?,?)",
[281]476 undef,
[744]477 ($args{domain_id}, $args{rdns_id}, $args{group_id}, $args{logparent}, $args{entry},
[488]478 $self->{loguserid}, $self->{logusername}, $self->{logfullname}) );
[744]479
480 my ($log_id) = $dbh->selectrow_array("SELECT currval('log_log_id_seq')");
481 return $log_id;
482
[517]483# } elsif ($self->{log_channel} eq 'file') {
484# } elsif ($self->{log_channel} eq 'syslog') {
[281]485# }
486} # end _log
487
488
[224]489##
[228]490## Record validation subs.
491##
492
[281]493## All of these subs take substantially the same arguments:
494# a hash containing at least the following keys:
495# - defrec (default/live flag)
496# - revrec (forward/reverse flag)
497# - id (parent entity ID)
498# - host (hostname)
499# - rectype
500# - val (IP, hostname [CNAME/MX/SRV] or text)
501# - addr (NetAddr::IP object from val. May be undef.)
502# MX and SRV record validation also expect distance, and SRV records expect weight and port as well.
503# host, rectype, and addr should be references as these may be modified in validation
504
[228]505# A record
506sub _validate_1 {
[467]507 my $self = shift;
508 my $dbh = $self->{dbh};
[229]509
[230]510 my %args = @_;
[229]511
[606]512# only for strict type restrictions
513# return ('FAIL', 'Reverse zones cannot contain A records') if $args{revrec} eq 'y';
[229]514
[606]515 if ($args{revrec} eq 'y') {
516 # Get the revzone, so we can see if ${$args{val}} is in that zone
517 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
[229]518
[610]519 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
[606]520
[611]521 # ${$args{val}} is either a valid IP or a string ending with the .arpa zone name;
522 # now check if it's a well-formed FQDN
[613]523 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
[612]524 ${$args{val}} =~ /\.arpa$/;
[611]525
[606]526 # Check IP is well-formed, and that it's a v4 address
527 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
528 return ('FAIL',"A record must be a valid IPv4 address")
[660]529 unless ${$args{host}} =~ m{^\d+\.\d+\.\d+\.\d+(/\d+)?$};
[606]530 $args{addr} = new NetAddr::IP ${$args{host}};
531 return ('FAIL',"A record must be a valid IPv4 address")
532 unless $args{addr} && !$args{addr}->{isv6};
533 # coerce IP/value to normalized form for storage
534 ${$args{host}} = $args{addr}->addr;
535
536 # I'm just going to ignore the utterly barmy idea of an A record in the *default*
537 # records for a reverse zone; it's bad enough to find one in funky legacy data.
538
539 } else {
540 # revrec ne 'y'
541
542 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
543 # or the intended parent domain for live records.
544 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]545 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[606]546
[620]547 # Check if it's a proper formal .arpa name for an IP, and renormalize it to the IP
548 # value if so. Done mainly for symmetry with PTR/A+PTR, and saves a conversion on export.
549 if (${$args{val}} =~ /\.arpa$/) {
550 my ($code,$tmp) = _zone2cidr(${$args{val}});
551 if ($code ne 'FAIL') {
552 ${$args{val}} = $tmp->addr;
553 $args{addr} = $tmp;
554 }
555 }
[606]556 # Check IP is well-formed, and that it's a v4 address
557 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
558 return ('FAIL',"A record must be a valid IPv4 address")
[234]559 unless ${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/;
[629]560 $args{addr} = new NetAddr::IP ${$args{val}};
[606]561 return ('FAIL',"A record must be a valid IPv4 address")
[230]562 unless $args{addr} && !$args{addr}->{isv6};
[606]563 # coerce IP/value to normalized form for storage
564 ${$args{val}} = $args{addr}->addr;
565 }
[229]566
[228]567 return ('OK','OK');
568} # done A record
569
570# NS record
571sub _validate_2 {
[467]572 my $self = shift;
573 my $dbh = $self->{dbh};
[230]574
575 my %args = @_;
576
[616]577 # NS target check - IP addresses not allowed. Must be a more or less well-formed hostname.
578 if ($args{revrec} eq 'y') {
579 return ('FAIL', "NS records cannot point directly to an IP address")
580 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
581##enhance: Look up the passed value to see if it exists. Ooo, fancy.
582 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
583 } else {
584 return ('FAIL', "NS records cannot point directly to an IP address")
585 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
586##enhance: Look up the passed value to see if it exists. Ooo, fancy.
587 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
588 }
589
[328]590 # Check that the target of the record is within the parent.
591 if ($args{defrec} eq 'n') {
592 # Check if IP/address/zone/"subzone" is within the parent
593 if ($args{revrec} eq 'y') {
[616]594 # Get the revzone, so we can see if ${$args{val}} is in that zone
595 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
596
597 # Note the NS record may or may not be for the zone itself, it may be a pointer for a subzone
598 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
599
600 # ${$args{val}} is either a valid IP or a string ending with the .arpa zone name;
601 # now check if it's a well-formed FQDN
602##enhance or ##fixme
603# convert well-formed .arpa names to IP addresses to match old "strict" validation design
604 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
605 ${$args{val}} =~ /\.arpa$/;
[328]606 } else {
[616]607 # Forcibly append the domain name if the hostname being added does not end with the current domain name
[467]608 my $pname = $self->domainName($args{id});
[657]609 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[328]610 }
[230]611 } else {
[616]612 # Default reverse NS records should always refer to the implied parent.
613 if ($args{revrec} eq 'y') {
614 ${$args{val}} = 'ZONE';
615 } else {
616 ${$args{host}} = 'DOMAIN';
617 }
[230]618 }
619
[228]620 return ('OK','OK');
621} # done NS record
622
623# CNAME record
624sub _validate_5 {
[467]625 my $self = shift;
626 my $dbh = $self->{dbh};
[230]627
628 my %args = @_;
629
[618]630 # CNAMEs in reverse zones shouldn't be handled manually, they should be generated on
631 # export by use of the "delegation" type. For the masochistic, and those importing
632 # legacy data from $deity-knows-where, we'll support them.
[230]633
[618]634 if ($args{revrec} eq 'y') {
635 # CNAME target check - IP addresses not allowed. Must be a more or less well-formed hostname.
636 return ('FAIL', "CNAME records cannot point directly to an IP address")
637 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
[230]638
[618]639 if ($args{defrec} eq 'n') {
640 # Get the revzone, so we can see if ${$args{val}} is in that zone
641 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
642 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
[632]643 # CNAMEs can not be used for parent nodes; just leaf nodes with no other record types
644 # note that this WILL probably miss some edge cases.
645 if (${$args{val}} =~ /^[\d.\/]+$/) {
646 # convert IP "hostname" to .arpa
647 my $tmphn = _ZONE(NetAddr::IP->new(${$args{val}}), 'ZONE', 'r', '.');
648 my $tmpz = _ZONE($revzone, 'ZONE', 'r', '.');
649 return ('FAIL', "The bare zone may not be a CNAME") if $tmphn eq $tmpz;
[656]650##enhance: look up the target name and publish that instead on export
[632]651 }
[618]652 }
653
654##enhance or ##fixme
655# convert well-formed .arpa names to IP addresses to match old "strict" validation design
656 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
657 ${$args{val}} =~ /\.arpa$/;
658
659##enhance: Look up the passed value to see if it exists. Ooo, fancy.
660 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
661 } else {
662 # CNAME target check - IP addresses not allowed. Must be a more or less well-formed hostname.
663 return ('FAIL', "CNAME records cannot point directly to an IP address")
664 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
665
[669]666 # Make sure target is a well-formed hostname
667 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
668
[618]669 # Forcibly append the domain name if the hostname being added does not end with the current domain name
670 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]671 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/i;
[618]672
[632]673 # CNAMEs can not be used for parent nodes; just leaf nodes with no other record types
674 # Enforce this for the zone name
[653]675 return ('FAIL', "The bare zone name may not be a CNAME") if ${$args{host}} eq $pname || ${$args{host}} =~ /^\@/;
[632]676
[618]677##enhance: Look up the passed value to see if it exists. Ooo, fancy.
678 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
679 }
680
[228]681 return ('OK','OK');
682} # done CNAME record
683
684# SOA record
685sub _validate_6 {
[230]686 # Smart monkeys won't stick their fingers in here; we have
687 # separate dedicated routines to deal with SOA records.
[228]688 return ('OK','OK');
689} # done SOA record
690
691# PTR record
692sub _validate_12 {
[467]693 my $self = shift;
694 my $dbh = $self->{dbh};
[232]695
696 my %args = @_;
[620]697 my $warnflag = '';
[232]698
[620]699 if ($args{defrec} eq 'y') {
700 if ($args{revrec} eq 'y') {
701 if (${$args{val}} =~ /^[\d.]+$/) {
702 # v4 or bare number
703 if (${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/) {
704 # probable full IP. pointless but harmless. validate/normalize.
705 my $tmp = NetAddr::IP->new(${$args{val}})->addr
706 or return ('FAIL', "${$args{val}} is not a valid IP address");
707 ${$args{val}} = $tmp;
708 $warnflag = "${$args{val}} will only be added to a small number of zones\n";
709 } elsif (${$args{val}} =~ /^\d+$/) {
710 # bare number. This can be expanded to either a v4 or v6 zone
711 ${$args{val}} =~ s/^\.*/ZONE./ unless ${$args{val}} =~ /^ZONE/;
712 } else {
713 # $deity-only-knows what kind of gibberish we've been given. Only usable as a formal .arpa name.
714 # Append ARPAZONE to be replaced with the formal .arpa zone name when converted to a live record.
715 ${$args{val}} =~ s/\.*$/.ARPAZONE/ unless ${$args{val}} =~ /ARPAZONE$/;
716 }
717 } elsif (${$args{val}} =~ /^[a-fA-F0-9:]+$/) {
718 # v6 or fragment; pray it's not complete gibberish
719 ${$args{val}} =~ s/^:*/ZONE::/ unless ${$args{val}} =~ /^ZONE/;
[234]720 } else {
[620]721 # $deity-only-knows what kind of gibberish we've been given. Only usable as a formal .arpa name.
722 # Append ARPAZONE to be replaced with the formal .arpa zone name when converted to a live record.
723 ${$args{val}} .= ".ARPAZONE" unless ${$args{val}} =~ /ARPAZONE$/;
[234]724 }
[620]725 } else {
726 return ('FAIL', "PTR records are not supported in default record sets for forward zones (domains)");
[232]727 }
[620]728 } else {
729 if ($args{revrec} eq 'y') {
730 # Get the revzone, so we can see if ${$args{val}} is in that zone
731 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
[232]732
[620]733 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
[249]734
[620]735 if (${$args{val}} =~ /\.arpa$/) {
736 # Check that it's well-formed
737 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
738
739 # Check if it's a proper formal .arpa name for an IP, and renormalize it to the IP
740 # value if so. I can't see why someone would voluntarily work with those instead of
741 # the natural IP values but what the hey.
742 my ($code,$tmp) = _zone2cidr(${$args{val}});
743 ${$args{val}} = $tmp->addr if $code ne 'FAIL';
[272]744 } else {
[620]745 # not a formal .arpa name, so it should be an IP value. Validate...
746 return ('FAIL', "${$args{val}} is not a valid IP value")
747 unless ${$args{val}} =~ /^(?:\d+\.\d+\.\d+\.\d+|[a-fA-F0-9:]+)$/;
748 $args{addr} = NetAddr::IP->new(${$args{val}})
749 or return ('FAIL', "IP/value looks like an IP address but isn't valid");
750 # ... and normalize.
751 ${$args{val}} = $args{addr}->addr;
[272]752 }
[620]753 # Validate PTR target for form.
[677]754 # %blank% skips the IP when expanding a template record
755 return ('FAIL', $errstr)
756 unless _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) ||
757 lc(${$args{host}}) eq '%blank%';
[620]758 } else { # revrec ne 'y'
759 # Fetch the domain and append if the passed hostname isn't within it.
760 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]761 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[620]762 # Validate hostname and target for form
763 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
764 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
[249]765 }
[620]766 }
[272]767
[620]768# Multiple PTR records do NOT generally do what most people believe they do,
769# and tend to fail in the most awkward way possible. Check and warn.
770
771 my $chkbase = ${$args{val}};;
772 my $hostcol = 'val'; # Reverse zone hostnames are stored "backwards"
773 if ($args{revrec} eq 'n') { # PTRs in forward zones should be rare.
774 $chkbase = ${$args{host}};
775 $hostcol = 'host';
[232]776 }
[620]777 my @checkvals = ($chkbase);
778 if ($chkbase =~ /,/) {
779 # push . and :: variants into checkvals if $chkbase has ,
780 my $tmp;
781 ($tmp = $chkbase) =~ s/,/./;
782 push @checkvals, $tmp;
783 ($tmp = $chkbase) =~ s/,/::/;
784 push @checkvals, $tmp;
785 }
[232]786
[620]787 my $pcsth = $dbh->prepare("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec})." WHERE $hostcol = ?");
788 foreach my $checkme (@checkvals) {
789 if ($args{update}) {
790 # $args{update} contains the ID of the record being updated. If the list of records that matches
791 # the new hostname specification doesn't include this, the change effectively adds a new PTR that's
792 # the same as one or more existing ones.
793 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
794 " WHERE val = ?", undef, ($checkme)) };
795 $warnflag .= "PTR record for $checkme already exists; adding another will probably not do what you want"
796 if @ptrs && (!grep /^$args{update}$/, @ptrs);
797 } else {
798 # New record. Always warn if a PTR exists
[661]799 # Don't warn when a matching A record exists tho
[620]800 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
[661]801 " WHERE $hostcol = ? AND (type=12 OR type=65280 OR type=65281)", undef, ($checkme));
[620]802 $warnflag .= "PTR record for $checkme already exists; adding another will probably not do what you want"
803 if $ptrcount;
804 }
805 }
806
807 return ('WARN',$warnflag) if $warnflag;
808
[228]809 return ('OK','OK');
810} # done PTR record
811
812# MX record
813sub _validate_15 {
[467]814 my $self = shift;
815 my $dbh = $self->{dbh};
[230]816
817 my %args = @_;
818
[622]819# only for strict type restrictions
820# return ('FAIL', 'Reverse zones cannot contain MX records') if $args{revrec} eq 'y';
[230]821
822 return ('FAIL', "Distance is required for MX records") unless defined(${$args{dist}});
823 ${$args{dist}} =~ s/\s*//g;
824 return ('FAIL',"Distance is required, and must be numeric") unless ${$args{dist}} =~ /^\d+$/;
825
826 ${$args{fields}} = "distance,";
827 push @{$args{vallist}}, ${$args{dist}};
828
[622]829 if ($args{revrec} eq 'n') {
830 # MX target check - IP addresses not allowed. Must be a more or less well-formed hostname.
831 return ('FAIL', "MX records cannot point directly to an IP address")
832 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
[230]833
[622]834 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
835 # or the intended parent domain for live records.
836 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]837 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[653]838 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
[622]839 } else {
840 # MX target check - IP addresses not allowed. Must be a more or less well-formed hostname.
841 return ('FAIL', "MX records cannot point directly to an IP address")
[627]842 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
[273]843
[622]844 # MX records in reverse zones get stricter treatment. The UI bars adding them in
845 # reverse record sets, but we "need" to allow editing existing ones. And we'll allow
846 # editing them if some loon manually munges one into a default reverse record set.
847 if ($args{defrec} eq 'n') {
848 # Get the revzone, so we can see if ${$args{val}} is in that zone
849 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
850 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
851 }
852
853##enhance or ##fixme
854# convert well-formed .arpa names to IP addresses to match old "strict" validation design
855 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
856 ${$args{val}} =~ /\.arpa$/;
857
858##enhance: Look up the passed value to see if it exists. Ooo, fancy.
859 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
860
861 }
862
[228]863 return ('OK','OK');
864} # done MX record
865
866# TXT record
867sub _validate_16 {
[586]868 my $self = shift;
869
870 my %args = @_;
871
[623]872 if ($args{revrec} eq 'n') {
[586]873 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
874 # or the intended parent domain for live records.
875 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]876 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[623]877 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
878 } else {
879 # We don't coerce reverse "hostnames" into the zone, mainly because we store most sane
880 # records as IP values, not .arpa names.
881 if ($args{defrec} eq 'n') {
882 # Get the revzone, so we can see if ${$args{val}} is in that zone
883 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
884 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
885 }
886
887##enhance or ##fixme
888# convert well-formed .arpa names to IP addresses to match old "strict" validation design
889 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
890 ${$args{val}} =~ /\.arpa$/;
[586]891 }
892
[231]893 # Could arguably put a WARN return here on very long (>512) records
[228]894 return ('OK','OK');
895} # done TXT record
896
897# RP record
898sub _validate_17 {
[623]899 # Probably have to validate these separately some day. Call _validate_16() above since
900 # they're otherwise very similar
901 return _validate_16(@_);
[228]902} # done RP record
903
904# AAAA record
[626]905# Almost but not quite an exact duplicate of A record
[228]906sub _validate_28 {
[467]907 my $self = shift;
908 my $dbh = $self->{dbh};
[229]909
[230]910 my %args = @_;
[229]911
[626]912# only for strict type restrictions
913# return ('FAIL', 'Reverse zones cannot contain AAAA records') if $args{revrec} eq 'y';
[229]914
[626]915 if ($args{revrec} eq 'y') {
916 # Get the revzone, so we can see if ${$args{val}} is in that zone
917 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
[229]918
[626]919 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
920
921 # ${$args{val}} is either a valid IP or a string ending with the .arpa zone name;
922 # now check if it's a well-formed FQDN
923 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
924 ${$args{val}} =~ /\.arpa$/;
925
926 # Check IP is well-formed, and that it's a v4 address
927 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
928 return ('FAIL',"AAAA record must be a valid IPv6 address")
929 unless ${$args{host}} =~ /^[a-fA-F0-9:]+$/;
930 $args{addr} = new NetAddr::IP ${$args{host}};
931 return ('FAIL',"AAAA record must be a valid IPv6 address")
[230]932 unless $args{addr} && $args{addr}->{isv6};
[626]933 # coerce IP/value to normalized form for storage
934 ${$args{host}} = $args{addr}->addr;
[229]935
[626]936 # I'm just going to ignore the utterly barmy idea of an AAAA record in the *default*
937 # records for a reverse zone; it's bad enough to find one in funky legacy data.
938
939 } else {
940 # revrec ne 'y'
941
942 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
943 # or the intended parent domain for live records.
944 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]945 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[626]946
947 # Check if it's a proper formal .arpa name for an IP, and renormalize it to the IP
948 # value if so. Done mainly for symmetry with PTR/AAAA+PTR, and saves a conversion on export.
949 if (${$args{val}} =~ /\.arpa$/) {
950 my ($code,$tmp) = _zone2cidr(${$args{val}});
951 if ($code ne 'FAIL') {
952 ${$args{val}} = $tmp->addr;
953 $args{addr} = $tmp;
954 }
955 }
956 # Check IP is well-formed, and that it's a v6 address
957 return ('FAIL',"AAAA record must be a valid IPv6 address")
958 unless ${$args{val}} =~ /^[a-fA-F0-9:]+$/;
959 $args{addr} = new NetAddr::IP ${$args{val}};
960 return ('FAIL',"AAAA record must be a valid IPv6 address")
961 unless $args{addr} && $args{addr}->{isv6};
962 # coerce IP/value to normalized form for storage
963 ${$args{val}} = $args{addr}->addr;
964 }
965
[228]966 return ('OK','OK');
967} # done AAAA record
968
969# SRV record
970sub _validate_33 {
[467]971 my $self = shift;
972 my $dbh = $self->{dbh};
[231]973
974 my %args = @_;
975
976# Not absolutely true but WTF use is an SRV record for a reverse zone?
[656]977# return ('FAIL', 'Reverse zones cannot contain SRV records') if $args{revrec} eq 'y';
[231]978
[627]979 # Key additional record parts. Always required.
980 return ('FAIL',"Distance, port and weight are required for SRV records")
981 unless defined(${$args{weight}}) && defined(${$args{port}}) && defined(${$args{dist}});
[231]982 ${$args{dist}} =~ s/\s*//g;
983 ${$args{weight}} =~ s/\s*//g;
984 ${$args{port}} =~ s/\s*//g;
[768]985 my @ferr;
986 push @ferr, "distance" unless ${$args{dist}} =~ /^\d+$/;
987 push @ferr, "weight" unless ${$args{weight}} =~ /^\d+$/;
988 push @ferr, "port" unless ${$args{port}} =~ /^\d+$/;
989 return ('FAIL',"Distance, port and weight are required, and must be numeric (check ".join(",", @ferr).")")
990 unless ${$args{dist}} =~ /^\d+$/ && ${$args{weight}} =~ /^\d+$/ && ${$args{port}} =~ /^\d+$/;
[231]991
992 ${$args{fields}} = "distance,weight,port,";
993 push @{$args{vallist}}, (${$args{dist}}, ${$args{weight}}, ${$args{port}});
994
[627]995 if ($args{revrec} eq 'n') {
996 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
997 # or the intended parent domain for live records.
998 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[657]999 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/i;
[627]1000
[631]1001##enhance: Rejig so that we can pass back a WARN red flag, instead of
1002# hard-failing, since it seems that purely from the DNS record perspective,
1003# SRV records without underscores are syntactically valid
[627]1004 # Not strictly true, but SRV records not following this convention won't be found.
1005 return ('FAIL',"SRV records must begin with _service._protocol [${$args{host}}]")
[698]1006 unless ${$args{host}} =~ /^_[A-Za-z-]+\._[A-Za-z]+\.[a-zA-Z0-9-]+/;
[627]1007
1008 # SRV target check - IP addresses not allowed. Must be a more or less well-formed hostname.
1009 return ('FAIL', "SRV records cannot point directly to an IP address")
1010 if ${$args{val}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
1011 } else {
1012 # hm. we can't do anything sane with IP values here; part of the record data is in
1013 # fact encoded in the "hostname". enforce .arpa names? OTOH, SRV records in a reverse
1014 # zone are pretty silly.
1015
[631]1016##enhance: Rejig so that we can pass back a WARN red flag, instead of
1017# hard-failing, since it seems that purely from the DNS record perspective,
1018# SRV records without underscores are syntactically valid
[627]1019 # Not strictly true, but SRV records not following this convention won't be found.
1020 return ('FAIL',"SRV records must begin with _service._protocol [${$args{host}}]")
1021 unless ${$args{val}} =~ /^_[A-Za-z]+\._[A-Za-z]+\.[a-zA-Z0-9-]+/;
1022
1023 # SRV target check - IP addresses not allowed. Must be a more or less well-formed hostname.
1024 return ('FAIL', "SRV records cannot point directly to an IP address")
1025 if ${$args{host}} =~ /^(?:[\d.]+|[0-9a-fA-F:]+)$/;
1026
1027 # SRV records in reverse zones get stricter treatment. The UI bars adding them in
1028 # reverse record sets, but we "need" to allow editing existing ones. And we'll allow
1029 # editing them if some loon manually munges one into a default reverse record set.
1030 if ($args{defrec} eq 'n') {
1031 # Get the revzone, so we can see if ${$args{val}} is in that zone
1032 my $revzone = new NetAddr::IP $self->revName($args{id}, 'y');
1033 return ('FAIL', $errstr) if !$self->_inrev($args{val}, $revzone);
1034 }
1035
1036##enhance or ##fixme
1037# convert well-formed .arpa names to IP addresses to match old "strict" validation design
1038 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec}) &&
1039 ${$args{val}} =~ /\.arpa$/;
1040
1041##enhance: Look up the passed value to see if it exists. Ooo, fancy.
1042 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
1043
1044 }
1045
[228]1046 return ('OK','OK');
1047} # done SRV record
1048
1049# Now the custom types
1050
[232]1051# A+PTR record. With a very little bit of magic we can also use this sub to validate AAAA+PTR. Whee!
[228]1052sub _validate_65280 {
[467]1053 my $self = shift;
1054 my $dbh = $self->{dbh};
[232]1055
1056 my %args = @_;
1057
1058 my $code = 'OK';
1059 my $msg = 'OK';
1060
1061 if ($args{defrec} eq 'n') {
1062 # live record; revrec determines whether we validate the PTR or A component first.
[233]1063
[630]1064 # Fail early on non-IP gibberish in ${$args{val}}. Arguably .arpa names might be acceptable
1065 # but that gets stupid in forward zones, since these records are shared.
1066 return ('FAIL', "$typemap{${$args{rectype}}} record must be a valid IPv4 address")
[660]1067 if ${$args{rectype}} == 65280 && ${$args{val}} !~ m{^\d+\.\d+\.\d+\.\d+(?:/\d+)?$};
[630]1068 return ('FAIL', "$typemap{${$args{rectype}}} record must be a valid IPv6 address")
[660]1069 if ${$args{rectype}} == 65281 && ${$args{val}} !~ m{^[a-fA-F0-9:]+(?:/\d+)?$};
[630]1070 # If things are not OK, this should prevent Stupid in the error log.
1071 $args{addr} = new NetAddr::IP ${$args{val}}
1072 or return ('FAIL', "$typemap{${$args{rectype}}} record must be a valid IPv".
1073 (${$args{rectype}} == 65280 ? '4' : '6')." address");
1074 ${$args{val}} = $args{addr}->addr;
1075
[232]1076 if ($args{revrec} eq 'y') {
[467]1077 ($code,$msg) = $self->_validate_12(%args);
[232]1078 return ($code,$msg) if $code eq 'FAIL';
1079
[467]1080 # check A+PTR is really v4
1081 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv4 address")
1082 if ${$args{rectype}} == 65280 && $args{addr}->{isv6};
1083 # check AAAA+PTR is really v6
1084 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv6 address")
1085 if ${$args{rectype}} == 65281 && !$args{addr}->{isv6};
1086
[232]1087 # Check if the reqested domain exists. If not, coerce the type down to PTR and warn.
[467]1088 if (!(${$args{domid}} = $self->_hostparent(${$args{host}}))) {
[272]1089 my $addmsg = "Record ".($args{update} ? 'updated' : 'added').
1090 " as PTR instead of $typemap{${$args{rectype}}}; domain not found for ${$args{host}}";
[232]1091 $msg .= "\n$addmsg" if $code eq 'WARN';
1092 $msg = $addmsg if $code eq 'OK';
1093 ${$args{rectype}} = $reverse_typemap{PTR};
1094 return ('WARN', $msg);
1095 }
1096
[242]1097 # Add domain ID to field list and values
1098 ${$args{fields}} .= "domain_id,";
1099 push @{$args{vallist}}, ${$args{domid}};
1100
[232]1101 } else {
[467]1102 ($code,$msg) = $self->_validate_1(%args) if ${$args{rectype}} == 65280;
1103 ($code,$msg) = $self->_validate_28(%args) if ${$args{rectype}} == 65281;
[232]1104 return ($code,$msg) if $code eq 'FAIL';
1105
1106 # Check if the requested reverse zone exists - note, an IP fragment won't
1107 # work here since we don't *know* which parent to put it in.
[233]1108 # ${$args{val}} has been validated as a valid IP by now, in one of the above calls.
[232]1109 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >> ?".
1110 " ORDER BY masklen(revnet) DESC", undef, (${$args{val}}));
1111 if (!$revid) {
[272]1112 $msg = "Record ".($args{update} ? 'updated' : 'added')." as ".(${$args{rectype}} == 65280 ? 'A' : 'AAAA').
[232]1113 " instead of $typemap{${$args{rectype}}}; reverse zone not found for ${$args{val}}";
1114 ${$args{rectype}} = (${$args{rectype}} == 65280 ? $reverse_typemap{A} : $reverse_typemap{AAAA});
1115 return ('WARN', $msg);
1116 }
1117
1118 # Check for duplicate PTRs. Note we don't have to play games with $code and $msg, because
1119 # by definition there can't be duplicate PTRs if the reverse zone isn't managed here.
[272]1120 if ($args{update}) {
1121 # Record update. There should usually be an existing PTR (the record being updated)
1122 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
1123 " WHERE val = ?", undef, (${$args{val}})) };
[273]1124 if (@ptrs && (!grep /^$args{update}$/, @ptrs)) {
[272]1125 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want";
1126 $code = 'WARN';
1127 }
1128 } else {
1129 # New record. Always warn if a PTR exists
1130 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
1131 " WHERE val = ?", undef, (${$args{val}}));
1132 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want"
1133 if $ptrcount;
1134 $code = 'WARN' if $ptrcount;
[232]1135 }
1136
[630]1137 # Add the reverse zone ID to the fieldlist
[232]1138 ${$args{fields}} .= "rdns_id,";
1139 push @{$args{vallist}}, $revid;
1140
[653]1141 # Coerce the hostname back to the domain; this is so it displays and manipulates
1142 # sanely in the reverse zone.
1143 if (${$args{host}} eq '@') {
1144 ${$args{host}} = $self->domainName($args{id}); # errors? What errors?
1145 }
1146 } # revrec ne 'y'
1147
[233]1148 } else { # defrec eq 'y'
[630]1149
[233]1150 if ($args{revrec} eq 'y') {
[467]1151 ($code,$msg) = $self->_validate_12(%args);
[233]1152 return ($code,$msg) if $code eq 'FAIL';
1153 if (${$args{rectype}} == 65280) {
1154 return ('FAIL',"A+PTR record must be a valid IPv4 address or fragment")
1155 if ${$args{val}} =~ /:/;
[234]1156 ${$args{val}} =~ s/^ZONE,/ZONE./; # Clean up after uncertain IP-fragment-type from _validate_12
[233]1157 } elsif (${$args{rectype}} == 65281) {
1158 return ('FAIL',"AAAA+PTR record must be a valid IPv6 address or fragment")
1159 if ${$args{val}} =~ /\./;
[234]1160 ${$args{val}} =~ s/^ZONE,/ZONE::/; # Clean up after uncertain IP-fragment-type from _validate_12
[233]1161 }
1162 } else {
1163 # This is easy. I also can't see a real use-case for A/AAAA+PTR in *all* forward
1164 # domains, since you wouldn't be able to substitute both domain and reverse zone
1165 # sanely, and you'd end up with guaranteed over-replicated PTR records that would
1166 # confuse the hell out of pretty much anything that uses them.
[234]1167##fixme: make this a config flag?
[233]1168 return ('FAIL', "$typemap{${$args{rectype}}} records not allowed in default domains");
1169 }
[232]1170 }
1171
1172 return ($code, $msg);
[228]1173} # done A+PTR record
1174
1175# AAAA+PTR record
[232]1176# A+PTR above has been magicked to handle AAAA+PTR as well.
[228]1177sub _validate_65281 {
[232]1178 return _validate_65280(@_);
[228]1179} # done AAAA+PTR record
1180
1181# PTR template record
1182sub _validate_65282 {
[467]1183 my $self = shift;
1184 my $dbh = $self->{dbh};
[340]1185
1186 my %args = @_;
1187
1188 # we're *this* >.< close to being able to just call _validate_12... unfortunately we can't, quite.
1189 if ($args{revrec} eq 'y') {
1190 if ($args{defrec} eq 'n') {
[467]1191 return ('FAIL', "Template block ${$args{val}} is not within ".$self->revName($args{id}))
1192 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$args{addr});
[340]1193##fixme: warn if $args{val} is not /31 or larger block?
1194 ${$args{val}} = "$args{addr}";
1195 } else {
1196 if (${$args{val}} =~ /\./) {
1197 # looks like a v4 or fragment
1198 if (${$args{val}} =~ m|^\d+\.\d+\.\d+\.\d+(?:/\d+)?$|) {
1199 # woo! a complete IP! validate it and normalize, or fail.
1200 $args{addr} = NetAddr::IP->new(${$args{val}})
1201 or return ('FAIL', "IP/value looks like IPv4 but isn't valid");
1202 ${$args{val}} = "$args{addr}";
1203 } else {
1204 ${$args{val}} =~ s/^\.*/ZONE./ unless ${$args{val}} =~ /^ZONE/;
1205 }
1206 } elsif (${$args{val}} =~ /[a-f:]/) {
1207 # looks like a v6 or fragment
1208 ${$args{val}} =~ s/^:*/ZONE::/ if !$args{addr} && ${$args{val}} !~ /^ZONE/;
1209 if ($args{addr}) {
1210 if ($args{addr}->addr =~ /^0/) {
1211 ${$args{val}} =~ s/^:*/ZONE::/ unless ${$args{val}} =~ /^ZONE/;
1212 } else {
1213 ${$args{val}} = "$args{addr}";
1214 }
1215 }
1216 } else {
1217 # bare number (probably). These could be v4 or v6, so we'll
1218 # expand on these on creation of a reverse zone.
1219 ${$args{val}} = "ZONE,${$args{val}}" unless ${$args{val}} =~ /^ZONE/;
1220 }
1221 }
1222##fixme: validate %-patterns?
1223
1224# Unlike single PTR records, there is absolutely no way to sanely support multiple
1225# PTR templates for the same block, since they expect to expand to all the individual
1226# IPs on export. Nested templates should be supported though.
1227
1228 my @checkvals = (${$args{val}});
1229 if (${$args{val}} =~ /,/) {
1230 # push . and :: variants into checkvals if val has ,
1231 my $tmp;
1232 ($tmp = ${$args{val}}) =~ s/,/./;
1233 push @checkvals, $tmp;
1234 ($tmp = ${$args{val}}) =~ s/,/::/;
1235 push @checkvals, $tmp;
1236 }
1237##fixme: this feels wrong still - need to restrict template pseudorecords to One Of Each
1238# Per Netblock such that they don't conflict on export
1239 my $typeck;
1240# type 65282 -> ptr template -> look for any of 65282, 65283, 65284
1241 $typeck = 'type=65283 OR type=65284' if ${$args{rectype}} == 65282;
1242# type 65283 -> a+ptr template -> v4 -> look for 65282 or 65283
1243 $typeck = 'type=65283' if ${$args{rectype}} == 65282;
1244# type 65284 -> aaaa+ptr template -> v6 -> look for 65282 or 65284
1245 $typeck = 'type=65284' if ${$args{rectype}} == 65282;
1246 my $pcsth = $dbh->prepare("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec})." WHERE val = ? ".
1247 "AND (type=65282 OR $typeck)");
1248 foreach my $checkme (@checkvals) {
1249 $pcsth->execute($checkme);
1250 my ($rc) = $pcsth->fetchrow_array;
[442]1251 return ('FAIL', "Only one template pseudorecord may exist for a given IP block") if $rc > 1;
[340]1252 }
1253
1254 } else {
1255 return ('FAIL', "Forward zones cannot contain PTR records");
1256 }
1257
[228]1258 return ('OK','OK');
1259} # done PTR template record
1260
1261# A+PTR template record
1262sub _validate_65283 {
[467]1263 my $self = shift;
1264 my $dbh = $self->{dbh};
[340]1265
1266 my %args = @_;
1267
1268 my ($code,$msg) = ('OK','OK');
1269
1270##fixme: need to fiddle things since A+PTR templates are acceptable in live
1271# forward zones but not default records
1272 if ($args{defrec} eq 'n') {
1273 if ($args{revrec} eq 'n') {
1274
[653]1275 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
1276 # or the intended parent domain for live records.
1277 my $pname = $self->domainName($args{id});
[657]1278 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/i;
[653]1279
1280 # check for form; note this checks both normal and "other" hostnames.
1281 return ('FAIL', $errstr)
1282 if !_check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
1283
[340]1284 # Check if the requested reverse zone exists - note, an IP fragment won't
1285 # work here since we don't *know* which parent to put it in.
1286 # ${$args{val}} has been validated as a valid IP by now, in one of the above calls.
1287 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >> ?".
1288 " ORDER BY masklen(revnet) DESC", undef, (${$args{val}}));
1289 # Fail if no match; we can't coerce a PTR-template type down to not include the PTR bit currently.
1290 if (!$revid) {
1291 $msg = "Can't ".($args{update} ? 'update' : 'add')." ${$args{host}}/${$args{val}} as ".
1292 "$typemap{${$args{rectype}}}: reverse zone not found for ${$args{val}}";
1293##fixme: add A template, AAAA template types?
1294# ${$args{rectype}} = (${$args{rectype}} == 65280 ? $reverse_typemap{A} : $reverse_typemap{AAAA});
1295 return ('FAIL', $msg);
1296 }
1297
1298 # Add reverse zone ID to field list and values
1299 ${$args{fields}} .= "rdns_id,";
1300 push @{$args{vallist}}, $revid;
1301
1302 } else {
[467]1303 return ('FAIL', "IP or IP fragment ${$args{val}} is not within ".$self->revName($args{id}))
1304 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$args{addr});
[340]1305 ${$args{val}} = "$args{addr}";
1306
[467]1307 if (!(${$args{domid}} = $self->_hostparent(${$args{host}}))) {
[340]1308 my $addmsg = "Record ".($args{update} ? 'updated' : 'added').
1309 " as PTR template instead of $typemap{${$args{rectype}}}; domain not found for ${$args{host}}";
1310 $msg .= "\n$addmsg" if $code eq 'WARN';
1311 $msg = $addmsg if $code eq 'OK';
1312 ${$args{rectype}} = 65282;
1313 return ('WARN', $msg);
1314 }
1315
1316 # Add domain ID to field list and values
1317 ${$args{fields}} .= "domain_id,";
1318 push @{$args{vallist}}, ${$args{domid}};
1319 }
1320
1321 } else {
[467]1322 my ($code,$msg) = $self->_validate_65282(%args);
[340]1323 return ($code, $msg) if $code eq 'FAIL';
1324 # get domain, check against ${$args{name}}
1325 }
1326
[228]1327 return ('OK','OK');
[624]1328} # done A+PTR template record
[228]1329
1330# AAAA+PTR template record
[624]1331# Not sure this can be handled sanely due to the size of IPv6 address space
[674]1332# _validate_65283 above should handle v6 template records fine. It's on export we've got trouble.
[228]1333sub _validate_65284 {
[674]1334 my $self = shift;
1335 my %args = @_;
1336
1337 # do a quick check on the form of the hostname part; this is effectively a
1338 # "*.0.0.f.ip6.arpa" hostname, not an actual expandable IP template pattern
1339 # like with 65283.
1340 return ('FAIL', $errstr)
1341 if !_check_hostname_form(${$args{host}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
1342 return $self->_validate_65283(%args);
[228]1343} # done AAAA+PTR template record
1344
[342]1345# Delegation record
[345]1346# This is essentially a specialized clone of the NS record, primarily useful
1347# for delegating IPv4 sub-/24 reverse blocks
[342]1348sub _validate_65285 {
[467]1349 my $self = shift;
1350 my $dbh = $self->{dbh};
[345]1351
1352 my %args = @_;
1353
1354# Almost, but not quite, identical to NS record validation.
1355
1356 # Check that the target of the record is within the parent.
1357 # Yes, host<->val are mixed up here; can't see a way to avoid it. :(
1358 if ($args{defrec} eq 'n') {
1359 # Check if IP/address/zone/"subzone" is within the parent
1360 if ($args{revrec} eq 'y') {
1361 my $tmpip = NetAddr::IP->new(${$args{val}});
[467]1362 my $pname = $self->revName($args{id});
[345]1363 return ('FAIL',"${$args{val}} not within $pname")
[467]1364 unless $self->_ipparent($args{defrec}, $args{revrec}, $args{val}, $args{id}, \$tmpip);
[345]1365 # Normalize
1366 ${$args{val}} = "$tmpip";
1367 } else {
[467]1368 my $pname = $self->domainName($args{id});
[657]1369 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/i;
[345]1370 }
1371 } else {
1372 return ('FAIL',"Delegation records are not permitted in default record sets");
1373 }
[342]1374 return ('OK','OK');
[752]1375} # done delegation record
[228]1376
[752]1377# ALIAS record
1378# A specialized variant of the CNAME, which retrieves the A record list on each
1379# export and publishes the A records instead. Primarily for "root CNAME" or "apex
1380# alias" records. See https://secure.deepnet.cx/trac/dnsadmin/ticket/55.
1381# Not allowed in reverse zones because this is already a hack, and reverse zones
1382# don't get pointed to CNAMEed CDNs the way domains do.
1383sub _validate_65300 {
1384 my $self = shift;
1385 my $dbh = $self->{dbh};
1386
1387 my %args = @_;
1388
1389 return ('FAIL',"ALIAS records are not permitted in reverse zones") if $args{revrec} eq 'y';
1390
1391 # Make sure target is a well-formed hostname
1392 return ('FAIL', $errstr) if ! _check_hostname_form(${$args{val}}, ${$args{rectype}}, $args{defrec}, $args{revrec});
1393
1394 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
1395 # or the intended parent domain for live records.
1396 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : $self->domainName($args{id}));
[754]1397 ${$args{host}} =~ s/\.*$/\.$pname/ if (${$args{host}} ne '@' && ${$args{host}} !~ /$pname$/i);
[752]1398
[754]1399 # Only do the cache thing on live/active records
1400 return ('OK','OK') unless $args{defrec} eq 'n';
[752]1401
1402 # now we check/update the cached target address info
1403 my ($iplist) = $self->{dbh}->selectrow_array("SELECT auxdata FROM records WHERE record_id = ?", undef, $args{recid});
1404 my $warnmsg;
[764]1405 $iplist = '' if !$iplist;
[752]1406
[764]1407 # shared target-name-to-IP converter
1408 my $liveips = $self->_grab_65300($args{recid}, ${$args{val}});
1409 $liveips = '' if !$liveips;
[752]1410
1411 # check to see if there was an OOOOPS checking for updated A records on the target. also make sure we have something cached.
1412 if (!$liveips) {
1413 if (!$iplist) {
1414 # not fatal since we do the lookup on export as well
[767]1415 $warnmsg = "No cached data and no live DNS data for ALIAS target ${$args{val}}; record may be SKIPPED on export!";
[752]1416 }
1417 }
1418
1419 # munge the insert/update fieldlist and data array
[767]1420 # note we always force this; if the target has changed the cached data is almost certainly invalid anyway
1421 if ($liveips && ($iplist ne $liveips)) {
[752]1422 ${$args{fields}} .= "auxdata,";
1423 push @{$args{vallist}}, $liveips;
1424 }
1425
[767]1426 return ('WARN', join("\n", $errstr, $warnmsg) ) if $warnmsg;
[752]1427
1428 return ('OK','OK');
1429} # done ALIAS record
1430
[764]1431# this segment used multiple places to update ALIAS target details
1432sub _grab_65300 {
1433 my $self = shift;
1434 my $dbh = $self->{dbh};
[752]1435
[764]1436 my $recid = shift;
1437 my $target = shift;
1438
1439 my $res = Net::DNS::Resolver->new;
1440 $res->tcp_timeout(2);
1441 $res->udp_timeout(2);
1442 my $reply = $res->query($target);
1443
[767]1444 my $liveips = '';
[764]1445 if ($reply) {
1446 # default to a one-hour TTL, which should be variously modified down the chain. Arguably this could
1447 # default even lower, since "The Cloud" often uses sub-1-minute TTLs on the final A records.
1448 my $minttl = 3600;
1449 my @newlist;
1450 foreach my $rr ($reply->answer) { #@alist) {
1451 next unless $rr->type eq "A";
1452 push @newlist, $rr->address;
1453 $minttl = $rr->ttl if $rr->ttl < $minttl;
1454 }
1455 # safety limit. could arguably take this lower, or for extra
1456 # complexity, reference off the zone SOA minTTL
1457 $minttl = 60 if $minttl < 60;
1458 # we don't need this to be perfectly correct IP address order, just consistent.
[767]1459 $liveips = "$minttl:".join(':', sort(@newlist)) if @newlist;
1460#fixme: should it be a formal error case if there are no A records returned?
[764]1461 } else {
1462 $errstr = "Lookup failure retrieving ALIAS IP list: ".$res->errorstring;
1463 }
1464
1465 return $liveips;
1466} # _grab_65300()
1467
1468
[617]1469# Subs not specific to a particular record type
[342]1470
[617]1471# Convert $$host and/or $$val to lowercase as appropriate.
1472# Should only be called if $self->{lowercase} is true.
1473# $rectype is also a reference for caller convenience
1474sub _caseclean {
1475 my ($rectype, $host, $val, $defrec, $revrec) = @_;
1476
1477 # Can't case-squash default records, due to DOMAIN, ZONE, and ADMINDOMAIN templating
1478 return if $defrec eq 'y';
1479
1480 if ($typemap{$$rectype} eq 'TXT' || $typemap{$$rectype} eq 'SPF') {
1481 # TXT records should preserve user entry in the string.
1482 # SPF records are a duplicate of TXT with a new record type value (99)
1483 $$host = lc($$host) if $revrec eq 'n'; # only lowercase $$host on live forward TXT; preserve TXT content
1484 $$val = lc($$val) if $revrec eq 'y'; # only lowercase $$val on live reverse TXT; preserve TXT content
1485 } else {
1486 # Non-TXT, live records, are fully case-insensitive
1487 $$host = lc($$host);
1488 $$val = lc($$val);
1489 } # $typemap{$$rectype} else
1490
1491} # _caseclean()
1492
1493
[265]1494##
1495## Record data substitution subs
1496##
[228]1497
[298]1498# Replace ZONE in hostname, or create (most of) the actual proper zone name
[265]1499sub _ZONE {
1500 my $zone = shift;
1501 my $string = shift;
1502 my $fr = shift || 'f'; # flag for forward/reverse order? nb: ignored for IP
[298]1503 my $sep = shift || '-'; # Separator character - unlikely we'll ever need more than . or -
[265]1504
[298]1505 my $prefix;
[265]1506
1507 $string =~ s/,/./ if !$zone->{isv6};
1508 $string =~ s/,/::/ if $zone->{isv6};
1509
[298]1510 # Subbing ZONE in the host. We need to properly ID the netblock range
1511 # The subbed text should have "network IP with trailing zeros stripped" for
1512 # blocks lined up on octet (for v4) or hex-quad (for v6) boundaries
1513 # For blocks that do NOT line up on these boundaries, we take the most
1514 # significant octet or 16-bit chunk of the "broadcast" IP and append it
1515 # after a double-dash
1516 # ie:
1517 # 8.0.0.0/6 -> 8.0.0.0 -> 11.255.255.255; sub should be 8--11
1518 # 10.0.0.0/12 -> 10.0.0.0 -> 10.0.0.0 -> 10.15.255.255; sub should be 10-0--15
1519 # 192.168.4.0/22 -> 192.168.4.0 -> 192.168.7.255; sub should be 192-168-4--7
1520 # 192.168.0.8/29 -> 192.168.0.8 -> 192.168.0.15; sub should be 192-168-0-8--15
1521 # Similar for v6
[265]1522
[298]1523 if (!$zone->{isv6}) { # IPv4
1524
1525 $prefix = $zone->network->addr; # Just In Case someone managed to slip in
1526 # a funky subnet that had host bits set.
1527 my $bc = $zone->broadcast->addr;
1528
1529 if ($zone->masklen > 24) {
1530 $bc =~ s/^\d+\.\d+\.\d+\.//;
1531 } elsif ($zone->masklen > 16) {
1532 $prefix =~ s/\.0$//;
1533 $bc =~ s/^\d+\.\d+\.//;
1534 } elsif ($zone->masklen > 8) {
1535 $bc =~ s/^\d+\.//;
1536 $prefix =~ s/\.0\.0$//;
1537 } else {
1538 $prefix =~ s/\.0\.0\.0$//;
1539 }
1540 if ($zone->masklen % 8) {
1541 $bc =~ s/(\.255)+$//;
1542 $prefix .= "--$bc"; #"--".zone->masklen; # use range or mask length?
1543 }
1544 if ($fr eq 'f') {
1545 $prefix =~ s/\.+/$sep/g;
1546 } else {
1547 $prefix = join($sep, reverse(split(/\./, $prefix)));
1548 }
1549
1550 } else { # IPv6
1551
1552 if ($fr eq 'f') {
1553
1554 $prefix = $zone->network->addr; # Just In Case someone managed to slip in
1555 # a funky subnet that had host bits set.
[265]1556 my $bc = $zone->broadcast->addr;
1557 if (($zone->masklen % 16) != 0) {
[298]1558 # Strip trailing :0 off $prefix, and :ffff off the broadcast IP
1559 for (my $i=0; $i<(7-int($zone->masklen / 16)); $i++) {
1560 $prefix =~ s/:0$//;
1561 $bc =~ s/:ffff$//;
1562 }
1563 # Strip the leading 16-bit chunks off the front of the broadcast IP
1564 $bc =~ s/^([a-f0-9]+:)+//;
1565 # Append the remaining 16-bit chunk to the prefix after "--"
1566 $prefix .= "--$bc";
[265]1567 } else {
[298]1568 # Strip off :0 from the end until we reach the netblock length.
1569 for (my $i=0; $i<(8-$zone->masklen / 16); $i++) {
[265]1570 $prefix =~ s/:0$//;
[298]1571 }
[265]1572 }
[298]1573 # Actually deal with the separator
1574 $prefix =~ s/:/$sep/g;
1575
1576 } else { # $fr eq 'f'
1577
1578 $prefix = $zone->network->full; # Just In Case someone managed to slip in
1579 # a funky subnet that had host bits set.
1580 my $bc = $zone->broadcast->full;
1581 $prefix =~ s/://g; # clean these out since they're not spaced right for this case
1582 $bc =~ s/://g;
1583 # Strip trailing 0 off $prefix, and f off the broadcast IP, to match the mask length
1584 for (my $i=0; $i<(31-int($zone->masklen / 4)); $i++) {
1585 $prefix =~ s/0$//;
1586 $bc =~ s/f$//;
1587 }
1588 # Split and reverse the order of the nibbles in the network/broadcast IPs
[332]1589 # trim another 0 for nibble-aligned blocks first, but only if we really have a block, not an IP
1590 $prefix =~ s/0$// if $zone->masklen % 4 == 0 && $zone->masklen != 128;
[298]1591 my @nbits = reverse split //, $prefix;
1592 my @bbits = reverse split //, $bc;
1593 # Handle the sub-nibble case. Eww. I feel dirty supporting this...
1594 $nbits[0] = "$nbits[0]-$bbits[0]" if ($zone->masklen % 4) != 0;
1595 # Glue it back together
1596 $prefix = join($sep, @nbits);
1597
1598 } # $fr ne 'f'
1599
1600 } # $zone->{isv6}
1601
1602 # Do the substitution, finally
1603 $string =~ s/ZONE/$prefix/;
1604 $string =~ s/--/-/ if $sep ne '-'; # - as separator needs extra help for sub-octet v4 netblocks
1605 return $string;
1606} # done _ZONE()
1607
1608# Not quite a substitution sub, but placed here as it's basically the inverse of above;
1609# given the .arpa zone name, return the CIDR netblock the zone is for.
[304]1610# Supports v4 non-octet/non-classful netblocks as per the method outlined in the Grasshopper Book (2nd Ed p217-218)
[298]1611# Does NOT support non-quad v6 netblocks via the same scheme; it shouldn't ever be necessary.
1612# Takes a nominal .arpa zone name, returns a success code and NetAddr::IP, or a fail code and message
1613sub _zone2cidr {
1614 my $zone = shift;
1615
1616 my $cidr;
[301]1617 my $tmpcidr;
1618 my $warnmsg = '';
[298]1619
1620 if ($zone =~ /\.in-addr\.arpa\.?$/) {
1621 # v4 revzone, formal zone name type
1622 my $tmpzone = $zone;
[583]1623 return ('FAIL', "Non-numerics in apparent IPv4 reverse zone name [$tmpzone]")
1624 if $tmpzone !~ m{^(?:\d+[/-])?[\d\.]+\.in-addr\.arpa\.?$};
[298]1625 $tmpzone =~ s/\.in-addr\.arpa\.?//;
1626
1627 # Snag the octet pieces
1628 my @octs = split /\./, $tmpzone;
1629
1630 # Map result of a range manipulation to a mask length change. Cheaper than finding the 2-root of $octets[0]+1.
[304]1631 # Note we will not support /31 blocks, mostly due to issues telling "24-31" -> .24/29 apart from
1632 # "24-31" -> .24/31", with a litte bit of "/31 is icky".
1633 my %maskmap = ( 3 => 2, 7 => 3, 15 => 4, 31 => 5, 63 => 6, 127 => 7,
1634 30 => 2, 29 => 3, 28 => 4, 27 => 5, 26 => 6, 25 => 7
1635 );
[298]1636
1637 # Handle "range" blocks, eg, 80-83.168.192.in-addr.arpa (192.168.80.0/22)
1638 # Need to take the size of the range to offset the basic octet-based mask length,
1639 # and make sure the first number in the range gets used as the network address for the block
[304]1640 # Alternate form: The second number is actually the real netmask, not the end of the range.
[298]1641 my $masklen = 0;
[571]1642 if ($octs[0] =~ m{^((\d+)[/-](\d+))$}) { # take the range...
[307]1643 if (24 < $3 && $3 < 31) {
[304]1644 # we have a real netmask
[307]1645 $masklen = -$maskmap{$3};
[304]1646 } else {
1647 # we have a range. NB: only real CIDR ranges are supported
[307]1648 $masklen -= $maskmap{-(eval $1)}; # find the mask base...
[304]1649 }
[307]1650 $octs[0] = $2; # set the base octet of the range...
[265]1651 }
[298]1652 @octs = reverse @octs; # We can reverse the octet pieces now that we've extracted and munged any ranges
[265]1653
[304]1654# arguably we should only allow sub-octet range/mask in-addr.arpa
1655# specifications in the least significant octet, but the code is
1656# simpler if we deal with sub-octet delegations at any level.
1657
[298]1658 # Now we find the "true" mask with the aid of the "base" calculated above
1659 if ($#octs == 0) {
1660 $masklen += 8;
1661 $tmpcidr = "$octs[0].0.0.0/$masklen"; # really hope we don't see one of these very often.
1662 } elsif ($#octs == 1) {
1663 $masklen += 16;
1664 $tmpcidr = "$octs[0].$octs[1].0.0/$masklen";
1665 } elsif ($#octs == 2) {
1666 $masklen += 24;
1667 $tmpcidr = "$octs[0].$octs[1].$octs[2].0/$masklen";
[265]1668 } else {
[298]1669 $masklen += 32;
1670 $tmpcidr = "$octs[0].$octs[1].$octs[2].$octs[3]/$masklen";
[265]1671 }
1672
[583]1673 } elsif ($zone =~ /\.ip6\.arpa\.?$/) {
[298]1674 # v6 revzone, formal zone name type
1675 my $tmpzone = $zone;
[583]1676##fixme: if-n-when we decide we can support sub-nibble v6 zone names, we'll need to change this segment
1677 return ('FAIL', "Non-hexadecimals in apparent IPv6 reverse zone name [$tmpzone]")
1678 if $tmpzone !~ /^[a-fA-F\d\.]+\.ip6\.arpa\.?$/;
[298]1679 $tmpzone =~ s/\.ip6\.arpa\.?//;
1680 my @quads = reverse(split(/\./, $tmpzone));
1681 $warnmsg .= "Apparent sub-/64 IPv6 reverse zone\n" if $#quads > 15;
1682 my $nc;
1683 foreach (@quads) {
[301]1684 $tmpcidr .= $_;
[583]1685 $tmpcidr .= ":" if ++$nc % 4 == 0 && $nc < $#quads;
[298]1686 }
1687 my $nq = 1 if $nc % 4 != 0;
1688 my $mask = $nc * 4; # need to do this here because we probably increment it below
1689 while ($nc++ % 4 != 0) {
[301]1690 $tmpcidr .= "0";
[298]1691 }
[583]1692 # polish it off with trailing ::/mask if this is a CIDR block instead of an IP
1693 $tmpcidr .= "::/$mask" if $mask != 128;
[298]1694 }
[301]1695
1696 # Just to be sure, use NetAddr::IP to validate. Saves a lot of nasty regex watching for valid octet values.
1697 return ('FAIL', "Invalid zone $zone (apparent netblock $tmpcidr)")
1698 unless $cidr = NetAddr::IP->new($tmpcidr);
1699
1700 if ($warnmsg) {
1701 $errstr = $warnmsg;
1702 return ('WARN', $cidr);
1703 }
1704 return ('OK', $cidr);
[583]1705##fixme: use wantarray() to decide what to return?
[298]1706} # done _zone2cidr()
[265]1707
[337]1708# Record template %-parameter expansion, IPv4. Note that IPv6 doesn't
1709# really have a sane way to handle this type of expansion at the moment
1710# due to the size of the address space.
[685]1711# Takes a reference to a template string to be expanded, an IP to use in the replacement,
1712# an optional netblock for the %ngb (net, gw, bcast) expansion, and an optional index
1713# number for %c "n'th usable IP in block/range" patterns.
1714# Alters the template string referred.
[337]1715sub _template4_expand {
[685]1716 # ugh pthui
1717 my $self;
1718 $self = shift if ref($_[0]) eq 'DNSDB';
1719
[337]1720 my $tmpl = shift;
1721 my $ip = shift;
[685]1722 my $subnet = shift; # for %ngb and %c
1723 my $ipindex = shift; # for %c
[298]1724
[685]1725 # blank $tmpl on config template_skip_0 or template_skip_255, unless we have a %ngb
1726 if ($$tmpl !~ /\%-?n-?g-?b\%/) {
1727 if ( ($ip =~ /\.0$/ && $self->{template_skip_0}) ||
1728 ($ip =~ /\.255$/ && $self->{template_skip_255}) ) {
1729 $$tmpl = '';
1730 return;
1731 }
1732 }
1733
[337]1734 my @ipparts = split /\./, $ip;
1735 my @iphex;
1736 my @ippad;
1737 for (@ipparts) {
1738 push @iphex, sprintf("%x", $_);
[443]1739 push @ippad, sprintf("%0.3u", $_);
[337]1740 }
1741
[685]1742 # Two or three consecutive separator characters (_ or -) should be rare - users that use them
1743 # anywhere other than punycoded internationalized domains get to keep the pieces when it breaks.
1744 # We clean up the ones that we may inadvertently generate after replacing %c and %ngb%
1745 my ($thrsep) = ($$tmpl =~ /[_-]{3}/);
1746 my ($twosep) = ($$tmpl =~ /[_-]{2}/);
1747
1748 # Take the simplest path to pattern substitution; replace only exactly the %c or %ngb%
1749 # patterns as-is. Then check after to see if we've caused doubled separator characters (- or _)
1750 # and eliminate them, but only if the original template didn't have them already. Also
1751 # unconditionally drop separator characters immediately before a dot; these do not always
1752 # strictly make the label invalid but almost always, and any exceptions should never show up
1753 # in a template record that expands to "many" real records anyway.
1754
1755 # %ngb and %c require a netblock
1756 if ($subnet) {
1757 # extract the fragments
1758 my ($ngb,$n,$g,$b) = ($$tmpl =~ /(\%(-?n)(-?g)(-?b)\%)/);
1759 my ($c) = ($$tmpl =~ /(\%-?c)/); my $nld = ''; my $cld = '';
1760 $c = '' if !$c;
[741]1761 my ($cn) = ($$tmpl =~ /(\%x)/);
[685]1762 my $skipgw = ($c =~ /\%-c/ ? 0 : 1);
1763 my $ipkill = 0;
1764
[741]1765 if ($cn) {
1766 # "natural n'th IP in the block" pattern
1767 $$tmpl =~ s/$cn/$ipindex+1/e;
1768 }
1769
[685]1770##fixme: still have one edge case not handled well:
1771# %c%n-gb%
1772# do we drop the record as per -g, or publish the record with an index of 1 as per %c?
1773# arguably this is a "that's a STUPID question!" case
1774
1775 if ($c) {
1776 # "n'th usable IP in the block" pattern. We need the caller to provide an index
1777 # number otherwise we see exponential time growth because we have to iterate over
1778 # the whole block to map the IP back to an index. :/
1779 # NetAddr::IP does not have a method for asking "what index is IP <foo> at?"
1780
1781 # no index, or index == 0, (AKA network address), or IP == broadcast, blank the index fragment
1782 if (!$ipindex || ($$subnet->broadcast->addr eq $ip)) {
1783 $$tmpl =~ s/$c//;
1784 } else {
1785 # if we have %c, AKA "skip the gateway", and we're on the nominal gateway IP, blank the index fragment
1786 if ($skipgw && $$subnet->first->addr eq $ip) {
1787 $$tmpl =~ s/$c//;
1788 }
1789 # else replace the index fragment with the passed index minus $skipgw, so that we can start the
1790 # resulting index at 1 on net+2
1791 else {
1792 $$tmpl =~ s/$c/($ipindex-$skipgw)/e;
1793 }
1794 }
1795 } # if ($c)
1796
1797 if ($ngb) {
1798 # individually check the network, standard gateway (net+1) IP, and broadcast IP
1799 # blank $$tmpl if n, g, or b was prefixed with - (this allows "hiding" net/gw/bcast entries)
1800
1801 if ($$subnet->network->addr eq $ip) {
1802 if ($n eq '-n') {
1803 $$tmpl = '';
1804 } else {
1805 $$tmpl =~ s/$ngb/net/;
1806 $ipkill = 1;
1807 }
1808 } elsif ($$subnet->first->addr eq $ip) {
1809 if ($g eq '-g') {
1810 $$tmpl = '';
1811 } else {
1812 $$tmpl =~ s/$ngb/gw/;
1813 $ipkill = 1;
1814 }
1815 } elsif ($$subnet->broadcast->addr eq $ip) {
1816 if ($b eq '-b') {
1817 $$tmpl = '';
1818 } else {
1819 $$tmpl =~ s/$ngb/bcast/;
1820 $ipkill = 1;
1821 }
1822 } else {
1823 $$tmpl =~ s/$ngb//;
1824 }
1825 }
1826
1827 # We don't (usually) want to expand the IP-related patterns on the -net, -gw, or -bcast IPs.
1828 # Arguably this is another place for another config knob, or possibly further extension of
1829 # the template pattern to control it on a per-subnet basis.
1830 if ($ipkill) {
1831 # kill common IP patterns
1832 $$tmpl =~ s/\%[_.-]?[irdh]//;
1833 # kill IP octet patterns
1834 $$tmpl =~ s/\%[1234][dh0](?:[_.-]\%[1234][dh0]){0,3}//;
1835 }
1836
1837 # and now clean up to make sure we leave a valid DNS label... mostly. Should arguably
1838 # split on /\./ and process each label separately.
1839 $$tmpl =~ s/([_-]){3}/$1/ if !$thrsep;
1840 $$tmpl =~ s/([_-]){2}/$1/ if !$twosep;
1841 $$tmpl =~ s/[_-]\././;
1842
1843 } # if ($subnet)
1844
[337]1845 # IP substitutions in template records:
1846 #major patterns:
1847 #dashed IP, forward and reverse
[532]1848 #underscoreed IP, forward and reverse
[337]1849 #dotted IP, forward and reverse (even if forward is... dumb)
[532]1850 # -> %r for reverse, %i for forward, leading -, _, or . to indicate separator, defaults to -
[337]1851 # %r or %-r => %4d-%3d-%2d-%1d
[532]1852 # %_r => %4d_%3d_%2d_%1d
[337]1853 # %.r => %4d.%3d.%2d.%1d
1854 # %i or %-i => %1d-%2d-%3d-%4d
[532]1855 # %_i => %1d_%2d_%3d_%4d
[337]1856 # %.i => %1d.%2d.%3d.%4d
1857 $$tmpl =~ s/\%r/\%4d-\%3d-\%2d-\%1d/g;
[532]1858 $$tmpl =~ s/\%([-._])r/\%4d$1\%3d$1\%2d$1\%1d/g;
[337]1859 $$tmpl =~ s/\%i/\%1d-\%2d-\%3d-\%4d/g;
[532]1860 $$tmpl =~ s/\%([-._])i/\%1d$1\%2d$1\%3d$1\%4d/g;
[337]1861
1862 #hex-coded IP
1863 # %h
1864 $$tmpl =~ s/\%h/$iphex[0]$iphex[1]$iphex[2]$iphex[3]/g;
1865
1866 #IP as decimal-coded 32-bit value
1867 # %d
1868 my $iptmp = $ipparts[0]*256*256*256 + $ipparts[1]*256*256 + $ipparts[2]*256 + $ipparts[3];
1869 $$tmpl =~ s/\%d/$iptmp/g;
1870
1871 #minor patterns (per-octet)
1872 # %[1234][dh0]
1873 #octet
1874 #hex-coded octet
1875 #0-padded octet
1876 $$tmpl =~ s/\%([1234])d/$ipparts[$1-1]/g;
1877 $$tmpl =~ s/\%([1234])h/$iphex[$1-1]/g;
[443]1878 $$tmpl =~ s/\%([1234])0/$ippad[$1-1]/g;
[685]1879
[337]1880} # _template4_expand()
1881
[532]1882# Broad syntactic check on the hostname. Checks for valid characters, correctly-expandable template patterns.
1883# Takes the hostname, type, and live/default and forward/reverse flags
1884# Returns true/false, sets errstr on failures
1885sub _check_hostname_form {
1886 my ($hname,$rectype,$defrec,$revrec) = @_;
[337]1887
[532]1888 if ($hname =~ /\%/ && ($rectype == 65282 || $rectype == 65283) ) {
1889 my $tmphost = $hname;
1890 # we don't actually need to test with the real IP passed; that saves a bit of fiddling.
[685]1891 DNSDB::_template4_expand(\$tmphost, '10.10.10.10');
[653]1892 if ($tmphost =~ /\%/ || lc($tmphost) !~ /^(?:\*\.)?(?:[0-9a-z_.-]+)$/) {
[532]1893 $errstr = "Invalid template $hname";
1894 return;
1895 }
[668]1896 } elsif ($rectype == $reverse_typemap{CNAME} && $revrec eq 'y') {
[625]1897 # Allow / in reverse CNAME hostnames for sub-/24 delegation
1898 if (lc($hname) !~ m|^[0-9a-z_./-]+$|) {
1899 # error message is deliberately restrictive; special cases are SPECIAL and not for general use
1900 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1901 return;
1902 }
[532]1903 } elsif ($revrec eq 'y') {
1904 # Reverse zones don't support @ in hostnames
[625]1905 if (lc($hname) !~ /^(?:\*\.)?[0-9a-z_.-]+$/) {
1906 # error message is deliberately restrictive; special cases are SPECIAL and not for general use
[532]1907 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1908 return;
1909 }
1910 } else {
[600]1911 if (lc($hname) !~ /^(?:\*\.)?(?:[0-9a-z_.-]+|@)$/) {
[532]1912 # Don't mention @, because it would be far too wordy to explain the nuance of @
1913 $errstr = "Hostnames may not contain anything other than (0-9 a-z . _)";
1914 return;
1915 }
1916 }
1917 return 1;
1918} # _check_hostname_form()
1919
1920
[228]1921##
[2]1922## Initialization and cleanup subs
1923##
1924
[128]1925## DNSDB::__cfgload()
1926# Private sub to parse a config file and load it into %config
[517]1927# Takes a filename and a hashref to put the parsed entries in
[128]1928sub __cfgload {
1929 $errstr = '';
1930 my $cfgfile = shift;
[517]1931 my $cfg = shift;
[131]1932
[128]1933 if (open CFG, "<$cfgfile") {
1934 while (<CFG>) {
1935 chomp;
1936 s/^\s*//;
1937 next if /^#/;
1938 next if /^$/;
1939# hmm. more complex bits in this file might require [heading] headers, maybe?
1940# $mode = $1 if /^\[(a-z)+]/;
1941 # DB connect info
[517]1942 $cfg->{dbname} = $1 if /^dbname\s*=\s*([a-z0-9_.-]+)/i;
1943 $cfg->{dbuser} = $1 if /^dbuser\s*=\s*([a-z0-9_.-]+)/i;
1944 $cfg->{dbpass} = $1 if /^dbpass\s*=\s*([a-z0-9_.-]+)/i;
1945 $cfg->{dbhost} = $1 if /^dbhost\s*=\s*([a-z0-9_.-]+)/i;
[128]1946 # Mail settings
[517]1947 $cfg->{mailhost} = $1 if /^mailhost\s*=\s*([a-z0-9_.-]+)/i;
1948 $cfg->{mailnotify} = $1 if /^mailnotify\s*=\s*([a-z0-9_.\@-]+)/i;
1949 $cfg->{mailsender} = $1 if /^mailsender\s*=\s*([a-z0-9_.\@-]+)/i;
1950 $cfg->{mailname} = $1 if /^mailname\s*=\s*([a-z0-9\s_.-]+)/i;
1951 $cfg->{orgname} = $1 if /^orgname\s*=\s*([a-z0-9\s_.,'-]+)/i;
1952 $cfg->{domain} = $1 if /^domain\s*=\s*([a-z0-9_.-]+)/i;
[163]1953 # session - note this is fed directly to CGI::Session
[517]1954 $cfg->{timeout} = $1 if /^[tT][iI][mM][eE][oO][uU][tT]\s*=\s*(\d+[smhdwMy]?)/;
1955 $cfg->{sessiondir} = $1 if m{^sessiondir\s*=\s*([a-z0-9/_.-]+)}i;
[201]1956 # misc
[517]1957 $cfg->{log_failures} = $1 if /^log_failures\s*=\s*([a-z01]+)/i;
1958 $cfg->{perpage} = $1 if /^perpage\s*=\s*(\d+)/i;
1959 $cfg->{exportcache} = $1 if m{^exportcache\s*=\s*([a-z0-9/_.-]+)}i;
[559]1960 $cfg->{usecache} = $1 if m{^usecache\s*=\s*([a-z01]+)}i;
1961 $cfg->{force_refresh} = $1 if /^force_refresh\s*=\s*([a-z01]+)/i;
[542]1962 $cfg->{lowercase} = $1 if /^lowercase\s*=\s*([a-z01]+)/i;
[583]1963 $cfg->{showrev_arpa} = $1 if /^showrev_arpa\s*=\s*([a-z]+)/i;
[644]1964 $cfg->{template_skip_0} = $1 if /^template_skip_0\s*=\s*([a-z01]+)/i;
1965 $cfg->{template_skip_255} = $1 if /^template_skip_255\s*=\s*([a-z01]+)/i;
[714]1966 $cfg->{autotxt} = $1 if /^autotxt\s*=\s*([a-z01]+)/i;
[517]1967# not supported in dns.cgi yet
1968# $cfg->{templatedir} = $1 if m{^templatedir\s*=\s*([a-z0-9/_.-]+)}i;
1969# $cfg->{templateoverride} = $1 if m{^templateoverride\s*=\s*([a-z0-9/_.-]+)}i;
[400]1970 # RPC options
[517]1971 $cfg->{rpcmode} = $1 if /^rpc_mode\s*=\s*(socket|HTTP|XMLRPC)\s*$/i;
1972 $cfg->{maxfcgi} = $1 if /^max_fcgi_requests\s*=\s*(\d+)\s*$/i;
[465]1973 if (my ($tmp) = /^rpc_iplist\s*=\s*(.+)/i) {
1974 my @ips = split /[,\s]+/, $tmp;
1975 my $rpcsys = shift @ips;
[517]1976 push @{$cfg->{rpcacl}{$rpcsys}}, @ips;
[400]1977 }
[128]1978 }
1979 close CFG;
1980 } else {
[517]1981 $errstr = "Couldn't load configuration file $cfgfile: $!";
[128]1982 return;
1983 }
1984 return 1;
1985} # end __cfgload()
1986
1987
[2]1988## DNSDB::connectDB()
1989# Creates connection to DNS database.
1990# Requires the database name, username, and password.
[465]1991# Returns a handle to the db or undef on failure.
[2]1992# Set up for a PostgreSQL db; could be any transactional DBMS with the
1993# right changes.
[465]1994# Called by new(); not intended to be called publicly.
[2]1995sub connectDB {
1996 $errstr = '';
[15]1997 my $dbname = shift;
1998 my $user = shift;
1999 my $pass = shift;
[2]2000 my $dbh;
2001 my $DSN = "DBI:Pg:dbname=$dbname";
2002
2003 my $host = shift;
2004 $DSN .= ";host=$host" if $host;
2005
2006# Note that we want to autocommit by default, and we will turn it off locally as necessary.
2007# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
2008 $dbh = DBI->connect($DSN, $user, $pass, {
2009 AutoCommit => 1,
2010 PrintError => 0
[465]2011 });
2012 if (!$dbh) {
2013 $errstr = $DBI::errstr;
2014 return;
2015 }
2016#) if(!$dbh);
[2]2017
[465]2018 local $dbh->{RaiseError} = 1;
2019
2020 eval {
[212]2021##fixme: initialize the DB if we can't find the table (since, by definition, there's
2022# nothing there if we can't select from it...)
[465]2023 my $tblsth = $dbh->prepare("SELECT count(*) FROM pg_catalog.pg_class WHERE relkind='r' AND relname=?");
2024 my ($tblcount) = $dbh->selectrow_array($tblsth, undef, ('misc'));
2025# return (undef,$DBI::errstr) if $dbh->err;
[212]2026
2027#if ($tblcount == 0) {
2028# # create tables one at a time, checking for each.
2029# return (undef, "check table misc missing");
2030#}
2031
2032# Return here if we can't select.
2033# This should retrieve the dbversion key.
[465]2034 my $sth = $dbh->prepare("SELECT key,value FROM misc WHERE misc_id=1");
2035 $sth->execute();
2036# return (undef,$DBI::errstr) if ($sth->err);
[2]2037
[212]2038##fixme: do stuff to the DB on version mismatch
2039# x.y series should upgrade on $DNSDB::VERSION > misc(key=>version)
2040# DB should be downward-compatible; column defaults should give sane (if possibly
2041# useless-and-needs-help) values in columns an older software stack doesn't know about.
2042
[2]2043# See if the select returned anything (or null data). This should
2044# succeed if the select executed, but...
[465]2045 $sth->fetchrow();
2046# return (undef,$DBI::errstr) if ($sth->err);
[2]2047
[465]2048 $sth->finish;
[2]2049
[465]2050 }; # wrapped DB checks
2051 if ($@) {
2052 $errstr = $@;
2053 return;
2054 }
2055
[2]2056# If we get here, we should be OK.
[465]2057 return $dbh;
[2]2058} # end connectDB
2059
2060
2061## DNSDB::finish()
2062# Cleans up after database handles and so on.
2063# Requires a database handle
2064sub finish {
[465]2065 my $self = shift;
2066 $self->{dbh}->disconnect;
[2]2067} # end finish
2068
2069
2070## DNSDB::initGlobals()
2071# Initialize global variables
2072# NB: this does NOT include web-specific session variables!
2073sub initGlobals {
[465]2074 my $self = shift;
2075 my $dbh = $self->{dbh};
[2]2076
[208]2077# load record types from database
[228]2078 my $sth = $dbh->prepare("SELECT val,name,stdflag FROM rectypes");
[2]2079 $sth->execute;
[228]2080 while (my ($recval,$recname,$stdflag) = $sth->fetchrow_array()) {
[2]2081 $typemap{$recval} = $recname;
2082 $reverse_typemap{$recname} = $recval;
[228]2083 # now we fill the record validation function hash
2084 if ($stdflag < 5) {
2085 my $fn = "_validate_$recval";
2086 $validators{$recval} = \&$fn;
2087 } else {
2088 my $fn = "sub { return ('FAIL','Type $recval ($recname) not supported'); }";
2089 $validators{$recval} = eval $fn;
2090 }
[2]2091 }
2092} # end initGlobals
2093
2094
[401]2095## DNSDB::initRPC()
[469]2096# Takes a remote username and remote fullname.
[401]2097# Sets up the RPC logging-pseudouser if needed.
2098# Sets the %userdata hash for logging.
2099# Returns undef on failure
2100sub initRPC {
[469]2101 my $self = shift;
2102 my $dbh = $self->{dbh};
[401]2103 my %args = @_;
2104
2105 return if !$args{username};
2106 return if !$args{fullname};
2107
[406]2108 $args{username} = "$args{username}/$args{rpcsys}";
2109
2110 my $tmpuser = $dbh->selectrow_hashref("SELECT username,user_id AS userid,group_id,firstname,lastname,status".
[404]2111 " FROM users WHERE username=?", undef, ($args{username}) );
[406]2112 if (!$tmpuser) {
[401]2113 $dbh->do("INSERT INTO users (username,password,firstname,type) VALUES (?,'RPC',?,'R')", undef,
2114 ($args{username}, $args{fullname}) );
[406]2115 $tmpuser = $dbh->selectrow_hashref("SELECT username,user_id AS userid,group_id,firstname,lastname,status".
[404]2116 " FROM users WHERE username=?", undef, ($args{username}) );
[401]2117 }
[488]2118 $tmpuser->{lastname} = '' if !$tmpuser->{lastname};
2119 $self->{loguserid} = $tmpuser->{userid};
2120 $self->{logusername} = $tmpuser->{username};
2121 $self->{logfullname} = "$tmpuser->{firstname} $tmpuser->{lastname} ($args{rpcsys})";
[406]2122 return 1 if $tmpuser;
[401]2123} # end initRPC()
2124
2125
[278]2126## DNSDB::login()
2127# Takes a database handle, username and password
[316]2128# Returns a userdata hash (UID, GID, username, fullname parts) if username exists,
2129# password matches the one on file, and account is not disabled
[278]2130# Returns undef otherwise
2131sub login {
[469]2132 my $self = shift;
2133 my $dbh = $self->{dbh};
[278]2134 my $user = shift;
2135 my $pass = shift;
2136
[316]2137 my $userinfo = $dbh->selectrow_hashref("SELECT user_id,group_id,password,firstname,lastname,status".
2138 " FROM users WHERE username=?",
[279]2139 undef, ($user) );
2140 return if !$userinfo;
[316]2141 return if !$userinfo->{status};
[278]2142
[279]2143 if ($userinfo->{password} =~ m|^\$1\$([A-Za-z0-9/.]+)\$|) {
[278]2144 # native passwords (crypt-md5)
[279]2145 return if $userinfo->{password} ne unix_md5_crypt($pass,$1);
2146 } elsif ($userinfo->{password} =~ /^[0-9a-f]{32}$/) {
[278]2147 # VegaDNS import (hex-coded MD5)
[279]2148 return if $userinfo->{password} ne md5_hex($pass);
[278]2149 } else {
2150 # plaintext (convenient now and then)
[279]2151 return if $userinfo->{password} ne $pass;
[278]2152 }
2153
[279]2154 return $userinfo;
[278]2155} # end login()
2156
2157
[279]2158## DNSDB::initActionLog()
2159# Set up action logging. Takes a database handle and user ID
2160# Sets some internal globals and Does The Right Thing to set up a logging channel.
2161# This sets up _log() to spew out log entries to the defined channel without worrying
2162# about having to open a file or a syslog channel
2163##fixme Need to call _initActionLog_blah() for various logging channels, configured
[517]2164# via dnsdb.conf, in $self->{log_channel} or something
[279]2165# See https://secure.deepnet.cx/trac/dnsadmin/ticket/21
2166sub initActionLog {
[469]2167 my $self = shift;
2168 my $dbh = $self->{dbh};
[279]2169 my $uid = shift;
2170
2171 return if !$uid;
2172
2173 # snag user info for logging. there's got to be a way to not have to pass this back
2174 # and forth from a caller, but web usage means no persistence we can rely on from
2175 # the server side.
2176 my ($username,$fullname) = $dbh->selectrow_array("SELECT username, firstname || ' ' || lastname".
2177 " FROM users WHERE user_id=?", undef, ($uid));
2178##fixme: errors are unpossible!
2179
[488]2180 $self->{logusername} = $username;
2181 $self->{loguserid} = $uid;
2182 $self->{logfullname} = $fullname;
[279]2183
2184 # convert to real check once we have other logging channels
[517]2185 # if ($self->{log_channel} eq 'sql') {
[279]2186 # Open Log, Sez Me!
2187 # }
2188
2189} # end initActionLog
2190
2191
[65]2192## DNSDB::getPermissions()
2193# Get permissions from DB
2194# Requires DB handle, group or user flag, ID, and hashref.
2195sub getPermissions {
[469]2196 my $self = shift;
2197 my $dbh = $self->{dbh};
2198
[65]2199 my $type = shift;
2200 my $id = shift;
2201 my $hash = shift;
2202
2203 my $sql = qq(
2204 SELECT
2205 p.admin,p.self_edit,
2206 p.group_create,p.group_edit,p.group_delete,
2207 p.user_create,p.user_edit,p.user_delete,
2208 p.domain_create,p.domain_edit,p.domain_delete,
[387]2209 p.record_create,p.record_edit,p.record_delete,p.record_locchg,
[382]2210 p.location_create,p.location_edit,p.location_delete,p.location_view
[65]2211 FROM permissions p
2212 );
2213 if ($type eq 'group') {
2214 $sql .= qq(
2215 JOIN groups g ON g.permission_id=p.permission_id
2216 WHERE g.group_id=?
2217 );
2218 } else {
2219 $sql .= qq(
2220 JOIN users u ON u.permission_id=p.permission_id
2221 WHERE u.user_id=?
2222 );
2223 }
2224
2225 my $sth = $dbh->prepare($sql);
2226
[514]2227##fixme? we don't trap other plain SELECT errors
2228 $sth->execute($id);
[65]2229
2230# my $permref = $sth->fetchrow_hashref;
2231# return $permref;
2232# $hash = $permref;
2233# Eww. Need to learn how to forcibly drop a hashref onto an existing hash.
2234 ($hash->{admin},$hash->{self_edit},
2235 $hash->{group_create},$hash->{group_edit},$hash->{group_delete},
2236 $hash->{user_create},$hash->{user_edit},$hash->{user_delete},
2237 $hash->{domain_create},$hash->{domain_edit},$hash->{domain_delete},
[387]2238 $hash->{record_create},$hash->{record_edit},$hash->{record_delete},$hash->{record_locchg},
[382]2239 $hash->{location_create},$hash->{location_edit},$hash->{location_delete},$hash->{location_view}
2240 ) = $sth->fetchrow_array;
[65]2241
2242} # end getPermissions()
2243
2244
2245## DNSDB::changePermissions()
2246# Update an ACL entry
2247# Takes a db handle, type, owner-id, and hashref for the changed permissions.
2248sub changePermissions {
[474]2249 my $self = shift;
2250 my $dbh = $self->{dbh};
[65]2251 my $type = shift;
2252 my $id = shift;
2253 my $newperms = shift;
[87]2254 my $inherit = shift || 0;
[65]2255
[294]2256 my $resultmsg = '';
[66]2257
[87]2258 # see if we're switching from inherited to custom. for bonus points,
2259 # snag the permid and parent permid anyway, since we'll need the permid
2260 # to set/alter custom perms, and both if we're switching from custom to
2261 # inherited.
[294]2262 my $sth = $dbh->prepare("SELECT (u.permission_id=g.permission_id) AS was_inherited,u.permission_id,g.permission_id,".
2263 ($type eq 'user' ? 'u.group_id,u.username' : 'u.parent_group_id,u.group_name').
[65]2264 " FROM ".($type eq 'user' ? 'users' : 'groups')." u ".
[66]2265 " JOIN groups g ON u.".($type eq 'user' ? '' : 'parent_')."group_id=g.group_id ".
[65]2266 " WHERE u.".($type eq 'user' ? 'user' : 'group')."_id=?");
2267 $sth->execute($id);
2268
[294]2269 my ($wasinherited,$permid,$parpermid,$parid,$name) = $sth->fetchrow_array;
[66]2270
[78]2271# hack phtoui
2272# group id 1 is "special" in that it's it's own parent (err... possibly.)
2273# may make its parent id 0 which doesn't exist, and as a bonus is Perl-false.
2274 $wasinherited = 0 if ($type eq 'group' && $id == 1);
2275
[66]2276 local $dbh->{AutoCommit} = 0;
2277 local $dbh->{RaiseError} = 1;
2278
2279 # Wrap all the SQL in a transaction
2280 eval {
[87]2281 if ($inherit) {
2282
2283 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='t',permission_id=? ".
2284 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($parpermid, $id) );
2285 $dbh->do("DELETE FROM permissions WHERE permission_id=?", undef, ($permid) );
2286
2287 } else {
2288
2289 if ($wasinherited) { # munge new permission entry in if we're switching from inherited perms
[66]2290##fixme: need to add semirecursive bit to properly munge inherited permission ID on subgroups and users
[87]2291# ... if'n'when we have groups with fully inherited permissions.
2292 # SQL is coo
2293 $dbh->do("INSERT INTO permissions ($permlist,".($type eq 'user' ? 'user' : 'group')."_id) ".
2294 "SELECT $permlist,? FROM permissions WHERE permission_id=?", undef, ($id,$permid) );
2295 ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions ".
2296 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($id) );
2297 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='f',permission_id=? ".
2298 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($permid, $id) );
[66]2299 }
[78]2300
[87]2301 # and now set the permissions we were passed
2302 foreach (@permtypes) {
2303 if (defined ($newperms->{$_})) {
2304 $dbh->do("UPDATE permissions SET $_=? WHERE permission_id=?", undef, ($newperms->{$_},$permid) );
2305 }
2306 }
2307
2308 } # (inherited->)? custom
2309
[294]2310 if ($type eq 'user') {
2311 $resultmsg = "Updated permissions for user $name";
2312 } else {
2313 $resultmsg = "Updated default permissions for group $name";
2314 }
[487]2315 $self->_log(group_id => ($type eq 'user' ? $parid : $id), entry => $resultmsg);
[66]2316 $dbh->commit;
2317 }; # end eval
2318 if ($@) {
2319 my $msg = $@;
2320 eval { $dbh->rollback; };
[294]2321 return ('FAIL',"Error changing permissions: $msg");
[66]2322 }
2323
[294]2324 return ('OK',$resultmsg);
[65]2325} # end changePermissions()
2326
2327
[67]2328## DNSDB::comparePermissions()
2329# Compare two permission hashes
2330# Returns '>', '<', '=', '!'
2331sub comparePermissions {
[592]2332 my $self = shift;
[67]2333 my $p1 = shift;
2334 my $p2 = shift;
2335
2336 my $retval = '='; # assume equality until proven otherwise
2337
2338 no warnings "uninitialized";
2339
2340 foreach (@permtypes) {
2341 next if $p1->{$_} == $p2->{$_}; # equal is good
2342 if ($p1->{$_} && !$p2->{$_}) {
2343 if ($retval eq '<') { # if we've already found an unequal pair where
2344 $retval = '!'; # $p2 has more access, and we now find a pair
2345 last; # where $p1 has more access, the overall access
2346 } # is neither greater or lesser, it's unequal.
2347 $retval = '>';
2348 }
2349 if (!$p1->{$_} && $p2->{$_}) {
2350 if ($retval eq '>') { # if we've already found an unequal pair where
2351 $retval = '!'; # $p1 has more access, and we now find a pair
2352 last; # where $p2 has more access, the overall access
2353 } # is neither greater or lesser, it's unequal.
2354 $retval = '<';
2355 }
2356 }
2357 return $retval;
2358} # end comparePermissions()
2359
2360
[112]2361## DNSDB::changeGroup()
2362# Change group ID of an entity
2363# Takes a database handle, entity type, entity ID, and new group ID
2364sub changeGroup {
[476]2365 my $self = shift;
2366 my $dbh = $self->{dbh};
[112]2367 my $type = shift;
2368 my $id = shift;
2369 my $newgrp = shift;
2370
2371##fixme: fail on not enough args
2372 #return ('FAIL', "Missing
2373
[295]2374 return ('FAIL', "Can't change the group of a $type")
2375 unless grep /^$type$/, ('domain','revzone','user','group'); # could be extended for defrecs?
2376
2377 # Collect some names for logging and messages
2378 my $entname;
[112]2379 if ($type eq 'domain') {
[473]2380 $entname = $self->domainName($id);
[295]2381 } elsif ($type eq 'revzone') {
[473]2382 $entname = $self->revName($id);
[112]2383 } elsif ($type eq 'user') {
[473]2384 $entname = $self->userFullName($id, '%u');
[112]2385 } elsif ($type eq 'group') {
[473]2386 $entname = $self->groupName($id);
[112]2387 }
[295]2388
2389 my ($oldgid) = $dbh->selectrow_array("SELECT group_id FROM $par_tbl{$type} WHERE $id_col{$type}=?",
2390 undef, ($id));
[473]2391 my $oldgname = $self->groupName($oldgid);
2392 my $newgname = $self->groupName($newgrp);
[295]2393
2394 return ('FAIL', "Can't move things into a group that doesn't exist") if !$newgname;
2395
2396 return ('WARN', "Nothing to do, new group is the same as the old group") if $oldgid == $newgrp;
2397
2398 # Allow transactions, and raise an exception on errors so we can catch it later.
2399 # Use local to make sure these get "reset" properly on exiting this block
2400 local $dbh->{AutoCommit} = 0;
2401 local $dbh->{RaiseError} = 1;
2402
2403 eval {
2404 $dbh->do("UPDATE $par_tbl{$type} SET group_id=? WHERE $id_col{$type}=?", undef, ($newgrp, $id));
2405 # Log the change in both the old and new groups
[487]2406 $self->_log(group_id => $oldgid, entry => "Moved $type $entname from $oldgname to $newgname");
2407 $self->_log(group_id => $newgrp, entry => "Moved $type $entname from $oldgname to $newgname");
[295]2408 $dbh->commit;
2409 };
2410 if ($@) {
2411 my $msg = $@;
2412 eval { $dbh->rollback; };
[517]2413 if ($self->{log_failures}) {
[487]2414 $self->_log(group_id => $oldgid, entry => "Error moving $type $entname to $newgname: $msg");
[295]2415 $dbh->commit; # since we enabled transactions earlier
2416 }
2417 return ('FAIL',"Error moving $type $entname to $newgname: $msg");
2418 }
2419
2420 return ('OK',"Moved $type $entname from $oldgname to $newgname");
[112]2421} # end changeGroup()
2422
2423
[2]2424##
2425## Processing subs
2426##
2427
2428## DNSDB::addDomain()
2429# Add a domain
[190]2430# Takes a database handle, domain name, numeric group, boolean(ish) state (active/inactive),
[704]2431# and a default location indicator
[2]2432# Returns a status code and message
2433sub addDomain {
2434 $errstr = '';
[477]2435 my $self = shift;
2436 my $dbh = $self->{dbh};
[2]2437 my $domain = shift;
[497]2438 return ('FAIL',"Domain must not be blank\n") if !$domain;
[2]2439 my $group = shift;
[497]2440 return ('FAIL',"Group must be specified\n") if !defined($group);
[2]2441 my $state = shift;
[497]2442 return ('FAIL',"Domain status must be specified\n") if !defined($state);
[516]2443 my $defloc = shift || '';
[2]2444
[116]2445 $state = 1 if $state =~ /^active$/;
2446 $state = 1 if $state =~ /^on$/;
2447 $state = 0 if $state =~ /^inactive$/;
2448 $state = 0 if $state =~ /^off$/;
2449
2450 return ('FAIL',"Invalid domain status") if $state !~ /^\d+$/;
2451
[542]2452 $domain = lc($domain) if $self->{lowercase};
2453
[190]2454 return ('FAIL', "Invalid characters in domain") if $domain !~ /^[a-zA-Z0-9_.-]+$/;
2455
[707]2456 my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE lower(domain) = lower(?) AND default_location = ?");
[3]2457 my $dom_id;
2458
[38]2459# quick check to start to see if we've already got one
[704]2460 $sth->execute($domain, $defloc);
[38]2461 ($dom_id) = $sth->fetchrow_array;
2462
2463 return ('FAIL', "Domain already exists") if $dom_id;
2464
[2]2465 # Allow transactions, and raise an exception on errors so we can catch it later.
2466 # Use local to make sure these get "reset" properly on exiting this block
2467 local $dbh->{AutoCommit} = 0;
2468 local $dbh->{RaiseError} = 1;
2469
2470 # Wrap all the SQL in a transaction
2471 eval {
2472 # insert the domain...
[516]2473 $dbh->do("INSERT INTO domains (domain,group_id,status,default_location) VALUES (?,?,?,?)", undef,
2474 ($domain, $group, $state, $defloc));
[2]2475
2476 # get the ID...
[707]2477 ($dom_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?) AND default_location = ?",
[704]2478 undef, ($domain, $defloc));
[2]2479
[744]2480 my $logparent = $self->_log(domain_id => $dom_id, group_id => $group,
[487]2481 entry => "Added ".($state ? 'active' : 'inactive')." domain $domain");
[190]2482
[2]2483 # ... and now we construct the standard records from the default set. NB: group should be variable.
[190]2484 my $sth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
[516]2485 my $sth_in = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,distance,weight,port,ttl,location)".
2486 " VALUES ($dom_id,?,?,?,?,?,?,?,?)");
[190]2487 $sth->execute($group);
[516]2488 while (my ($host, $type, $val, $dist, $weight, $port, $ttl) = $sth->fetchrow_array()) {
[2]2489 $host =~ s/DOMAIN/$domain/g;
[37]2490 $val =~ s/DOMAIN/$domain/g;
[617]2491 _caseclean(\$type, \$host, \$val, 'n', 'n') if $self->{lowercase};
[516]2492 $sth_in->execute($host, $type, $val, $dist, $weight, $port, $ttl, $defloc);
[190]2493 if ($typemap{$type} eq 'SOA') {
2494 my @tmp1 = split /:/, $host;
2495 my @tmp2 = split /:/, $val;
[744]2496 $self->_log(domain_id => $dom_id, group_id => $group, logparent => $logparent,
[284]2497 entry => "[new $domain] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
[487]2498 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl");
[190]2499 } else {
2500 my $logentry = "[new $domain] Added record '$host $typemap{$type}";
2501 $logentry .= " [distance $dist]" if $typemap{$type} eq 'MX';
2502 $logentry .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$type} eq 'SRV';
[744]2503 $self->_log(domain_id => $dom_id, group_id => $group, logparent => $logparent,
[487]2504 entry => $logentry." $val', TTL $ttl");
[190]2505 }
[2]2506 }
2507
2508 # once we get here, we should have suceeded.
2509 $dbh->commit;
2510 }; # end eval
2511
2512 if ($@) {
2513 my $msg = $@;
2514 eval { $dbh->rollback; };
[487]2515 $self->_log(group_id => $group, entry => "Failed adding domain $domain ($msg)")
[517]2516 if $self->{log_failures};
[284]2517 $dbh->commit; # since we enabled transactions earlier
[193]2518 return ('FAIL',$msg);
[2]2519 } else {
[3]2520 return ('OK',$dom_id);
[2]2521 }
2522} # end addDomain
2523
2524
[274]2525## DNSDB::delZone()
2526# Delete a forward or reverse zone.
2527# Takes a database handle, zone ID, and forward/reverse flag.
[3]2528# for now, just delete the records, then the domain.
2529# later we may want to archive it in some way instead (status code 2, for example?)
[274]2530sub delZone {
[477]2531 my $self = shift;
2532 my $dbh = $self->{dbh};
[274]2533 my $zoneid = shift;
2534 my $revrec = shift;
[3]2535
2536 # Allow transactions, and raise an exception on errors so we can catch it later.
2537 # Use local to make sure these get "reset" properly on exiting this block
2538 local $dbh->{AutoCommit} = 0;
2539 local $dbh->{RaiseError} = 1;
2540
[687]2541 return ('FAIL', 'Need a zone identifier to look up') if !$zoneid;
2542
[285]2543 my $msg = '';
[23]2544 my $failmsg = '';
[473]2545 my $zone = ($revrec eq 'n' ? $self->domainName($zoneid) : $self->revName($zoneid));
[23]2546
[343]2547 return ('FAIL', ($revrec eq 'n' ? 'Domain' : 'Reverse zone')." ID $zoneid doesn't exist") if !$zone;
2548
[517]2549 # Set this up here since we may use if if $self->{log_failures} is enabled
[285]2550 my %loghash;
2551 $loghash{domain_id} = $zoneid if $revrec eq 'n';
2552 $loghash{rdns_id} = $zoneid if $revrec eq 'y';
[473]2553 $loghash{group_id} = $self->parentID(
2554 id => $zoneid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec);
[285]2555
[3]2556 # Wrap all the SQL in a transaction
2557 eval {
[274]2558 # Disentangle custom record types before removing the
2559 # ones that are only in the zone to be deleted
2560 if ($revrec eq 'n') {
2561 my $sth = $dbh->prepare("UPDATE records SET type=?,domain_id=0 WHERE domain_id=? AND type=?");
2562 $failmsg = "Failure converting multizone types to single-zone";
2563 $sth->execute($reverse_typemap{PTR}, $zoneid, 65280);
2564 $sth->execute($reverse_typemap{PTR}, $zoneid, 65281);
2565 $sth->execute(65282, $zoneid, 65283);
2566 $sth->execute(65282, $zoneid, 65284);
2567 $failmsg = "Failure removing domain records";
2568 $dbh->do("DELETE FROM records WHERE domain_id=?", undef, ($zoneid));
2569 $failmsg = "Failure removing domain";
2570 $dbh->do("DELETE FROM domains WHERE domain_id=?", undef, ($zoneid));
2571 } else {
2572 my $sth = $dbh->prepare("UPDATE records SET type=?,rdns_id=0 WHERE rdns_id=? AND type=?");
2573 $failmsg = "Failure converting multizone types to single-zone";
2574 $sth->execute($reverse_typemap{A}, $zoneid, 65280);
2575 $sth->execute($reverse_typemap{AAAA}, $zoneid, 65281);
2576# We don't have an "A template" or "AAAA template" type, although it might be useful for symmetry.
[345]2577# $sth->execute(65286?, $zoneid, 65283);
2578# $sth->execute(65286?, $zoneid, 65284);
[274]2579 $failmsg = "Failure removing reverse records";
2580 $dbh->do("DELETE FROM records WHERE rdns_id=?", undef, ($zoneid));
2581 $failmsg = "Failure removing reverse zone";
2582 $dbh->do("DELETE FROM revzones WHERE rdns_id=?", undef, ($zoneid));
2583 }
[3]2584
[285]2585 $msg = "Deleted ".($revrec eq 'n' ? 'domain' : 'reverse zone')." $zone";
2586 $loghash{entry} = $msg;
[487]2587 $self->_log(%loghash);
[285]2588
[3]2589 # once we get here, we should have suceeded.
[23]2590 $dbh->commit;
[3]2591 }; # end eval
2592
2593 if ($@) {
[285]2594 $msg = $@;
[3]2595 eval { $dbh->rollback; };
[295]2596 $loghash{entry} = "Error deleting $zone: $msg ($failmsg)";
[517]2597 if ($self->{log_failures}) {
[487]2598 $self->_log(%loghash);
[295]2599 $dbh->commit; # since we enabled transactions earlier
2600 }
2601 return ('FAIL', $loghash{entry});
[3]2602 } else {
[295]2603 return ('OK', $msg);
[3]2604 }
2605
[274]2606} # end delZone()
[3]2607
2608
[2]2609## DNSDB::domainName()
2610# Return the domain name based on a domain ID
2611# Takes a database handle and the domain ID
2612# Returns the domain name or undef on failure
2613sub domainName {
2614 $errstr = '';
[473]2615 my $self = shift;
2616 my $dbh = $self->{dbh};
[2]2617 my $domid = shift;
[91]2618 my ($domname) = $dbh->selectrow_array("SELECT domain FROM domains WHERE domain_id=?", undef, ($domid) );
[2]2619 $errstr = $DBI::errstr if !$domname;
2620 return $domname if $domname;
[91]2621} # end domainName()
[2]2622
2623
[224]2624## DNSDB::revName()
2625# Return the reverse zone name based on an rDNS ID
[583]2626# Takes a database handle and the rDNS ID, and an optional flag to force return of the CIDR zone
2627# instead of the formal .arpa zone name
[224]2628# Returns the reverse zone name or undef on failure
2629sub revName {
2630 $errstr = '';
[473]2631 my $self = shift;
2632 my $dbh = $self->{dbh};
[224]2633 my $revid = shift;
[583]2634 my $cidrflag = shift || 'n';
[224]2635 my ($revname) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id=?", undef, ($revid) );
2636 $errstr = $DBI::errstr if !$revname;
[583]2637 my $tmp = new NetAddr::IP $revname;
2638 $revname = _ZONE($tmp, 'ZONE', 'r', '.').($tmp->{isv6} ? '.ip6.arpa' : '.in-addr.arpa')
2639 if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') && $cidrflag eq 'n';
[224]2640 return $revname if $revname;
2641} # end revName()
2642
2643
[91]2644## DNSDB::domainID()
2645# Takes a database handle and domain name
2646# Returns the domain ID number
2647sub domainID {
2648 $errstr = '';
[473]2649 my $self = shift;
2650 my $dbh = $self->{dbh};
[91]2651 my $domain = shift;
[719]2652 my $location = shift;
2653
2654 # Note that location may be *empty*, but it may not be *undefined*
2655 if (!defined($location)) {
2656 $errstr = "Missing location";
2657 return;
2658 }
2659
2660 my ($domid) = $dbh->selectrow_array(
2661 "SELECT domain_id FROM domains WHERE lower(domain) = lower(?) AND default_location = ?",
2662 undef, ($domain, $location) );
[501]2663 if (!$domid) {
2664 if ($dbh->err) {
2665 $errstr = $DBI::errstr;
2666 } else {
2667 $errstr = "Domain $domain not present";
2668 }
2669 }
[91]2670 return $domid if $domid;
2671} # end domainID()
2672
2673
[276]2674## DNSDB::revID()
2675# Takes a database handle and reverse zone name
2676# Returns the rDNS ID number
2677sub revID {
2678 $errstr = '';
[473]2679 my $self = shift;
2680 my $dbh = $self->{dbh};
[276]2681 my $revzone = shift;
[719]2682 my $location = shift;
2683
2684 # Note that location may be *empty*, but it may not be *undefined*
2685 if (!defined($location)) {
2686 $errstr = "Missing location";
2687 return;
2688 }
2689
2690 my ($revid) = $dbh->selectrow_array(
2691 "SELECT rdns_id FROM revzones WHERE revnet = ? AND default_location = ?",
2692 undef, ($revzone, $location) );
[501]2693 if (!$revid) {
2694 if ($dbh->err) {
2695 $errstr = $DBI::errstr;
2696 } else {
2697 $errstr = "Reverse zone $revzone not present";
2698 }
2699 }
[276]2700 return $revid if $revid;
2701} # end revID()
2702
2703
[260]2704## DNSDB::addRDNS
2705# Adds a reverse DNS zone
[286]2706# Takes a database handle, CIDR block, reverse DNS pattern, numeric group,
2707# and boolean(ish) state (active/inactive)
[260]2708# Returns a status code and message
2709sub addRDNS {
[477]2710 my $self = shift;
2711 my $dbh = $self->{dbh};
[583]2712 my $zone = shift;
[446]2713
[583]2714 # Autodetect formal .arpa zones
2715 if ($zone =~ /\.arpa\.?$/) {
2716 my $code;
2717 ($code,$zone) = _zone2cidr($zone);
2718 return ('FAIL', $zone) if $code eq 'FAIL';
2719 }
2720 $zone = NetAddr::IP->new($zone);
2721
[260]2722 return ('FAIL',"Zone name must be a valid CIDR netblock") unless ($zone && $zone->addr !~ /^0/);
[270]2723 my $revpatt = shift; # construct a custom (A/AAAA+)? PTR template record
[260]2724 my $group = shift;
2725 my $state = shift;
[446]2726 my $defloc = shift || '';
[260]2727
2728 $state = 1 if $state =~ /^active$/;
2729 $state = 1 if $state =~ /^on$/;
2730 $state = 0 if $state =~ /^inactive$/;
2731 $state = 0 if $state =~ /^off$/;
2732
2733 return ('FAIL',"Invalid zone status") if $state !~ /^\d+$/;
2734
2735# quick check to start to see if we've already got one
[704]2736 my ($rdns_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet = ? AND default_location = ?",
2737 undef, ("$zone", $defloc));
[260]2738
2739 return ('FAIL', "Zone already exists") if $rdns_id;
2740
2741 # Allow transactions, and raise an exception on errors so we can catch it later.
2742 # Use local to make sure these get "reset" properly on exiting this block
2743 local $dbh->{AutoCommit} = 0;
2744 local $dbh->{RaiseError} = 1;
2745
[264]2746 my $warnstr = '';
[270]2747 my $defttl = 3600; # 1 hour should be reasonable. And unless things have gone horribly
2748 # wrong, we should have a value to override this anyway.
[264]2749
[260]2750 # Wrap all the SQL in a transaction
2751 eval {
[446]2752 # insert the zone...
2753 $dbh->do("INSERT INTO revzones (revnet,group_id,status,default_location) VALUES (?,?,?,?)", undef,
2754 ($zone, $group, $state, $defloc) );
[260]2755
2756 # get the ID...
2757 ($rdns_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
2758
[487]2759 $self->_log(rdns_id => $rdns_id, group_id => $group,
2760 entry => "Added ".($state ? 'active' : 'inactive')." reverse zone $zone");
[260]2761
2762 # ... and now we construct the standard records from the default set. NB: group should be variable.
2763 my $sth = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
[446]2764 my $sth_in = $dbh->prepare("INSERT INTO records (rdns_id,domain_id,host,type,val,ttl,location)".
2765 " VALUES ($rdns_id,?,?,?,?,?,?)");
[260]2766 $sth->execute($group);
2767 while (my ($host,$type,$val,$ttl) = $sth->fetchrow_array()) {
[264]2768 # Silently skip v4/v6 mismatches. This is not an error, this is expected.
2769 if ($zone->{isv6}) {
2770 next if ($type == 65280 || $type == 65283);
2771 } else {
2772 next if ($type == 65281 || $type == 65284);
2773 }
[269]2774
[517]2775 $host =~ s/ADMINDOMAIN/$self->{domain}/g;
[264]2776
[265]2777 # Check to make sure the IP stubs will fit in the zone. Under most usage failures here should be rare.
2778 # On failure, tack a note on to a warning string and continue without adding this record.
2779 # While we're at it, we substitute $zone for ZONE in the value.
2780 if ($val eq 'ZONE') {
[444]2781 # If we've got a pattern, we skip the default record version on (A+)PTR-template types
2782 next if $revpatt && ($type == 65282 || $type == 65283);
[269]2783##fixme? do we care if we have multiple whole-zone templates?
[265]2784 $val = $zone->network;
2785 } elsif ($val =~ /ZONE/) {
2786 my $tmpval = $val;
2787 $tmpval =~ s/ZONE//;
[269]2788 # Bend the rules and allow single-trailing-number PTR or PTR template records to be inserted
2789 # as either v4 or v6. May make this an off-by-default config flag
2790 # Note that the origin records that may trigger this **SHOULD** already have ZONE,\d
2791 if ($type == 12 || $type == 65282) {
2792 $tmpval =~ s/[,.]/::/ if ($tmpval =~ /^[,.]\d+$/ && $zone->{isv6});
2793 $tmpval =~ s/[,:]+/./ if ($tmpval =~ /^(?:,|::)\d+$/ && !$zone->{isv6});
2794 }
[265]2795 my $addr;
[471]2796 if ($self->_ipparent('n', 'y', \$tmpval, $rdns_id, \$addr)) {
[265]2797 $val = $addr->addr;
2798 } else {
[269]2799 $warnstr .= "\nDefault record '$val $typemap{$type} $host' doesn't fit in $zone, skipping";
[264]2800 next;
2801 }
2802 }
2803
[328]2804 # Substitute $zone for ZONE in the hostname, but only for non-NS records.
2805 # NS records get this substitution on the value instead.
2806 $host = _ZONE($zone, $host) if $type != 2;
[265]2807
[269]2808 # Fill in the forward domain ID if we can find it, otherwise:
2809 # Coerce type down to PTR or PTR template if we can't
2810 my $domid = 0;
2811 if ($type >= 65280) {
[471]2812 if (!($domid = $self->_hostparent($host))) {
[269]2813 $warnstr .= "\nRecord added as PTR instead of $typemap{$type}; domain not found for $host";
2814 $type = $reverse_typemap{PTR};
2815 $domid = 0; # just to be explicit.
2816 }
2817 }
2818
[617]2819 _caseclean(\$type, \$host, \$val, 'n', 'y') if $self->{lowercase};
2820
[446]2821 $sth_in->execute($domid,$host,$type,$val,$ttl,$defloc);
[269]2822
[260]2823 if ($typemap{$type} eq 'SOA') {
2824 my @tmp1 = split /:/, $host;
2825 my @tmp2 = split /:/, $val;
[487]2826 $self->_log(rdns_id => $rdns_id, group_id => $group,
[286]2827 entry => "[new $zone] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
[487]2828 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl");
[270]2829 $defttl = $tmp2[3];
[260]2830 } else {
[446]2831 my $logentry = "[new $zone] Added record '$host $typemap{$type} $val', TTL $ttl";
[480]2832 $logentry .= ", default location ".$self->getLoc($defloc)->{description} if $defloc;
[487]2833 $self->_log(rdns_id => $rdns_id, domain_id => $domid, group_id => $group, entry => $logentry);
[260]2834 }
2835 }
2836
[270]2837 # Generate record based on provided pattern.
2838 if ($revpatt) {
2839 my $host;
2840 my $type = ($zone->{isv6} ? 65284 : 65283);
2841 my $val = $zone->network;
[269]2842
[270]2843 # Substitute $zone for ZONE in the hostname.
2844 $host = _ZONE($zone, $revpatt);
2845
2846 my $domid = 0;
[471]2847 if (!($domid = $self->_hostparent($host))) {
[270]2848 $warnstr .= "\nDefault pattern added as PTR template instead of $typemap{$type}; domain not found for $host";
2849 $type = 65282;
2850 $domid = 0; # just to be explicit.
2851 }
2852
[446]2853 $sth_in->execute($domid,$host,$type,$val,$defttl,$defloc);
[286]2854 my $logentry = "[new $zone] Added record '$host $typemap{$type}";
[487]2855 $self->_log(rdns_id => $rdns_id, domain_id => $domid, group_id => $group,
2856 entry => $logentry." $val', TTL $defttl from pattern");
[270]2857 }
2858
[264]2859 # If there are warnings (presumably about default records skipped for cause) log them
[487]2860 $self->_log(rdns_id => $rdns_id, group_id => $group, entry => "Warning(s) adding $zone:$warnstr")
[264]2861 if $warnstr;
[269]2862
[260]2863 # once we get here, we should have suceeded.
2864 $dbh->commit;
2865 }; # end eval
2866
2867 if ($@) {
2868 my $msg = $@;
2869 eval { $dbh->rollback; };
[487]2870 $self->_log(group_id => $group, entry => "Failed adding reverse zone $zone ($msg)")
[517]2871 if $self->{log_failures};
[286]2872 $dbh->commit; # since we enabled transactions earlier
[260]2873 return ('FAIL',$msg);
2874 } else {
[286]2875 my $retcode = 'OK';
2876 if ($warnstr) {
2877 $resultstr = $warnstr;
2878 $retcode = 'WARN';
2879 }
2880 return ($retcode, $rdns_id);
[260]2881 }
2882
2883} # end addRDNS()
2884
2885
[237]2886## DNSDB::getZoneCount
2887# Get count of zones in group or groups
2888# Takes a database handle and hash containing:
2889# - the "current" group
2890# - an array of "acceptable" groups
2891# - a flag for forward/reverse zones
2892# - Optionally accept a "starts with" and/or "contains" filter argument
2893# Returns an integer count of the resulting zone list.
2894sub getZoneCount {
[477]2895 my $self = shift;
2896 my $dbh = $self->{dbh};
[237]2897
2898 my %args = @_;
2899
[509]2900 # Fail on bad curgroup argument. There's no sane fallback on this one.
2901 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2902 $errstr = "Bad or missing curgroup argument";
2903 return;
2904 }
2905 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2906 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2907 $errstr = "Bad childlist argument";
2908 return;
2909 }
2910
[237]2911 my @filterargs;
[239]2912 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2913 push @filterargs, "^$args{startwith}" if $args{startwith};
2914 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
[237]2915 push @filterargs, $args{filter} if $args{filter};
2916
2917 my $sql;
2918 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2919 if ($args{revrec} eq 'n') {
2920 $sql = "SELECT count(*) FROM domains".
2921 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2922 ($args{startwith} ? " AND domain ~* ?" : '').
2923 ($args{filter} ? " AND domain ~* ?" : '');
2924 } else {
2925 $sql = "SELECT count(*) FROM revzones".
2926 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
[583]2927 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2928# if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') {
2929 # Just In Case the UI is using formal .arpa notation, and someone enters something reversed,
2930 # we want to match both the formal and natural zone name
2931 $sql .= ($args{filter} ? " AND (CAST(revnet AS VARCHAR) ~* ? OR CAST(revnet AS VARCHAR) ~* ?)" : '');
2932 push @filterargs, join('[.]',reverse(split(/\[\.\]/,$args{filter}))) if $args{filter};
2933# } else {
2934# $sql .= ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2935# }
[237]2936 }
2937 my ($count) = $dbh->selectrow_array($sql, undef, @filterargs);
2938 return $count;
2939} # end getZoneCount()
2940
2941
2942## DNSDB::getZoneList()
2943# Get a list of zones in the specified group(s)
2944# Takes the same arguments as getZoneCount() above
2945# Returns a reference to an array of hashrefs suitable for feeding to HTML::Template
2946sub getZoneList {
[477]2947 my $self = shift;
2948 my $dbh = $self->{dbh};
[237]2949
2950 my %args = @_;
2951
2952 my @zonelist;
2953
[475]2954 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
[239]2955 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[237]2956
[509]2957 # Fail on bad curgroup argument. There's no sane fallback on this one.
2958 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
2959 $errstr = "Bad or missing curgroup argument";
2960 return;
2961 }
2962 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
2963 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
2964 $errstr = "Bad childlist argument";
2965 return;
2966 }
2967
[237]2968 my @filterargs;
[239]2969 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2970 push @filterargs, "^$args{startwith}" if $args{startwith};
2971 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
[237]2972 push @filterargs, $args{filter} if $args{filter};
2973
2974 my $sql;
2975 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2976 if ($args{revrec} eq 'n') {
[475]2977 $args{sortby} = 'domain' if !$args{sortby} || !grep /^$args{sortby}$/, ('domain','group','status');
[704]2978 $sql = q(SELECT
2979 domain_id AS zoneid,
2980 domain AS zone,
2981 status,
2982 groups.group_name AS group,
2983 l.description AS location
2984 FROM domains
2985 LEFT JOIN locations l ON domains.default_location=l.location
2986 INNER JOIN groups ON domains.group_id=groups.group_id ).
2987 "WHERE domains.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
[237]2988 ($args{startwith} ? " AND domain ~* ?" : '').
2989 ($args{filter} ? " AND domain ~* ?" : '');
2990 } else {
[239]2991##fixme: arguably startwith here is irrelevant. depends on the UI though.
[475]2992 $args{sortby} = 'revnet' if !$args{sortby} || !grep /^$args{sortby}$/, ('revnet','group','status');
[704]2993 $sql = q(SELECT
2994 rdns_id AS zoneid,
2995 revnet AS zone,
2996 status,
2997 groups.group_name AS group,
2998 l.description AS location
2999 FROM revzones
3000 LEFT JOIN locations l ON revzones.default_location=l.location
3001 INNER JOIN groups ON revzones.group_id=groups.group_id ).
[237]3002 " WHERE revzones.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
[583]3003 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
3004# if ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all') {
3005 # Just In Case the UI is using formal .arpa notation, and someone enters something reversed,
3006 # we want to match both the formal and natural zone name
3007 $sql .= ($args{filter} ? " AND (CAST(revnet AS VARCHAR) ~* ? OR CAST(revnet AS VARCHAR) ~* ?)" : '');
3008 push @filterargs, join('[.]',reverse(split(/\[\.\]/,$args{filter}))) if $args{filter};
3009# } else {
3010# $sql .= ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
3011# }
[237]3012 }
3013 # A common tail.
[239]3014 $sql .= " ORDER BY ".($args{sortby} eq 'group' ? 'groups.group_name' : $args{sortby})." $args{sortorder} ".
[517]3015 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage}".
3016 " OFFSET ".$args{offset}*$self->{perpage});
[237]3017
[583]3018 my @working;
3019 my $zsth = $dbh->prepare($sql);
3020 $zsth->execute(@filterargs);
3021 while (my $zone = $zsth->fetchrow_hashref) {
3022 if ($args{revrec} eq 'y' && ($self->{showrev_arpa} eq 'zone' || $self->{showrev_arpa} eq 'all')) {
3023 my $tmp = new NetAddr::IP $zone->{zone};
3024 $zone->{zone} = DNSDB::_ZONE($tmp, 'ZONE', 'r', '.').($tmp->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
3025 }
3026 push @working, $zone;
3027 }
3028 return \@working;
[237]3029} # end getZoneList()
3030
3031
[383]3032## DNSDB::getZoneLocation()
[387]3033# Retrieve the default location for a zone.
[383]3034# Takes a database handle, forward/reverse flag, and zone ID
3035sub getZoneLocation {
[477]3036 my $self = shift;
3037 my $dbh = $self->{dbh};
[383]3038 my $revrec = shift;
3039 my $zoneid = shift;
3040
3041 my ($loc) = $dbh->selectrow_array("SELECT default_location FROM ".
3042 ($revrec eq 'n' ? 'domains WHERE domain_id = ?' : 'revzones WHERE rdns_id = ?'),
3043 undef, ($zoneid));
3044 return $loc;
3045} # end getZoneLocation()
3046
3047
[18]3048## DNSDB::addGroup()
3049# Add a group
[66]3050# Takes a database handle, group name, parent group, hashref for permissions,
[292]3051# and optional template-vs-cloneme flag for the default records
[18]3052# Returns a status code and message
3053sub addGroup {
3054 $errstr = '';
[476]3055 my $self = shift;
3056 my $dbh = $self->{dbh};
[20]3057 my $groupname = shift;
3058 my $pargroup = shift;
[66]3059 my $permissions = shift;
[18]3060
[66]3061 # 0 indicates "custom", hardcoded.
[18]3062 # Any other value clones that group's default records, if it exists.
[66]3063 my $inherit = shift || 0;
3064##fixme: need a flag to indicate clone records or <?> ?
[18]3065
3066 # Allow transactions, and raise an exception on errors so we can catch it later.
3067 # Use local to make sure these get "reset" properly on exiting this block
3068 local $dbh->{AutoCommit} = 0;
3069 local $dbh->{RaiseError} = 1;
3070
[292]3071 my ($group_id) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($groupname));
[38]3072
3073 return ('FAIL', "Group already exists") if $group_id;
3074
[18]3075 # Wrap all the SQL in a transaction
3076 eval {
[292]3077 $dbh->do("INSERT INTO groups (parent_group_id,group_name) VALUES (?,?)", undef, ($pargroup, $groupname) );
[18]3078
[292]3079 my ($groupid) = $dbh->selectrow_array("SELECT currval('groups_group_id_seq')");
[18]3080
[292]3081 # We work through the whole set of permissions instead of specifying them so
3082 # that when we add a new permission, we don't have to change the code anywhere
3083 # that doesn't explicitly deal with that specific permission.
3084 my @permvals;
3085 foreach (@permtypes) {
3086 if (!defined ($permissions->{$_})) {
3087 push @permvals, 0;
3088 } else {
3089 push @permvals, $permissions->{$_};
[66]3090 }
[292]3091 }
3092 $dbh->do("INSERT INTO permissions (group_id,$permlist) values (?".',?'x($#permtypes+1).")",
3093 undef, ($groupid, @permvals) );
3094 my ($permid) = $dbh->selectrow_array("SELECT currval('permissions_permission_id_seq')");
3095 $dbh->do("UPDATE groups SET permission_id=$permid WHERE group_id=$groupid");
[66]3096
[292]3097 # Default records
[255]3098 my $sthf = $dbh->prepare("INSERT INTO default_records (group_id,host,type,val,distance,weight,port,ttl) ".
[20]3099 "VALUES ($groupid,?,?,?,?,?,?,?)");
[255]3100 my $sthr = $dbh->prepare("INSERT INTO default_rev_records (group_id,host,type,val,ttl) ".
3101 "VALUES ($groupid,?,?,?,?)");
[66]3102 if ($inherit) {
[87]3103 # Duplicate records from parent. Actually relying on inherited records feels
3104 # very fragile, and it would be problematic to roll over at a later time.
[18]3105 my $sth2 = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
[87]3106 $sth2->execute($pargroup);
[18]3107 while (my @clonedata = $sth2->fetchrow_array) {
[255]3108 $sthf->execute(@clonedata);
[18]3109 }
[255]3110 # And now the reverse records
[292]3111 $sth2 = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
[255]3112 $sth2->execute($pargroup);
3113 while (my @clonedata = $sth2->fetchrow_array) {
3114 $sthr->execute(@clonedata);
3115 }
[18]3116 } else {
[66]3117##fixme: Hardcoding is Bad, mmmmkaaaay?
[18]3118 # reasonable basic defaults for SOA, MX, NS, and minimal hosting
3119 # could load from a config file, but somewhere along the line we need hardcoded bits.
[255]3120 $sthf->execute('ns1.example.com:hostmaster.example.com', 6, '10800:3600:604800:10800', 0, 0, 0, 86400);
3121 $sthf->execute('DOMAIN', 1, '192.168.4.2', 0, 0, 0, 7200);
3122 $sthf->execute('DOMAIN', 15, 'mx.example.com', 10, 0, 0, 7200);
3123 $sthf->execute('DOMAIN', 2, 'ns1.example.com', 0, 0, 0, 7200);
3124 $sthf->execute('DOMAIN', 2, 'ns2.example.com', 0, 0, 0, 7200);
3125 $sthf->execute('www.DOMAIN', 5, 'DOMAIN', 0, 0, 0, 7200);
3126 # reasonable basic defaults for generic reverse zone. Same as initial SQL tabledef.
3127 $sthr->execute('hostmaster.ADMINDOMAIN:ns1.ADMINDOMAIN', 6, '10800:3600:604800:10800', 86400);
3128 $sthr->execute('unused-%r.ADMINDOMAIN', 65283, 'ZONE', 3600);
[18]3129 }
3130
[487]3131 $self->_log(group_id => $pargroup, entry => "Added group $groupname");
[292]3132
[18]3133 # once we get here, we should have suceeded.
3134 $dbh->commit;
3135 }; # end eval
3136
3137 if ($@) {
3138 my $msg = $@;
3139 eval { $dbh->rollback; };
[517]3140 if ($self->{log_failures}) {
[487]3141 $self->_log(group_id => $pargroup, entry => "Failed to add group $groupname: $msg");
[292]3142 $dbh->commit;
3143 }
[18]3144 return ('FAIL',$msg);
3145 }
3146
[292]3147 return ('OK','OK');
[18]3148} # end addGroup()
3149
3150
[22]3151## DNSDB::delGroup()
3152# Delete a group.
3153# Takes a group ID
3154# Returns a status code and message
3155sub delGroup {
[476]3156 my $self = shift;
3157 my $dbh = $self->{dbh};
[22]3158 my $groupid = shift;
3159
3160 # Allow transactions, and raise an exception on errors so we can catch it later.
3161 # Use local to make sure these get "reset" properly on exiting this block
3162 local $dbh->{AutoCommit} = 0;
3163 local $dbh->{RaiseError} = 1;
3164
3165##fixme: locate "knowable" error conditions and deal with them before the eval
[23]3166# ... or inside, whatever.
[22]3167# -> domains still exist in group
3168# -> ...
[23]3169 my $failmsg = '';
[293]3170 my $resultmsg = '';
[22]3171
[293]3172 # collect some pieces for logging and error messages
[473]3173 my $groupname = $self->groupName($groupid);
3174 my $parid = $self->parentID(id => $groupid, type => 'group');
[293]3175
[22]3176 # Wrap all the SQL in a transaction
3177 eval {
[293]3178 # Check for Things in the group
3179 $failmsg = "Can't remove group $groupname";
3180 my ($grpcnt) = $dbh->selectrow_array("SELECT count(*) FROM groups WHERE parent_group_id=?", undef, ($groupid));
3181 die "$grpcnt groups still in group\n" if $grpcnt;
3182 my ($domcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($groupid));
[23]3183 die "$domcnt domains still in group\n" if $domcnt;
[512]3184 my ($revcnt) = $dbh->selectrow_array("SELECT count(*) FROM revzones WHERE group_id=?", undef, ($groupid));
3185 die "$revcnt reverse zones still in group\n" if $revcnt;
[293]3186 my ($usercnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($groupid));
3187 die "$usercnt users still in group\n" if $usercnt;
[23]3188
[293]3189 $failmsg = "Failed to delete default records for $groupname";
3190 $dbh->do("DELETE from default_records WHERE group_id=?", undef, ($groupid));
3191 $failmsg = "Failed to delete default reverse records for $groupname";
3192 $dbh->do("DELETE from default_rev_records WHERE group_id=?", undef, ($groupid));
3193 $failmsg = "Failed to remove group $groupname";
3194 $dbh->do("DELETE from groups WHERE group_id=?", undef, ($groupid));
[22]3195
[487]3196 $self->_log(group_id => $parid, entry => "Deleted group $groupname");
[293]3197 $resultmsg = "Deleted group $groupname";
3198
[22]3199 # once we get here, we should have suceeded.
3200 $dbh->commit;
3201 }; # end eval
3202
3203 if ($@) {
3204 my $msg = $@;
3205 eval { $dbh->rollback; };
[517]3206 if ($self->{log_failures}) {
[487]3207 $self->_log(group_id => $parid, entry => "$failmsg: $msg");
[293]3208 $dbh->commit; # since we enabled transactions earlier
3209 }
[23]3210 return ('FAIL',"$failmsg: $msg");
[22]3211 }
[293]3212
3213 return ('OK',$resultmsg);
[22]3214} # end delGroup()
3215
3216
[19]3217## DNSDB::getChildren()
3218# Get a list of all groups whose parent^n is group <n>
[24]3219# Takes a database handle, group ID, reference to an array to put the group IDs in,
3220# and an optional flag to return only immediate children or all children-of-children
3221# default to returning all children
[19]3222# Calls itself
3223sub getChildren {
3224 $errstr = '';
[476]3225 my $self = shift;
3226 my $dbh = $self->{dbh};
[20]3227 my $rootgroup = shift;
3228 my $groupdest = shift;
[24]3229 my $immed = shift || 'all';
[19]3230
3231 # special break for default group; otherwise we get stuck.
[20]3232 if ($rootgroup == 1) {
[19]3233 # by definition, group 1 is the Root Of All Groups
[24]3234 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE NOT (group_id=1)".
[331]3235 ($immed ne 'all' ? " AND parent_group_id=1" : '')." ORDER BY group_name");
[19]3236 $sth->execute;
3237 while (my @this = $sth->fetchrow_array) {
[20]3238 push @$groupdest, @this;
[19]3239 }
3240 } else {
[331]3241 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE parent_group_id=? ORDER BY group_name");
[20]3242 $sth->execute($rootgroup);
[19]3243 return if $sth->rows == 0;
[20]3244 my @grouplist;
3245 while (my ($group) = $sth->fetchrow_array) {
3246 push @$groupdest, $group;
[476]3247 $self->getChildren($group, $groupdest) if $immed eq 'all';
[19]3248 }
3249 }
3250} # end getChildren()
3251
3252
[20]3253## DNSDB::groupName()
[17]3254# Return the group name based on a group ID
3255# Takes a database handle and the group ID
3256# Returns the group name or undef on failure
[20]3257sub groupName {
[13]3258 $errstr = '';
[473]3259 my $self = shift;
3260 my $dbh = $self->{dbh};
[20]3261 my $groupid = shift;
3262 my $sth = $dbh->prepare("SELECT group_name FROM groups WHERE group_id=?");
3263 $sth->execute($groupid);
3264 my ($groupname) = $sth->fetchrow_array();
3265 $errstr = $DBI::errstr if !$groupname;
3266 return $groupname if $groupname;
3267} # end groupName
[13]3268
3269
[314]3270## DNSDB::getGroupCount()
3271# Get count of subgroups in group or groups
3272# Takes a database handle and hash containing:
3273# - the "current" group
3274# - an array of "acceptable" groups
3275# - Optionally accept a "starts with" and/or "contains" filter argument
3276# Returns an integer count of the resulting group list.
3277sub getGroupCount {
[476]3278 my $self = shift;
3279 my $dbh = $self->{dbh};
[314]3280
3281 my %args = @_;
3282
[509]3283 # Fail on bad curgroup argument. There's no sane fallback on this one.
3284 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3285 $errstr = "Bad or missing curgroup argument";
3286 return;
3287 }
3288 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3289 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3290 $errstr = "Bad childlist argument";
3291 return;
3292 }
3293
[314]3294 my @filterargs;
3295 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3296 push @filterargs, "^$args{startwith}" if $args{startwith};
3297 push @filterargs, $args{filter} if $args{filter};
3298
3299 my $sql = "SELECT count(*) FROM groups ".
3300 "WHERE parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3301 ($args{startwith} ? " AND group_name ~* ?" : '').
3302 ($args{filter} ? " AND group_name ~* ?" : '');
3303 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
3304 $errstr = $dbh->errstr if !$count;
3305 return $count;
3306} # end getGroupCount
3307
3308
3309## DNSDB::getGroupList()
3310# Get a list of sub^n-groups in the specified group(s)
3311# Takes the same arguments as getGroupCount() above
3312# Returns an arrayref containing hashrefs suitable for feeding straight to HTML::Template
3313sub getGroupList {
[476]3314 my $self = shift;
3315 my $dbh = $self->{dbh};
[314]3316
3317 my %args = @_;
3318
[509]3319 # Fail on bad curgroup argument. There's no sane fallback on this one.
3320 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3321 $errstr = "Bad or missing curgroup argument";
3322 return;
3323 }
3324 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3325 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3326 $errstr = "Bad childlist argument";
3327 return;
3328 }
3329
[314]3330 my @filterargs;
3331 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3332 push @filterargs, "^$args{startwith}" if $args{startwith};
3333 push @filterargs, $args{filter} if $args{filter};
3334
3335 # protection against bad or missing arguments
[508]3336 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
3337 $args{sortby} = 'group' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
[397]3338 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[314]3339
3340 # munge sortby for columns in database
3341 $args{sortby} = 'g.group_name' if $args{sortby} eq 'group';
3342 $args{sortby} = 'g2.group_name' if $args{sortby} eq 'parent';
3343
[385]3344 my $sql = q(SELECT g.group_id AS groupid, g.group_name AS groupname, g2.group_name AS pgroup
[314]3345 FROM groups g
3346 INNER JOIN groups g2 ON g2.group_id=g.parent_group_id
3347 ).
[385]3348 " WHERE g.parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
[314]3349 ($args{startwith} ? " AND g.group_name ~* ?" : '').
3350 ($args{filter} ? " AND g.group_name ~* ?" : '').
3351 " GROUP BY g.group_id, g.group_name, g2.group_name ".
3352 " ORDER BY $args{sortby} $args{sortorder} ".
[517]3353 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
[314]3354 my $glist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
3355 $errstr = $dbh->errstr if !$glist;
[385]3356
3357 # LEFT JOINs make the result set balloon beyond sanity just to include counts;
3358 # this means there's lots of crunching needed to trim the result set back down.
3359 # So instead we track the order of the groups, and push the counts into the
3360 # arrayref result separately.
3361##fixme: put this whole sub in a transaction? might be
3362# needed for accurate results on very busy systems.
[386]3363##fixme: large group lists need prepared statements?
3364#my $ucsth = $dbh->prepare("SELECT count(*) FROM users WHERE group_id=?");
3365#my $dcsth = $dbh->prepare("SELECT count(*) FROM domains WHERE group_id=?");
3366#my $rcsth = $dbh->prepare("SELECT count(*) FROM revzones WHERE group_id=?");
[385]3367 foreach (@{$glist}) {
[386]3368 my ($ucnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($$_{groupid}));
3369 $$_{nusers} = $ucnt;
3370 my ($dcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($$_{groupid}));
3371 $$_{ndomains} = $dcnt;
3372 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM revzones WHERE group_id=?", undef, ($$_{groupid}));
3373 $$_{nrevzones} = $rcnt;
[385]3374 }
3375
[314]3376 return $glist;
3377} # end getGroupList
3378
3379
[118]3380## DNSDB::groupID()
3381# Return the group ID based on the group name
3382# Takes a database handle and the group name
3383# Returns the group ID or undef on failure
3384sub groupID {
3385 $errstr = '';
[473]3386 my $self = shift;
3387 my $dbh = $self->{dbh};
[118]3388 my $group = shift;
[406]3389 my ($grpid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($group) );
[118]3390 $errstr = $DBI::errstr if !$grpid;
3391 return $grpid if $grpid;
3392} # end groupID()
3393
3394
[24]3395## DNSDB::addUser()
[87]3396# Add a user.
3397# Takes a DB handle, username, group ID, password, state (active/inactive).
3398# Optionally accepts:
3399# user type (user/admin) - defaults to user
3400# permissions string - defaults to inherit from group
3401# three valid forms:
3402# i - Inherit permissions
3403# c:<user_id> - Clone permissions from <user_id>
3404# C:<permission list> - Set these specific permissions
3405# first name - defaults to username
3406# last name - defaults to blank
3407# phone - defaults to blank (could put other data within column def)
[90]3408# Returns (OK,<uid>) on success, (FAIL,<message>) on failure
[24]3409sub addUser {
3410 $errstr = '';
[479]3411 my $self = shift;
3412 my $dbh = $self->{dbh};
[24]3413 my $username = shift;
3414 my $group = shift;
3415 my $pass = shift;
3416 my $state = shift;
[25]3417
[90]3418 return ('FAIL', "Missing one or more required entries") if !defined($state);
3419 return ('FAIL', "Username must not be blank") if !$username;
[87]3420
[408]3421 # Munge in some alternate state values
3422 $state = 1 if $state =~ /^active$/;
3423 $state = 1 if $state =~ /^on$/;
3424 $state = 0 if $state =~ /^inactive$/;
3425 $state = 0 if $state =~ /^off$/;
3426
[25]3427 my $type = shift || 'u'; # create limited users by default - fwiw, not sure yet how this will interact with ACLs
3428
[67]3429 my $permstring = shift || 'i'; # default is to inhert permissions from group
3430
[25]3431 my $fname = shift || $username;
[24]3432 my $lname = shift || '';
[25]3433 my $phone = shift || ''; # not going format-check
[24]3434
[38]3435 my $sth = $dbh->prepare("SELECT user_id FROM users WHERE username=?");
[24]3436 my $user_id;
3437
[38]3438# quick check to start to see if we've already got one
3439 $sth->execute($username);
3440 ($user_id) = $sth->fetchrow_array;
3441
3442 return ('FAIL', "User already exists") if $user_id;
3443
[24]3444 # Allow transactions, and raise an exception on errors so we can catch it later.
3445 # Use local to make sure these get "reset" properly on exiting this block
3446 local $dbh->{AutoCommit} = 0;
3447 local $dbh->{RaiseError} = 1;
3448
3449 # Wrap all the SQL in a transaction
3450 eval {
[87]3451 # insert the user... note we set inherited perms by default since
3452 # it's simple and cleans up some other bits of state
[592]3453##fixme: need better handling of case of inherited or missing (!!) permissions entries
[87]3454 my $sth = $dbh->prepare("INSERT INTO users ".
3455 "(group_id,username,password,firstname,lastname,phone,type,status,permission_id,inherit_perm) ".
3456 "VALUES (?,?,?,?,?,?,?,?,(SELECT permission_id FROM permissions WHERE group_id=?),'t')");
3457 $sth->execute($group,$username,unix_md5_crypt($pass),$fname,$lname,$phone,$type,$state,$group);
[24]3458
3459 # get the ID...
[94]3460 ($user_id) = $dbh->selectrow_array("SELECT currval('users_user_id_seq')");
[24]3461
[87]3462# Permissions! Gotta set'em all!
[401]3463 die "Invalid permission string $permstring\n"
[87]3464 if $permstring !~ /^(?:
3465 i # inherit
3466 |c:\d+ # clone
3467 # custom. no, the leading , is not a typo
[391]3468 |C:(?:,(?:group|user|domain|record|location|self)_(?:edit|create|delete|locchg|view))*
[87]3469 )$/x;
3470# bleh. I'd call another function to do my dirty work, but we're in the middle of a transaction already.
3471 if ($permstring ne 'i') {
3472 # for cloned or custom permissions, we have to create a new permissions entry.
3473 my $clonesrc = $group;
3474 if ($permstring =~ /^c:(\d+)/) { $clonesrc = $1; }
3475 $dbh->do("INSERT INTO permissions ($permlist,user_id) ".
3476 "SELECT $permlist,? FROM permissions WHERE permission_id=".
3477 "(SELECT permission_id FROM permissions WHERE ".($permstring =~ /^c:/ ? 'user' : 'group')."_id=?)",
3478 undef, ($user_id,$clonesrc) );
3479 $dbh->do("UPDATE users SET permission_id=".
3480 "(SELECT permission_id FROM permissions WHERE user_id=?) ".
3481 "WHERE user_id=?", undef, ($user_id, $user_id) );
3482 }
3483 if ($permstring =~ /^C:/) {
3484 # finally for custom permissions, we set the passed-in permissions (and unset
3485 # any that might have been brought in by the clone operation above)
3486 my ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions WHERE user_id=?",
3487 undef, ($user_id) );
3488 foreach (@permtypes) {
3489 if ($permstring =~ /,$_/) {
3490 $dbh->do("UPDATE permissions SET $_='t' WHERE permission_id=?", undef, ($permid) );
3491 } else {
3492 $dbh->do("UPDATE permissions SET $_='f' WHERE permission_id=?", undef, ($permid) );
3493 }
3494 }
3495 }
3496
3497 $dbh->do("UPDATE users SET inherit_perm='n' WHERE user_id=?", undef, ($user_id) );
3498
[25]3499##fixme: add another table to hold name/email for log table?
3500
[487]3501 $self->_log(group_id => $group, entry => "Added user $username ($fname $lname)");
[24]3502 # once we get here, we should have suceeded.
3503 $dbh->commit;
3504 }; # end eval
3505
3506 if ($@) {
3507 my $msg = $@;
3508 eval { $dbh->rollback; };
[517]3509 if ($self->{log_failures}) {
[487]3510 $self->_log(group_id => $group, entry => "Error adding user $username: $msg");
[294]3511 $dbh->commit; # since we enabled transactions earlier
3512 }
3513 return ('FAIL',"Error adding user $username: $msg");
[24]3514 }
[294]3515
3516 return ('OK',"User $username ($fname $lname) added");
[24]3517} # end addUser
3518
3519
[325]3520## DNSDB::getUserCount()
3521# Get count of users in group
3522# Takes a database handle and hash containing at least the current group, and optionally:
3523# - a reference list of secondary groups
3524# - a filter string
3525# - a "Starts with" string
3526sub getUserCount {
[479]3527 my $self = shift;
3528 my $dbh = $self->{dbh};
[325]3529
3530 my %args = @_;
3531
[509]3532 # Fail on bad curgroup argument. There's no sane fallback on this one.
3533 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3534 $errstr = "Bad or missing curgroup argument";
3535 return;
3536 }
3537 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3538 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3539 $errstr = "Bad childlist argument";
3540 return;
3541 }
3542
[325]3543 my @filterargs;
3544 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3545 push @filterargs, "^$args{startwith}" if $args{startwith};
3546 push @filterargs, $args{filter} if $args{filter};
3547
3548 my $sql = "SELECT count(*) FROM users ".
3549 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3550 ($args{startwith} ? " AND username ~* ?" : '').
[730]3551 ($args{filter} ? " AND username ~* ?" : '').
3552 " AND NOT type = 'R' ";
[325]3553 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
3554 $errstr = $dbh->errstr if !$count;
3555 return $count;
3556} # end getUserCount()
3557
3558
3559## DNSDB::getUserList()
3560# Get list of users
3561# Takes the same arguments as getUserCount() above, plus optional:
3562# - sort field
3563# - sort order
3564# - offset/return-all-everything flag (defaults to $perpage records)
3565sub getUserList {
[479]3566 my $self = shift;
3567 my $dbh = $self->{dbh};
[325]3568
3569 my %args = @_;
3570
[509]3571 # Fail on bad curgroup argument. There's no sane fallback on this one.
3572 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
3573 $errstr = "Bad or missing curgroup argument";
3574 return;
3575 }
3576 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
3577 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
3578 $errstr = "Bad childlist argument";
3579 return;
3580 }
3581
[325]3582 my @filterargs;
3583 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3584 push @filterargs, "^$args{startwith}" if $args{startwith};
3585 push @filterargs, $args{filter} if $args{filter};
3586
3587 # better to request sorts on "simple" names, but it means we need to map it to real columns
3588 my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
3589 fname => 'fname');
3590 $args{sortby} = $sortmap{$args{sortby}};
3591
3592 # protection against bad or missing arguments
[508]3593 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
3594 $args{sortby} = 'u.username' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
[397]3595 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[325]3596
3597 my $sql = "SELECT u.user_id, u.username, u.firstname || ' ' || u.lastname AS fname, u.type, g.group_name, u.status ".
3598 "FROM users u ".
3599 "INNER JOIN groups g ON u.group_id=g.group_id ".
3600 "WHERE u.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3601 ($args{startwith} ? " AND u.username ~* ?" : '').
3602 ($args{filter} ? " AND u.username ~* ?" : '').
[401]3603 " AND NOT u.type = 'R' ".
[325]3604 " ORDER BY $args{sortby} $args{sortorder} ".
[517]3605 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
[325]3606 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
3607 $errstr = $dbh->errstr if !$ulist;
3608 return $ulist;
3609} # end getUserList()
3610
3611
[326]3612## DNSDB::getUserDropdown()
3613# Get a list of usernames for use in a dropdown menu.
3614# Takes a database handle, current group, and optional "tag this as selected" flag.
3615# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
3616sub getUserDropdown {
[479]3617 my $self = shift;
3618 my $dbh = $self->{dbh};
[326]3619 my $grp = shift;
3620 my $sel = shift || 0;
3621
[720]3622 my $sth = $dbh->prepare("SELECT username,user_id FROM users WHERE group_id=? AND password <> 'RPC'");
[326]3623 $sth->execute($grp);
3624
3625 my @userlist;
3626 while (my ($username,$uid) = $sth->fetchrow_array) {
3627 my %row = (
3628 username => $username,
3629 uid => $uid,
3630 selected => ($sel == $uid ? 1 : 0)
3631 );
3632 push @userlist, \%row;
3633 }
3634 return \@userlist;
3635} # end getUserDropdown()
3636
3637
[83]3638## DNSDB:: updateUser()
[90]3639# Update general data about user
[83]3640sub updateUser {
[479]3641 my $self = shift;
3642 my $dbh = $self->{dbh};
[118]3643
3644##fixme: tweak calling convention so that we can update any given bit of data
[83]3645 my $uid = shift;
3646 my $username = shift;
3647 my $group = shift;
3648 my $pass = shift;
3649 my $state = shift;
[87]3650 my $type = shift || 'u';
[83]3651 my $fname = shift || $username;
3652 my $lname = shift || '';
3653 my $phone = shift || ''; # not going format-check
3654
[294]3655 my $resultmsg = '';
[83]3656
[411]3657 # Munge in some alternate state values
3658 $state = 1 if $state =~ /^active$/;
3659 $state = 1 if $state =~ /^on$/;
3660 $state = 0 if $state =~ /^inactive$/;
3661 $state = 0 if $state =~ /^off$/;
3662
[83]3663 # Allow transactions, and raise an exception on errors so we can catch it later.
3664 # Use local to make sure these get "reset" properly on exiting this block
3665 local $dbh->{AutoCommit} = 0;
3666 local $dbh->{RaiseError} = 1;
3667
3668 my $sth;
3669
3670 # Password can be left blank; if so we assume there's one on file.
3671 # Actual blank passwords are bad, mm'kay?
3672 if (!$pass) {
[294]3673 ($pass) = $dbh->selectrow_array("SELECT password FROM users WHERE user_id=?", undef, ($uid));
[83]3674 } else {
3675 $pass = unix_md5_crypt($pass);
3676 }
3677
3678 eval {
[294]3679 $dbh->do("UPDATE users SET username=?, password=?, firstname=?, lastname=?, phone=?, type=?, status=?".
3680 " WHERE user_id=?", undef, ($username, $pass, $fname, $lname, $phone, $type, $state, $uid));
3681 $resultmsg = "Updated user info for $username ($fname $lname)";
[487]3682 $self->_log(group_id => $group, entry => $resultmsg);
[83]3683 $dbh->commit;
3684 };
3685 if ($@) {
3686 my $msg = $@;
3687 eval { $dbh->rollback; };
[517]3688 if ($self->{log_failures}) {
[487]3689 $self->_log(group_id => $group, entry => "Error updating user $username: $msg");
[294]3690 $dbh->commit; # since we enabled transactions earlier
3691 }
3692 return ('FAIL',"Error updating user $username: $msg");
[83]3693 }
[294]3694
3695 return ('OK',$resultmsg);
[83]3696} # end updateUser()
3697
3698
[24]3699## DNSDB::delUser()
[297]3700# Delete a user.
3701# Takes a database handle and user ID
3702# Returns a success/failure code and matching message
[24]3703sub delUser {
[479]3704 my $self = shift;
3705 my $dbh = $self->{dbh};
[25]3706 my $userid = shift;
3707
[297]3708 return ('FAIL',"Bad userid") if !defined($userid);
[25]3709
[479]3710 my $userdata = $self->getUserData($userid);
[25]3711
[297]3712 # Allow transactions, and raise an exception on errors so we can catch it later.
3713 # Use local to make sure these get "reset" properly on exiting this block
3714 local $dbh->{AutoCommit} = 0;
3715 local $dbh->{RaiseError} = 1;
[25]3716
[297]3717 eval {
3718 $dbh->do("DELETE FROM users WHERE user_id=?", undef, ($userid));
[487]3719 $self->_log(group_id => $userdata->{group_id},
[297]3720 entry => "Deleted user ID $userid/".$userdata->{username}.
[487]3721 " (".$userdata->{firstname}." ".$userdata->{lastname}.")");
[297]3722 $dbh->commit;
3723 };
3724 if ($@) {
3725 my $msg = $@;
3726 eval { $dbh->rollback; };
[517]3727 if ($self->{log_failures}) {
[487]3728 $self->_log(group_id => $userdata->{group_id}, entry => "Error deleting user ID ".
3729 "$userid/".$userdata->{username}.": $msg");
[297]3730 $dbh->commit;
3731 }
3732 return ('FAIL',"Error deleting user $userid/".$userdata->{username}.": $msg");
3733 }
3734
3735 return ('OK',"Deleted user ".$userdata->{username}." (".$userdata->{firstname}." ".$userdata->{lastname}.")");
[24]3736} # end delUser
3737
3738
[25]3739## DNSDB::userFullName()
3740# Return a pretty string!
3741# Takes a user_id and optional printf-ish string to indicate which pieces where:
3742# %u for the username
3743# %f for the first name
3744# %l for the last name
3745# All other text in the passed string will be left as-is.
3746##fixme: need a "smart" option too, so that missing/null/blank first/last names don't give funky output
3747sub userFullName {
3748 $errstr = '';
[473]3749 my $self = shift;
3750 my $dbh = $self->{dbh};
[25]3751 my $userid = shift;
3752 my $fullformat = shift || '%f %l (%u)';
3753 my $sth = $dbh->prepare("select username,firstname,lastname from users where user_id=?");
3754 $sth->execute($userid);
3755 my ($uname,$fname,$lname) = $sth->fetchrow_array();
3756 $errstr = $DBI::errstr if !$uname;
3757
[732]3758 no warnings qw (uninitialized);
[25]3759 $fullformat =~ s/\%u/$uname/g;
3760 $fullformat =~ s/\%f/$fname/g;
3761 $fullformat =~ s/\%l/$lname/g;
3762
3763 return $fullformat;
3764} # end userFullName
3765
3766
[51]3767## DNSDB::userStatus()
3768# Sets and/or returns a user's status
3769# Takes a database handle, user ID and optionally a status argument
3770# Returns undef on errors.
3771sub userStatus {
[479]3772 my $self = shift;
3773 my $dbh = $self->{dbh};
[51]3774 my $id = shift;
[296]3775 my $newstatus = shift || 'mu';
[51]3776
3777 return undef if $id !~ /^\d+$/;
3778
[479]3779 my $userdata = $self->getUserData($id);
[51]3780
[296]3781 # Allow transactions, and raise an exception on errors so we can catch it later.
3782 # Use local to make sure these get "reset" properly on exiting this block
3783 local $dbh->{AutoCommit} = 0;
3784 local $dbh->{RaiseError} = 1;
3785
3786 if ($newstatus ne 'mu') {
3787 # ooo, fun! let's see what we were passed for status
3788 eval {
3789 $newstatus = 0 if $newstatus eq 'useroff';
3790 $newstatus = 1 if $newstatus eq 'useron';
3791 $dbh->do("UPDATE users SET status=? WHERE user_id=?", undef, ($newstatus, $id));
3792
[297]3793 $resultstr = ($newstatus ? 'Enabled' : 'Disabled')." user ".$userdata->{username}.
3794 " (".$userdata->{firstname}." ".$userdata->{lastname}.")";
[296]3795
3796 my %loghash;
[473]3797 $loghash{group_id} = $self->parentID(id => $id, type => 'user');
[296]3798 $loghash{entry} = $resultstr;
[487]3799 $self->_log(%loghash);
[296]3800
3801 $dbh->commit;
3802 };
3803 if ($@) {
3804 my $msg = $@;
3805 eval { $dbh->rollback; };
3806 $resultstr = '';
3807 $errstr = $msg;
3808##fixme: failure logging?
3809 return;
[51]3810 }
3811 }
3812
[296]3813 my ($status) = $dbh->selectrow_array("SELECT status FROM users WHERE user_id=?", undef, ($id));
[51]3814 return $status;
3815} # end userStatus()
3816
3817
[83]3818## DNSDB::getUserData()
3819# Get misc user data for display
3820sub getUserData {
[479]3821 my $self = shift;
3822 my $dbh = $self->{dbh};
[83]3823 my $uid = shift;
3824
3825 my $sth = $dbh->prepare("SELECT group_id,username,firstname,lastname,phone,type,status,inherit_perm ".
3826 "FROM users WHERE user_id=?");
3827 $sth->execute($uid);
3828 return $sth->fetchrow_hashref();
3829} # end getUserData()
3830
3831
[370]3832## DNSDB::addLoc()
[375]3833# Add a new location.
3834# Takes a database handle, group ID, short and long description, and a comma-separated
3835# list of IP addresses.
3836# Returns ('OK',<location>) on success, ('FAIL',<failmsg>) on failure
3837sub addLoc {
[480]3838 my $self = shift;
3839 my $dbh = $self->{dbh};
[709]3840 my %args = @_;
[370]3841
[709]3842 my $grp = $args{group};
3843 my $shdesc = $args{desc};
3844 my $comments = $args{comments};
3845 my $iplist = $args{iplist};
3846
[375]3847 # $shdesc gets set to the generated location ID if possible, but these can be de-undefined here.
3848 $comments = '' if !$comments;
3849 $iplist = '' if !$iplist;
3850
[709]3851 # allow requesting a specific location entry.
3852 my $loc = $args{loc};
[375]3853
3854 # Generate a location ID. This is, by spec, a two-character widget. We'll use [a-z][a-z]
3855 # for now; 676 locations should satisfy all but the largest of the huge networks.
3856
[709]3857 # just to be as clear as possible; as per http://cr.yp.to/djbdns/tinydns-data.html:
[699]3858
3859#For versions 1.04 and above: You may include a client location on each line. The line is ignored for clients
3860#outside that location. Client locations are specified by % lines:
3861#
3862# %lo:ipprefix
3863#
3864#means that IP addresses starting with ipprefix are in location lo. lo is a sequence of one or two ASCII letters.
3865
[709]3866 # this has been confirmed by experiment; locations "lo", "Lo", and "lO" are all distinct.
[699]3867
[375]3868# add just after "my $origloc = $loc;":
3869# # These expand the possible space from 26^2 to 52^2 [* note in testing only 2052 were achieved],
3870# # and wrap it around.
3871# # Yes, they skip a couple of possibles. No, I don't care.
3872# $loc = 'aA' if $loc eq 'zz';
3873# $loc = 'Aa' if $loc eq 'zZ';
3874# $loc = 'ZA' if $loc eq 'Zz';
3875# $loc = 'aa' if $loc eq 'ZZ';
3876
3877 # Allow transactions, and raise an exception on errors so we can catch it later.
3878 # Use local to make sure these get "reset" properly on exiting this block
3879 local $dbh->{AutoCommit} = 0;
3880 local $dbh->{RaiseError} = 1;
3881
3882##fixme: There is probably a far better way to do this. Sequential increments
3883# are marginally less stupid that pure random generation though, and the existence
3884# check makes sure we don't stomp on an imported one.
3885
3886 eval {
3887 # Get the "last" location. Note this is the only use for loc_id, because selecting on location Does Funky Things
[709]3888 my ($newloc) = $dbh->selectrow_array("SELECT location FROM locations ORDER BY loc_id DESC LIMIT 1");
3889
3890 no warnings qw(uninitialized);
3891
3892 my $ecnt = $dbh->prepare("SELECT count(*) FROM locations WHERE location LIKE ?");
3893
3894 if ($loc) {
3895 $ecnt->execute($loc);
3896 if (($ecnt->fetchrow_array())[0]) {
3897 # too bad, so sad, requested location is unavailable.
3898##fixme: known failure case: caller requests a location ID that is not two characters.
3899 die "Requested location is already defined\n" if $args{reqonly};
3900 # fall back to autoincrement
3901 }
3902 $newloc = $loc;
3903 }
3904
3905 # Either the requested location ID is unavailable and the caller isn't too attached
3906 # to it, OR, the caller hasn't specified a location ID. (The second case should be
3907 # far more common.) Find the "next available" location identifier.
3908
3909 ($newloc) = ($newloc =~ /^(..)/) if $newloc;
3910 my $origloc = $newloc;
3911 $newloc = 'aa' if !$newloc;
[375]3912 # Make a change...
3913 # ... and keep changing if it exists
[709]3914 while ($dbh->selectrow_array("SELECT count(*) FROM locations WHERE location LIKE ?", undef, ($newloc.'%'))) {
3915 $newloc++;
3916 ($newloc) = ($newloc =~ /^(..)/);
3917 die "too many locations in use, can't add another one\n" if $newloc eq $origloc;
[375]3918##fixme: really need to handle this case faster somehow
3919#if $loc eq $origloc die "<thwap> bad admin: all locations used, your network is too fragmented";
3920 }
[709]3921 # And now we should have a unique location.
3922 $shdesc = $newloc if !$shdesc;
[375]3923 $dbh->do("INSERT INTO locations (location, group_id, iplist, description, comments) VALUES (?,?,?,?,?)",
[709]3924 undef, ($newloc, $grp, $iplist, $shdesc, $comments) );
[487]3925 $self->_log(entry => "Added location ($shdesc, '$iplist')");
[709]3926 $loc = $newloc;
[377]3927 $dbh->commit;
[375]3928 };
3929 if ($@) {
3930 my $msg = $@;
3931 eval { $dbh->rollback; };
[517]3932 if ($self->{log_failures}) {
[375]3933 $shdesc = $loc if !$shdesc;
[487]3934 $self->_log(entry => "Failed adding location ($shdesc, '$iplist'): $msg");
[375]3935 $dbh->commit;
3936 }
3937 return ('FAIL',$msg);
3938 }
3939
3940 return ('OK',$loc);
[377]3941} # end addLoc()
[375]3942
3943
[370]3944## DNSDB::updateLoc()
[428]3945# Update details of a location.
3946# Takes a database handle, location ID, group ID, short description,
3947# long comments/notes, and comma/space-separated IP list
3948# Returns a result code and message
[377]3949sub updateLoc {
[480]3950 my $self = shift;
3951 my $dbh = $self->{dbh};
[377]3952 my $loc = shift;
3953 my $grp = shift;
3954 my $shdesc = shift;
3955 my $comments = shift;
3956 my $iplist = shift;
[370]3957
[377]3958 $shdesc = '' if !$shdesc;
3959 $comments = '' if !$comments;
3960 $iplist = '' if !$iplist;
3961
3962 # Allow transactions, and raise an exception on errors so we can catch it later.
3963 # Use local to make sure these get "reset" properly on exiting this block
3964 local $dbh->{AutoCommit} = 0;
3965 local $dbh->{RaiseError} = 1;
3966
[480]3967 my $oldloc = $self->getLoc($loc);
[377]3968 my $okmsg = "Updated location (".$oldloc->{description}.", '".$oldloc->{iplist}."') to ($shdesc, '$iplist')";
3969
3970 eval {
3971 $dbh->do("UPDATE locations SET group_id=?,iplist=?,description=?,comments=? WHERE location=?",
3972 undef, ($grp, $iplist, $shdesc, $comments, $loc) );
[487]3973 $self->_log(entry => $okmsg);
[377]3974 $dbh->commit;
3975 };
3976 if ($@) {
3977 my $msg = $@;
3978 eval { $dbh->rollback; };
[517]3979 if ($self->{log_failures}) {
[377]3980 $shdesc = $loc if !$shdesc;
[487]3981 $self->_log(entry => "Failed updating location ($shdesc, '$iplist'): $msg");
[377]3982 $dbh->commit;
3983 }
3984 return ('FAIL',$msg);
3985 }
3986
3987 return ('OK',$okmsg);
3988} # end updateLoc()
3989
3990
[370]3991## DNSDB::delLoc()
[428]3992sub delLoc {
[480]3993 my $self = shift;
3994 my $dbh = $self->{dbh};
[428]3995 my $loc = shift;
[370]3996
[428]3997 # Allow transactions, and raise an exception on errors so we can catch it later.
3998 # Use local to make sure these get "reset" properly on exiting this block
3999 local $dbh->{AutoCommit} = 0;
4000 local $dbh->{RaiseError} = 1;
[370]4001
[480]4002 my $oldloc = $self->getLoc($loc);
[428]4003 my $olddesc = ($oldloc->{description} ? $oldloc->{description} : $loc);
4004 my $okmsg = "Deleted location ($olddesc, '".$oldloc->{iplist}."')";
4005
4006 eval {
4007 # Check for records with this location first. Deleting a location without deleting records
4008 # tagged for that location will render them unpublished without other warning.
4009 my ($r) = $dbh->selectrow_array("SELECT record_id FROM records WHERE location=? LIMIT 1", undef, ($loc) );
4010 die "Records still exist in location $olddesc\n" if $r;
4011 $dbh->do("DELETE FROM locations WHERE location=?", undef, ($loc) );
[487]4012 $self->_log(entry => $okmsg);
[428]4013 $dbh->commit;
4014 };
4015 if ($@) {
4016 my $msg = $@;
4017 eval { $dbh->rollback; };
[517]4018 if ($self->{log_failures}) {
[487]4019 $self->_log(entry => "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg");
[428]4020 $dbh->commit;
4021 }
4022 return ('FAIL', "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg");
4023 }
4024
4025 return ('OK',$okmsg);
4026} # end delLoc()
4027
4028
[375]4029## DNSDB::getLoc()
[428]4030# Get details about a location/view
4031# Takes a database handle and location ID.
4032# Returns a reference to a hash containing the group ID, IP list, description, and comments/notes
[375]4033sub getLoc {
[480]4034 my $self = shift;
4035 my $dbh = $self->{dbh};
[375]4036 my $loc = shift;
4037
4038 my $sth = $dbh->prepare("SELECT group_id,iplist,description,comments FROM locations WHERE location=?");
4039 $sth->execute($loc);
4040 return $sth->fetchrow_hashref();
4041} # end getLoc()
4042
4043
[370]4044## DNSDB::getLocCount()
4045# Get count of locations/views
4046# Takes a database handle and hash containing at least the current group, and optionally:
4047# - a reference list of secondary groups
4048# - a filter string
4049# - a "Starts with" string
4050sub getLocCount {
[480]4051 my $self = shift;
4052 my $dbh = $self->{dbh};
[370]4053
4054 my %args = @_;
4055
[509]4056 # Fail on bad curgroup argument. There's no sane fallback on this one.
4057 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
4058 $errstr = "Bad or missing curgroup argument";
4059 return;
4060 }
4061 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
4062 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
4063 $errstr = "Bad childlist argument";
4064 return;
4065 }
4066
[370]4067 my @filterargs;
4068 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
4069 push @filterargs, "^$args{startwith}" if $args{startwith};
4070 push @filterargs, $args{filter} if $args{filter};
4071
4072 my $sql = "SELECT count(*) FROM locations ".
4073 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
4074 ($args{startwith} ? " AND description ~* ?" : '').
4075 ($args{filter} ? " AND description ~* ?" : '');
4076 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
4077 $errstr = $dbh->errstr if !$count;
4078 return $count;
4079} # end getLocCount()
4080
4081
4082## DNSDB::getLocList()
4083sub getLocList {
[480]4084 my $self = shift;
4085 my $dbh = $self->{dbh};
[370]4086
4087 my %args = @_;
4088
[509]4089 # Fail on bad curgroup argument. There's no sane fallback on this one.
4090 if (!$args{curgroup} || $args{curgroup} !~ /^\d+$/) {
4091 $errstr = "Bad or missing curgroup argument";
4092 return;
4093 }
4094 # Fail on bad childlist argument. This could be sanely ignored if bad, maybe.
4095 if ($args{childlist} && $args{childlist} !~ /^[\d,]+$/) {
4096 $errstr = "Bad childlist argument";
4097 return;
4098 }
4099
[370]4100 my @filterargs;
4101 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
4102 push @filterargs, "^$args{startwith}" if $args{startwith};
4103 push @filterargs, $args{filter} if $args{filter};
4104
4105 # better to request sorts on "simple" names, but it means we need to map it to real columns
4106# my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
4107# fname => 'fname');
4108# $args{sortby} = $sortmap{$args{sortby}};
4109
4110 # protection against bad or missing arguments
[508]4111 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
4112 $args{sortby} = 'l.description' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
[397]4113 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[370]4114
4115 my $sql = "SELECT l.location, l.description, l.iplist, g.group_name ".
4116 "FROM locations l ".
4117 "INNER JOIN groups g ON l.group_id=g.group_id ".
4118 "WHERE l.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
4119 ($args{startwith} ? " AND l.description ~* ?" : '').
4120 ($args{filter} ? " AND l.description ~* ?" : '').
4121 " ORDER BY $args{sortby} $args{sortorder} ".
[517]4122 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
[370]4123 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
4124 $errstr = $dbh->errstr if !$ulist;
4125 return $ulist;
4126} # end getLocList()
4127
4128
4129## DNSDB::getLocDropdown()
[383]4130# Get a list of location names for use in a dropdown menu.
4131# Takes a database handle, current group, and optional "tag this as selected" flag.
4132# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
4133sub getLocDropdown {
[480]4134 my $self = shift;
4135 my $dbh = $self->{dbh};
[383]4136 my $grp = shift;
4137 my $sel = shift || '';
[370]4138
[383]4139 my $sth = $dbh->prepare(qq(
4140 SELECT description,location FROM locations
4141 WHERE group_id=?
4142 ORDER BY description
4143 ) );
4144 $sth->execute($grp);
[370]4145
[383]4146 my @loclist;
[446]4147 push @loclist, { locname => "(Default/All)", loc => '', selected => ($sel ? 0 : ($sel eq '' ? 1 : 0)) };
[383]4148 while (my ($locname, $loc) = $sth->fetchrow_array) {
4149 my %row = (
4150 locname => $locname,
4151 loc => $loc,
4152 selected => ($sel eq $loc ? 1 : 0)
4153 );
4154 push @loclist, \%row;
4155 }
4156 return \@loclist;
4157} # end getLocDropdown()
4158
4159
[2]4160## DNSDB::getSOA()
4161# Return all suitable fields from an SOA record in separate elements of a hash
[224]4162# Takes a database handle, default/live flag, domain/reverse flag, and parent ID
[2]4163sub getSOA {
4164 $errstr = '';
[481]4165 my $self = shift;
4166 my $dbh = $self->{dbh};
[2]4167 my $def = shift;
[224]4168 my $rev = shift;
[2]4169 my $id = shift;
4170
[224]4171 # (ab)use distance and weight columns to store SOA data? can't for default_rev_records...
4172 # - should really attach serial to the zone parent somewhere
[101]4173
[224]4174 my $sql = "SELECT record_id,host,val,ttl from "._rectable($def,$rev).
4175 " WHERE "._recparent($def,$rev)." = ? AND type=$reverse_typemap{SOA}";
[311]4176 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
4177 return if !$ret;
[246]4178##fixme: stick a flag somewhere if the record doesn't exist. by the API, this is an impossible case, but...
[2]4179
[311]4180 ($ret->{contact},$ret->{prins}) = split /:/, $ret->{host};
4181 delete $ret->{host};
4182 ($ret->{refresh},$ret->{retry},$ret->{expire},$ret->{minttl}) = split /:/, $ret->{val};
4183 delete $ret->{val};
[2]4184
[311]4185 return $ret;
[2]4186} # end getSOA()
4187
4188
[246]4189## DNSDB::updateSOA()
4190# Update the specified SOA record
4191# Takes a database handle, default/live flag, forward/reverse flag, and SOA data hash
[277]4192# Returns a two-element list with a result code and message
[246]4193sub updateSOA {
[473]4194 my $self = shift;
4195 my $dbh = $self->{dbh};
[246]4196 my $defrec = shift;
[248]4197 my $revrec = shift;
[246]4198
4199 my %soa = @_;
4200
[473]4201 my $oldsoa = $self->getSOA($defrec, $revrec, $soa{id});
[277]4202
[311]4203 my $msg;
4204 my %logdata;
4205 if ($defrec eq 'n') {
4206 $logdata{domain_id} = $soa{id} if $revrec eq 'n';
4207 $logdata{rdns_id} = $soa{id} if $revrec eq 'y';
[473]4208 $logdata{group_id} = $self->parentID(id => $soa{id}, revrec => $revrec,
4209 type => ($revrec eq 'n' ? 'domain' : 'revzone') );
[311]4210 } else {
4211 $logdata{group_id} = $soa{id};
4212 }
[473]4213 my $parname = ($defrec eq 'y' ? $self->groupName($soa{id}) :
4214 ($revrec eq 'n' ? $self->domainName($soa{id}) : $self->revName($soa{id})) );
[311]4215
[277]4216 # Allow transactions, and raise an exception on errors so we can catch it later.
4217 # Use local to make sure these get "reset" properly on exiting this block
4218 local $dbh->{AutoCommit} = 0;
4219 local $dbh->{RaiseError} = 1;
4220
4221 eval {
[565]4222 if (!$oldsoa) {
4223 # old SOA record is missing for some reason. create a new one.
[583]4224 my $sql = "INSERT INTO "._rectable($defrec, $revrec)." ("._recparent($defrec, $revrec).
4225 ", host, type, val, ttl) VALUES (?,?,6,?,?)";
[565]4226 $dbh->do($sql, undef, ($soa{id}, "$soa{contact}:$soa{prins}",
4227 "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}", $soa{ttl}) );
4228 $msg = ($defrec eq 'y' ? ($revrec eq 'y' ? 'Default reverse ' : 'Default ') : '').
4229 "SOA missing for $parname; added (ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
4230 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
4231 } else {
4232 my $sql = "UPDATE "._rectable($defrec, $revrec)." SET host=?, val=?, ttl=? WHERE record_id=? AND type=6";
4233 $dbh->do($sql, undef, ("$soa{contact}:$soa{prins}", "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}",
[311]4234 $soa{ttl}, $oldsoa->{record_id}) );
[565]4235 $msg = "Updated ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse ' : 'default ') : '').
[311]4236 "SOA for $parname: ".
4237 "(ns $oldsoa->{prins}, contact $oldsoa->{contact}, refresh $oldsoa->{refresh},".
4238 " retry $oldsoa->{retry}, expire $oldsoa->{expire}, minTTL $oldsoa->{minttl}, TTL $oldsoa->{ttl}) to ".
[277]4239 "(ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
4240 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
[565]4241 }
[311]4242 $logdata{entry} = $msg;
[487]4243 $self->_log(%logdata);
[277]4244
4245 $dbh->commit;
4246 };
4247 if ($@) {
4248 $msg = $@;
4249 eval { $dbh->rollback; };
[311]4250 $logdata{entry} = "Error updating ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse zone ' : 'default ') : '').
4251 "SOA record for $parname: $msg";
[517]4252 if ($self->{log_failures}) {
[487]4253 $self->_log(%logdata);
[311]4254 $dbh->commit;
4255 }
4256 return ('FAIL', $logdata{entry});
[277]4257 } else {
4258 return ('OK', $msg);
4259 }
[246]4260} # end updateSOA()
4261
4262
[2]4263## DNSDB::getRecLine()
4264# Return all data fields for a zone record in separate elements of a hash
[243]4265# Takes a database handle, default/live flag, forward/reverse flag, and record ID
[2]4266sub getRecLine {
4267 $errstr = '';
[481]4268 my $self = shift;
4269 my $dbh = $self->{dbh};
[243]4270 my $defrec = shift;
4271 my $revrec = shift;
[2]4272 my $id = shift;
4273
[543]4274##fixme: do we need a knob to twist to switch between unix epoch and postgres time string?
[429]4275 my $sql = "SELECT record_id,host,type,val,ttl".
4276 ($defrec eq 'n' ? ',location' : '').
4277 ($revrec eq 'n' ? ',distance,weight,port' : '').
[543]4278 (($defrec eq 'y') ? ',group_id FROM ' : ',domain_id,rdns_id,stamp,stamp < now() AS ispast,expires,stampactive FROM ').
[243]4279 _rectable($defrec,$revrec)." WHERE record_id=?";
[123]4280 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
[2]4281
[90]4282 if ($dbh->err) {
[2]4283 $errstr = $DBI::errstr;
4284 return undef;
4285 }
4286
[123]4287 if (!$ret) {
4288 $errstr = "No such record";
4289 return undef;
4290 }
4291
[243]4292 # explicitly set a parent id
4293 if ($defrec eq 'y') {
4294 $ret->{parid} = $ret->{group_id};
4295 } else {
4296 $ret->{parid} = (($revrec eq 'n') ? $ret->{domain_id} : $ret->{rdns_id});
4297 # and a secondary if we have a custom type that lives in both a forward and reverse zone
4298 $ret->{secid} = (($revrec eq 'y') ? $ret->{domain_id} : $ret->{rdns_id}) if $ret->{type} > 65279;
4299 }
[451]4300 $ret->{address} = $ret->{val}; # because.
[90]4301
4302 return $ret;
[2]4303}
4304
4305
4306##fixme: should use above (getRecLine()) to get lines for below?
[495]4307## DNSDB::getRecList()
4308# Return records for a group or zone
4309# Takes a default/live flag, group or zone ID, start,
[2]4310# number of records, sort field, and sort order
4311# Returns a reference to an array of hashes
[495]4312sub getRecList {
[2]4313 $errstr = '';
[481]4314 my $self = shift;
4315 my $dbh = $self->{dbh};
[2]4316
[397]4317 my %args = @_;
[4]4318
[666]4319 $args{revrec} = 'n' if !$args{revrec};
4320 $args{defrec} = 'n' if !$args{defrec};
4321
[716]4322 # RPC callers generally want the "true" IP. Flag argument for those to bypass showrev_arpa
4323##fixme: this will still blow up if some idiot has actually stored .arpa names in the DB.
4324# ... do we care?
4325 $args{rpc} = 0 if !$args{rpc};
4326
[397]4327 # protection against bad or missing arguments
[508]4328 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
[510]4329 my $defsort;
4330 $defsort = 'host' if $args{revrec} eq 'n'; # default sort by host on domain record list
4331 $defsort = 'val' if $args{revrec} eq 'y'; # default sort by IP on revzone record list
[513]4332 $args{sortby} = '' if !$args{sortby};
[508]4333 $args{sortby} = $defsort if !$args{revrec};
[512]4334 $args{sortby} = $defsort if $args{sortby} !~ /^[\w_,.]+$/;
[397]4335 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[517]4336 my $perpage = ($args{nrecs} ? $args{nrecs} : $self->{perpage});
[397]4337
[543]4338##fixme: do we need a knob to twist to switch from unix epoch to postgres time string?
[666]4339 my @bindvars;
4340 my $sql = "SELECT r.record_id,";
4341 # only include the parent info if we don't already know which parent we're in
4342 $sql .= "r.domain_id,r.rdns_id," unless $args{id};
4343 $sql .= "r.host,r.type,r.val,r.ttl";
[543]4344 $sql .= ",l.description AS locname,stamp,r.stamp < now() AS ispast,r.expires,r.stampactive"
4345 if $args{defrec} eq 'n';
[397]4346 $sql .= ",r.distance,r.weight,r.port" if $args{revrec} eq 'n';
4347 $sql .= " FROM "._rectable($args{defrec},$args{revrec})." r ";
[104]4348 $sql .= "INNER JOIN rectypes t ON r.type=t.val "; # for sorting by type alphabetically
[397]4349 $sql .= "LEFT JOIN locations l ON r.location=l.location " if $args{defrec} eq 'n';
[666]4350 $sql .= "WHERE NOT r.type=$reverse_typemap{SOA}";
4351
4352 # "normal" record list
4353 if ($args{id}) {
4354 $sql .= " AND "._recparent($args{defrec},$args{revrec})." = ?";
4355 push @bindvars, $args{id};
4356 }
4357
4358 # Filtering on host/val (mainly normal record list)
[614]4359 if ($args{filter}) {
4360 $sql .= " AND (r.host ~* ? OR r.val ~* ? OR r.host ~* ? OR r.val ~* ?)";
4361 my $tmp = join('.',reverse(split(/\./,$args{filter})));
[666]4362 push @bindvars, ($args{filter},$args{filter});
[614]4363 push @bindvars, ($tmp, $tmp);
4364 }
[666]4365
4366 # Filtering on other fields
[715]4367 foreach (qw(type distance weight port ttl description location)) {
[666]4368 if ($args{$_}) {
[716]4369 $sql .= " AND r.$_ ~* ?";
[666]4370 push @bindvars, $args{$_};
4371 }
4372 }
4373
4374 # whee! multisort means just passing comma-separated fields in sortby!
4375 my $newsort = '';
4376 foreach my $sf (split /,/, $args{sortby}) {
4377 $sf = "r.$sf";
4378 # sort on IP, correctly
4379 $sf =~ s/r\.val/inetlazy(r.val)/;
4380# hmm. do we really need to limit this?
4381# if $args{revrec} eq 'y' && $args{defrec} eq 'n';
4382 $sf =~ s/r\.type/t.alphaorder/; # subtly different from sorting on rectypes.name
4383 $newsort .= ",$sf";
4384 }
4385 $newsort =~ s/^,//;
4386##enhance: pass in ascending/descending sort per-field
[420]4387 $sql .= " ORDER BY $newsort $args{sortorder}";
[324]4388 # ensure consistent ordering by sorting on record_id too
[397]4389 $sql .= ", record_id $args{sortorder}";
[666]4390
4391 # Offset/pagination
[501]4392 $sql .= ($args{offset} eq 'all' ? '' : " LIMIT $perpage OFFSET ".$args{offset}*$perpage);
[4]4393
[583]4394 my @working;
4395 my $recsth = $dbh->prepare($sql);
4396 $recsth->execute(@bindvars);
4397 while (my $rec = $recsth->fetchrow_hashref) {
[716]4398 if (!$args{rpc} && $args{revrec} eq 'y' && $args{defrec} eq 'n' &&
[607]4399 ($self->{showrev_arpa} eq 'record' || $self->{showrev_arpa} eq 'all') &&
4400 $rec->{val} !~ /\.arpa$/ ) {
[608]4401 # skip all reverse zone .arpa "hostnames" since they're already .arpa names.
[583]4402##enhance: extend {showrev_arpa} eq 'record' to specify record types
[633]4403 my $tmpip = new NetAddr::IP $rec->{val} if $rec->{val} =~ /^(?:[\d.\/]+|[a-fA-F0-9:\/]+)$/;
[607]4404 $rec->{val} = DNSDB::_ZONE($tmpip, 'ZONE', 'r', '.').($tmpip->{isv6} ? '.ip6.arpa' : '.in-addr.arpa') if $tmpip;
[583]4405 }
4406 push @working, $rec;
4407 }
4408 return \@working;
[495]4409} # end getRecList()
[2]4410
4411
[91]4412## DNSDB::getRecCount()
[224]4413# Return count of non-SOA records in zone (or default records in a group)
4414# Takes a database handle, default/live flag, reverse/forward flag, group/domain ID,
4415# and optional filtering modifier
[91]4416# Returns the count
4417sub getRecCount {
[481]4418 my $self = shift;
4419 my $dbh = $self->{dbh};
[91]4420
[666]4421 my %args = @_;
[135]4422
[666]4423 $args{defrec} = 'n' if !$args{defrec};
4424 $args{revrec} = 'n' if !$args{revrec};
4425
4426 my @bindvars;
[224]4427 my $sql = "SELECT count(*) FROM ".
[666]4428 _rectable($args{defrec},$args{revrec}).
[689]4429 " r WHERE NOT type=$reverse_typemap{SOA}";
[666]4430 if ($args{id}) {
4431 $sql .= " AND "._recparent($args{defrec},$args{revrec})." = ?";
4432 push @bindvars, $args{id};
4433 }
4434
4435 # Filtering on host/val (mainly normal record list)
4436 if ($args{filter}) {
[614]4437 $sql .= " AND (r.host ~* ? OR r.val ~* ? OR r.host ~* ? OR r.val ~* ?)";
[666]4438 my $tmp = join('.',reverse(split(/\./,$args{filter})));
4439 push @bindvars, ($args{filter},$args{filter});
[614]4440 push @bindvars, ($tmp, $tmp);
4441 }
[584]4442
[666]4443 # Filtering on other fields
4444 foreach (qw(type distance weight port ttl description)) {
4445 if ($args{$_}) {
4446 $sql .= " AND $_ ~* ?";
4447 push @bindvars, $args{$_};
4448 }
4449 }
4450
[224]4451 my ($count) = $dbh->selectrow_array($sql, undef, (@bindvars) );
[91]4452
4453 return $count;
4454
4455} # end getRecCount()
4456
4457
[3]4458## DNSDB::addRec()
[2]4459# Add a new record to a domain or a group's default records
4460# Takes a database handle, default/live flag, group/domain ID,
4461# host, type, value, and TTL
4462# Some types require additional detail: "distance" for MX and SRV,
4463# and weight/port for SRV
4464# Returns a status code and detail message in case of error
[234]4465##fixme: pass a hash with the record data, not a series of separate values
[2]4466sub addRec {
4467 $errstr = '';
[481]4468 my $self = shift;
4469 my $dbh = $self->{dbh};
[2]4470 my $defrec = shift;
[226]4471 my $revrec = shift;
4472 my $id = shift; # parent (group_id for defrecs, rdns_id for reverse records,
4473 # domain_id for domain records)
[2]4474
4475 my $host = shift;
[234]4476 my $rectype = shift; # reference so we can coerce it if "+"-types can't find both zones
[2]4477 my $val = shift;
4478 my $ttl = shift;
[389]4479 my $location = shift;
4480 $location = '' if !$location;
[2]4481
[658]4482 my $expires = shift || '';
[543]4483 $expires = 1 if $expires eq 'until'; # Turn some special values into the appropriate booleans.
4484 $expires = 0 if $expires eq 'after';
4485 my $stamp = shift;
4486 $stamp = '' if !$stamp; # Timestamp should be a string at this point.
4487
[674]4488 # extra safety net - apparently RPC can squeak this by. O_o
4489 return ('FAIL', "host must contain a value") if !$$host;
4490 return ('FAIL', "val must contain a value") if !$$val;
4491
[417]4492 # Spaces are evil.
4493 $$host =~ s/^\s+//;
4494 $$host =~ s/\s+$//;
[418]4495 if ($typemap{$$rectype} ne 'TXT') {
[417]4496 # Leading or trailng spaces could be legit in TXT records.
4497 $$val =~ s/^\s+//;
4498 $$val =~ s/\s+$//;
4499 }
4500
[617]4501 _caseclean($rectype, $host, $val, $defrec, $revrec) if $self->{lowercase};
[542]4502
[226]4503 # prep for validation
[609]4504 my $addr = NetAddr::IP->new($$val) if _maybeip($val);
[252]4505 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
[226]4506
4507 my $domid = 0;
4508 my $revid = 0;
4509
4510 my $retcode = 'OK'; # assume everything will go OK
4511 my $retmsg = '';
4512
4513 # do simple validation first
[768]4514 $ttl = '' if !$ttl;
4515 $ttl =~ s/\s*//g;
[559]4516 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^-?\d+$/;
[226]4517
[234]4518 # Collect these even if we're only doing a simple A record so we can call *any* validation sub
4519 my $dist = shift;
[281]4520 my $weight = shift;
[234]4521 my $port = shift;
[226]4522
[234]4523 my $fields;
4524 my @vallist;
[226]4525
[234]4526 # Call the validation sub for the type requested.
[481]4527 ($retcode,$retmsg) = $validators{$$rectype}($self, defrec => $defrec, revrec => $revrec, id => $id,
[249]4528 host => $host, rectype => $rectype, val => $val, addr => $addr,
[234]4529 dist => \$dist, port => \$port, weight => \$weight,
[481]4530 fields => \$fields, vallist => \@vallist);
[129]4531
[234]4532 return ($retcode,$retmsg) if $retcode eq 'FAIL';
[209]4533
[234]4534 # Set up database fields and bind parameters
[481]4535 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
4536 push @vallist, ($$host,$$rectype,$$val,$ttl,$id);
4537
4538 if ($defrec eq 'n') {
[543]4539 # locations are not for default records, silly coder!
[481]4540 $fields .= ",location";
4541 push @vallist, $location;
[543]4542 # timestamps are rare.
4543 if ($stamp) {
4544 $fields .= ",stamp,expires,stampactive";
4545 push @vallist, $stamp, $expires, 'y';
4546 } else {
4547 $fields .= ",stampactive";
4548 push @vallist, 'n';
4549 }
[481]4550 }
[543]4551
4552 # a little magic to get the right number of ? placeholders based on how many values we're providing
[234]4553 my $vallen = '?'.(',?'x$#vallist);
[2]4554
[287]4555 # Put together the success log entry. We have to use this horrible kludge
4556 # because domain_id and rdns_id may or may not be present, and if they are,
4557 # they're not at a guaranteed consistent index in the array. wheee!
4558 my %logdata;
4559 my @ftmp = split /,/, $fields;
4560 for (my $i=0; $i <= $#vallist; $i++) {
4561 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
4562 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
4563 }
4564 $logdata{group_id} = $id if $defrec eq 'y';
[473]4565 $logdata{group_id} = $self->parentID(id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec)
[287]4566 if $defrec eq 'n';
[328]4567 $logdata{entry} = "Added ".($defrec eq 'y' ? 'default record' : 'record');
[621]4568 # Log reverse records to match the formal .arpa tree
4569 if ($revrec eq 'y') {
[328]4570 $logdata{entry} .= " '$$val $typemap{$$rectype} $$host";
4571 } else {
4572 $logdata{entry} .= " '$$host $typemap{$$rectype} $$val";
4573 }
4574
[287]4575 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
4576 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]"
4577 if $typemap{$$rectype} eq 'SRV';
[425]4578 $logdata{entry} .= "', TTL $ttl";
[480]4579 $logdata{entry} .= ", location ".$self->getLoc($location)->{description} if $location;
[642]4580 $logdata{entry} .= ($expires ? ', expires at ' : ', valid after ').$stamp if $stamp;
[287]4581
[90]4582 # Allow transactions, and raise an exception on errors so we can catch it later.
4583 # Use local to make sure these get "reset" properly on exiting this block
4584 local $dbh->{AutoCommit} = 0;
4585 local $dbh->{RaiseError} = 1;
[2]4586
[90]4587 eval {
[236]4588 $dbh->do("INSERT INTO "._rectable($defrec, $revrec)." ($fields) VALUES ($vallen)",
[90]4589 undef, @vallist);
[487]4590 $self->_log(%logdata);
[90]4591 $dbh->commit;
4592 };
4593 if ($@) {
4594 my $msg = $@;
4595 eval { $dbh->rollback; };
[517]4596 if ($self->{log_failures}) {
[289]4597 $logdata{entry} = "Failed adding ".($defrec eq 'y' ? 'default ' : '').
4598 "record '$$host $typemap{$$rectype} $$val', TTL $ttl ($msg)";
[487]4599 $self->_log(%logdata);
[289]4600 $dbh->commit;
4601 }
[90]4602 return ('FAIL',$msg);
4603 }
[2]4604
[287]4605 $resultstr = $logdata{entry};
[226]4606 return ($retcode, $retmsg);
[90]4607
[2]4608} # end addRec()
4609
4610
[16]4611## DNSDB::updateRec()
4612# Update a record
[273]4613# Takes a database handle, default and reverse flags, record ID, immediate parent ID, and new record data.
4614# Returns a status code and message
[16]4615sub updateRec {
4616 $errstr = '';
[17]4617
[481]4618 my $self = shift;
4619 my $dbh = $self->{dbh};
[679]4620
[16]4621 my $defrec = shift;
[272]4622 my $revrec = shift;
[16]4623 my $id = shift;
[272]4624 my $parid = shift; # immediate parent entity that we're descending from to update the record
[16]4625
[273]4626 # all records have these
[16]4627 my $host = shift;
[272]4628 my $hostbk = $$host; # Keep a backup copy of the original, so we can WARN if the update mangles the domain
4629 my $rectype = shift;
[16]4630 my $val = shift;
4631 my $ttl = shift;
[389]4632 my $location = shift; # may be empty/null/undef depending on caller
4633 $location = '' if !$location;
[16]4634
[658]4635 my $expires = shift || '';
[543]4636 $expires = 1 if $expires eq 'until'; # Turn some special values into the appropriate booleans.
4637 $expires = 0 if $expires eq 'after';
4638 my $stamp = shift;
4639 $stamp = '' if !$stamp; # Timestamp should be a string at this point.
4640
[510]4641 # just set it to an empty string; failures will be caught later.
4642 $$host = '' if !$$host;
4643
[417]4644 # Spaces are evil.
4645 $$host =~ s/^\s+//;
4646 $$host =~ s/\s+$//;
[418]4647 if ($typemap{$$rectype} ne 'TXT') {
[417]4648 # Leading or trailng spaces could be legit in TXT records.
4649 $$val =~ s/^\s+//;
4650 $$val =~ s/\s+$//;
4651 }
4652
[617]4653 _caseclean($rectype, $host, $val, $defrec, $revrec) if $self->{lowercase};
[542]4654
[272]4655 # prep for validation
[609]4656 my $addr = NetAddr::IP->new($$val) if _maybeip($val);
[272]4657 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
[16]4658
[272]4659 my $domid = 0;
4660 my $revid = 0;
4661
4662 my $retcode = 'OK'; # assume everything will go OK
4663 my $retmsg = '';
4664
[273]4665 # do simple validation first
[768]4666 $ttl = '' if !$ttl;
4667 $ttl =~ s/\s*//g;
[559]4668 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^-?\d+$/;
[272]4669
[273]4670 # only MX and SRV will use these
[288]4671 my $dist = shift || 0;
4672 my $weight = shift || 0;
4673 my $port = shift || 0;
[16]4674
[272]4675 my $fields;
4676 my @vallist;
[16]4677
[273]4678 # get old record data so we have the right parent ID
4679 # and for logging (eventually)
[481]4680 my $oldrec = $self->getRecLine($defrec, $revrec, $id);
[223]4681
[272]4682 # Call the validation sub for the type requested.
4683 # Note the ID to pass here is the *parent*, not the record
[481]4684 ($retcode,$retmsg) = $validators{$$rectype}($self, defrec => $defrec, revrec => $revrec,
[272]4685 id => ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})),
4686 host => $host, rectype => $rectype, val => $val, addr => $addr,
4687 dist => \$dist, port => \$port, weight => \$weight,
4688 fields => \$fields, vallist => \@vallist,
[481]4689 update => $id);
[272]4690
4691 return ($retcode,$retmsg) if $retcode eq 'FAIL';
4692
[273]4693 # Set up database fields and bind parameters. Note only the optional fields
4694 # (distance, weight, port, secondary parent ID) are added in the validation call above
[448]4695 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
4696 push @vallist, ($$host,$$rectype,$$val,$ttl,
[273]4697 ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})) );
[272]4698
[448]4699 if ($defrec eq 'n') {
[543]4700 # locations are not for default records, silly coder!
[448]4701 $fields .= ",location";
4702 push @vallist, $location;
[543]4703 # timestamps are rare.
4704 if ($stamp) {
4705 $fields .= ",stamp,expires,stampactive";
4706 push @vallist, $stamp, $expires, 'y';
4707 } else {
4708 $fields .= ",stampactive";
4709 push @vallist, 'n';
4710 }
[448]4711 }
4712
[273]4713 # hack hack PTHUI
4714 # need to forcibly make sure we disassociate a record with a parent it's no longer related to.
4715 # eg, PTR records may not have a domain parent, or A/AAAA records may not have a revzone parent.
[605]4716 # needed for crossover types that got coerced down to "standard" types due to data changes
4717 # need to *avoid* funky records being updated like A/AAAA records in revzones, or PTRs in forward zones.
4718 if ($defrec eq 'n' && $oldrec->{type} > 65000) {
[273]4719 if ($$rectype == $reverse_typemap{PTR}) {
4720 $fields .= ",domain_id";
4721 push @vallist, 0;
4722 }
4723 if ($$rectype == $reverse_typemap{A} || $$rectype == $reverse_typemap{AAAA}) {
4724 $fields .= ",rdns_id";
4725 push @vallist, 0;
4726 }
4727 }
[345]4728 # fix fat-finger-originated record type changes
[605]4729 if ($$rectype == 65285) { # delegation
[345]4730 $fields .= ",rdns_id" if $revrec eq 'n';
4731 $fields .= ",domain_id" if $revrec eq 'y';
4732 push @vallist, 0;
4733 }
[605]4734 # ... and now make sure we *do* associate a record with the "calling" parent
[341]4735 if ($defrec eq 'n') {
4736 $domid = $parid if $revrec eq 'n';
4737 $revid = $parid if $revrec eq 'y';
4738 }
[272]4739
[288]4740 # Put together the success log entry. Horrible kludge from addRec() copied as-is since
4741 # we don't know whether the passed arguments or retrieved values for domain_id and rdns_id
4742 # will be maintained (due to "not-in-zone" validation changes)
4743 my %logdata;
[341]4744 $logdata{domain_id} = $domid;
4745 $logdata{rdns_id} = $revid;
[288]4746 my @ftmp = split /,/, $fields;
4747 for (my $i=0; $i <= $#vallist; $i++) {
4748 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
4749 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
4750 }
4751 $logdata{group_id} = $parid if $defrec eq 'y';
[473]4752 $logdata{group_id} = $self->parentID(id => $parid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec)
[288]4753 if $defrec eq 'n';
[328]4754 $logdata{entry} = "Updated ".($defrec eq 'y' ? 'default record' : 'record')." from\n";
[621]4755 # Log reverse records "naturally", since they're stored, um, unnaturally.
4756 if ($revrec eq 'y') {
[328]4757 $logdata{entry} .= " '$oldrec->{val} $typemap{$oldrec->{type}} $oldrec->{host}";
4758 } else {
4759 $logdata{entry} .= " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
4760 }
[288]4761 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
4762 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
4763 if $typemap{$oldrec->{type}} eq 'SRV';
[425]4764 $logdata{entry} .= "', TTL $oldrec->{ttl}";
[480]4765 $logdata{entry} .= ", location ".$self->getLoc($oldrec->{location})->{description} if $oldrec->{location};
[543]4766 $logdata{entry} .= ($oldrec->{expires} ? ', expires at ' : ', valid after ').$oldrec->{stamp}
4767 if $oldrec->{stampactive};
[425]4768 $logdata{entry} .= "\nto\n";
[621]4769 # Log reverse records "naturally", since they're stored, um, unnaturally.
4770 if ($revrec eq 'y') {
[328]4771 $logdata{entry} .= "'$$val $typemap{$$rectype} $$host";
4772 } else {
4773 $logdata{entry} .= "'$$host $typemap{$$rectype} $$val";
4774 }
[288]4775 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
4776 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$$rectype} eq 'SRV';
[425]4777 $logdata{entry} .= "', TTL $ttl";
[480]4778 $logdata{entry} .= ", location ".$self->getLoc($location)->{description} if $location;
[642]4779 $logdata{entry} .= ($expires ? ', expires at ' : ', valid after ').$stamp if $stamp;
[288]4780
[90]4781 local $dbh->{AutoCommit} = 0;
4782 local $dbh->{RaiseError} = 1;
4783
[341]4784 # Fiddle the field list into something suitable for updates
4785 $fields =~ s/,/=?,/g;
4786 $fields .= "=?";
4787
[90]4788 eval {
[273]4789 $dbh->do("UPDATE "._rectable($defrec,$revrec)." SET $fields WHERE record_id=?", undef, (@vallist, $id) );
[487]4790 $self->_log(%logdata);
[130]4791 $dbh->commit;
[90]4792 };
4793 if ($@) {
4794 my $msg = $@;
[288]4795 eval { $dbh->rollback; };
[517]4796 if ($self->{log_failures}) {
[289]4797 $logdata{entry} = "Failed updating ".($defrec eq 'y' ? 'default ' : '').
4798 "record '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
[487]4799 $self->_log(%logdata);
[289]4800 $dbh->commit;
4801 }
[90]4802 return ('FAIL', $msg);
4803 }
4804
[288]4805 $resultstr = $logdata{entry};
[272]4806 return ($retcode, $retmsg);
[16]4807} # end updateRec()
4808
4809
[459]4810## DNSDB::downconvert()
4811# A mostly internal (not exported) semiutilty sub to downconvert from pseudotype <x>
4812# to a compatible component type. Only a handful of operations are valid, anything
4813# else is a null-op.
4814# Takes the record ID and the new type. Returns boolean.
4815sub downconvert {
[481]4816 my $self = shift;
4817 my $dbh = $self->{dbh};
[459]4818 my $recid = shift;
4819 my $newtype = shift;
4820
4821 # also, only work on live records; little to no value trying to do this on default records.
[481]4822 my $rec = $self->getRecLine('n', 'y', $recid);
[459]4823
4824 # hm?
4825 #return 1 if !$rec;
4826
4827 return 1 if $rec->{type} < 65000; # Only the reverse-record pseudotypes can be downconverted
4828 return 1 if $rec->{type} == 65282; # Nowhere to go
4829
4830 my $delpar;
4831 my @sqlargs;
4832 if ($rec->{type} == 65280) {
4833 return 1 if $newtype != 1 && $newtype != 12;
4834 $delpar = ($newtype == 1 ? 'rdns_id' : 'domain_id');
4835 push @sqlargs, 0, $newtype, $recid;
4836 } elsif ($rec->{type} == 65281) {
4837 return 1 if $newtype != 28 && $newtype != 12;
4838 $delpar = ($newtype == 28 ? 'rdns_id' : 'domain_id');
4839 push @sqlargs, 0, $newtype, $recid;
4840 } elsif ($rec->{type} == 65283) {
4841 return 1 if $newtype != 65282;
4842 $delpar = 'rdns_id';
4843 } elsif ($rec->{type} == 65284) {
4844 return 1 if $newtype != 65282;
4845 $delpar = 'rdns_id';
4846 } else {
4847 # Your llama is on fire.
4848 }
4849
4850 local $dbh->{AutoCommit} = 0;
4851 local $dbh->{RaiseError} = 1;
4852
4853 eval {
4854 $dbh->do("UPDATE records SET $delpar = ?, type = ? WHERE record_id = ?", undef, @sqlargs);
[665]4855 $self->_log(domain_id => $rec->{domain_id}, rdns_id => $rec->{rdns_id},
4856 group_id => $self->parentID(id => $rec->{rdns_id}, type => 'revzone', revrec => 'y'),
4857 entry => "'$rec->{host} $typemap{$rec->{type}} $rec->{val}' downconverted to ".
4858 "'$rec->{host} $typemap{$newtype} $rec->{val}'");
[459]4859 $dbh->commit;
4860 };
4861 if ($@) {
4862 $errstr = $@;
4863 eval { $dbh->rollback; };
4864 return 0;
4865 }
4866 return 1;
4867} # end downconvert()
4868
4869
[3]4870## DNSDB::delRec()
4871# Delete a record.
[667]4872# Takes a default/live flag, forward/reverse flag, and the ID of the record to delete.
[3]4873sub delRec {
4874 $errstr = '';
[481]4875 my $self = shift;
4876 my $dbh = $self->{dbh};
[3]4877 my $defrec = shift;
[243]4878 my $revrec = shift;
[3]4879 my $id = shift;
4880
[481]4881 my $oldrec = $self->getRecLine($defrec, $revrec, $id);
[3]4882
[290]4883 # Allow transactions, and raise an exception on errors so we can catch it later.
4884 # Use local to make sure these get "reset" properly on exiting this block
4885 local $dbh->{AutoCommit} = 0;
4886 local $dbh->{RaiseError} = 1;
[3]4887
[290]4888 # Put together the log entry
4889 my %logdata;
4890 $logdata{domain_id} = $oldrec->{domain_id};
4891 $logdata{rdns_id} = $oldrec->{rdns_id};
4892 $logdata{group_id} = $oldrec->{group_id} if $defrec eq 'y';
[667]4893 $logdata{group_id} = $self->parentID(id => ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id}),
4894 type => 'domain', revrec => $revrec)
[290]4895 if $defrec eq 'n';
4896 $logdata{entry} = "Deleted ".($defrec eq 'y' ? 'default record ' : 'record ').
4897 "'$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
4898 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
4899 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
4900 if $typemap{$oldrec->{type}} eq 'SRV';
[425]4901 $logdata{entry} .= "', TTL $oldrec->{ttl}";
[480]4902 $logdata{entry} .= ", location ".$self->getLoc($oldrec->{location})->{description} if $oldrec->{location};
[290]4903
4904 eval {
4905 my $sth = $dbh->do("DELETE FROM "._rectable($defrec,$revrec)." WHERE record_id=?", undef, ($id));
[487]4906 $self->_log(%logdata);
[290]4907 $dbh->commit;
4908 };
4909 if ($@) {
4910 my $msg = $@;
4911 eval { $dbh->rollback; };
[517]4912 if ($self->{log_failures}) {
[290]4913 $logdata{entry} = "Error deleting ".($defrec eq 'y' ? 'default record' : 'record').
4914 " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
[487]4915 $self->_log(%logdata);
[290]4916 $dbh->commit;
4917 }
4918 return ('FAIL', $msg);
4919 }
4920
4921 return ('OK',$logdata{entry});
[3]4922} # end delRec()
4923
4924
[323]4925## DNSDB::getLogCount()
4926# Get a count of log entries
4927# Takes a database handle and a hash containing at least:
[733]4928# - Entity identifier and entity type as the primary log "slice"
[323]4929sub getLogCount {
[483]4930 my $self = shift;
[733]4931 return $self->getLogEntries(@_, count => 1);
[323]4932} # end getLogCount()
4933
4934
4935## DNSDB::getLogEntries()
4936# Get a list of log entries
4937# Takes arguments as with getLogCount() above, plus optional:
[733]4938# - "count" flag
4939# OR
[323]4940# - sort field
4941# - sort order
4942# - offset for pagination
4943sub getLogEntries {
[483]4944 my $self = shift;
4945 my $dbh = $self->{dbh};
[323]4946
4947 my %args = @_;
4948
4949 my @filterargs;
4950
[733]4951 # fail if the prime id type is missing or invalid
4952 $errstr = "Missing primary log slice type";
[323]4953 return if !$args{logtype};
4954 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
4955 $args{logtype} = 'domain' if $args{logtype} eq 'dom'; # hack pthui
[733]4956 $errstr = "Invalid primary log slice type";
[323]4957 return if !grep /^$args{logtype}$/, ('group', 'domain', 'revzone', 'user');
4958
[733]4959 # fail if we don't have a prime ID to look for log entries for
4960 $errstr = "Missing ID for primary log slice";
4961 return if !($args{id} || $args{fname});
4962
[323]4963 # Sorting defaults
[508]4964 $args{sortorder} = 'DESC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
4965 $args{sortby} = 'stamp' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
[397]4966 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
[323]4967
[733]4968 my %sortmap = (fname => 'name', username => 'email', entry => 'entry', stamp => 'stamp',
4969 revzone => 'revnet', domain => 'domain');
[323]4970 $args{sortby} = $sortmap{$args{sortby}};
4971
[733]4972 push @filterargs, $args{filter} if $args{filter};
4973 my $sql;
4974 if ($args{count}) {
4975 $sql = "SELECT count(*) FROM log l ";
4976 } else {
[744]4977 $sql = "SELECT l.log_id AS logparent, l.user_id AS userid, l.name AS userfname, d.domain, l.domain_id, ".
4978 "r.revnet AS revzone, ".
[733]4979 "l.rdns_id, l.entry AS logentry, date_trunc('second',l.stamp) AS logtime ".
4980 "FROM log l ".
4981 "LEFT JOIN domains d ON l.domain_id = d.domain_id ".
4982 "LEFT JOIN revzones r ON l.rdns_id = r.rdns_id ";
4983 }
4984
4985 # decide which ID argument to use. Only use the "full name" if no normal ID is present
4986 my $idarg;
4987 if ($args{id}) {
4988 $sql .= "WHERE l.$id_col{$args{logtype}} = ? ";
4989 $idarg = $args{id};
4990 } else {
4991 $sql .= "WHERE l.name = ? ";
4992 $idarg = $args{fname};
4993 }
4994
[744]4995 # trim log "subentries" - we'll figure out where to stash these later
4996 $sql .= " AND logparent = 0";
4997
[733]4998 # add the entry filter, if any
4999 $sql .= ($args{filter} ? " AND entry ~* ?" : '');
5000
5001 # Limit scope based on group. Mainly useful for ltype==user, so subgroup
5002 # users can see what the deities in parent groups have done to their domains.
5003 if ($args{group} != 1) {
5004 my @grouplist;
5005 $self->getChildren($args{group}, \@grouplist);
5006 my $groupset = join(',', $args{group}, @grouplist);
5007 $sql .= " AND l.group_id IN ($groupset)";
5008 }
5009
5010 if ($args{count}) {
5011 my ($count) = $dbh->selectrow_array($sql, undef, ($idarg, @filterargs) );
5012 $errstr = $dbh->errstr if !$count;
5013 return $count;
5014 } else {
5015 $sql .= " ORDER BY $args{sortby} $args{sortorder}, log_id $args{sortorder}".
[517]5016 ($args{offset} eq 'all' ? '' : " LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
[744]5017 my @loglist;
5018 my $sth = $dbh->prepare($sql);
5019 my $logchild = $dbh->prepare("SELECT entry FROM log WHERE logparent = ? ORDER BY log_id");
5020 $sth->execute($idarg, @filterargs);
5021 while (my $row = $sth->fetchrow_hashref) {
5022 $logchild->execute($row->{logparent});
5023 my $childlist = $logchild->fetchall_arrayref({});
5024 $row->{childentries} = $childlist;
5025 push @loglist, $row;
5026 }
5027 return \@loglist;
[733]5028 }
5029
5030 # Your llama is on fire
5031
[323]5032} # end getLogEntries()
5033
5034
[723]5035# a collection of joins for the record search
5036our $recsearchsqlbase = q(
[722]5037FROM records r
5038LEFT JOIN domains d ON r.domain_id = d.domain_id
5039 LEFT JOIN groups g1 ON d.group_id = g1.group_id
5040LEFT JOIN revzones z ON r.rdns_id = z.rdns_id
5041 LEFT JOIN groups g2 on z.group_id = g2.group_id
5042JOIN rectypes t ON r.type = t.val
5043LEFT JOIN locations l ON r.location = l.location
5044WHERE r.type <> 6 AND (r.host ~* ? OR r.val ~* ?)
5045);
5046
[723]5047
5048## DNSDB::recSearchCount()
5049# Get a total count for a global record search
5050# Takes a hash with the search string and the login group of the user
5051sub recSearchCount {
5052 my $self = shift;
5053 my $dbh = $self->{dbh};
5054 my %args = @_;
5055
5056 my $sql = "SELECT count(*)".$recsearchsqlbase;
5057
5058 # Limit scope based on group
5059 if ($args{group} != 1) {
5060 my @grouplist;
5061 $self->getChildren($args{group}, \@grouplist);
5062 my $groupset = join(',', $args{group}, @grouplist);
5063 # oh my aching HEAD. there has to be a better way to do conditions on joined tables...
5064 $sql .= "AND (
5065 (g1.group_id IN ($groupset) AND g2.group_id IN ($groupset)) OR
5066 (g1.group_id IN ($groupset) AND g2.group_id IS NULL) OR
5067 (g1.group_id IS NULL AND g2.group_id IN ($groupset))
5068 )
[722]5069";
[723]5070 }
[722]5071
[723]5072 my $count = $dbh->selectrow_array($sql, undef, $args{searchfor}, $args{searchfor});
5073 $errstr = $dbh->errstr if !$count;
5074 return $count;
[722]5075
[723]5076} # end recSearchCount()
[722]5077
5078
[723]5079## DNSDB::recSearch()
5080# Find records matching the search string
5081# Takes a hash with the search string, login group of the user, pagination offset, sort field,
5082# and sort direction
5083# Returns a reference to a list of hashrefs
5084sub recSearch {
5085 my $self = shift;
5086 my $dbh = $self->{dbh};
5087 my %args = @_;
5088
5089 my $sql = q(SELECT
5090 r.domain_id, d.domain, g1.group_name AS domgroup,
5091 r.rdns_id, z.revnet AS revzone, g2.group_name AS revgroup,
5092 r.host, t.name AS rectype, r.val, l.description AS location, r.record_id).
5093 $recsearchsqlbase;
5094
5095 # Limit scope based on group
5096 if ($args{group} != 1) {
5097 my @grouplist;
5098 $self->getChildren($args{group}, \@grouplist);
5099 my $groupset = join(',', $args{group}, @grouplist);
5100 # oh my aching HEAD. there has to be a better way to do conditions on joined tables...
5101 $sql .= "AND (
5102 (g1.group_id IN ($groupset) AND g2.group_id IN ($groupset)) OR
5103 (g1.group_id IN ($groupset) AND g2.group_id IS NULL) OR
5104 (g1.group_id IS NULL AND g2.group_id IN ($groupset))
5105 )
5106";
5107 }
5108
5109 # mixed tables means this isn't a simple prefix like the regular record list filter. :/
5110 my %sortmap = (
5111 domain => 'd.domain',
5112 revzone => 'z.revnet',
5113 host => 'r.host',
5114 type => 't.name',
5115 val => 'inetlazy(r.val)',
5116 location => 'r.location',
5117 );
5118
5119 # Sorting defaults
5120 $args{sortorder} = 'ASC' if !$args{sortorder} || !grep /^$args{sortorder}$/, ('ASC','DESC');
5121 $args{sortby} = 'r.host' if !$args{sortby} || $args{sortby} !~ /^[\w_.]+$/;
5122 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
5123
5124 $args{sortby} = $sortmap{$args{sortby}} if $args{sortby} !~ /\./;
5125
5126 # Add sort and offset to SQL
5127 $sql .= "ORDER BY $args{sortby} $args{sortorder},record_id ASC\n";
5128 $sql .= ($args{offset} eq 'all' ? '' : "LIMIT $self->{perpage} OFFSET ".$args{offset}*$self->{perpage});
5129
5130##fixme: should probably sent the warning somewhere else
[747]5131 my $ret = $dbh->selectall_arrayref($sql, { Slice => {} }, $args{searchfor}, $args{searchfor})
[723]5132 or warn $dbh->errstr;
[747]5133 return $ret;
[723]5134
[722]5135} # end recSearch()
5136
5137
[673]5138## DNSDB::getRevPattern()
[452]5139# Get the narrowest template pattern applicable to a passed CIDR address (may be a netblock or an IP)
5140sub getRevPattern {
[483]5141 my $self = shift;
5142 my $dbh = $self->{dbh};
[452]5143 my $cidr = shift;
[701]5144 my %args = @_;
5145 $args{group} = 1 if !$args{group}; # just in case
5146 $args{location} = '' if !$args{location};
[452]5147
[462]5148 # for speed! Casting and comparing even ~7K records takes ~2.5s, so narrow it down to one revzone first.
[664]5149 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >>= ?",
5150 undef, ($cidr) );
[462]5151
5152##fixme? may need to narrow things down more by octet-chopping and doing text comparisons before casting.
5153 my ($revpatt) = $dbh->selectrow_array("SELECT host FROM records ".
[701]5154 "WHERE (type in (12,65280,65281,65282,65283,65284)) AND rdns_id = ? ".
5155 "AND location = ? AND inetlazy(val) >>= ? ".
5156 "ORDER BY inetlazy(val) DESC LIMIT 1",
5157 undef, ($revid, $args{location}, $cidr) );
5158
[452]5159 return $revpatt;
5160} # end getRevPattern()
5161
5162
[673]5163## DNSDB::getRevSet()
5164# Return the unique per-IP reverse hostnames, if any, for the passed
5165# CIDR address (may be a netblock or an IP)
5166sub getRevSet {
5167 my $self = shift;
5168 my $dbh = $self->{dbh};
5169 my $cidr = shift;
[701]5170 my %args = @_;
5171 $args{group} = 1 if !$args{group}; # just in case
5172 $args{location} = '' if !$args{location};
[673]5173
5174 # for speed! Casting and comparing even ~7K records takes ~2.5s, so narrow it down to one revzone first.
5175 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >>= ?",
5176 undef, ($cidr) );
5177
5178 $cidr = new NetAddr::IP $cidr;
5179 if ($cidr->num > 256) { # should also catch v6!
5180 # Even reverse entries for a v4 /24 of IPs is a bit much. I don't expect
5181 # there to be a sane reason to retrive more than a /27 at once, really.
5182 # v6 is going to be hairy no matter how you slice it.
5183 $errstr = "Reverse hostname detail range too large";
5184 return;
5185 }
5186
5187 my $sth = $dbh->prepare("SELECT val, host FROM records ".
[701]5188 "WHERE (type in (12,65280,65281,65282,65283,65284)) AND rdns_id = ? AND location = ? AND inetlazy(val) = ?");
[673]5189
5190 my @ret;
5191 foreach my $ip (@{$cidr->splitref()}) {
[701]5192 $sth->execute($revid, $args{location}, $ip);
[673]5193 my @data = $sth->fetchrow_array();
5194 my %row;
5195 if (@data) {
5196 $row{r_ip} = $data[0];
5197 $row{iphost} = $data[1];
5198 } else {
5199 $row{r_ip} = $ip->addr;
5200 $row{iphost} = '';
5201 }
5202 push @ret, \%row;
5203 }
5204
5205 return \@ret;
5206} # end getRevSet()
5207
5208
[225]5209## DNSDB::getTypelist()
5210# Get a list of record types for various UI dropdowns
5211# Takes database handle, forward/reverse/lookup flag, and optional "tag as selected" indicator (defaults to A)
5212# Returns an arrayref to list of hashrefs perfect for HTML::Template
5213sub getTypelist {
[483]5214 my $self = shift;
5215 my $dbh = $self->{dbh};
[225]5216 my $recgroup = shift;
5217 my $type = shift || $reverse_typemap{A};
5218
5219 # also accepting $webvar{revrec}!
5220 $recgroup = 'f' if $recgroup eq 'n';
5221 $recgroup = 'r' if $recgroup eq 'y';
5222
5223 my $sql = "SELECT val,name FROM rectypes WHERE ";
5224 if ($recgroup eq 'r') {
5225 # reverse zone types
5226 $sql .= "stdflag=2 OR stdflag=3";
5227 } elsif ($recgroup eq 'l') {
5228 # DNS lookup types. Note we avoid our custom types >= 65280, since those are entirely internal.
5229 $sql .= "(stdflag=1 OR stdflag=2 OR stdflag=3) AND val < 65280";
5230 } else {
5231 # default; forward zone types. technically $type eq 'f' but not worth the error message.
5232 $sql .= "stdflag=1 OR stdflag=2";
[506]5233 $sql .= " AND val < 65280" if $recgroup eq 'fo'; # An extra flag to trim off the pseudotypes as well.
[225]5234 }
5235 $sql .= " ORDER BY listorder";
5236
5237 my $sth = $dbh->prepare($sql);
5238 $sth->execute;
5239 my @typelist;
[603]5240 # track whether the passed type is in the list at all. allows you to edit a record
5241 # that wouldn't otherwise be generally available in that zone (typically, reverse zones)
5242 # without changing its type (accidentally or otherwise)
5243 my $selflag = 0;
[225]5244 while (my ($rval,$rname) = $sth->fetchrow_array()) {
5245 my %row = ( recval => $rval, recname => $rname );
[603]5246 if ($rval == $type) {
5247 $row{tselect} = 1;
5248 $selflag = 1;
5249 }
[225]5250 push @typelist, \%row;
5251 }
5252
[603]5253 # add the passed type if it wasn't in the list
5254 if (!$selflag) {
5255 my %row = ( recval => $type, recname => $typemap{$type}, tselect => 1 );
5256 push @typelist, \%row;
5257 }
5258
[225]5259 # Add SOA on lookups since it's not listed in other dropdowns.
5260 if ($recgroup eq 'l') {
5261 my %row = ( recval => $reverse_typemap{SOA}, recname => 'SOA' );
5262 $row{tselect} = 1 if $reverse_typemap{SOA} == $type;
5263 push @typelist, \%row;
5264 }
5265
5266 return \@typelist;
5267} # end getTypelist()
5268
5269
[254]5270## DNSDB::parentID()
5271# Get ID of entity that is nearest parent to requested id
5272# Takes a database handle and a hash of entity ID, entity type, optional parent type flag
5273# (domain/reverse zone or group), and optional default/live and forward/reverse flags
5274# Returns the ID or undef on failure
5275sub parentID {
[473]5276 my $self = shift;
5277 my $dbh = $self->{dbh};
[116]5278
[254]5279 my %args = @_;
[116]5280
[254]5281 # clean up defrec and revrec. default to live record, forward zone
5282 $args{defrec} = 'n' if !$args{defrec};
5283 $args{revrec} = 'n' if !$args{revrec};
[116]5284
[667]5285 # clean up the parent-type. Set it to group if not set
5286 $args{partype} = 'group' if !$args{partype};
5287
5288 # allow callers to be lazy with type
5289 $args{type} = 'revzone' if $args{type} eq 'domain' && $args{revrec} eq 'y';
5290
5291 if ($par_type{$args{partype}} eq 'domain' || $par_type{$args{partype}} eq 'revzone') {
[254]5292 # only live records can have a domain/zone parent
5293 return unless ($args{type} eq 'record' && $args{defrec} eq 'n');
5294 my $result = $dbh->selectrow_hashref("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
5295 " FROM records WHERE record_id = ?",
5296 undef, ($args{id}) ) or return;
5297 return $result;
5298 } else {
5299 # snag some arguments that will either fall through or be overwritten to save some code duplication
5300 my $tmpid = $args{id};
5301 my $type = $args{type};
5302 if ($type eq 'record' && $args{defrec} eq 'n') {
5303 # Live records go through the records table first.
5304 ($tmpid) = $dbh->selectrow_array("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
5305 " FROM records WHERE record_id = ?",
5306 undef, ($args{id}) ) or return;
5307 $type = ($args{revrec} eq 'n' ? 'domain' : 'revzone');
5308 }
5309 my ($result) = $dbh->selectrow_array("SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?",
5310 undef, ($tmpid) );
5311 return $result;
5312 }
5313# should be impossible to get here with even remotely sane arguments
5314 return;
5315} # end parentID()
[116]5316
5317
[117]5318## DNSDB::isParent()
5319# Returns true if $id1 is a parent of $id2, false otherwise
5320sub isParent {
[470]5321 my $self = shift;
5322 my $dbh = $self->{dbh};
[117]5323 my $id1 = shift;
5324 my $type1 = shift;
5325 my $id2 = shift;
5326 my $type2 = shift;
5327##todo: immediate, secondary, full (default)
5328
[157]5329 # Return false on invalid types
[244]5330 return 0 if !grep /^$type1$/, ('record','defrec','defrevrec','user','domain','revzone','group');
5331 return 0 if !grep /^$type2$/, ('record','defrec','defrevrec','user','domain','revzone','group');
[157]5332
[117]5333 # Return false on impossible relations
5334 return 0 if $type1 eq 'record'; # nothing may be a child of a record
5335 return 0 if $type1 eq 'defrec'; # nothing may be a child of a record
[244]5336 return 0 if $type1 eq 'defrevrec'; # nothing may be a child of a record
[117]5337 return 0 if $type1 eq 'user'; # nothing may be child of a user
5338 return 0 if $type1 eq 'domain' && $type2 ne 'record'; # domain may not be a parent of anything other than a record
[244]5339 return 0 if $type1 eq 'revzone' && $type2 ne 'record';# reverse zone may not be a parent of anything other than a record
[117]5340
[186]5341 # ennnhhhh.... if we're passed an id of 0, it will never be found. usual
5342 # case would be the UI creating a new <thing>, and so we don't have an ID for
5343 # <thing> to look up yet. in that case the UI should check the parent as well.
5344 return 0 if $id1 == 0; # nothing can have a parent id of 0
5345 return 1 if $id2 == 0; # anything could have a child id of 0 (or "unknown")
5346
[117]5347 # group 1 is the ultimate root parent
5348 return 1 if $type1 eq 'group' && $id1 == 1;
5349
[155]5350 # groups are always (a) parent of themselves
5351 return 1 if $type1 eq 'group' && $type2 eq 'group' && $id1 == $id2;
5352
[117]5353 my $id = $id2;
5354 my $type = $type2;
5355 my $foundparent = 0;
[155]5356
[244]5357 # Records are the only entity with two possible parents. We need to split the parent checks on
5358 # domain/rdns.
5359 if ($type eq 'record') {
5360 my ($dom,$rdns) = $dbh->selectrow_array("SELECT domain_id,rdns_id FROM records WHERE record_id=?",
5361 undef, ($id));
5362 # check immediate parent against request
5363 return 1 if $type1 eq 'domain' && $id1 == $dom;
5364 return 1 if $type1 eq 'revzone' && $id1 == $rdns;
5365 # if request is group, check *both* parents. Only check if the parent is nonzero though.
[470]5366 return 1 if $dom && $self->isParent($id1, $type1, $dom, 'domain');
5367 return 1 if $rdns && $self->isParent($id1, $type1, $rdns, 'revzone');
[244]5368 # exit here since we've executed the loop below by proxy in the above recursive calls.
5369 return 0;
5370 }
5371
5372# almost the same loop as getParents() above
[186]5373 my $limiter = 0;
[117]5374 while (1) {
[155]5375 my $sql = "SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?";
[117]5376 my $result = $dbh->selectrow_hashref($sql,
[157]5377 undef, ($id) );
[186]5378 if (!$result) {
5379 $limiter++;
[244]5380##fixme: how often will this happen on a live site? fail at max limiter <n>?
[541]5381# 2013/10/22 only seems to happen when you request an entity that doesn't exist.
[186]5382 warn "no results looking for $sql with id $id (depth $limiter)\n";
5383 last;
5384 }
[157]5385 if ($result && $result->{$par_col{$type}} == $id1) {
[117]5386 $foundparent = 1;
5387 last;
[157]5388 } else {
5389##fixme: do we care about trying to return a "no such record/domain/user/group" error?
[244]5390# should be impossible to create an inconsistent DB just with API calls.
[157]5391 warn $dbh->errstr." $sql, $id" if $dbh->errstr;
[117]5392 }
5393 # group 1 is its own parent. need this here more to break strange loops than for detecting a parent
5394 last if $result->{$par_col{$type}} == 1;
[152]5395 $id = $result->{$par_col{$type}};
[117]5396 $type = $par_type{$type};
5397 }
5398
5399 return $foundparent;
5400} # end isParent()
5401
5402
[275]5403## DNSDB::zoneStatus()
5404# Returns and optionally sets a zone's status
5405# Takes a database handle, domain/revzone ID, forward/reverse flag, and optionally a status argument
5406# Returns status, or undef on errors.
5407sub zoneStatus {
[477]5408 my $self = shift;
5409 my $dbh = $self->{dbh};
[3]5410 my $id = shift;
[275]5411 my $revrec = shift;
5412 my $newstatus = shift || 'mu';
[3]5413
5414 return undef if $id !~ /^\d+$/;
5415
[283]5416 # Allow transactions, and raise an exception on errors so we can catch it later.
5417 # Use local to make sure these get "reset" properly on exiting this block
5418 local $dbh->{AutoCommit} = 0;
5419 local $dbh->{RaiseError} = 1;
5420
[275]5421 if ($newstatus ne 'mu') {
[283]5422 # ooo, fun! let's see what we were passed for status
5423 eval {
5424 $newstatus = 0 if $newstatus eq 'domoff';
5425 $newstatus = 1 if $newstatus eq 'domon';
5426 $dbh->do("UPDATE ".($revrec eq 'n' ? 'domains' : 'revzones')." SET status=? WHERE ".
[275]5427 ($revrec eq 'n' ? 'domain_id' : 'rdns_id')."=?", undef, ($newstatus,$id) );
[283]5428
5429##fixme switch to more consise "Enabled <domain"/"Disabled <domain>" as with users?
[473]5430 $resultstr = "Changed ".($revrec eq 'n' ? $self->domainName($id) : $self->revName($id)).
[283]5431 " state to ".($newstatus ? 'active' : 'inactive');
5432
5433 my %loghash;
5434 $loghash{domain_id} = $id if $revrec eq 'n';
5435 $loghash{rdns_id} = $id if $revrec eq 'y';
[473]5436 $loghash{group_id} = $self->parentID(id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec);
[283]5437 $loghash{entry} = $resultstr;
[487]5438 $self->_log(%loghash);
[283]5439
5440 $dbh->commit;
5441 };
5442 if ($@) {
5443 my $msg = $@;
5444 eval { $dbh->rollback; };
5445 $resultstr = '';
5446 $errstr = $msg;
5447 return;
5448 }
[3]5449 }
5450
[275]5451 my ($status) = $dbh->selectrow_array("SELECT status FROM ".
5452 ($revrec eq 'n' ? "domains WHERE domain_id=?" : "revzones WHERE rdns_id=?"),
5453 undef, ($id) );
[3]5454 return $status;
[275]5455} # end zoneStatus()
[3]5456
5457
[452]5458## DNSDB::getZonesByCIDR()
5459# Get a list of zone names and IDs that records for a passed CIDR block are within.
[710]5460# Optionally restrict to a specific location/view
[715]5461# Optionally leave off the default_location field
[452]5462sub getZonesByCIDR {
[477]5463 my $self = shift;
5464 my $dbh = $self->{dbh};
[452]5465 my %args = @_;
[715]5466 $args{return_location} = 1 if !defined($args{return_location});
[452]5467
[715]5468 my $sql = "SELECT rdns_id,revnet".($args{return_location} ? ',default_location' : '').
5469 " FROM revzones WHERE (revnet >>= ? OR revnet <<= ?)".
5470 (defined($args{location}) ? " AND default_location = ?" : '');
[710]5471 my @svals = ($args{cidr}, $args{cidr});
[715]5472 push @svals, $args{location} if defined $args{location};
[710]5473
5474 my $result = $dbh->selectall_arrayref($sql, { Slice => {} }, @svals );
[452]5475 return $result;
5476} # end getZonesByCIDR()
5477
5478
[33]5479## DNSDB::importAXFR
5480# Import a domain via AXFR
[37]5481# Takes AXFR host, domain to transfer, group to put the domain in,
[484]5482# and an optional hash containing:
5483# status - active/inactive state flag (defaults to active)
5484# rwsoa - overwrite-SOA flag (defaults to off)
5485# rwns - overwrite-NS flag (defaults to off, doesn't affect subdomain NS records)
5486# merge - flag to automerge A or AAAA records with matching PTR records
[37]5487# Returns a status code (OK, WARN, or FAIL) and message - message should be blank
5488# if status is OK, but WARN includes conditions that are not fatal but should
5489# really be reported.
[33]5490sub importAXFR {
[484]5491 my $self = shift;
5492 my $dbh = $self->{dbh};
[35]5493 my $ifrom_in = shift;
[301]5494 my $zone = shift;
[33]5495 my $group = shift;
[484]5496
5497 my %args = @_;
5498
[33]5499##fixme: add mode to delete&replace, merge+overwrite, merge new?
5500
[484]5501 $args{status} = (defined($args{status}) ? $args{status} : 0);
5502 $args{status} = 1 if $args{status} eq 'on';
5503
[37]5504 my $nrecs = 0;
5505 my $soaflag = 0;
5506 my $nsflag = 0;
5507 my $warnmsg = '';
5508 my $ifrom;
[33]5509
[301]5510 my $rev = 'n';
[302]5511 my $code = 'OK';
5512 my $msg = 'foobar?';
[301]5513
[35]5514 # choke on possible bad setting in ifrom
[37]5515 # IPv4 and v6, and valid hostnames!
[35]5516 ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
5517 return ('FAIL', "Bad AXFR source host $ifrom")
5518 unless ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
5519
[301]5520 my $errmsg;
5521
5522 my $zone_id;
5523 my $domain_id = 0;
5524 my $rdns_id = 0;
5525 my $cidr;
5526
5527# magic happens! detect if we're importing a domain or a reverse zone
5528# while we're at it, figure out what the CIDR netblock is (if we got a .arpa)
5529# or what the formal .arpa zone is (if we got a CIDR netblock)
5530# Handles sub-octet v4 zones in the format specified in the Cricket Book, 2nd Ed, p217-218
5531
[601]5532 if ($zone =~ m{(?:\.arpa\.?|/\d+|^[\d.]+|^[a-fA-F0-9:]+)$}) {
[301]5533 # we seem to have a reverse zone
5534 $rev = 'y';
5535
5536 if ($zone =~ /\.arpa\.?$/) {
5537 # we have a formal reverse zone. call _zone2cidr and get the CIDR block.
5538 ($code,$msg) = _zone2cidr($zone);
5539 return ($code, $msg) if $code eq 'FAIL';
5540 $cidr = $msg;
5541 } elsif ($zone =~ m|^[\d.]+/\d+$|) {
5542 # v4 revzone, CIDR netblock
5543 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
5544 $zone = _ZONE($cidr, 'ZONE.in-addr.arpa', 'r', '.');
[601]5545 } elsif ($zone =~ /^[\d.]+$/) {
5546 # v4 revzone, leading-octet format
5547 my $mask = 32;
5548 while ($zone !~ /^\d+\.\d+\.\d+\.\d+$/) {
5549 $zone .= '.0';
5550 $mask -= 8;
5551 }
5552 $zone .= "/$mask";
5553 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
5554 $zone = _ZONE($cidr, 'ZONE.in-addr.arpa', 'r', '.');
[301]5555 } elsif ($zone =~ m|^[a-fA-F\d:]+/\d+$|) {
5556 # v6 revzone, CIDR netblock
5557 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
5558 return ('FAIL', "$zone is not a nibble-aligned block") if $cidr->masklen % 4 != 0;
5559 $zone = _ZONE($cidr, 'ZONE.ip6.arpa', 'r', '.');
[601]5560 } elsif ($zone =~ /^[a-fA-F\d:]+$/) {
5561 # v6 revzone, leading-group format
5562 $zone =~ s/::$//;
5563 my $mask = 128;
5564 while ($zone !~ /^(?:[a-fA-F\d]{1,4}:){7}[a-fA-F\d]$/) {
5565 $zone .= ":0";
5566 $mask -= 16;
5567 }
5568 $zone .= "/$mask";
5569 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
5570 $zone = _ZONE($cidr, 'ZONE.ip6.arpa', 'r', '.');
[301]5571 } else {
5572 # there is. no. else!
[601]5573 return ('FAIL', "Unknown zone name format '$zone'");
[301]5574 }
5575
[601]5576 # several places this can be triggered from; better to do it once.
5577 $warnmsg .= "Apparent sub-/64 IPv6 reverse zone\n" if $cidr->masklen > 64;
5578
[301]5579 # quick check to start to see if we've already got one
5580
5581 ($zone_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?",
5582 undef, ("$cidr"));
5583 $rdns_id = $zone_id;
5584 } else {
5585 # default to domain
[349]5586 ($zone_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
[301]5587 undef, ($zone));
5588 $domain_id = $zone_id;
5589 }
5590
5591 return ('FAIL', ($rev eq 'n' ? 'Domain' : 'Reverse zone')." already exists") if $zone_id;
5592
[303]5593 # little local utility sub to swap $val and $host for revzone records.
5594 sub _revswap {
5595 my $rechost = shift;
5596 my $recdata = shift;
5597
5598 if ($rechost =~ /\.in-addr\.arpa\.?$/) {
5599 $rechost =~ s/\.in-addr\.arpa\.?$//;
5600 $rechost = join '.', reverse split /\./, $rechost;
5601 } else {
5602 $rechost =~ s/\.ip6\.arpa\.?$//;
5603 my @nibs = reverse split /\./, $rechost;
5604 $rechost = '';
5605 my $nc;
5606 foreach (@nibs) {
[634]5607# # fail on multicharacter nibbles; it's syntactically valid but no standard lookup
5608# # will ever reach it, because it doesn't directly represent a real IP address.
5609# return ('FAIL', "Invalid reverse v6 entry") if $_ !~ /^.$/;
[303]5610 $rechost.= $_;
5611 $rechost .= ":" if ++$nc % 4 == 0 && $nc < 32;
5612 }
[307]5613 $rechost .= ":" if $nc < 32 && $rechost !~ /\*$/; # close netblock records?
5614##fixme: there's a case that ends up with a partial entry here:
5615# ip:add:re:ss::
5616# can't reproduce after letting it sit overnight after discovery. :(
5617#print "$rechost\n";
[303]5618 # canonicalize with NetAddr::IP
5619 $rechost = NetAddr::IP->new($rechost)->addr unless $rechost =~ /\*$/;
5620 }
5621 return ($recdata,$rechost)
5622 }
5623
5624
[33]5625 # Allow transactions, and raise an exception on errors so we can catch it later.
5626 # Use local to make sure these get "reset" properly on exiting this block
5627 local $dbh->{AutoCommit} = 0;
5628 local $dbh->{RaiseError} = 1;
5629
[301]5630 my $sth;
5631 eval {
[34]5632
[744]5633 my $logparent;
5634
[301]5635 if ($rev eq 'n') {
[33]5636##fixme: serial
[484]5637 $dbh->do("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)", undef,
[710]5638 ($zone, $group, $args{status}) ) or die $dbh->errstr;
[301]5639 # get domain id so we can do the records
5640 ($zone_id) = $dbh->selectrow_array("SELECT currval('domains_domain_id_seq')");
5641 $domain_id = $zone_id;
[744]5642 $logparent = $self->_log(group_id => $group, domain_id => $domain_id,
[487]5643 entry => "[Added ".($args{status} ? 'active' : 'inactive')." domain $zone via AXFR]");
[301]5644 } else {
5645##fixme: serial
[484]5646 $dbh->do("INSERT INTO revzones (revnet,group_id,status) VALUES (?,?,?)", undef,
5647 ($cidr,$group,$args{status}) );
[301]5648 # get revzone id so we can do the records
5649 ($zone_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
5650 $rdns_id = $zone_id;
[744]5651 $logparent = $self->_log(group_id => $group, rdns_id => $rdns_id,
[487]5652 entry => "[Added ".($args{status} ? 'active' : 'inactive')." reverse zone $cidr via AXFR]");
[301]5653 }
[33]5654
[35]5655## bizarre DBI<->Net::DNS interaction bug:
5656## sometimes a zone will cause an immediate commit-and-exit (sort of) of the while()
[37]5657## fixed, apparently I was doing *something* odd, but not certain what it was that
5658## caused a commit instead of barfing
[35]5659
[34]5660 my $res = Net::DNS::Resolver->new;
[35]5661 $res->nameservers($ifrom);
[301]5662 $res->axfr_start($zone)
[35]5663 or die "Couldn't begin AXFR\n";
[34]5664
[301]5665 $sth = $dbh->prepare("INSERT INTO records (domain_id,rdns_id,host,type,val,distance,weight,port,ttl)".
5666 " VALUES (?,?,?,?,?,?,?,?,?)");
5667
[307]5668 # Stash info about sub-octet v4 revzones here so we don't have
5669 # to store the CNAMEs used to delegate a suboctet zone
5670 # $suboct{zone}{ns}[] -> array of nameservers
5671 # $suboct{zone}{cname}[] -> array of extant CNAMEs (Just In Case someone did something bizarre)
5672## commented pending actual use of this data. for now, we'll just
5673## auto-(re)create the CNAMEs in revzones on export
5674# my %suboct;
5675
[35]5676 while (my $rr = $res->axfr_next()) {
[301]5677
[596]5678 # Discard out-of-zone records. After trying for a while to replicate this with
5679 # *nix-based DNS servers, it appears that only MS DNS is prone to including these
5680 # in the AXFR data in the first place, and possibly only older versions at that...
5681 # so it can't be reasonably tested. Yay Microsoft.
5682 if ($rr->name !~ /$zone$/i) {
5683 $warnmsg .= "Discarding out-of-zone record ".$rr->string."\n";
5684 }
5685
[301]5686 my $val;
5687 my $distance = 0;
5688 my $weight = 0;
5689 my $port = 0;
[303]5690 my $logfrag = '';
[301]5691
[602]5692 # Collect some record parts
[33]5693 my $type = $rr->type;
[301]5694 my $host = $rr->name;
[484]5695 my $ttl = ($args{newttl} ? $args{newttl} : $rr->ttl); # allow force-override TTLs
[35]5696
[602]5697 # Info flags for SOA and NS records
[37]5698 $soaflag = 1 if $type eq 'SOA';
5699 $nsflag = 1 if $type eq 'NS';
[35]5700
[34]5701# "Primary" types:
5702# A, NS, CNAME, SOA, PTR(warn in forward), MX, TXT, AAAA, SRV, A6(ob), SPF
5703# maybe KEY
5704
[302]5705# BIND supports:
5706# [standard]
5707# A AAAA CNAME MX NS PTR SOA TXT
5708# [variously experimental, obsolete, or obscure]
5709# HINFO MB(ex) MD(ob) MF(ob) MG(ex) MINFO(ex) MR(ex) NULL WKS AFSDB(ex) ISDN(ex) RP(ex) RT(ex) X25(ex) PX
5710# ... if one can ever find the right magic to format them correctly
5711
5712# Net::DNS supports:
5713# RRSIG SIG NSAP NS NIMLOC NAPTR MX MR MINFO MG MB LOC ISDN IPSECKEY HINFO
5714# EID DNAME CNAME CERT APL AFSDB AAAA A DS NXT NSEC3PARAM NSEC3 NSEC KEY
5715# DNSKEY DLV X25 TXT TSIG TKEY SSHFP SRV SPF SOA RT RP PX PTR NULL APL::AplItem
5716
[35]5717# nasty big ugly case-like thing here, since we have to do *some* different
5718# processing depending on the record. le sigh.
5719
[602]5720# do the initial processing as if the record was in a forward zone. If we're
5721# doing a revzone, we can flip $host and $val as needed, once, after this
5722# monster if-elsif-...-elsif-else. This actually simplifies things a lot.
5723
[105]5724##fixme: what record types other than TXT can/will have >255-byte payloads?
5725
[34]5726 if ($type eq 'A') {
[301]5727 $val = $rr->address;
[34]5728 } elsif ($type eq 'NS') {
[635]5729# hmm. should we warn here if subdomain NS'es are left alone? OTOH, those should rarely be rewritten anyway.
[602]5730 next if ($args{rwns} && ($host eq $zone));
5731 $val = $rr->nsdname;
[639]5732 $warnmsg .= "Suspect record '".$rr->string."' may not be imported correctly: NS records may not be bare IP addresses\n"
5733 if $val =~ /^(?:(?:\d+\.){3}\d+|[a-fA-F0-9:]+)$/;
[35]5734 $nsflag = 1;
[34]5735 } elsif ($type eq 'CNAME') {
[602]5736 $val = $rr->cname;
[639]5737 $warnmsg .= "Suspect record '".$rr->string."' may not be imported correctly: CNAME records may not be bare IP addresses\n"
5738 if $val =~ /^(?:(?:\d+\.){3}\d+|[a-fA-F0-9:]+)$/;
[34]5739 } elsif ($type eq 'SOA') {
[484]5740 next if $args{rwsoa};
[307]5741 $host = $rr->rname.":".$rr->mname;
[301]5742 $val = $rr->refresh.":".$rr->retry.":".$rr->expire.":".$rr->minimum;
[35]5743 $soaflag = 1;
[34]5744 } elsif ($type eq 'PTR') {
[602]5745 $val = $rr->ptrdname;
[34]5746 } elsif ($type eq 'MX') {
[301]5747 $val = $rr->exchange;
5748 $distance = $rr->preference;
[34]5749 } elsif ($type eq 'TXT') {
5750##fixme: Net::DNS docs say this should be deprecated for rdatastr() or char_str_list(),
5751## but don't really seem enthusiastic about it.
[303]5752#print "should use rdatastr:\n\t".$rr->rdatastr."\n or char_str_list:\n\t".join(' ',$rr->char_str_list())."\n";
5753# rdatastr returns a BIND-targetted logical string, including opening and closing quotes
5754# char_str_list returns a list of the individual string fragments in the record
[307]5755# txtdata returns the more useful all-in-one form (since we want to push such protocol
5756# details as far down the stack as we can)
[303]5757# NB: this may turn out to be more troublesome if we ever have need of >512-byte TXT records.
[602]5758 $val = $rr->txtdata;
[34]5759 } elsif ($type eq 'SPF') {
5760##fixme: and the same caveat here, since it is apparently a clone of ::TXT
[301]5761 $val = $rr->txtdata;
[34]5762 } elsif ($type eq 'AAAA') {
[301]5763 $val = $rr->address;
[34]5764 } elsif ($type eq 'SRV') {
[301]5765 $val = $rr->target;
5766 $distance = $rr->priority;
5767 $weight = $rr->weight;
5768 $port = $rr->port;
[639]5769 $warnmsg .= "Suspect record '".$rr->string."' may not be imported correctly: SRV records may not be bare IP addresses\n"
5770 if $val =~ /^(?:(?:\d+\.){3}\d+|[a-fA-F0-9:]+)$/;
[34]5771 } elsif ($type eq 'KEY') {
[35]5772 # we don't actually know what to do with these...
[301]5773 $val = $rr->flags.":".$rr->protocol.":".$rr->algorithm.":".$rr->key.":".$rr->keytag.":".$rr->privatekeyname;
[35]5774 } else {
[301]5775 $val = $rr->rdatastr;
[35]5776 # Finding a different record type is not fatal.... just problematic.
[37]5777 # We may not be able to export it correctly.
[35]5778 $warnmsg .= "Unusual record ".$rr->name." ($type) found\n";
[33]5779 }
5780
[602]5781 if ($rev eq 'y' && $type ne 'SOA') {
5782 # up to this point we haven't meddled with the record's hostname part or rdata part.
5783 # for reverse records, (except SOA) we must swap the two.
5784 $host = $val;
5785 $val = $rr->name;
5786 my ($tmpcode,$tmpmsg) = _zone2cidr($val);
5787 if ($tmpcode eq 'FAIL') {
5788 # $val did not have a valid IP value. It's syntactically valid but WTF?
5789 $warnmsg .= "Suspect record '".$rr->string."' may not be imported correctly: $tmpmsg\n";
5790 } else {
5791 # $val has a valid IP value. See if we can store it as that IP value.
5792 # Note we're enumerating do-nothing cases for clarity.
5793##enhance: this is where we will implement the more subtle variations on #53
5794 if ($type ne 'PTR' && $type ne 'NS' && $type ne 'CNAME' && $type ne 'TXT') {
5795 # case: the record is "weird" - ie, not a PTR, NS, CNAME, or TXT
5796 # $warnmsg .= "Discarding suspect record '".$rr->string."'\n" if $self->{strict} eq 'full';
5797 } elsif ($type eq 'PTR' && $tmpmsg->masklen != 32 && $tmpmsg->masklen != 128) {
5798 # case: PTR with netblock value, not IP value
5799 # eg, "@ PTR foo" in zone f.e.e.b.d.a.e.d.ip6.arpa should not be
5800 # stored/displayed as dead:beef::/32 PTR foo
5801
5802## hrm. WTF is this case for, anyway? Needs testing to check the logic.
5803# } elsif ( ($type eq 'PTR' || $type eq 'NS' || $type eq 'CNAME' || $type eq 'TXT') &&
5804# ($tmpmsg->masklen != $cidr->masklen)
5805# ) {
5806# # leave $val as-is if the record is "normal" (a PTR, NS, CNAME, or TXT),
5807# # and the mask does not match the zone
5808#$warnmsg .= "WTF case: $host $type $val\n";
5809# # $warnmsg .= "Discarding suspect record '".$rr->string."'\n" if $self->{strict} eq 'full';
5810
5811 } else {
5812 $val = $tmpmsg;
5813 $val =~ s/\/(?:32|128)$//; # automagically converts $val back to a string before s///
5814 #$val =~ s/:0$//g;
5815 }
5816 }
5817 # magic? convert * records to PTR template (not sure this actually makes sense)
5818 #if ($val =~ /^\*/) {
5819 # $val =~ s/\*\.//;
5820 # ($tmpcode,$tmpmsg) = _zone2cidr($val);
5821 # if ($tmpcode eq 'FAIL') {
5822 # $val = "*.$val";
5823 # $warnmsg .= "Suspect record '".$rr->string."' may not be converted to PTR template correctly: $tmpmsg\n";
5824 # } else {
5825 # $type = 'PTR template';
5826 # $val = $tmpmsg; if $tmp
5827 # $val =~ s/\/(?:32|128)$//; # automagically converts $val back to a string before s///
5828 # }
5829 #}
5830 } # non-SOA revrec $host/$val inversion and munging
5831
[303]5832 my $logentry = "[AXFR ".($rev eq 'n' ? $zone : $cidr)."] ";
[34]5833
[484]5834 if ($args{merge}) {
[307]5835 if ($rev eq 'n') {
5836 # importing a domain; we have A and AAAA records that could be merged with matching PTR records
5837 my $etype;
5838 my ($erdns,$erid,$ettl) = $dbh->selectrow_array("SELECT rdns_id,record_id,ttl FROM records ".
5839 "WHERE host=? AND val=? AND type=12",
5840 undef, ($host, $val) );
5841 if ($erid) {
5842 if ($type eq 'A') { # PTR -> A+PTR
5843 $etype = 65280;
5844 $logentry .= "Merged A record with existing PTR record '$host A+PTR $val', TTL $ettl";
5845 }
5846 if ($type eq 'AAAA') { # PTR -> AAAA+PTR
5847 $etype = 65281;
5848 $logentry .= "Merged AAAA record with existing PTR record '$host AAAA+PTR $val', TTL $ettl";
5849 }
5850 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
5851 $dbh->do("UPDATE records SET domain_id=?,ttl=?,type=? WHERE record_id=?", undef,
5852 ($domain_id, $ettl, $etype, $erid));
5853 $nrecs++;
[487]5854 $self->_log(group_id => $group, domain_id => $domain_id, rdns_id => $erdns, entry => $logentry);
[307]5855 next; # while axfr_next
5856 }
5857 } # $rev eq 'n'
5858 else {
5859 # importing a revzone, we have PTR records that could be merged with matching A/AAAA records
5860 my ($domid,$erid,$ettl,$etype) = $dbh->selectrow_array("SELECT domain_id,record_id,ttl,type FROM records ".
5861 "WHERE host=? AND val=? AND (type=1 OR type=28)",
5862 undef, ($host, $val) );
5863 if ($erid) {
5864 if ($etype == 1) { # A -> A+PTR
5865 $etype = 65280;
5866 $logentry .= "Merged PTR record with existing matching A record '$host A+PTR $val', TTL $ettl";
5867 }
5868 if ($etype == 28) { # AAAA -> AAAA+PTR
5869 $etype = 65281;
5870 $logentry .= "Merged PTR record with existing matching AAAA record '$host AAAA+PTR $val', TTL $ettl";
5871 }
5872 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
5873 $dbh->do("UPDATE records SET rdns_id=?,ttl=?,type=? WHERE record_id=?", undef,
5874 ($rdns_id, $ettl, $etype, $erid));
5875 $nrecs++;
[487]5876 $self->_log(group_id => $group, domain_id => $domid, rdns_id => $rdns_id, entry => $logentry);
[307]5877 next; # while axfr_next
5878 }
5879 } # $rev eq 'y'
[484]5880 } # if $args{merge}
[34]5881
[302]5882 # Insert the new record
[301]5883 $sth->execute($domain_id, $rdns_id, $host, $reverse_typemap{$type}, $val,
5884 $distance, $weight, $port, $ttl);
5885
[37]5886 $nrecs++;
[34]5887
[301]5888 if ($type eq 'SOA') {
[484]5889 # also !$args{rwsoa}, but if that's set, it should be impossible to get here.
[301]5890 my @tmp1 = split /:/, $host;
5891 my @tmp2 = split /:/, $val;
5892 $logentry .= "Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
5893 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl";
[303]5894 } elsif ($logfrag) {
5895 # special case for log entries we need to meddle with a little.
5896 $logentry .= $logfrag;
[301]5897 } else {
[602]5898 $logentry .= "Added record '".($rev eq 'y' ? $val : $host)." $type";
[301]5899 $logentry .= " [distance $distance]" if $type eq 'MX';
5900 $logentry .= " [priority $distance] [weight $weight] [port $port]" if $type eq 'SRV';
[602]5901 $logentry .= " ".($rev eq 'y' ? $host : $val)."', TTL $ttl";
[301]5902 }
[744]5903 $self->_log(group_id => $group, domain_id => $domain_id, rdns_id => $rdns_id,
5904 logparent => $logparent, entry => $logentry);
[301]5905
[37]5906 } # while axfr_next
5907
[307]5908# Detect and handle delegated subzones
5909# Placeholder for when we decide what to actually do with this, see previous comments in NS and CNAME handling.
5910#foreach (keys %suboct) {
5911# print "found ".($suboct{$_}{ns} ? @{$suboct{$_}{ns}} : '0')." NS records and ".
5912# ($suboct{$_}{cname} ? @{$suboct{$_}{cname}} : '0')." CNAMEs for $_\n";
5913#}
5914
[37]5915 # Overwrite SOA record
[484]5916 if ($args{rwsoa}) {
[37]5917 $soaflag = 1;
[573]5918 my $sthgetsoa = $dbh->prepare("SELECT host,val,ttl FROM "._rectable('y', $rev)." WHERE group_id=? AND type=?");
5919 my $sthputsoa = $dbh->prepare("INSERT INTO records (".
5920 ($rev eq 'n' ? 'domain_id' : 'rdns_id').",host,type,val,ttl) VALUES (?,?,?,?,?)");
[37]5921 $sthgetsoa->execute($group,$reverse_typemap{SOA});
5922 while (my ($host,$val,$ttl) = $sthgetsoa->fetchrow_array()) {
[573]5923 if ($rev eq 'n') {
5924 $host =~ s/DOMAIN/$zone/g;
5925 $val =~ s/DOMAIN/$zone/g; # arguably useless
5926 } else {
5927 $host =~ s/ADMINDOMAIN/$self->{domain}/g;
5928 }
[301]5929 $sthputsoa->execute($zone_id,$host,$reverse_typemap{SOA},$val,$ttl);
[34]5930 }
[37]5931 }
[34]5932
[573]5933 # Add standard NS records. The old one(s) should have been skipped by this point.
[484]5934 if ($args{rwns}) {
[37]5935 $nsflag = 1;
[573]5936 my $sthgetns = $dbh->prepare("SELECT host,val,ttl FROM "._rectable('y',$rev)." WHERE group_id=? AND type=?");
5937 my $sthputns = $dbh->prepare("INSERT INTO records (".
5938 ($rev eq 'n' ? 'domain_id' : 'rdns_id').",host,type,val,ttl) VALUES (?,?,?,?,?)");
[37]5939 $sthgetns->execute($group,$reverse_typemap{NS});
5940 while (my ($host,$val,$ttl) = $sthgetns->fetchrow_array()) {
[573]5941 if ($rev eq 'n') {
5942 $host =~ s/DOMAIN/$zone/g;
5943 $val =~ s/DOMAIN/$zone/g; #hmm.
5944 } else {
5945 $host =~ s/ADMINDOMAIN/$self->{domain}/g; #hmm.
5946 $val =~ s/ZONE/$cidr/g;
5947 }
[301]5948 $sthputns->execute($zone_id,$host,$reverse_typemap{NS},$val,$ttl);
[37]5949 }
5950 }
[34]5951
[35]5952 die "No records found; either $ifrom is not authoritative or doesn't allow transfers\n" if !$nrecs;
5953 die "Bad zone: No SOA record!\n" if !$soaflag;
5954 die "Bad zone: No NS records!\n" if !$nsflag;
5955
[37]5956 $dbh->commit;
[35]5957
[33]5958 };
5959
5960 if ($@) {
5961 my $msg = $@;
5962 eval { $dbh->rollback; };
[34]5963 return ('FAIL',$msg." $warnmsg");
[33]5964 } else {
[35]5965 return ('WARN', $warnmsg) if $warnmsg;
[91]5966 return ('OK',"Imported OK");
[33]5967 }
5968
[37]5969 # it should be impossible to get here.
[34]5970 return ('WARN',"OOOK!");
[33]5971} # end importAXFR()
5972
5973
[302]5974## DNSDB::importBIND()
5975sub importBIND {
5976} # end importBIND()
5977
5978
5979## DNSDB::import_tinydns()
5980sub import_tinydns {
5981} # end import_tinydns()
5982
5983
[103]5984## DNSDB::export()
5985# Export the DNS database, or a part of it
[485]5986# Takes a string indicating the export type, plus optional arguments depending on type
[103]5987# Writes zone data to targets as appropriate for type
5988sub export {
[485]5989 my $self = shift;
[103]5990 my $target = shift;
5991
5992 if ($target eq 'tiny') {
[567]5993 eval {
5994 $self->__export_tiny(@_);
5995 };
5996 if ($@) {
5997 $errstr = $@;
5998 return undef;
5999 }
[103]6000 }
6001# elsif ($target eq 'foo') {
[485]6002# __export_foo(@_);
[103]6003#}
6004# etc
6005
[567]6006 return 1;
[103]6007} # end export()
6008
6009
6010## DNSDB::__export_tiny
6011# Internal sub to implement tinyDNS (compatible) export
[485]6012# Takes filehandle to write export to, optional argument(s)
[103]6013# to determine which data gets exported
6014sub __export_tiny {
[485]6015 my $self = shift;
6016 my $dbh = $self->{dbh};
[103]6017 my $datafile = shift;
[559]6018 my $zonefilehandle = $datafile; # makes cache/no-cache a little simpler
[103]6019
6020##fixme: slurp up further options to specify particular zone(s) to export
6021
6022##fixme: fail if $datafile isn't an open, writable file
6023
[566]6024 # Error check - does the cache dir exist, if we're using one?
6025 if ($self->{usecache}) {
[763]6026 die "Cache directory $self->{exportcache} does not exist\n" if !-e $self->{exportcache};
[566]6027 die "$self->{exportcache} is not a directory\n" if !-d $self->{exportcache};
6028 die "$self->{exportcache} must be both readable and writable\n"
6029 if !-r $self->{exportcache} || !-w $self->{exportcache};
6030 }
6031
[103]6032 # easy case - export all evarything
6033 # not-so-easy case - export item(s) specified
6034 # todo: figure out what kind of list we use to export items
6035
[329]6036# raw packet in unknown format: first byte indicates length
6037# of remaining data, allows up to 255 raw bytes
6038
[566]6039 # note: the only I/O failures we seem to be able to actually catch
6040 # here are "closed filehandle" errors. we're probably not writing
6041 # enough data at this point to properly trigger an "out of space"
6042 # error. :/
6043 eval {
6044 use warnings FATAL => ('io');
6045 # Locations/views - worth including in the caching setup?
6046 my $lochash = $dbh->selectall_hashref("SELECT location,iplist FROM locations", 'location');
6047 foreach my $location (keys %$lochash) {
6048 foreach my $ipprefix (split /[,\s]+/, $lochash->{$location}{iplist}) {
6049 $ipprefix =~ s/\s+//g;
6050 $ipprefix = new NetAddr::IP $ipprefix;
[449]6051##fixme: how to handle IPv6?
6052next if $ipprefix->{isv6};
[566]6053 # have to account for /nn CIDR entries. tinydns only speaks octet-sliced prefix.
6054 if ($ipprefix->masklen <= 8) {
6055 foreach ($ipprefix->split(8)) {
6056 my $tmp = $_->addr;
6057 $tmp =~ s/\.\d+\.\d+\.\d+$//;
6058 print $datafile "%$location:$tmp\n";
6059 }
6060 } elsif ($ipprefix->masklen <= 16) {
6061 foreach ($ipprefix->split(16)) {
6062 my $tmp = $_->addr;
6063 $tmp =~ s/\.\d+\.\d+$//;
6064 print $datafile "%$location:$tmp\n";
6065 }
6066 } elsif ($ipprefix->masklen <= 24) {
6067 foreach ($ipprefix->split(24)) {
6068 my $tmp = $_->addr;
6069 $tmp =~ s/\.\d+$//;
6070 print $datafile "%$location:$tmp\n";
6071 }
6072 } else {
6073 foreach ($ipprefix->split(32)) {
6074 print $datafile "%$location:".$_->addr."\n";
6075 }
[449]6076 }
6077 }
[566]6078 print $datafile "%$location\n" if !$lochash->{$location}{iplist};
[372]6079 }
[566]6080 };
6081 if ($@) {
6082 die "Error writing locations to master file: $@, $!\n";
[372]6083 }
6084
[329]6085 # tracking hash so we don't double-export A+PTR or AAAA+PTR records.
6086 my %recflags;
6087
[523]6088# For reasons unknown, we can't sanely UNION these statements. Feh.
6089# Supposedly it should work though (note last 3 lines):
6090## PG manual
6091#UNION Clause
6092#
6093#The UNION clause has this general form:
6094#
6095# select_statement UNION [ ALL ] select_statement
6096#
6097#select_statement is any SELECT statement without an ORDER BY, LIMIT, FOR UPDATE, or FOR SHARE clause. (ORDER BY
6098#and LIMIT can be attached to a subexpression if it is enclosed in parentheses. Without parentheses, these
6099#clauses will be taken to apply to the result of the UNION, not to its right-hand input expression.)
6100 my $soasth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
6101 "FROM records WHERE rdns_id=? AND type=6");
[543]6102 my $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location,extract(epoch from stamp),expires,stampactive ".
[576]6103 "FROM records WHERE rdns_id=? AND NOT type=6 ".
[599]6104 "ORDER BY masklen(inetlazy(val)) DESC, inetlazy(val)");
[523]6105 my $revsth = $dbh->prepare("SELECT rdns_id,revnet,status,changed FROM revzones WHERE status=1 ".
[566]6106 "ORDER BY masklen(revnet) DESC, rdns_id");
[523]6107 my $zonesth = $dbh->prepare("UPDATE revzones SET changed='n' WHERE rdns_id=?");
6108 $revsth->execute();
6109 while (my ($revid,$revzone,$revstat,$changed) = $revsth->fetchrow_array) {
[368]6110##fixme: need to find a way to block opening symlinked files without introducing a race.
6111# O_NOFOLLOW
6112# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
6113# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
6114# still be followed.
6115# but that doesn't help other platforms. :/
[523]6116 my $tmpzone = NetAddr::IP->new($revzone);
6117##fixme: locations/views? subnet mask? need to avoid possible collisions with zone/superzone
6118## (eg /20 vs /24, starting on .0.0)
6119 my $cz = $tmpzone->network->addr."-".$tmpzone->masklen;
6120 my $cachefile = "$self->{exportcache}/$cz";
6121 my $tmpcache = "$self->{exportcache}/tmp.$cz.$$";
[521]6122 eval {
[108]6123
[559]6124 # write fresh records if:
6125 # - we are not using the cache
6126 # - force_refresh is set
6127 # - the zone has changed
6128 # - the cache file does not exist
6129 # - the cache file is empty
6130 if (!$self->{usecache} || $self->{force_refresh} || $changed || !-e $cachefile || -z $cachefile) {
6131 if ($self->{usecache}) {
6132 open ZONECACHE, ">$tmpcache" or die "Error creating temporary file $tmpcache: $!\n";
6133 $zonefilehandle = *ZONECACHE;
6134 }
[521]6135
[523]6136 # need to fetch this separately since the rest of the records all (should) have real IPs in val
6137 $soasth->execute($revid);
6138 my (@zsoa) = $soasth->fetchrow_array();
[644]6139 $self->_printrec_tiny($zonefilehandle, $zsoa[7], 'y',\%recflags,$revzone,
[523]6140 $zsoa[0],$zsoa[1],$zsoa[2],$zsoa[3],$zsoa[4],$zsoa[5],$zsoa[6],$zsoa[8],'');
6141
6142 $recsth->execute($revid);
[596]6143 my $fullzone = _ZONE($tmpzone, 'ZONE', 'r', '.').($tmpzone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
6144
[573]6145 while (my ($host, $type, $val, $dist, $weight, $port, $ttl, $recid, $loc, $stamp, $expires, $stampactive)
6146 = $recsth->fetchrow_array) {
[523]6147 next if $recflags{$recid};
[521]6148
[596]6149 # Check for out-of-zone data
6150 if ($val =~ /\.arpa$/) {
6151 # val is non-IP
6152 if ($val !~ /$fullzone$/) {
6153 warn "Not exporting out-of-zone record $val $typemap{$type} $host, $ttl (zone $tmpzone)\n";
6154 next;
6155 }
6156 } else {
6157 my $ipval = new NetAddr::IP $val;
6158 if (!$tmpzone->contains($ipval)) {
6159 warn "Not exporting out-of-zone record $val $typemap{$type} $host, $ttl (zone $tmpzone)\n";
6160 next;
6161 }
6162 } # is $val a raw .arpa name?
6163
[597]6164 # Spaces are evil.
6165 $val =~ s/^\s+//;
6166 $val =~ s/\s+$//;
6167 if ($typemap{$type} ne 'TXT') {
6168 # Leading or trailng spaces could be legit in TXT records.
6169 $host =~ s/^\s+//;
6170 $host =~ s/\s+$//;
6171 }
[372]6172
[644]6173 $self->_printrec_tiny($zonefilehandle, $recid, 'y', \%recflags, $revzone,
[559]6174 $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp, $expires, $stampactive);
[450]6175
[523]6176 $recflags{$recid} = 1;
[368]6177
[521]6178 } # while ($recsth)
6179
[559]6180 if ($self->{usecache}) {
6181 close ZONECACHE; # force the file to be written
6182 # catch obvious write errors that leave an empty temp file
6183 if (-s $tmpcache) {
6184 rename $tmpcache, $cachefile
6185 or die "Error overwriting cache file $cachefile with temporary file: $!\n";
6186 }
[521]6187 }
6188
6189 } # if $changed or cache filesize is 0
6190
6191 };
6192 if ($@) {
[566]6193 die "error writing ".($self->{usecache} ? 'new data for ' : '')."$revzone: $@\n";
[521]6194 # error! something borked, and we should be able to fall back on the old cache file
6195 # report the error, somehow.
6196 } else {
[523]6197 # mark zone as unmodified. Only do this if no errors, that way
[521]6198 # export failures should recover a little more automatically.
[523]6199 $zonesth->execute($revid);
[368]6200 }
[521]6201
[559]6202 if ($self->{usecache}) {
6203 # We've already made as sure as we can that a cached zone file is "good",
6204 # although possibly stale/obsolete due to errors creating a new one.
[566]6205 eval {
6206 open CACHE, "<$cachefile" or die $!;
6207 print $datafile $_ or die "error copying cached $revzone to master file: $!" while <CACHE>;
6208 close CACHE;
6209 };
6210 die $@ if $@;
[559]6211 }
6212
[523]6213 } # while ($revsth)
[329]6214
[576]6215 $soasth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
[578]6216 "FROM records WHERE domain_id=? AND type=6");
[543]6217 $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location,extract(epoch from stamp),expires,stampactive ".
[576]6218 "FROM records WHERE domain_id=? AND NOT type=6"); # Just exclude all types relating to rDNS
[523]6219# "FROM records WHERE domain_id=? AND type < 65280"); # Just exclude all types relating to rDNS
[576]6220 my $domsth = $dbh->prepare("SELECT domain_id,domain,status,changed FROM domains WHERE status=1 ORDER BY domain_id");
[523]6221 $zonesth = $dbh->prepare("UPDATE domains SET changed='n' WHERE domain_id=?");
6222 $domsth->execute();
6223 while (my ($domid,$dom,$domstat,$changed) = $domsth->fetchrow_array) {
[368]6224##fixme: need to find a way to block opening symlinked files without introducing a race.
6225# O_NOFOLLOW
6226# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
6227# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
6228# still be followed.
6229# but that doesn't help other platforms. :/
[523]6230 my $cachefile = "$self->{exportcache}/$dom";
6231 my $tmpcache = "$self->{exportcache}/tmp.$dom.$$";
[521]6232 eval {
[344]6233
[559]6234 # write fresh records if:
6235 # - we are not using the cache
6236 # - force_refresh is set
6237 # - the zone has changed
6238 # - the cache file does not exist
6239 # - the cache file is empty
[755]6240 # - the zone contains ALIAS pseudorecords, which need to cascade changes from the upstream CNAME farm at every opportunity
6241 if ( ($dbh->selectrow_array("SELECT count(*) FROM records WHERE domain_id = ? AND type=65300", undef, $domid))[0] ) {
6242 $changed = 1; # abuse this flag for zones with ALIAS records
6243 }
[559]6244 if (!$self->{usecache} || $self->{force_refresh} || $changed || !-e $cachefile || -z $cachefile) {
6245 if ($self->{usecache}) {
6246 open ZONECACHE, ">$tmpcache" or die "Error creating temporary file $tmpcache: $!\n";
6247 $zonefilehandle = *ZONECACHE;
6248 }
[329]6249
[576]6250 # need to fetch this separately so the SOA comes first in the flatfile....
6251 # Just In Case we need/want to reimport from the flatfile later on.
6252 $soasth->execute($domid);
6253 my (@zsoa) = $soasth->fetchrow_array();
[644]6254 $self->_printrec_tiny($zonefilehandle, $zsoa[7], 'n',\%recflags,$dom,
[576]6255 $zsoa[0],$zsoa[1],$zsoa[2],$zsoa[3],$zsoa[4],$zsoa[5],$zsoa[6],$zsoa[8],'');
6256
[523]6257 $recsth->execute($domid);
[543]6258 while (my ($host,$type,$val,$dist,$weight,$port,$ttl,$recid,$loc,$stamp,$expires,$stampactive) = $recsth->fetchrow_array) {
[523]6259 next if $recflags{$recid};
[521]6260
[596]6261 # Check for out-of-zone data
[655]6262 $host = $dom if $host eq '@';
[663]6263 if ($host !~ /$dom$/i) {
[596]6264 warn "Not exporting out-of-zone record $host $type $val, $ttl (zone $dom)\n";
6265 next;
6266 }
6267
[523]6268 # Spaces are evil.
6269 $host =~ s/^\s+//;
6270 $host =~ s/\s+$//;
6271 if ($typemap{$type} ne 'TXT') {
6272 # Leading or trailng spaces could be legit in TXT records.
6273 $val =~ s/^\s+//;
6274 $val =~ s/\s+$//;
6275 }
6276
[644]6277 $self->_printrec_tiny($zonefilehandle, $recid, 'n', \%recflags,
[559]6278 $dom, $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp, $expires, $stampactive);
[329]6279
[523]6280 $recflags{$recid} = 1;
[450]6281
[521]6282 } # while ($recsth)
6283
6284
[559]6285 if ($self->{usecache}) {
6286 close ZONECACHE; # force the file to be written
6287 # catch obvious write errors that leave an empty temp file
6288 if (-s $tmpcache) {
6289 rename $tmpcache, $cachefile
6290 or die "Error overwriting cache file $cachefile with temporary file: $!\n";
6291 }
[521]6292 }
6293
6294 } # if $changed or cache filesize is 0
6295
6296 };
6297 if ($@) {
[566]6298 die "error writing ".($self->{usecache} ? 'new data for ' : '')."$dom: $@\n";
[521]6299 # error! something borked, and we should be able to fall back on the old cache file
6300 # report the error, somehow.
6301 } else {
[523]6302 # mark domain as unmodified. Only do this if no errors, that way
[521]6303 # export failures should recover a little more automatically.
[523]6304 $zonesth->execute($domid);
[368]6305 }
[521]6306
[559]6307 if ($self->{usecache}) {
6308 # We've already made as sure as we can that a cached zone file is "good",
6309 # although possibly stale/obsolete due to errors creating a new one.
[566]6310 eval {
6311 open CACHE, "<$cachefile" or die $!;
6312 print $datafile $_ or die "error copying cached $dom to master file: $!" while <CACHE>;
6313 close CACHE;
6314 };
6315 die $@ if $@;
[559]6316 }
6317
[329]6318 } # while ($domsth)
6319
[566]6320 return 1;
[329]6321} # end __export_tiny()
6322
6323
6324# Utility sub for __export_tiny above
6325sub _printrec_tiny {
[644]6326 my $self = shift;
[573]6327 my ($datafile, $recid, $revrec, $recflags, $zone, $host, $type, $val, $dist, $weight, $port, $ttl,
6328 $loc, $stamp, $expires, $stampactive) = @_;
[329]6329
[543]6330 $loc = '' if !$loc; # de-nullify - just in case
6331##fixme: handle case of record-with-location-that-doesn't-exist better.
6332# note this currently fails safe (tested) - records with a location that
6333# doesn't exist will not be sent to any client
6334# $loc = '' if !$lochash->{$loc};
6335
6336
6337## Records that are valid only before or after a set time
6338
6339# record due to expire sometime is the complex case. we don't want to just
6340# rely on tinydns' auto-adjusting TTLs, because the default TTL in that case
6341# is one day instead of the SOA minttl as BIND might do.
6342
6343# consider the case where a record is set to expire a week ahead, but the next
6344# day later you want to change it NOW (or as NOWish as you get with your DNS
6345# management practice). but now you're stuck, because someone, somewhere,
6346# has just done a lookup before your latest change was published, and they'll
6347# be caching that old, broken record for 1 day instead of your zone default
6348# TTL.
6349
6350# $stamp-$ttl is the *latest* we can publish the record with the defined TTL
6351# to still have the expiry happen as scheduled, but we need to find some
6352# *earlier* point. We can maybe guess, and 2x TTL is probably reasonable,
6353# but we need info on the export frequency.
6354
6355# export the normal, non-expiring record up until $stamp-<guesstimate>, then
6356# switch to exporting a record with the TAI64 stamp and a 0 TTL so tinydns
6357# takes over TTL management.
6358
6359 if ($stampactive) {
6360 if ($expires) {
6361 # record expires at $stamp; decide if we need to keep the TTL and ignore
6362 # the stamp for a time or if we need to change the TTL to 0 and convert
6363 # $stamp to TAI64 so tinydns can use $stamp to autoadjust the TTL on the fly.
6364# extra hack, optimally needs more knowledge of data export frequency
6365# smack the idiot customer who insists on 0 TTLs; they can suck up and
6366# deal with a 10-minute TTL. especially on scheduled changes. note this
6367# should be (export freq * 2), but we don't know the actual export frequency.
6368$ttl = 300 if $ttl == 0; #hack phtui
6369 my $ahead = (86400 < $ttl*2 ? 86400 : $ttl*2);
6370 if ((time() + $ahead) < $stamp) {
6371 # more than 2x TTL OR more than one day (whichever is less) from expiry time; publish normal record
6372 $stamp = '';
6373 } else {
6374 # less than 2x TTL from expiry time, let tinydns take over TTL management and publish the TAI64 stamp.
6375 $ttl = 0;
6376 $stamp = unixtai64($stamp);
6377 $stamp =~ s/\@//;
6378 }
6379 } else {
6380 # record is "active after"; convert epoch from database to TAI64, publish, and collect $200.
6381 $stamp = unixtai64($stamp);
6382 $stamp =~ s/\@//;
6383 }
6384 } else {
6385 # flag for active timestamp is false; don't actually put a timestamp in the output
6386 $stamp = '';
6387 }
6388
6389 # support tinydns' auto-TTL
6390 $ttl = '' if $ttl == -1;
6391# these are WAY FREAKING HIGH - higher even than most TLD registry TTLs!
6392# NS 259200 => 3d
6393# all others 86400 => 1d
6394
[531]6395 if ($revrec eq 'y') {
6396 $val = $zone if $val eq '@';
6397 } else {
6398 $host = $zone if $host eq '@';
6399 }
6400
[329]6401 ## Convert a bare number into an octal-coded pair of octets.
6402 # Take optional arg to indicate a decimal or hex input. Defaults to hex.
6403 sub octalize {
6404 my $tmp = shift;
6405 my $srctype = shift || 'h'; # default assumes hex string
6406 $tmp = sprintf "%0.4x", hex($tmp) if $srctype eq 'h'; # 0-pad hex to 4 digits
6407 $tmp = sprintf "%0.4x", $tmp if $srctype eq 'd'; # 0-pad decimal to 4 hex digits
6408 my @o = ($tmp =~ /^(..)(..)$/); # split into octets
[656]6409 return sprintf "\\%0.3o\\%0.3o", hex($o[0]), hex($o[1]);
[329]6410 }
6411
[637]6412 # Utility sub-sub for reverse records; with "any-record-in-any-zone"
6413 # we may need to do extra processing on $val to make it publishable.
6414 sub __revswap {
6415 my $host = shift;
6416 my $val = shift;
6417 return ($val, $host) if $val =~ /\.arpa/;
6418 $val = new NetAddr::IP $val;
6419 my $newval = _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
6420 return ($newval, $host);
6421 }
6422
[339]6423## WARNING: This works to export even the whole Internet's worth of IP space...
6424## if you have the disk/RAM to handle the dataset, and you call this sub based on /16-sized chunks
6425## A /16 took ~3 seconds with a handful of separate records; adding a /8 pushed export time out to ~13m:40s
6426## 0/0 is estimated to take ~54 hours and ~256G of disk
6427## RAM usage depends on how many non-template entries you have in the set.
6428## This should probably be done on record addition rather than export; large blocks may need to be done in a
6429## forked process
6430 sub __publish_subnet {
[685]6431 my $self = shift; # *sigh* need to pass in the DNSDB object so we can read a couple of options
[339]6432 my $sub = shift;
6433 my $recflags = shift;
6434 my $hpat = shift;
6435 my $fh = shift;
6436 my $ttl = shift;
6437 my $stamp = shift;
6438 my $loc = shift;
[637]6439 my $zone = new NetAddr::IP shift;
[339]6440 my $ptronly = shift || 0;
6441
[637]6442 # do this conversion once, not (number-of-ips-in-subnet) times
6443 my $arpabase = _ZONE($zone, 'ZONE.in-addr.arpa', 'r', '.');
6444
[339]6445 my $iplist = $sub->splitref(32);
[685]6446 my $ipindex = -1;
[339]6447 foreach (@$iplist) {
6448 my $ip = $_->addr;
[685]6449 $ipindex++;
[339]6450 # make as if we split the non-octet-aligned block into octet-aligned blocks as with SOA
[637]6451 my $lastoct = (split /\./, $ip)[3];
[635]6452 next if $$recflags{$ip}; # && $self->{skip_bcast_255}
[339]6453 $$recflags{$ip}++;
[463]6454 next if $hpat eq '%blank%'; # Allows blanking a subnet so no records are published.
[339]6455 my $rec = $hpat; # start fresh with the template for each IP
[637]6456##fixme: there really isn't a good way to handle sub-/24 zones here. This way at least
[685]6457# seems less bad than some alternatives.
6458 $self->_template4_expand(\$rec, $ip, \$sub, $ipindex);
6459 # _template4_expand may blank $rec; if so, don't publish a record
6460 next if !$rec;
[637]6461 if ($ptronly || $zone->masklen > 24) {
6462 print $fh "^$lastoct.$arpabase:$rec:$ttl:$stamp:$loc\n" or die $!;
6463 if (!$ptronly) {
6464 # print a separate A record. Arguably we could use an = record here instead.
6465 print $fh "+$rec:$ip:$ttl:$stamp:$loc\n" or die $!;
6466 }
6467 } else {
6468 print $fh "=$rec:$ip:$ttl:$stamp:$loc\n" or die $!;
6469 }
[339]6470 }
[679]6471 } # __publish_subnet
[339]6472
[636]6473## And now the meat.
6474
[103]6475##fixme? append . to all host/val hostnames
[637]6476#print "debug: rawdata: $host $typemap{$type} $val\n";
[103]6477
[636]6478 if ($typemap{$type} eq 'SOA') {
6479 # host contains pri-ns:responsible
6480 # val is abused to contain refresh:retry:expire:minttl
[103]6481##fixme: "manual" serial vs tinydns-autoserial
[636]6482 # let's be explicit about abusing $host and $val
6483 my ($email, $primary) = (split /:/, $host)[0,1];
6484 my ($refresh, $retry, $expire, $min_ttl) = (split /:/, $val)[0,1,2,3];
6485 if ($revrec eq 'y') {
[337]6486##fixme: have to publish SOA records for each v4 /24 in sub-/16, and each /16 in sub-/8
6487# what about v6?
6488# -> only need SOA for local chunks offset from reverse delegation boundaries, so v6 is fine
[636]6489# anyone who says they need sub-nibble v6 delegations, at this time, needs their head examined.
6490 $zone = NetAddr::IP->new($zone);
6491 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
6492 if (!$zone->{isv6} && ($zone->masklen < 24) && ($zone->masklen % 8 != 0)) {
6493 foreach my $szone ($zone->split($zone->masklen + (8 - $zone->masklen % 8))) {
6494 $szone = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
6495 print $datafile "Z$szone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n"
6496 or die $!;
6497 }
6498 return; # skips "default" bits just below
6499 }
6500 $zone = _ZONE($zone, 'ZONE', 'r', '.').($zone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
6501 }
6502 print $datafile "Z$zone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n"
6503 or die $!;
[103]6504
[636]6505 } elsif ($typemap{$type} eq 'A') {
[103]6506
[637]6507 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
[636]6508 print $datafile "+$host:$val:$ttl:$stamp:$loc\n" or die $!;
[103]6509
[636]6510 } elsif ($typemap{$type} eq 'NS') {
[103]6511
[636]6512 if ($revrec eq 'y') {
6513 $val = NetAddr::IP->new($val);
6514 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
6515 if (!$val->{isv6} && ($val->masklen < 24) && ($val->masklen % 8 != 0)) {
6516 foreach my $szone ($val->split($val->masklen + (8 - $val->masklen % 8))) {
6517 my $szone2 = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
6518 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
6519 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n" or die $!;
6520 $$recflags{$szone2} = $val->masklen;
6521 }
6522 } elsif ($val->{isv6} && ($val->masklen < 64) && ($val->masklen % 4 !=0)) {
6523 foreach my $szone ($val->split($val->masklen + (4 - $val->masklen % 4))) {
6524 my $szone2 = _ZONE($szone, 'ZONE.ip6.arpa', 'r', '.');
6525 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
6526 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n" or die $!;
6527 $$recflags{$szone2} = $val->masklen;
6528 }
6529 } else {
6530 my $val2 = _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
6531 print $datafile "\&$val2"."::$host:$ttl:$stamp:$loc\n" or die $!;
6532 $$recflags{$val2} = $val->masklen;
6533 }
6534 } else {
6535 print $datafile "\&$host"."::$val:$ttl:$stamp:$loc\n" or die $!;
6536 }
[103]6537
[636]6538 } elsif ($typemap{$type} eq 'AAAA') {
[103]6539
[637]6540 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
[636]6541 my $altgrp = 0;
6542 my @altconv;
6543 # Split in to up to 8 groups of hex digits (allows for IPv6 :: 0-collapsing)
6544 foreach (split /:/, $val) {
6545 if (/^$/) {
6546 # flag blank entry; this is a series of 0's of (currently) unknown length
6547 $altconv[$altgrp++] = 's';
6548 } else {
6549 # call sub to convert 1-4 hex digits to 2 string-rep octal bytes
6550 $altconv[$altgrp++] = octalize($_)
6551 }
6552 }
6553 my $prefix = ":$host:28:";
6554 foreach my $octet (@altconv) {
6555 # if not 's', output
6556 $prefix .= $octet unless $octet =~ /^s$/;
6557 # if 's', output (9-array length)x literal '\000\000'
6558 $prefix .= '\000\000'x(9-$altgrp) if $octet =~ /^s$/;
6559 }
6560 print $datafile "$prefix:$ttl:$stamp:$loc\n" or die $!;
[103]6561
[636]6562 } elsif ($typemap{$type} eq 'MX') {
[103]6563
[637]6564 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
[636]6565 print $datafile "\@$host"."::$val:$dist:$ttl:$stamp:$loc\n" or die $!;
[103]6566
[636]6567 } elsif ($typemap{$type} eq 'TXT') {
[103]6568
[637]6569 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
[703]6570# le sigh. Some idiot DNS implementations don't seem to like tinydns autosplitting
6571# long TXT records at 127 characters instead of 255. Hand-crafting a record seems
6572# to paper over the remote stupid. We will NOT try to split on whitespace; the
6573# contents of a TXT record are opaque and clients who can't deal are even more broken
6574# than the ones that don't like them split at 127 characters... because BIND tries
6575# to "intelligently" split TXT data, and abso-by-damn-lutely generates chunks <255
6576# characters, and anything that can't interpret BIND's DNS responses has no business
6577# trying to interpret DNS data at all.
[103]6578
[708]6579 if ($self->{autotxt}) {
6580 # let tinydns deal with splitting the record. note tinydns autosplits at 127
6581 # characters, not 255. Because Reasons.
6582 $val =~ s/:/\\072/g; # may need to replace other symbols
6583 print $datafile "'$host:$val:$ttl:$stamp:$loc\n" or die $!;
6584 } else {
6585 print $datafile ":$host:16:";
6586 my @txtsegs = $val =~ /.{1,255}/g;
6587 foreach (@txtsegs) {
6588 my $len = length($_);
6589 s/:/\\072/g;
6590 printf $datafile "\\%0.3o%s", $len, $_;
6591 }
6592 print $datafile ":$ttl:$stamp:$loc\n";
[703]6593 }
6594
[103]6595# by-hand TXT
6596#:deepnet.cx:16:2v\075spf1\040a\040a\072bacon.deepnet.cx\040a\072home.deepnet.cx\040-all:3600
6597#@ IN TXT "v=spf1 a a:bacon.deepnet.cx a:home.deepnet.cx -all"
6598#'deepnet.cx:v=spf1 a a\072bacon.deepnet.cx a\072home.deepnet.cx -all:3600
6599
6600#txttest IN TXT "v=foo bar:bob kn;ob' \" !@#$%^&*()-=_+[]{}<>?"
6601#:txttest.deepnet.cx:16:\054v\075foo\040bar\072bob\040kn\073ob\047\040\042\040\041\100\043\044\045\136\046\052\050\051-\075\137\053\133\135\173\175\074\076\077:3600
6602
6603# very long TXT record as brought in by axfr-get
6604# note tinydns does not support >512-byte RR data, need axfr-dns (for TCP support) for that
6605# also note, tinydns does not seem to support <512, >256-byte RRdata from axfr-get either. :/
6606#:longtxt.deepnet.cx:16:
6607#\170this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
6608#\263 it is really long. long. very long. really very long. this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
6609#\351 it is really long. long. very long. really very long.this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record. it is really long. long. very long. really very long.
6610#:3600
6611
[636]6612 } elsif ($typemap{$type} eq 'CNAME') {
[103]6613
[637]6614 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
6615 print $datafile "C$host:$val:$ttl:$stamp:$loc\n" or die $!;
[103]6616
[636]6617 } elsif ($typemap{$type} eq 'SRV') {
[103]6618
[637]6619 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
6620
[636]6621 # data is two-byte values for priority, weight, port, in that order,
6622 # followed by length/string data
[103]6623
[637]6624 my $prefix = ":$host:33:".octalize($dist,'d').octalize($weight,'d').octalize($port,'d');
[103]6625
[636]6626 $val .= '.' if $val !~ /\.$/;
6627 foreach (split /\./, $val) {
[637]6628 $prefix .= sprintf "\\%0.3o%s", length($_), $_ or die $!;
[636]6629 }
[637]6630 print $datafile "$prefix\\000:$ttl:$stamp:$loc\n" or die $!;
[103]6631
[636]6632 } elsif ($typemap{$type} eq 'RP') {
[103]6633
[637]6634 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
[636]6635 # RP consists of two mostly free-form strings.
6636 # The first is supposed to be an email address with @ replaced by . (as with the SOA contact)
6637 # The second is the "hostname" of a TXT record with more info.
6638 my $prefix = ":$host:17:";
6639 my ($who,$what) = split /\s/, $val;
6640 foreach (split /\./, $who) {
6641 $prefix .= sprintf "\\%0.3o%s", length($_), $_;
6642 }
6643 $prefix .= '\000';
6644 foreach (split /\./, $what) {
6645 $prefix .= sprintf "\\%0.3o%s", length($_), $_;
6646 }
6647 print $datafile "$prefix\\000:$ttl:$stamp:$loc\n" or die $!;
[103]6648
[636]6649 } elsif ($typemap{$type} eq 'PTR') {
[103]6650
[636]6651 $$recflags{$val}++;
[637]6652 if ($revrec eq 'y') {
6653
6654 if ($val =~ /\.arpa$/) {
6655 # someone put in the formal .arpa name. humor them.
6656 print $datafile "^$val:$host:$ttl:$stamp:$loc\n" or die $!;
6657 } else {
6658 $zone = NetAddr::IP->new($zone);
6659 if (!$zone->{isv6} && $zone->masklen > 24) {
6660 # sub-octet v4 zone
6661 ($val) = ($val =~ /\.(\d+)$/);
6662 print $datafile "^$val."._ZONE($zone, 'ZONE', 'r', '.').'.in-addr.arpa'.
6663 ":$host:$ttl:$stamp:$loc\n" or die $!;
6664 } else {
6665 # not going to care about strange results if $val is not an IP value and is resolveable in DNS
6666 $val = NetAddr::IP->new($val);
6667 print $datafile "^".
6668 _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
6669 ":$host:$ttl:$stamp:$loc\n" or die $!;
6670 }
6671 } # non-".arpa" $val
6672
[636]6673 } else {
[637]6674 # PTRs in forward zones are less bizarre and insane than some other record types
6675 # in reverse zones... OTOH we can't validate them any which way, so we cross our
6676 # fingers and close our eyes and make it Someone Else's Problem.
6677 print $datafile "^$host:$val:$ttl:$stamp:$loc\n" or die $!;
[636]6678 }
[103]6679
[636]6680 } elsif ($type == 65280) { # A+PTR
[334]6681
[636]6682 $$recflags{$val}++;
6683 print $datafile "=$host:$val:$ttl:$stamp:$loc\n" or die $!;
[334]6684
[636]6685 } elsif ($type == 65281) { # AAAA+PTR
[333]6686
[636]6687 $$recflags{$val}++;
6688 # treat these as two separate records. since tinydns doesn't have
6689 # a native combined type, we have to create them separately anyway.
6690 # print both; a dangling record is harmless, and impossible via web
6691 # UI anyway
[654]6692 $self->_printrec_tiny($datafile,$recid,'n',$recflags, $self->domainName($self->_hostparent($host)),
6693 $host, 28, $val, $dist, $weight, $port, $ttl, $loc, $stamp);
6694 $self->_printrec_tiny($datafile, $recid, 'y', $recflags, $zone,
6695 $host, 12, $val, $dist, $weight, $port, $ttl, $loc, $stamp);
6696
[335]6697##fixme: add a config flag to indicate use of the patch from http://www.fefe.de/dns/
6698# type 6 is for AAAA+PTR, type 3 is for AAAA
[333]6699
[636]6700 } elsif ($type == 65282) { # PTR template
[335]6701
[636]6702 # only useful for v4 with standard DNS software, since this expands all
6703 # IPs in $zone (or possibly $val?) with autogenerated records
6704 $val = NetAddr::IP->new($val);
6705 return if $val->{isv6};
[336]6706
[636]6707 if ($val->masklen <= 16) {
6708 foreach my $sub ($val->split(16)) {
[644]6709 $self->__publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, $zone, 1);
[636]6710 }
6711 } else {
[644]6712 $self->__publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, $zone, 1);
[636]6713 }
[335]6714
[636]6715 } elsif ($type == 65283) { # A+PTR template
[335]6716
[636]6717 $val = NetAddr::IP->new($val);
6718 # Just In Case. An A+PTR should be impossible to add to a v6 revzone via API.
6719 return if $val->{isv6};
[339]6720
[679]6721 if ($val->masklen < 16) {
[636]6722 foreach my $sub ($val->split(16)) {
[644]6723 $self->__publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, $zone, 0);
[636]6724 }
6725 } else {
[644]6726 $self->__publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, $zone, 0);
[636]6727 }
[335]6728
[636]6729 } elsif ($type == 65284) { # AAAA+PTR template
6730 # Stub for completeness. Could be exported to DNS software that supports
6731 # some degree of internal automagic in generic-record-creation
6732 # (eg http://search.cpan.org/dist/AllKnowingDNS/ )
[333]6733
[636]6734 } elsif ($type == 65285) { # Delegation
6735 # This is intended for reverse zones, but may prove useful in forward zones.
[345]6736
[636]6737 # All delegations need to create one or more NS records. The NS record handler knows what to do.
[644]6738 $self->_printrec_tiny($datafile,$recid,$revrec,$recflags,$zone,$host,$reverse_typemap{'NS'},
[636]6739 $val,$dist,$weight,$port,$ttl,$loc,$stamp);
6740 if ($revrec eq 'y') {
6741 # In the case of a sub-/24 v4 reverse delegation, we need to generate CNAMEs
6742 # to redirect all of the individual IP lookups as well.
[637]6743 # OR
6744 # create NS records for each IP
[636]6745 # Not sure how this would actually resolve if a /24 or larger was delegated
6746 # one way, and a sub-/24 in that >=/24 was delegated elsewhere...
6747 my $dblock = NetAddr::IP->new($val);
6748 if (!$dblock->{isv6} && $dblock->masklen > 24) {
6749 my @subs = $dblock->split;
6750 foreach (@subs) {
6751 next if $$recflags{"$_"};
6752 my ($oct) = ($_->addr =~ /(\d+)$/);
6753 print $datafile "C"._ZONE($_, 'ZONE.in-addr.arpa', 'r', '.').":$oct.".
6754 _ZONE($dblock, 'ZONE.in-addr.arpa', 'r', '.').":$ttl:$stamp:$loc\n" or die $!;
6755 $$recflags{"$_"}++;
6756 }
6757 }
6758 }
[345]6759
[750]6760 } elsif ($type == 65300) { # ALIAS
6761 # Implemented as a unique record in parallel with many other
6762 # management tools, for clarity VS formal behviour around CNAME
6763 # Mainly for "root CNAME" or "apex alias"; limited value for any
6764 # other use case since CNAME can generally be used elsewhere.
6765
6766 # .arpa zones don't need this hack. shouldn't be allowed into
6767 # the DB in the first place, but Just In Case...
6768 return if $revrec eq 'y';
6769
[752]6770 my ($iplist) = $self->{dbh}->selectrow_array("SELECT auxdata FROM records WHERE record_id = ?", undef, $recid);
[767]6771 $iplist = '' if !$iplist;
[750]6772
[764]6773 # shared target-name-to-IP converter
6774 my $liveips = $self->_grab_65300($recid, $val);
[767]6775 # only update the cache if the live lookup actually returned data
6776 if ($liveips && ($iplist ne $liveips)) {
[764]6777 $self->{dbh}->do("UPDATE records SET auxdata = ? WHERE record_id = ?", undef, $liveips, $recid);
6778 $iplist = $liveips;
[750]6779 }
6780
[764]6781 # slice the TTL we'll actually publish off the front
6782 my @asubs = split ':', $iplist;
6783 my $attl = shift @asubs;
6784
[750]6785 # output a plain old A record for each IP the target name really points to.
[764]6786 # in the event that, for whatever reason, no A records are available for $val, nothing will be output.
6787 foreach my $subip (@asubs) {
6788 print $datafile "+$host:$subip:$attl:$stamp:$loc\n" or die $!;
[750]6789 }
6790
[364]6791##
6792## Uncommon types. These will need better UI support Any Day Sometime Maybe(TM).
6793##
6794
[636]6795 } elsif ($type == 44) { # SSHFP
[637]6796
6797 ($host,$val) = __revswap($host,$val) if $revrec eq 'y';
6798
[636]6799 my ($algo,$fpt,$fp) = split /\s+/, $val;
[364]6800
[636]6801 my $rec = sprintf ":$host:44:\\%0.3o\\%0.3o", $algo, $fpt;
6802 while (my ($byte) = ($fp =~ /^(..)/) ) {
6803 $rec .= sprintf "\\%0.3o", hex($byte);
6804 $fp =~ s/^..//;
6805 }
6806 print $datafile "$rec:$ttl:$stamp:$loc\n" or die $!;
[364]6807
[636]6808 } else {
6809 # raw record. we don't know what's in here, so we ASS-U-ME the user has
6810 # put it in correctly, since either the user is messing directly with the
6811 # database, or the record was imported via AXFR
6812 # <split by char>
6813 # convert anything not a-zA-Z0-9.- to octal coding
[108]6814
6815##fixme: add flag to export "unknown" record types - note we'll probably end up
6816# mangling them since they were written to the DB from Net::DNS::RR::<type>->rdatastr.
[636]6817 #print $datafile ":$host:$type:$val:$ttl:$stamp:$loc\n";
[108]6818
[636]6819 } # record type if-else
[103]6820
[329]6821} # end _printrec_tiny()
[103]6822
6823
[197]6824## DNSDB::mailNotify()
[283]6825# Sends notification mail to recipients regarding a DNSDB operation
[197]6826sub mailNotify {
[483]6827 my $self = shift;
6828 my $dbh = $self->{dbh};
[197]6829 my ($subj,$message) = @_;
6830
[517]6831 return if $self->{mailhost} eq 'smtp.example.com'; # do nothing if still using default SMTP host.
[197]6832
[517]6833 my $mailer = Net::SMTP->new($self->{mailhost}, Hello => "dnsadmin.$self->{domain}");
[197]6834
[517]6835 my $mailsender = ($self->{mailsender} ? $self->{mailsender} : $self->{mailnotify});
[197]6836
6837 $mailer->mail($mailsender);
[517]6838 $mailer->to($self->{mailnotify});
6839 $mailer->data("From: \"$self->{mailname}\" <$mailsender>\n",
6840 "To: <$self->{mailnotify}>\n",
[197]6841 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
6842 "Subject: $subj\n",
[529]6843 "X-Mailer: DNSAdmin v".$DNSDB::VERSION." Notify\n",
[517]6844 "Organization: $self->{orgname}\n",
[197]6845 "\n$message\n");
6846 $mailer->quit;
6847}
6848
[2]6849# shut Perl up
68501;
Note: See TracBrowser for help on using the repository browser.