source: trunk/DNSDB.pm@ 752

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

/trunk

Minor administrivia cleanups

Mostly finalize new ALIAS pseudotype. See #55.

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