source: trunk/DNSDB.pm@ 496

Last change on this file since 496 was 496, checked in by Kris Deugau, 11 years ago

/trunk

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