source: trunk/DNSDB.pm@ 475

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

/trunk

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