source: trunk/DNSDB.pm@ 656

Last change on this file since 656 was 656, checked in by Kris Deugau, 10 years ago

/trunk

Add a comment for a possible enhancement ("CNAME Flattening")
Comment the failure on validating a SRV in a reverse zone; who knows what

stupid might lurk in some legacy DNS template?

Remove a spare semicolon at the end of a line

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