source: trunk/DNSDB.pm@ 750

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

/trunk

Start adding support for "root CNAME" or "apex alias" records:

  • record export
  • type definition for SQL

Instead of overloading "true" CNAME handling, we'll follow one existing
path and create a managed pseudotype ALIAS instead.

See #55.

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