source: trunk/DNSDB.pm@ 470

Last change on this file since 470 was 470, checked in by Kris Deugau, 12 years ago

/trunk

Object conversion of DNSDB.pm, 6 of <mumble>. See #11.

  • convert isParent(), fix up partial caller conversion that shouldn't have been committed in r469
  • Property svn:keywords set to Date Rev Author Id
File size: 187.8 KB
Line 
1# dns/trunk/DNSDB.pm
2# Abstraction functions for DNS administration
3##
4# $Id: DNSDB.pm 470 2013-03-12 20:19:08Z 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 $dbh = shift;
1634 my $type = shift;
1635 my $id = shift;
1636 my $newperms = shift;
1637 my $inherit = shift || 0;
1638
1639 my $resultmsg = '';
1640
1641 # see if we're switching from inherited to custom. for bonus points,
1642 # snag the permid and parent permid anyway, since we'll need the permid
1643 # to set/alter custom perms, and both if we're switching from custom to
1644 # inherited.
1645 my $sth = $dbh->prepare("SELECT (u.permission_id=g.permission_id) AS was_inherited,u.permission_id,g.permission_id,".
1646 ($type eq 'user' ? 'u.group_id,u.username' : 'u.parent_group_id,u.group_name').
1647 " FROM ".($type eq 'user' ? 'users' : 'groups')." u ".
1648 " JOIN groups g ON u.".($type eq 'user' ? '' : 'parent_')."group_id=g.group_id ".
1649 " WHERE u.".($type eq 'user' ? 'user' : 'group')."_id=?");
1650 $sth->execute($id);
1651
1652 my ($wasinherited,$permid,$parpermid,$parid,$name) = $sth->fetchrow_array;
1653
1654# hack phtoui
1655# group id 1 is "special" in that it's it's own parent (err... possibly.)
1656# may make its parent id 0 which doesn't exist, and as a bonus is Perl-false.
1657 $wasinherited = 0 if ($type eq 'group' && $id == 1);
1658
1659 local $dbh->{AutoCommit} = 0;
1660 local $dbh->{RaiseError} = 1;
1661
1662 # Wrap all the SQL in a transaction
1663 eval {
1664 if ($inherit) {
1665
1666 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='t',permission_id=? ".
1667 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($parpermid, $id) );
1668 $dbh->do("DELETE FROM permissions WHERE permission_id=?", undef, ($permid) );
1669
1670 } else {
1671
1672 if ($wasinherited) { # munge new permission entry in if we're switching from inherited perms
1673##fixme: need to add semirecursive bit to properly munge inherited permission ID on subgroups and users
1674# ... if'n'when we have groups with fully inherited permissions.
1675 # SQL is coo
1676 $dbh->do("INSERT INTO permissions ($permlist,".($type eq 'user' ? 'user' : 'group')."_id) ".
1677 "SELECT $permlist,? FROM permissions WHERE permission_id=?", undef, ($id,$permid) );
1678 ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions ".
1679 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($id) );
1680 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='f',permission_id=? ".
1681 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($permid, $id) );
1682 }
1683
1684 # and now set the permissions we were passed
1685 foreach (@permtypes) {
1686 if (defined ($newperms->{$_})) {
1687 $dbh->do("UPDATE permissions SET $_=? WHERE permission_id=?", undef, ($newperms->{$_},$permid) );
1688 }
1689 }
1690
1691 } # (inherited->)? custom
1692
1693 if ($type eq 'user') {
1694 $resultmsg = "Updated permissions for user $name";
1695 } else {
1696 $resultmsg = "Updated default permissions for group $name";
1697 }
1698 _log($dbh, (group_id => ($type eq 'user' ? $parid : $id), entry => $resultmsg));
1699 $dbh->commit;
1700 }; # end eval
1701 if ($@) {
1702 my $msg = $@;
1703 eval { $dbh->rollback; };
1704 return ('FAIL',"Error changing permissions: $msg");
1705 }
1706
1707 return ('OK',$resultmsg);
1708} # end changePermissions()
1709
1710
1711## DNSDB::comparePermissions()
1712# Compare two permission hashes
1713# Returns '>', '<', '=', '!'
1714sub comparePermissions {
1715 my $p1 = shift;
1716 my $p2 = shift;
1717
1718 my $retval = '='; # assume equality until proven otherwise
1719
1720 no warnings "uninitialized";
1721
1722 foreach (@permtypes) {
1723 next if $p1->{$_} == $p2->{$_}; # equal is good
1724 if ($p1->{$_} && !$p2->{$_}) {
1725 if ($retval eq '<') { # if we've already found an unequal pair where
1726 $retval = '!'; # $p2 has more access, and we now find a pair
1727 last; # where $p1 has more access, the overall access
1728 } # is neither greater or lesser, it's unequal.
1729 $retval = '>';
1730 }
1731 if (!$p1->{$_} && $p2->{$_}) {
1732 if ($retval eq '>') { # if we've already found an unequal pair where
1733 $retval = '!'; # $p1 has more access, and we now find a pair
1734 last; # where $p2 has more access, the overall access
1735 } # is neither greater or lesser, it's unequal.
1736 $retval = '<';
1737 }
1738 }
1739 return $retval;
1740} # end comparePermissions()
1741
1742
1743## DNSDB::changeGroup()
1744# Change group ID of an entity
1745# Takes a database handle, entity type, entity ID, and new group ID
1746sub changeGroup {
1747 my $dbh = shift;
1748 my $type = shift;
1749 my $id = shift;
1750 my $newgrp = shift;
1751
1752##fixme: fail on not enough args
1753 #return ('FAIL', "Missing
1754
1755 return ('FAIL', "Can't change the group of a $type")
1756 unless grep /^$type$/, ('domain','revzone','user','group'); # could be extended for defrecs?
1757
1758 # Collect some names for logging and messages
1759 my $entname;
1760 if ($type eq 'domain') {
1761 $entname = domainName($dbh, $id);
1762 } elsif ($type eq 'revzone') {
1763 $entname = revName($dbh, $id);
1764 } elsif ($type eq 'user') {
1765 $entname = userFullName($dbh, $id, '%u');
1766 } elsif ($type eq 'group') {
1767 $entname = groupName($dbh, $id);
1768 }
1769
1770 my ($oldgid) = $dbh->selectrow_array("SELECT group_id FROM $par_tbl{$type} WHERE $id_col{$type}=?",
1771 undef, ($id));
1772 my $oldgname = groupName($dbh, $oldgid);
1773 my $newgname = groupName($dbh, $newgrp);
1774
1775 return ('FAIL', "Can't move things into a group that doesn't exist") if !$newgname;
1776
1777 return ('WARN', "Nothing to do, new group is the same as the old group") if $oldgid == $newgrp;
1778
1779 # Allow transactions, and raise an exception on errors so we can catch it later.
1780 # Use local to make sure these get "reset" properly on exiting this block
1781 local $dbh->{AutoCommit} = 0;
1782 local $dbh->{RaiseError} = 1;
1783
1784 eval {
1785 $dbh->do("UPDATE $par_tbl{$type} SET group_id=? WHERE $id_col{$type}=?", undef, ($newgrp, $id));
1786 # Log the change in both the old and new groups
1787 _log($dbh, (group_id => $oldgid, entry => "Moved $type $entname from $oldgname to $newgname"));
1788 _log($dbh, (group_id => $newgrp, entry => "Moved $type $entname from $oldgname to $newgname"));
1789 $dbh->commit;
1790 };
1791 if ($@) {
1792 my $msg = $@;
1793 eval { $dbh->rollback; };
1794 if ($config{log_failures}) {
1795 _log($dbh, (group_id => $oldgid, entry => "Error moving $type $entname to $newgname: $msg"));
1796 $dbh->commit; # since we enabled transactions earlier
1797 }
1798 return ('FAIL',"Error moving $type $entname to $newgname: $msg");
1799 }
1800
1801 return ('OK',"Moved $type $entname from $oldgname to $newgname");
1802} # end changeGroup()
1803
1804
1805##
1806## Processing subs
1807##
1808
1809## DNSDB::addDomain()
1810# Add a domain
1811# Takes a database handle, domain name, numeric group, boolean(ish) state (active/inactive),
1812# and user info hash (for logging).
1813# Returns a status code and message
1814sub addDomain {
1815 $errstr = '';
1816 my $dbh = shift;
1817 return ('FAIL',"Need database handle") if !$dbh;
1818 my $domain = shift;
1819 return ('FAIL',"Domain must not be blank") if !$domain;
1820 my $group = shift;
1821 return ('FAIL',"Need group") if !defined($group);
1822 my $state = shift;
1823 return ('FAIL',"Need domain status") if !defined($state);
1824
1825 $state = 1 if $state =~ /^active$/;
1826 $state = 1 if $state =~ /^on$/;
1827 $state = 0 if $state =~ /^inactive$/;
1828 $state = 0 if $state =~ /^off$/;
1829
1830 return ('FAIL',"Invalid domain status") if $state !~ /^\d+$/;
1831
1832 return ('FAIL', "Invalid characters in domain") if $domain !~ /^[a-zA-Z0-9_.-]+$/;
1833
1834 my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)");
1835 my $dom_id;
1836
1837# quick check to start to see if we've already got one
1838 $sth->execute($domain);
1839 ($dom_id) = $sth->fetchrow_array;
1840
1841 return ('FAIL', "Domain already exists") if $dom_id;
1842
1843 # Allow transactions, and raise an exception on errors so we can catch it later.
1844 # Use local to make sure these get "reset" properly on exiting this block
1845 local $dbh->{AutoCommit} = 0;
1846 local $dbh->{RaiseError} = 1;
1847
1848 # Wrap all the SQL in a transaction
1849 eval {
1850 # insert the domain...
1851 $dbh->do("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)", undef, ($domain, $group, $state));
1852
1853 # get the ID...
1854 ($dom_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
1855 undef, ($domain));
1856
1857 _log($dbh, (domain_id => $dom_id, group_id => $group,
1858 entry => "Added ".($state ? 'active' : 'inactive')." domain $domain"));
1859
1860 # ... and now we construct the standard records from the default set. NB: group should be variable.
1861 my $sth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
1862 my $sth_in = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,distance,weight,port,ttl)".
1863 " VALUES ($dom_id,?,?,?,?,?,?,?)");
1864 $sth->execute($group);
1865 while (my ($host,$type,$val,$dist,$weight,$port,$ttl) = $sth->fetchrow_array()) {
1866 $host =~ s/DOMAIN/$domain/g;
1867 $val =~ s/DOMAIN/$domain/g;
1868 $sth_in->execute($host,$type,$val,$dist,$weight,$port,$ttl);
1869 if ($typemap{$type} eq 'SOA') {
1870 my @tmp1 = split /:/, $host;
1871 my @tmp2 = split /:/, $val;
1872 _log($dbh, (domain_id => $dom_id, group_id => $group,
1873 entry => "[new $domain] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
1874 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl"));
1875 } else {
1876 my $logentry = "[new $domain] Added record '$host $typemap{$type}";
1877 $logentry .= " [distance $dist]" if $typemap{$type} eq 'MX';
1878 $logentry .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$type} eq 'SRV';
1879 _log($dbh, (domain_id => $dom_id, group_id => $group,
1880 entry => $logentry." $val', TTL $ttl"));
1881 }
1882 }
1883
1884 # once we get here, we should have suceeded.
1885 $dbh->commit;
1886 }; # end eval
1887
1888 if ($@) {
1889 my $msg = $@;
1890 eval { $dbh->rollback; };
1891 _log($dbh, (group_id => $group, entry => "Failed adding domain $domain ($msg)"))
1892 if $config{log_failures};
1893 $dbh->commit; # since we enabled transactions earlier
1894 return ('FAIL',$msg);
1895 } else {
1896 return ('OK',$dom_id);
1897 }
1898} # end addDomain
1899
1900
1901## DNSDB::delZone()
1902# Delete a forward or reverse zone.
1903# Takes a database handle, zone ID, and forward/reverse flag.
1904# for now, just delete the records, then the domain.
1905# later we may want to archive it in some way instead (status code 2, for example?)
1906sub delZone {
1907 my $dbh = shift;
1908 my $zoneid = shift;
1909 my $revrec = shift;
1910
1911 # Allow transactions, and raise an exception on errors so we can catch it later.
1912 # Use local to make sure these get "reset" properly on exiting this block
1913 local $dbh->{AutoCommit} = 0;
1914 local $dbh->{RaiseError} = 1;
1915
1916 my $msg = '';
1917 my $failmsg = '';
1918 my $zone = ($revrec eq 'n' ? domainName($dbh, $zoneid) : revName($dbh, $zoneid));
1919
1920 return ('FAIL', ($revrec eq 'n' ? 'Domain' : 'Reverse zone')." ID $zoneid doesn't exist") if !$zone;
1921
1922 # Set this up here since we may use if if $config{log_failures} is enabled
1923 my %loghash;
1924 $loghash{domain_id} = $zoneid if $revrec eq 'n';
1925 $loghash{rdns_id} = $zoneid if $revrec eq 'y';
1926 $loghash{group_id} = parentID($dbh,
1927 (id => $zoneid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) );
1928
1929 # Wrap all the SQL in a transaction
1930 eval {
1931 # Disentangle custom record types before removing the
1932 # ones that are only in the zone to be deleted
1933 if ($revrec eq 'n') {
1934 my $sth = $dbh->prepare("UPDATE records SET type=?,domain_id=0 WHERE domain_id=? AND type=?");
1935 $failmsg = "Failure converting multizone types to single-zone";
1936 $sth->execute($reverse_typemap{PTR}, $zoneid, 65280);
1937 $sth->execute($reverse_typemap{PTR}, $zoneid, 65281);
1938 $sth->execute(65282, $zoneid, 65283);
1939 $sth->execute(65282, $zoneid, 65284);
1940 $failmsg = "Failure removing domain records";
1941 $dbh->do("DELETE FROM records WHERE domain_id=?", undef, ($zoneid));
1942 $failmsg = "Failure removing domain";
1943 $dbh->do("DELETE FROM domains WHERE domain_id=?", undef, ($zoneid));
1944 } else {
1945 my $sth = $dbh->prepare("UPDATE records SET type=?,rdns_id=0 WHERE rdns_id=? AND type=?");
1946 $failmsg = "Failure converting multizone types to single-zone";
1947 $sth->execute($reverse_typemap{A}, $zoneid, 65280);
1948 $sth->execute($reverse_typemap{AAAA}, $zoneid, 65281);
1949# We don't have an "A template" or "AAAA template" type, although it might be useful for symmetry.
1950# $sth->execute(65286?, $zoneid, 65283);
1951# $sth->execute(65286?, $zoneid, 65284);
1952 $failmsg = "Failure removing reverse records";
1953 $dbh->do("DELETE FROM records WHERE rdns_id=?", undef, ($zoneid));
1954 $failmsg = "Failure removing reverse zone";
1955 $dbh->do("DELETE FROM revzones WHERE rdns_id=?", undef, ($zoneid));
1956 }
1957
1958 $msg = "Deleted ".($revrec eq 'n' ? 'domain' : 'reverse zone')." $zone";
1959 $loghash{entry} = $msg;
1960 _log($dbh, %loghash);
1961
1962 # once we get here, we should have suceeded.
1963 $dbh->commit;
1964 }; # end eval
1965
1966 if ($@) {
1967 $msg = $@;
1968 eval { $dbh->rollback; };
1969 $loghash{entry} = "Error deleting $zone: $msg ($failmsg)";
1970 if ($config{log_failures}) {
1971 _log($dbh, %loghash);
1972 $dbh->commit; # since we enabled transactions earlier
1973 }
1974 return ('FAIL', $loghash{entry});
1975 } else {
1976 return ('OK', $msg);
1977 }
1978
1979} # end delZone()
1980
1981
1982## DNSDB::domainName()
1983# Return the domain name based on a domain ID
1984# Takes a database handle and the domain ID
1985# Returns the domain name or undef on failure
1986sub domainName {
1987 $errstr = '';
1988 my $dbh = shift;
1989 my $domid = shift;
1990 my ($domname) = $dbh->selectrow_array("SELECT domain FROM domains WHERE domain_id=?", undef, ($domid) );
1991 $errstr = $DBI::errstr if !$domname;
1992 return $domname if $domname;
1993} # end domainName()
1994
1995
1996## DNSDB::revName()
1997# Return the reverse zone name based on an rDNS ID
1998# Takes a database handle and the rDNS ID
1999# Returns the reverse zone name or undef on failure
2000sub revName {
2001 $errstr = '';
2002 my $dbh = shift;
2003 my $revid = shift;
2004 my ($revname) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id=?", undef, ($revid) );
2005 $errstr = $DBI::errstr if !$revname;
2006 return $revname if $revname;
2007} # end revName()
2008
2009
2010## DNSDB::domainID()
2011# Takes a database handle and domain name
2012# Returns the domain ID number
2013sub domainID {
2014 $errstr = '';
2015 my $dbh = shift;
2016 my $domain = shift;
2017 my ($domid) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
2018 undef, ($domain) );
2019 $errstr = $DBI::errstr if !$domid;
2020 return $domid if $domid;
2021} # end domainID()
2022
2023
2024## DNSDB::revID()
2025# Takes a database handle and reverse zone name
2026# Returns the rDNS ID number
2027sub revID {
2028 $errstr = '';
2029 my $dbh = shift;
2030 my $revzone = shift;
2031 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?", undef, ($revzone) );
2032 $errstr = $DBI::errstr if !$revid;
2033 return $revid if $revid;
2034} # end revID()
2035
2036
2037## DNSDB::addRDNS
2038# Adds a reverse DNS zone
2039# Takes a database handle, CIDR block, reverse DNS pattern, numeric group,
2040# and boolean(ish) state (active/inactive)
2041# Returns a status code and message
2042sub addRDNS {
2043 my $dbh = shift;
2044 my $zone = NetAddr::IP->new(shift);
2045
2046 return ('FAIL',"Zone name must be a valid CIDR netblock") unless ($zone && $zone->addr !~ /^0/);
2047 my $revpatt = shift; # construct a custom (A/AAAA+)? PTR template record
2048 my $group = shift;
2049 my $state = shift;
2050 my $defloc = shift || '';
2051
2052 $state = 1 if $state =~ /^active$/;
2053 $state = 1 if $state =~ /^on$/;
2054 $state = 0 if $state =~ /^inactive$/;
2055 $state = 0 if $state =~ /^off$/;
2056
2057 return ('FAIL',"Invalid zone status") if $state !~ /^\d+$/;
2058
2059# quick check to start to see if we've already got one
2060 my ($rdns_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?", undef, ("$zone"));
2061
2062 return ('FAIL', "Zone already exists") if $rdns_id;
2063
2064 # Allow transactions, and raise an exception on errors so we can catch it later.
2065 # Use local to make sure these get "reset" properly on exiting this block
2066 local $dbh->{AutoCommit} = 0;
2067 local $dbh->{RaiseError} = 1;
2068
2069 my $warnstr = '';
2070 my $defttl = 3600; # 1 hour should be reasonable. And unless things have gone horribly
2071 # wrong, we should have a value to override this anyway.
2072
2073 # Wrap all the SQL in a transaction
2074 eval {
2075 # insert the zone...
2076 $dbh->do("INSERT INTO revzones (revnet,group_id,status,default_location) VALUES (?,?,?,?)", undef,
2077 ($zone, $group, $state, $defloc) );
2078
2079 # get the ID...
2080 ($rdns_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
2081
2082 _log($dbh, (rdns_id => $rdns_id, group_id => $group,
2083 entry => "Added ".($state ? 'active' : 'inactive')." reverse zone $zone"));
2084
2085 # ... and now we construct the standard records from the default set. NB: group should be variable.
2086 my $sth = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
2087 my $sth_in = $dbh->prepare("INSERT INTO records (rdns_id,domain_id,host,type,val,ttl,location)".
2088 " VALUES ($rdns_id,?,?,?,?,?,?)");
2089 $sth->execute($group);
2090 while (my ($host,$type,$val,$ttl) = $sth->fetchrow_array()) {
2091 # Silently skip v4/v6 mismatches. This is not an error, this is expected.
2092 if ($zone->{isv6}) {
2093 next if ($type == 65280 || $type == 65283);
2094 } else {
2095 next if ($type == 65281 || $type == 65284);
2096 }
2097
2098 $host =~ s/ADMINDOMAIN/$config{domain}/g;
2099
2100 # Check to make sure the IP stubs will fit in the zone. Under most usage failures here should be rare.
2101 # On failure, tack a note on to a warning string and continue without adding this record.
2102 # While we're at it, we substitute $zone for ZONE in the value.
2103 if ($val eq 'ZONE') {
2104 # If we've got a pattern, we skip the default record version on (A+)PTR-template types
2105 next if $revpatt && ($type == 65282 || $type == 65283);
2106##fixme? do we care if we have multiple whole-zone templates?
2107 $val = $zone->network;
2108 } elsif ($val =~ /ZONE/) {
2109 my $tmpval = $val;
2110 $tmpval =~ s/ZONE//;
2111 # Bend the rules and allow single-trailing-number PTR or PTR template records to be inserted
2112 # as either v4 or v6. May make this an off-by-default config flag
2113 # Note that the origin records that may trigger this **SHOULD** already have ZONE,\d
2114 if ($type == 12 || $type == 65282) {
2115 $tmpval =~ s/[,.]/::/ if ($tmpval =~ /^[,.]\d+$/ && $zone->{isv6});
2116 $tmpval =~ s/[,:]+/./ if ($tmpval =~ /^(?:,|::)\d+$/ && !$zone->{isv6});
2117 }
2118 my $addr;
2119 if (_ipparent($dbh, 'n', 'y', \$tmpval, $rdns_id, \$addr)) {
2120 $val = $addr->addr;
2121 } else {
2122 $warnstr .= "\nDefault record '$val $typemap{$type} $host' doesn't fit in $zone, skipping";
2123 next;
2124 }
2125 }
2126
2127 # Substitute $zone for ZONE in the hostname, but only for non-NS records.
2128 # NS records get this substitution on the value instead.
2129 $host = _ZONE($zone, $host) if $type != 2;
2130
2131 # Fill in the forward domain ID if we can find it, otherwise:
2132 # Coerce type down to PTR or PTR template if we can't
2133 my $domid = 0;
2134 if ($type >= 65280) {
2135 if (!($domid = _hostparent($dbh, $host))) {
2136 $warnstr .= "\nRecord added as PTR instead of $typemap{$type}; domain not found for $host";
2137 $type = $reverse_typemap{PTR};
2138 $domid = 0; # just to be explicit.
2139 }
2140 }
2141
2142 $sth_in->execute($domid,$host,$type,$val,$ttl,$defloc);
2143
2144 if ($typemap{$type} eq 'SOA') {
2145 my @tmp1 = split /:/, $host;
2146 my @tmp2 = split /:/, $val;
2147 _log($dbh, (rdns_id => $rdns_id, group_id => $group,
2148 entry => "[new $zone] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
2149 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl"));
2150 $defttl = $tmp2[3];
2151 } else {
2152 my $logentry = "[new $zone] Added record '$host $typemap{$type} $val', TTL $ttl";
2153 $logentry .= ", default location ".getLoc($dbh, $defloc)->{description} if $defloc;
2154 _log($dbh, (rdns_id => $rdns_id, domain_id => $domid, group_id => $group, entry => $logentry) );
2155 }
2156 }
2157
2158 # Generate record based on provided pattern.
2159 if ($revpatt) {
2160 my $host;
2161 my $type = ($zone->{isv6} ? 65284 : 65283);
2162 my $val = $zone->network;
2163
2164 # Substitute $zone for ZONE in the hostname.
2165 $host = _ZONE($zone, $revpatt);
2166
2167 my $domid = 0;
2168 if (!($domid = _hostparent($dbh, $host))) {
2169 $warnstr .= "\nDefault pattern added as PTR template instead of $typemap{$type}; domain not found for $host";
2170 $type = 65282;
2171 $domid = 0; # just to be explicit.
2172 }
2173
2174 $sth_in->execute($domid,$host,$type,$val,$defttl,$defloc);
2175 my $logentry = "[new $zone] Added record '$host $typemap{$type}";
2176 _log($dbh, (rdns_id => $rdns_id, domain_id => $domid, group_id => $group,
2177 entry => $logentry." $val', TTL $defttl from pattern"));
2178 }
2179
2180 # If there are warnings (presumably about default records skipped for cause) log them
2181 _log($dbh, (rdns_id => $rdns_id, group_id => $group, entry => "Warning(s) adding $zone:$warnstr"))
2182 if $warnstr;
2183
2184 # once we get here, we should have suceeded.
2185 $dbh->commit;
2186 }; # end eval
2187
2188 if ($@) {
2189 my $msg = $@;
2190 eval { $dbh->rollback; };
2191 _log($dbh, (group_id => $group, entry => "Failed adding reverse zone $zone ($msg)"))
2192 if $config{log_failures};
2193 $dbh->commit; # since we enabled transactions earlier
2194 return ('FAIL',$msg);
2195 } else {
2196 my $retcode = 'OK';
2197 if ($warnstr) {
2198 $resultstr = $warnstr;
2199 $retcode = 'WARN';
2200 }
2201 return ($retcode, $rdns_id);
2202 }
2203
2204} # end addRDNS()
2205
2206
2207## DNSDB::getZoneCount
2208# Get count of zones in group or groups
2209# Takes a database handle and hash containing:
2210# - the "current" group
2211# - an array of "acceptable" groups
2212# - a flag for forward/reverse zones
2213# - Optionally accept a "starts with" and/or "contains" filter argument
2214# Returns an integer count of the resulting zone list.
2215sub getZoneCount {
2216 my $dbh = shift;
2217
2218 my %args = @_;
2219
2220 my @filterargs;
2221 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2222 push @filterargs, "^$args{startwith}" if $args{startwith};
2223 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
2224 push @filterargs, $args{filter} if $args{filter};
2225
2226 my $sql;
2227 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2228 if ($args{revrec} eq 'n') {
2229 $sql = "SELECT count(*) FROM domains".
2230 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2231 ($args{startwith} ? " AND domain ~* ?" : '').
2232 ($args{filter} ? " AND domain ~* ?" : '');
2233 } else {
2234 $sql = "SELECT count(*) FROM revzones".
2235 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2236 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '').
2237 ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2238 }
2239 my ($count) = $dbh->selectrow_array($sql, undef, @filterargs);
2240 return $count;
2241} # end getZoneCount()
2242
2243
2244## DNSDB::getZoneList()
2245# Get a list of zones in the specified group(s)
2246# Takes the same arguments as getZoneCount() above
2247# Returns a reference to an array of hashrefs suitable for feeding to HTML::Template
2248sub getZoneList {
2249 my $dbh = shift;
2250
2251 my %args = @_;
2252
2253 my @zonelist;
2254
2255 $args{sortorder} = 'ASC' if !grep /^$args{sortorder}$/, ('ASC','DESC');
2256 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
2257
2258 my @filterargs;
2259 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2260 push @filterargs, "^$args{startwith}" if $args{startwith};
2261 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
2262 push @filterargs, $args{filter} if $args{filter};
2263
2264 my $sql;
2265 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
2266 if ($args{revrec} eq 'n') {
2267 $args{sortby} = 'domain' if !grep /^$args{sortby}$/, ('domain','group','status');
2268 $sql = "SELECT domain_id,domain,status,groups.group_name AS group FROM domains".
2269 " INNER JOIN groups ON domains.group_id=groups.group_id".
2270 " WHERE domains.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2271 ($args{startwith} ? " AND domain ~* ?" : '').
2272 ($args{filter} ? " AND domain ~* ?" : '');
2273 } else {
2274##fixme: arguably startwith here is irrelevant. depends on the UI though.
2275 $args{sortby} = 'revnet' if !grep /^$args{sortby}$/, ('revnet','group','status');
2276 $sql = "SELECT rdns_id,revnet,status,groups.group_name AS group FROM revzones".
2277 " INNER JOIN groups ON revzones.group_id=groups.group_id".
2278 " WHERE revzones.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2279 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '').
2280 ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
2281 }
2282 # A common tail.
2283 $sql .= " ORDER BY ".($args{sortby} eq 'group' ? 'groups.group_name' : $args{sortby})." $args{sortorder} ".
2284 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage}".
2285 " OFFSET ".$args{offset}*$config{perpage});
2286 my $sth = $dbh->prepare($sql);
2287 $sth->execute(@filterargs);
2288 my $rownum = 0;
2289
2290 while (my @data = $sth->fetchrow_array) {
2291 my %row;
2292 $row{domain_id} = $data[0];
2293 $row{domain} = $data[1];
2294 $row{status} = $data[2];
2295 $row{group} = $data[3];
2296 push @zonelist, \%row;
2297 }
2298
2299 return \@zonelist;
2300} # end getZoneList()
2301
2302
2303## DNSDB::getZoneLocation()
2304# Retrieve the default location for a zone.
2305# Takes a database handle, forward/reverse flag, and zone ID
2306sub getZoneLocation {
2307 my $dbh = shift;
2308 my $revrec = shift;
2309 my $zoneid = shift;
2310
2311 my ($loc) = $dbh->selectrow_array("SELECT default_location FROM ".
2312 ($revrec eq 'n' ? 'domains WHERE domain_id = ?' : 'revzones WHERE rdns_id = ?'),
2313 undef, ($zoneid));
2314 return $loc;
2315} # end getZoneLocation()
2316
2317
2318## DNSDB::addGroup()
2319# Add a group
2320# Takes a database handle, group name, parent group, hashref for permissions,
2321# and optional template-vs-cloneme flag for the default records
2322# Returns a status code and message
2323sub addGroup {
2324 $errstr = '';
2325 my $dbh = shift;
2326 my $groupname = shift;
2327 my $pargroup = shift;
2328 my $permissions = shift;
2329
2330 # 0 indicates "custom", hardcoded.
2331 # Any other value clones that group's default records, if it exists.
2332 my $inherit = shift || 0;
2333##fixme: need a flag to indicate clone records or <?> ?
2334
2335 # Allow transactions, and raise an exception on errors so we can catch it later.
2336 # Use local to make sure these get "reset" properly on exiting this block
2337 local $dbh->{AutoCommit} = 0;
2338 local $dbh->{RaiseError} = 1;
2339
2340 my ($group_id) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($groupname));
2341
2342 return ('FAIL', "Group already exists") if $group_id;
2343
2344 # Wrap all the SQL in a transaction
2345 eval {
2346 $dbh->do("INSERT INTO groups (parent_group_id,group_name) VALUES (?,?)", undef, ($pargroup, $groupname) );
2347
2348 my ($groupid) = $dbh->selectrow_array("SELECT currval('groups_group_id_seq')");
2349
2350 # We work through the whole set of permissions instead of specifying them so
2351 # that when we add a new permission, we don't have to change the code anywhere
2352 # that doesn't explicitly deal with that specific permission.
2353 my @permvals;
2354 foreach (@permtypes) {
2355 if (!defined ($permissions->{$_})) {
2356 push @permvals, 0;
2357 } else {
2358 push @permvals, $permissions->{$_};
2359 }
2360 }
2361 $dbh->do("INSERT INTO permissions (group_id,$permlist) values (?".',?'x($#permtypes+1).")",
2362 undef, ($groupid, @permvals) );
2363 my ($permid) = $dbh->selectrow_array("SELECT currval('permissions_permission_id_seq')");
2364 $dbh->do("UPDATE groups SET permission_id=$permid WHERE group_id=$groupid");
2365
2366 # Default records
2367 my $sthf = $dbh->prepare("INSERT INTO default_records (group_id,host,type,val,distance,weight,port,ttl) ".
2368 "VALUES ($groupid,?,?,?,?,?,?,?)");
2369 my $sthr = $dbh->prepare("INSERT INTO default_rev_records (group_id,host,type,val,ttl) ".
2370 "VALUES ($groupid,?,?,?,?)");
2371 if ($inherit) {
2372 # Duplicate records from parent. Actually relying on inherited records feels
2373 # very fragile, and it would be problematic to roll over at a later time.
2374 my $sth2 = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
2375 $sth2->execute($pargroup);
2376 while (my @clonedata = $sth2->fetchrow_array) {
2377 $sthf->execute(@clonedata);
2378 }
2379 # And now the reverse records
2380 $sth2 = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
2381 $sth2->execute($pargroup);
2382 while (my @clonedata = $sth2->fetchrow_array) {
2383 $sthr->execute(@clonedata);
2384 }
2385 } else {
2386##fixme: Hardcoding is Bad, mmmmkaaaay?
2387 # reasonable basic defaults for SOA, MX, NS, and minimal hosting
2388 # could load from a config file, but somewhere along the line we need hardcoded bits.
2389 $sthf->execute('ns1.example.com:hostmaster.example.com', 6, '10800:3600:604800:10800', 0, 0, 0, 86400);
2390 $sthf->execute('DOMAIN', 1, '192.168.4.2', 0, 0, 0, 7200);
2391 $sthf->execute('DOMAIN', 15, 'mx.example.com', 10, 0, 0, 7200);
2392 $sthf->execute('DOMAIN', 2, 'ns1.example.com', 0, 0, 0, 7200);
2393 $sthf->execute('DOMAIN', 2, 'ns2.example.com', 0, 0, 0, 7200);
2394 $sthf->execute('www.DOMAIN', 5, 'DOMAIN', 0, 0, 0, 7200);
2395 # reasonable basic defaults for generic reverse zone. Same as initial SQL tabledef.
2396 $sthr->execute('hostmaster.ADMINDOMAIN:ns1.ADMINDOMAIN', 6, '10800:3600:604800:10800', 86400);
2397 $sthr->execute('unused-%r.ADMINDOMAIN', 65283, 'ZONE', 3600);
2398 }
2399
2400 _log($dbh, (group_id => $pargroup, entry => "Added group $groupname") );
2401
2402 # once we get here, we should have suceeded.
2403 $dbh->commit;
2404 }; # end eval
2405
2406 if ($@) {
2407 my $msg = $@;
2408 eval { $dbh->rollback; };
2409 if ($config{log_failures}) {
2410 _log($dbh, (group_id => $pargroup, entry => "Failed to add group $groupname: $msg") );
2411 $dbh->commit;
2412 }
2413 return ('FAIL',$msg);
2414 }
2415
2416 return ('OK','OK');
2417} # end addGroup()
2418
2419
2420## DNSDB::delGroup()
2421# Delete a group.
2422# Takes a group ID
2423# Returns a status code and message
2424sub delGroup {
2425 my $dbh = shift;
2426 my $groupid = shift;
2427
2428 # Allow transactions, and raise an exception on errors so we can catch it later.
2429 # Use local to make sure these get "reset" properly on exiting this block
2430 local $dbh->{AutoCommit} = 0;
2431 local $dbh->{RaiseError} = 1;
2432
2433##fixme: locate "knowable" error conditions and deal with them before the eval
2434# ... or inside, whatever.
2435# -> domains still exist in group
2436# -> ...
2437 my $failmsg = '';
2438 my $resultmsg = '';
2439
2440 # collect some pieces for logging and error messages
2441 my $groupname = groupName($dbh,$groupid);
2442 my $parid = parentID($dbh, (id => $groupid, type => 'group'));
2443
2444 # Wrap all the SQL in a transaction
2445 eval {
2446 # Check for Things in the group
2447 $failmsg = "Can't remove group $groupname";
2448 my ($grpcnt) = $dbh->selectrow_array("SELECT count(*) FROM groups WHERE parent_group_id=?", undef, ($groupid));
2449 die "$grpcnt groups still in group\n" if $grpcnt;
2450 my ($domcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($groupid));
2451 die "$domcnt domains still in group\n" if $domcnt;
2452 my ($usercnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($groupid));
2453 die "$usercnt users still in group\n" if $usercnt;
2454
2455 $failmsg = "Failed to delete default records for $groupname";
2456 $dbh->do("DELETE from default_records WHERE group_id=?", undef, ($groupid));
2457 $failmsg = "Failed to delete default reverse records for $groupname";
2458 $dbh->do("DELETE from default_rev_records WHERE group_id=?", undef, ($groupid));
2459 $failmsg = "Failed to remove group $groupname";
2460 $dbh->do("DELETE from groups WHERE group_id=?", undef, ($groupid));
2461
2462 _log($dbh, (group_id => $parid, entry => "Deleted group $groupname"));
2463 $resultmsg = "Deleted group $groupname";
2464
2465 # once we get here, we should have suceeded.
2466 $dbh->commit;
2467 }; # end eval
2468
2469 if ($@) {
2470 my $msg = $@;
2471 eval { $dbh->rollback; };
2472 if ($config{log_failures}) {
2473 _log($dbh, (group_id => $parid, entry => "$failmsg: $msg"));
2474 $dbh->commit; # since we enabled transactions earlier
2475 }
2476 return ('FAIL',"$failmsg: $msg");
2477 }
2478
2479 return ('OK',$resultmsg);
2480} # end delGroup()
2481
2482
2483## DNSDB::getChildren()
2484# Get a list of all groups whose parent^n is group <n>
2485# Takes a database handle, group ID, reference to an array to put the group IDs in,
2486# and an optional flag to return only immediate children or all children-of-children
2487# default to returning all children
2488# Calls itself
2489sub getChildren {
2490 $errstr = '';
2491 my $dbh = shift;
2492 my $rootgroup = shift;
2493 my $groupdest = shift;
2494 my $immed = shift || 'all';
2495
2496 # special break for default group; otherwise we get stuck.
2497 if ($rootgroup == 1) {
2498 # by definition, group 1 is the Root Of All Groups
2499 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE NOT (group_id=1)".
2500 ($immed ne 'all' ? " AND parent_group_id=1" : '')." ORDER BY group_name");
2501 $sth->execute;
2502 while (my @this = $sth->fetchrow_array) {
2503 push @$groupdest, @this;
2504 }
2505 } else {
2506 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE parent_group_id=? ORDER BY group_name");
2507 $sth->execute($rootgroup);
2508 return if $sth->rows == 0;
2509 my @grouplist;
2510 while (my ($group) = $sth->fetchrow_array) {
2511 push @$groupdest, $group;
2512 getChildren($dbh,$group,$groupdest) if $immed eq 'all';
2513 }
2514 }
2515} # end getChildren()
2516
2517
2518## DNSDB::groupName()
2519# Return the group name based on a group ID
2520# Takes a database handle and the group ID
2521# Returns the group name or undef on failure
2522sub groupName {
2523 $errstr = '';
2524 my $dbh = shift;
2525 my $groupid = shift;
2526 my $sth = $dbh->prepare("SELECT group_name FROM groups WHERE group_id=?");
2527 $sth->execute($groupid);
2528 my ($groupname) = $sth->fetchrow_array();
2529 $errstr = $DBI::errstr if !$groupname;
2530 return $groupname if $groupname;
2531} # end groupName
2532
2533
2534## DNSDB::getGroupCount()
2535# Get count of subgroups in group or groups
2536# Takes a database handle and hash containing:
2537# - the "current" group
2538# - an array of "acceptable" groups
2539# - Optionally accept a "starts with" and/or "contains" filter argument
2540# Returns an integer count of the resulting group list.
2541sub getGroupCount {
2542 my $dbh = shift;
2543
2544 my %args = @_;
2545
2546 my @filterargs;
2547
2548 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2549 push @filterargs, "^$args{startwith}" if $args{startwith};
2550 push @filterargs, $args{filter} if $args{filter};
2551
2552 my $sql = "SELECT count(*) FROM groups ".
2553 "WHERE parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2554 ($args{startwith} ? " AND group_name ~* ?" : '').
2555 ($args{filter} ? " AND group_name ~* ?" : '');
2556 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
2557 $errstr = $dbh->errstr if !$count;
2558 return $count;
2559} # end getGroupCount
2560
2561
2562## DNSDB::getGroupList()
2563# Get a list of sub^n-groups in the specified group(s)
2564# Takes the same arguments as getGroupCount() above
2565# Returns an arrayref containing hashrefs suitable for feeding straight to HTML::Template
2566sub getGroupList {
2567 my $dbh = shift;
2568
2569 my %args = @_;
2570
2571 my @filterargs;
2572
2573 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2574 push @filterargs, "^$args{startwith}" if $args{startwith};
2575 push @filterargs, $args{filter} if $args{filter};
2576
2577 # protection against bad or missing arguments
2578 $args{sortorder} = 'ASC' if !$args{sortorder};
2579 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
2580
2581 # munge sortby for columns in database
2582 $args{sortby} = 'g.group_name' if $args{sortby} eq 'group';
2583 $args{sortby} = 'g2.group_name' if $args{sortby} eq 'parent';
2584
2585 my $sql = q(SELECT g.group_id AS groupid, g.group_name AS groupname, g2.group_name AS pgroup
2586 FROM groups g
2587 INNER JOIN groups g2 ON g2.group_id=g.parent_group_id
2588 ).
2589 " WHERE g.parent_group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2590 ($args{startwith} ? " AND g.group_name ~* ?" : '').
2591 ($args{filter} ? " AND g.group_name ~* ?" : '').
2592 " GROUP BY g.group_id, g.group_name, g2.group_name ".
2593 " ORDER BY $args{sortby} $args{sortorder} ".
2594 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage} OFFSET ".$args{offset}*$config{perpage});
2595 my $glist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
2596 $errstr = $dbh->errstr if !$glist;
2597
2598 # LEFT JOINs make the result set balloon beyond sanity just to include counts;
2599 # this means there's lots of crunching needed to trim the result set back down.
2600 # So instead we track the order of the groups, and push the counts into the
2601 # arrayref result separately.
2602##fixme: put this whole sub in a transaction? might be
2603# needed for accurate results on very busy systems.
2604##fixme: large group lists need prepared statements?
2605#my $ucsth = $dbh->prepare("SELECT count(*) FROM users WHERE group_id=?");
2606#my $dcsth = $dbh->prepare("SELECT count(*) FROM domains WHERE group_id=?");
2607#my $rcsth = $dbh->prepare("SELECT count(*) FROM revzones WHERE group_id=?");
2608 foreach (@{$glist}) {
2609 my ($ucnt) = $dbh->selectrow_array("SELECT count(*) FROM users WHERE group_id=?", undef, ($$_{groupid}));
2610 $$_{nusers} = $ucnt;
2611 my ($dcnt) = $dbh->selectrow_array("SELECT count(*) FROM domains WHERE group_id=?", undef, ($$_{groupid}));
2612 $$_{ndomains} = $dcnt;
2613 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM revzones WHERE group_id=?", undef, ($$_{groupid}));
2614 $$_{nrevzones} = $rcnt;
2615 }
2616
2617 return $glist;
2618} # end getGroupList
2619
2620
2621## DNSDB::groupID()
2622# Return the group ID based on the group name
2623# Takes a database handle and the group name
2624# Returns the group ID or undef on failure
2625sub groupID {
2626 $errstr = '';
2627 my $dbh = shift;
2628 my $group = shift;
2629 my ($grpid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($group) );
2630 $errstr = $DBI::errstr if !$grpid;
2631 return $grpid if $grpid;
2632} # end groupID()
2633
2634
2635## DNSDB::addUser()
2636# Add a user.
2637# Takes a DB handle, username, group ID, password, state (active/inactive).
2638# Optionally accepts:
2639# user type (user/admin) - defaults to user
2640# permissions string - defaults to inherit from group
2641# three valid forms:
2642# i - Inherit permissions
2643# c:<user_id> - Clone permissions from <user_id>
2644# C:<permission list> - Set these specific permissions
2645# first name - defaults to username
2646# last name - defaults to blank
2647# phone - defaults to blank (could put other data within column def)
2648# Returns (OK,<uid>) on success, (FAIL,<message>) on failure
2649sub addUser {
2650 $errstr = '';
2651 my $dbh = shift;
2652 my $username = shift;
2653 my $group = shift;
2654 my $pass = shift;
2655 my $state = shift;
2656
2657 return ('FAIL', "Missing one or more required entries") if !defined($state);
2658 return ('FAIL', "Username must not be blank") if !$username;
2659
2660 # Munge in some alternate state values
2661 $state = 1 if $state =~ /^active$/;
2662 $state = 1 if $state =~ /^on$/;
2663 $state = 0 if $state =~ /^inactive$/;
2664 $state = 0 if $state =~ /^off$/;
2665
2666 my $type = shift || 'u'; # create limited users by default - fwiw, not sure yet how this will interact with ACLs
2667
2668 my $permstring = shift || 'i'; # default is to inhert permissions from group
2669
2670 my $fname = shift || $username;
2671 my $lname = shift || '';
2672 my $phone = shift || ''; # not going format-check
2673
2674 my $sth = $dbh->prepare("SELECT user_id FROM users WHERE username=?");
2675 my $user_id;
2676
2677# quick check to start to see if we've already got one
2678 $sth->execute($username);
2679 ($user_id) = $sth->fetchrow_array;
2680
2681 return ('FAIL', "User already exists") if $user_id;
2682
2683 # Allow transactions, and raise an exception on errors so we can catch it later.
2684 # Use local to make sure these get "reset" properly on exiting this block
2685 local $dbh->{AutoCommit} = 0;
2686 local $dbh->{RaiseError} = 1;
2687
2688 # Wrap all the SQL in a transaction
2689 eval {
2690 # insert the user... note we set inherited perms by default since
2691 # it's simple and cleans up some other bits of state
2692 my $sth = $dbh->prepare("INSERT INTO users ".
2693 "(group_id,username,password,firstname,lastname,phone,type,status,permission_id,inherit_perm) ".
2694 "VALUES (?,?,?,?,?,?,?,?,(SELECT permission_id FROM permissions WHERE group_id=?),'t')");
2695 $sth->execute($group,$username,unix_md5_crypt($pass),$fname,$lname,$phone,$type,$state,$group);
2696
2697 # get the ID...
2698 ($user_id) = $dbh->selectrow_array("SELECT currval('users_user_id_seq')");
2699
2700# Permissions! Gotta set'em all!
2701 die "Invalid permission string $permstring\n"
2702 if $permstring !~ /^(?:
2703 i # inherit
2704 |c:\d+ # clone
2705 # custom. no, the leading , is not a typo
2706 |C:(?:,(?:group|user|domain|record|location|self)_(?:edit|create|delete|locchg|view))*
2707 )$/x;
2708# bleh. I'd call another function to do my dirty work, but we're in the middle of a transaction already.
2709 if ($permstring ne 'i') {
2710 # for cloned or custom permissions, we have to create a new permissions entry.
2711 my $clonesrc = $group;
2712 if ($permstring =~ /^c:(\d+)/) { $clonesrc = $1; }
2713 $dbh->do("INSERT INTO permissions ($permlist,user_id) ".
2714 "SELECT $permlist,? FROM permissions WHERE permission_id=".
2715 "(SELECT permission_id FROM permissions WHERE ".($permstring =~ /^c:/ ? 'user' : 'group')."_id=?)",
2716 undef, ($user_id,$clonesrc) );
2717 $dbh->do("UPDATE users SET permission_id=".
2718 "(SELECT permission_id FROM permissions WHERE user_id=?) ".
2719 "WHERE user_id=?", undef, ($user_id, $user_id) );
2720 }
2721 if ($permstring =~ /^C:/) {
2722 # finally for custom permissions, we set the passed-in permissions (and unset
2723 # any that might have been brought in by the clone operation above)
2724 my ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions WHERE user_id=?",
2725 undef, ($user_id) );
2726 foreach (@permtypes) {
2727 if ($permstring =~ /,$_/) {
2728 $dbh->do("UPDATE permissions SET $_='t' WHERE permission_id=?", undef, ($permid) );
2729 } else {
2730 $dbh->do("UPDATE permissions SET $_='f' WHERE permission_id=?", undef, ($permid) );
2731 }
2732 }
2733 }
2734
2735 $dbh->do("UPDATE users SET inherit_perm='n' WHERE user_id=?", undef, ($user_id) );
2736
2737##fixme: add another table to hold name/email for log table?
2738
2739 _log($dbh, (group_id => $group, entry => "Added user $username ($fname $lname)"));
2740 # once we get here, we should have suceeded.
2741 $dbh->commit;
2742 }; # end eval
2743
2744 if ($@) {
2745 my $msg = $@;
2746 eval { $dbh->rollback; };
2747 if ($config{log_failures}) {
2748 _log($dbh, (group_id => $group, entry => "Error adding user $username: $msg"));
2749 $dbh->commit; # since we enabled transactions earlier
2750 }
2751 return ('FAIL',"Error adding user $username: $msg");
2752 }
2753
2754 return ('OK',"User $username ($fname $lname) added");
2755} # end addUser
2756
2757
2758## DNSDB::getUserCount()
2759# Get count of users in group
2760# Takes a database handle and hash containing at least the current group, and optionally:
2761# - a reference list of secondary groups
2762# - a filter string
2763# - a "Starts with" string
2764sub getUserCount {
2765 my $dbh = shift;
2766
2767 my %args = @_;
2768
2769 my @filterargs;
2770
2771 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2772 push @filterargs, "^$args{startwith}" if $args{startwith};
2773 push @filterargs, $args{filter} if $args{filter};
2774
2775
2776 my $sql = "SELECT count(*) FROM users ".
2777 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2778 ($args{startwith} ? " AND username ~* ?" : '').
2779 ($args{filter} ? " AND username ~* ?" : '');
2780 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
2781 $errstr = $dbh->errstr if !$count;
2782 return $count;
2783} # end getUserCount()
2784
2785
2786## DNSDB::getUserList()
2787# Get list of users
2788# Takes the same arguments as getUserCount() above, plus optional:
2789# - sort field
2790# - sort order
2791# - offset/return-all-everything flag (defaults to $perpage records)
2792sub getUserList {
2793 my $dbh = shift;
2794
2795 my %args = @_;
2796
2797 my @filterargs;
2798
2799 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
2800 push @filterargs, "^$args{startwith}" if $args{startwith};
2801 push @filterargs, $args{filter} if $args{filter};
2802
2803 # better to request sorts on "simple" names, but it means we need to map it to real columns
2804 my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
2805 fname => 'fname');
2806 $args{sortby} = $sortmap{$args{sortby}};
2807
2808 # protection against bad or missing arguments
2809 $args{sortorder} = 'ASC' if !$args{sortorder};
2810 $args{sortby} = 'u.username' if !$args{sortby};
2811 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
2812
2813 my $sql = "SELECT u.user_id, u.username, u.firstname || ' ' || u.lastname AS fname, u.type, g.group_name, u.status ".
2814 "FROM users u ".
2815 "INNER JOIN groups g ON u.group_id=g.group_id ".
2816 "WHERE u.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
2817 ($args{startwith} ? " AND u.username ~* ?" : '').
2818 ($args{filter} ? " AND u.username ~* ?" : '').
2819 " AND NOT u.type = 'R' ".
2820 " ORDER BY $args{sortby} $args{sortorder} ".
2821 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage} OFFSET ".$args{offset}*$config{perpage});
2822 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
2823 $errstr = $dbh->errstr if !$ulist;
2824 return $ulist;
2825} # end getUserList()
2826
2827
2828## DNSDB::getUserDropdown()
2829# Get a list of usernames for use in a dropdown menu.
2830# Takes a database handle, current group, and optional "tag this as selected" flag.
2831# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
2832sub getUserDropdown {
2833 my $dbh = shift;
2834 my $grp = shift;
2835 my $sel = shift || 0;
2836
2837 my $sth = $dbh->prepare("SELECT username,user_id FROM users WHERE group_id=?");
2838 $sth->execute($grp);
2839
2840 my @userlist;
2841 while (my ($username,$uid) = $sth->fetchrow_array) {
2842 my %row = (
2843 username => $username,
2844 uid => $uid,
2845 selected => ($sel == $uid ? 1 : 0)
2846 );
2847 push @userlist, \%row;
2848 }
2849 return \@userlist;
2850} # end getUserDropdown()
2851
2852
2853## DNSDB::checkUser()
2854# Check user/pass combo on login
2855sub checkUser {
2856 my $dbh = shift;
2857 my $user = shift;
2858 my $inpass = shift;
2859
2860 my $sth = $dbh->prepare("SELECT user_id,group_id,password,firstname,lastname FROM users WHERE username=?");
2861 $sth->execute($user);
2862 my ($uid,$gid,$pass,$fname,$lname) = $sth->fetchrow_array;
2863 my $loginfailed = 1 if !defined($uid);
2864
2865 if ($pass =~ m|^\$1\$([A-Za-z0-9/.]+)\$|) {
2866 $loginfailed = 1 if $pass ne unix_md5_crypt($inpass,$1);
2867 } else {
2868 $loginfailed = 1 if $pass ne $inpass;
2869 }
2870
2871 # nnnngggg
2872 return ($uid, $gid);
2873} # end checkUser
2874
2875
2876## DNSDB:: updateUser()
2877# Update general data about user
2878sub updateUser {
2879 my $dbh = shift;
2880
2881##fixme: tweak calling convention so that we can update any given bit of data
2882 my $uid = shift;
2883 my $username = shift;
2884 my $group = shift;
2885 my $pass = shift;
2886 my $state = shift;
2887 my $type = shift || 'u';
2888 my $fname = shift || $username;
2889 my $lname = shift || '';
2890 my $phone = shift || ''; # not going format-check
2891
2892 my $resultmsg = '';
2893
2894 # Munge in some alternate state values
2895 $state = 1 if $state =~ /^active$/;
2896 $state = 1 if $state =~ /^on$/;
2897 $state = 0 if $state =~ /^inactive$/;
2898 $state = 0 if $state =~ /^off$/;
2899
2900 # Allow transactions, and raise an exception on errors so we can catch it later.
2901 # Use local to make sure these get "reset" properly on exiting this block
2902 local $dbh->{AutoCommit} = 0;
2903 local $dbh->{RaiseError} = 1;
2904
2905 my $sth;
2906
2907 # Password can be left blank; if so we assume there's one on file.
2908 # Actual blank passwords are bad, mm'kay?
2909 if (!$pass) {
2910 ($pass) = $dbh->selectrow_array("SELECT password FROM users WHERE user_id=?", undef, ($uid));
2911 } else {
2912 $pass = unix_md5_crypt($pass);
2913 }
2914
2915 eval {
2916 $dbh->do("UPDATE users SET username=?, password=?, firstname=?, lastname=?, phone=?, type=?, status=?".
2917 " WHERE user_id=?", undef, ($username, $pass, $fname, $lname, $phone, $type, $state, $uid));
2918 $resultmsg = "Updated user info for $username ($fname $lname)";
2919 _log($dbh, group_id => $group, entry => $resultmsg);
2920 $dbh->commit;
2921 };
2922 if ($@) {
2923 my $msg = $@;
2924 eval { $dbh->rollback; };
2925 if ($config{log_failures}) {
2926 _log($dbh, (group_id => $group, entry => "Error updating user $username: $msg"));
2927 $dbh->commit; # since we enabled transactions earlier
2928 }
2929 return ('FAIL',"Error updating user $username: $msg");
2930 }
2931
2932 return ('OK',$resultmsg);
2933} # end updateUser()
2934
2935
2936## DNSDB::delUser()
2937# Delete a user.
2938# Takes a database handle and user ID
2939# Returns a success/failure code and matching message
2940sub delUser {
2941 my $dbh = shift;
2942 my $userid = shift;
2943
2944 return ('FAIL',"Bad userid") if !defined($userid);
2945
2946 my $userdata = getUserData($dbh, $userid);
2947
2948 # Allow transactions, and raise an exception on errors so we can catch it later.
2949 # Use local to make sure these get "reset" properly on exiting this block
2950 local $dbh->{AutoCommit} = 0;
2951 local $dbh->{RaiseError} = 1;
2952
2953 eval {
2954 $dbh->do("DELETE FROM users WHERE user_id=?", undef, ($userid));
2955 _log($dbh, (group_id => $userdata->{group_id},
2956 entry => "Deleted user ID $userid/".$userdata->{username}.
2957 " (".$userdata->{firstname}." ".$userdata->{lastname}.")") );
2958 $dbh->commit;
2959 };
2960 if ($@) {
2961 my $msg = $@;
2962 eval { $dbh->rollback; };
2963 if ($config{log_failures}) {
2964 _log($dbh, (group_id => $userdata->{group_id}, entry => "Error deleting user ID ".
2965 "$userid/".$userdata->{username}.": $msg") );
2966 $dbh->commit;
2967 }
2968 return ('FAIL',"Error deleting user $userid/".$userdata->{username}.": $msg");
2969 }
2970
2971 return ('OK',"Deleted user ".$userdata->{username}." (".$userdata->{firstname}." ".$userdata->{lastname}.")");
2972} # end delUser
2973
2974
2975## DNSDB::userFullName()
2976# Return a pretty string!
2977# Takes a user_id and optional printf-ish string to indicate which pieces where:
2978# %u for the username
2979# %f for the first name
2980# %l for the last name
2981# All other text in the passed string will be left as-is.
2982##fixme: need a "smart" option too, so that missing/null/blank first/last names don't give funky output
2983sub userFullName {
2984 $errstr = '';
2985 my $dbh = shift;
2986 my $userid = shift;
2987 my $fullformat = shift || '%f %l (%u)';
2988 my $sth = $dbh->prepare("select username,firstname,lastname from users where user_id=?");
2989 $sth->execute($userid);
2990 my ($uname,$fname,$lname) = $sth->fetchrow_array();
2991 $errstr = $DBI::errstr if !$uname;
2992
2993 $fullformat =~ s/\%u/$uname/g;
2994 $fullformat =~ s/\%f/$fname/g;
2995 $fullformat =~ s/\%l/$lname/g;
2996
2997 return $fullformat;
2998} # end userFullName
2999
3000
3001## DNSDB::userStatus()
3002# Sets and/or returns a user's status
3003# Takes a database handle, user ID and optionally a status argument
3004# Returns undef on errors.
3005sub userStatus {
3006 my $dbh = shift;
3007 my $id = shift;
3008 my $newstatus = shift || 'mu';
3009
3010 return undef if $id !~ /^\d+$/;
3011
3012 my $userdata = getUserData($dbh, $id);
3013
3014 # Allow transactions, and raise an exception on errors so we can catch it later.
3015 # Use local to make sure these get "reset" properly on exiting this block
3016 local $dbh->{AutoCommit} = 0;
3017 local $dbh->{RaiseError} = 1;
3018
3019 if ($newstatus ne 'mu') {
3020 # ooo, fun! let's see what we were passed for status
3021 eval {
3022 $newstatus = 0 if $newstatus eq 'useroff';
3023 $newstatus = 1 if $newstatus eq 'useron';
3024 $dbh->do("UPDATE users SET status=? WHERE user_id=?", undef, ($newstatus, $id));
3025
3026 $resultstr = ($newstatus ? 'Enabled' : 'Disabled')." user ".$userdata->{username}.
3027 " (".$userdata->{firstname}." ".$userdata->{lastname}.")";
3028
3029 my %loghash;
3030 $loghash{group_id} = parentID($dbh, (id => $id, type => 'user'));
3031 $loghash{entry} = $resultstr;
3032 _log($dbh, %loghash);
3033
3034 $dbh->commit;
3035 };
3036 if ($@) {
3037 my $msg = $@;
3038 eval { $dbh->rollback; };
3039 $resultstr = '';
3040 $errstr = $msg;
3041##fixme: failure logging?
3042 return;
3043 }
3044 }
3045
3046 my ($status) = $dbh->selectrow_array("SELECT status FROM users WHERE user_id=?", undef, ($id));
3047 return $status;
3048} # end userStatus()
3049
3050
3051## DNSDB::getUserData()
3052# Get misc user data for display
3053sub getUserData {
3054 my $dbh = shift;
3055 my $uid = shift;
3056
3057 my $sth = $dbh->prepare("SELECT group_id,username,firstname,lastname,phone,type,status,inherit_perm ".
3058 "FROM users WHERE user_id=?");
3059 $sth->execute($uid);
3060 return $sth->fetchrow_hashref();
3061} # end getUserData()
3062
3063
3064## DNSDB::addLoc()
3065# Add a new location.
3066# Takes a database handle, group ID, short and long description, and a comma-separated
3067# list of IP addresses.
3068# Returns ('OK',<location>) on success, ('FAIL',<failmsg>) on failure
3069sub addLoc {
3070 my $dbh = shift;
3071 my $grp = shift;
3072 my $shdesc = shift;
3073 my $comments = shift;
3074 my $iplist = shift;
3075
3076 # $shdesc gets set to the generated location ID if possible, but these can be de-undefined here.
3077 $comments = '' if !$comments;
3078 $iplist = '' if !$iplist;
3079
3080 my $loc;
3081
3082 # Generate a location ID. This is, by spec, a two-character widget. We'll use [a-z][a-z]
3083 # for now; 676 locations should satisfy all but the largest of the huge networks.
3084 # Not sure whether these are case-sensitive, or what other rules might apply - in any case
3085 # the absolute maximum is 16K (256*256) since it's parsed by tinydns as a two-character field.
3086
3087# add just after "my $origloc = $loc;":
3088# # These expand the possible space from 26^2 to 52^2 [* note in testing only 2052 were achieved],
3089# # and wrap it around.
3090# # Yes, they skip a couple of possibles. No, I don't care.
3091# $loc = 'aA' if $loc eq 'zz';
3092# $loc = 'Aa' if $loc eq 'zZ';
3093# $loc = 'ZA' if $loc eq 'Zz';
3094# $loc = 'aa' if $loc eq 'ZZ';
3095
3096 # Allow transactions, and raise an exception on errors so we can catch it later.
3097 # Use local to make sure these get "reset" properly on exiting this block
3098 local $dbh->{AutoCommit} = 0;
3099 local $dbh->{RaiseError} = 1;
3100
3101##fixme: There is probably a far better way to do this. Sequential increments
3102# are marginally less stupid that pure random generation though, and the existence
3103# check makes sure we don't stomp on an imported one.
3104
3105 eval {
3106 # Get the "last" location. Note this is the only use for loc_id, because selecting on location Does Funky Things
3107 ($loc) = $dbh->selectrow_array("SELECT location FROM locations ORDER BY loc_id DESC LIMIT 1");
3108 ($loc) = ($loc =~ /^(..)/);
3109 my $origloc = $loc;
3110 $loc = 'aa' if !$loc;
3111 # Make a change...
3112 $loc++;
3113 # ... and keep changing if it exists
3114 while ($dbh->selectrow_array("SELECT count(*) FROM locations WHERE location LIKE ?", undef, ($loc.'%'))) {
3115 $loc++;
3116 ($loc) = ($loc =~ /^(..)/);
3117 die "too many locations in use, can't add another one\n" if $loc eq $origloc;
3118##fixme: really need to handle this case faster somehow
3119#if $loc eq $origloc die "<thwap> bad admin: all locations used, your network is too fragmented";
3120 }
3121 # And now we should have a unique location. tinydns fundamentally limits the
3122 # number of these but there's no doc on what characters are valid.
3123 $shdesc = $loc if !$shdesc;
3124 $dbh->do("INSERT INTO locations (location, group_id, iplist, description, comments) VALUES (?,?,?,?,?)",
3125 undef, ($loc, $grp, $iplist, $shdesc, $comments) );
3126 _log($dbh, entry => "Added location ($shdesc, '$iplist')");
3127 $dbh->commit;
3128 };
3129 if ($@) {
3130 my $msg = $@;
3131 eval { $dbh->rollback; };
3132 if ($config{log_failures}) {
3133 $shdesc = $loc if !$shdesc;
3134 _log($dbh, (entry => "Failed adding location ($shdesc, '$iplist'): $msg"));
3135 $dbh->commit;
3136 }
3137 return ('FAIL',$msg);
3138 }
3139
3140 return ('OK',$loc);
3141} # end addLoc()
3142
3143
3144## DNSDB::updateLoc()
3145# Update details of a location.
3146# Takes a database handle, location ID, group ID, short description,
3147# long comments/notes, and comma/space-separated IP list
3148# Returns a result code and message
3149sub updateLoc {
3150 my $dbh = shift;
3151 my $loc = shift;
3152 my $grp = shift;
3153 my $shdesc = shift;
3154 my $comments = shift;
3155 my $iplist = shift;
3156
3157 $shdesc = '' if !$shdesc;
3158 $comments = '' if !$comments;
3159 $iplist = '' if !$iplist;
3160
3161 # Allow transactions, and raise an exception on errors so we can catch it later.
3162 # Use local to make sure these get "reset" properly on exiting this block
3163 local $dbh->{AutoCommit} = 0;
3164 local $dbh->{RaiseError} = 1;
3165
3166 my $oldloc = getLoc($dbh, $loc);
3167 my $okmsg = "Updated location (".$oldloc->{description}.", '".$oldloc->{iplist}."') to ($shdesc, '$iplist')";
3168
3169 eval {
3170 $dbh->do("UPDATE locations SET group_id=?,iplist=?,description=?,comments=? WHERE location=?",
3171 undef, ($grp, $iplist, $shdesc, $comments, $loc) );
3172 _log($dbh, entry => $okmsg);
3173 $dbh->commit;
3174 };
3175 if ($@) {
3176 my $msg = $@;
3177 eval { $dbh->rollback; };
3178 if ($config{log_failures}) {
3179 $shdesc = $loc if !$shdesc;
3180 _log($dbh, (entry => "Failed updating location ($shdesc, '$iplist'): $msg"));
3181 $dbh->commit;
3182 }
3183 return ('FAIL',$msg);
3184 }
3185
3186 return ('OK',$okmsg);
3187} # end updateLoc()
3188
3189
3190## DNSDB::delLoc()
3191sub delLoc {
3192 my $dbh = shift;
3193 my $loc = shift;
3194
3195 # Allow transactions, and raise an exception on errors so we can catch it later.
3196 # Use local to make sure these get "reset" properly on exiting this block
3197 local $dbh->{AutoCommit} = 0;
3198 local $dbh->{RaiseError} = 1;
3199
3200 my $oldloc = getLoc($dbh, $loc);
3201 my $olddesc = ($oldloc->{description} ? $oldloc->{description} : $loc);
3202 my $okmsg = "Deleted location ($olddesc, '".$oldloc->{iplist}."')";
3203
3204 eval {
3205 # Check for records with this location first. Deleting a location without deleting records
3206 # tagged for that location will render them unpublished without other warning.
3207 my ($r) = $dbh->selectrow_array("SELECT record_id FROM records WHERE location=? LIMIT 1", undef, ($loc) );
3208 die "Records still exist in location $olddesc\n" if $r;
3209 $dbh->do("DELETE FROM locations WHERE location=?", undef, ($loc) );
3210 _log($dbh, entry => $okmsg);
3211 $dbh->commit;
3212 };
3213 if ($@) {
3214 my $msg = $@;
3215 eval { $dbh->rollback; };
3216 if ($config{log_failures}) {
3217 _log($dbh, (entry => "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg"));
3218 $dbh->commit;
3219 }
3220 return ('FAIL', "Failed to delete location ($olddesc, '$oldloc->{iplist}'): $msg");
3221 }
3222
3223 return ('OK',$okmsg);
3224} # end delLoc()
3225
3226
3227## DNSDB::getLoc()
3228# Get details about a location/view
3229# Takes a database handle and location ID.
3230# Returns a reference to a hash containing the group ID, IP list, description, and comments/notes
3231sub getLoc {
3232 my $dbh = shift;
3233 my $loc = shift;
3234
3235 my $sth = $dbh->prepare("SELECT group_id,iplist,description,comments FROM locations WHERE location=?");
3236 $sth->execute($loc);
3237 return $sth->fetchrow_hashref();
3238} # end getLoc()
3239
3240
3241## DNSDB::getLocCount()
3242# Get count of locations/views
3243# Takes a database handle and hash containing at least the current group, and optionally:
3244# - a reference list of secondary groups
3245# - a filter string
3246# - a "Starts with" string
3247sub getLocCount {
3248 my $dbh = shift;
3249
3250 my %args = @_;
3251
3252 my @filterargs;
3253
3254 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3255 push @filterargs, "^$args{startwith}" if $args{startwith};
3256 push @filterargs, $args{filter} if $args{filter};
3257
3258
3259 my $sql = "SELECT count(*) FROM locations ".
3260 "WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3261 ($args{startwith} ? " AND description ~* ?" : '').
3262 ($args{filter} ? " AND description ~* ?" : '');
3263 my ($count) = $dbh->selectrow_array($sql, undef, (@filterargs) );
3264 $errstr = $dbh->errstr if !$count;
3265 return $count;
3266} # end getLocCount()
3267
3268
3269## DNSDB::getLocList()
3270sub getLocList {
3271 my $dbh = shift;
3272
3273 my %args = @_;
3274
3275 my @filterargs;
3276
3277 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
3278 push @filterargs, "^$args{startwith}" if $args{startwith};
3279 push @filterargs, $args{filter} if $args{filter};
3280
3281 # better to request sorts on "simple" names, but it means we need to map it to real columns
3282# my %sortmap = (user => 'u.username', type => 'u.type', group => 'g.group_name', status => 'u.status',
3283# fname => 'fname');
3284# $args{sortby} = $sortmap{$args{sortby}};
3285
3286 # protection against bad or missing arguments
3287 $args{sortorder} = 'ASC' if !$args{sortorder};
3288 $args{sortby} = 'l.description' if !$args{sortby};
3289 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
3290
3291 my $sql = "SELECT l.location, l.description, l.iplist, g.group_name ".
3292 "FROM locations l ".
3293 "INNER JOIN groups g ON l.group_id=g.group_id ".
3294 "WHERE l.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
3295 ($args{startwith} ? " AND l.description ~* ?" : '').
3296 ($args{filter} ? " AND l.description ~* ?" : '').
3297 " ORDER BY $args{sortby} $args{sortorder} ".
3298 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage} OFFSET ".$args{offset}*$config{perpage});
3299 my $ulist = $dbh->selectall_arrayref($sql, { Slice => {} }, (@filterargs) );
3300 $errstr = $dbh->errstr if !$ulist;
3301 return $ulist;
3302} # end getLocList()
3303
3304
3305## DNSDB::getLocDropdown()
3306# Get a list of location names for use in a dropdown menu.
3307# Takes a database handle, current group, and optional "tag this as selected" flag.
3308# Returns a reference to a list of hashrefs suitable to feeding to HTML::Template
3309sub getLocDropdown {
3310 my $dbh = shift;
3311 my $grp = shift;
3312 my $sel = shift || '';
3313
3314 my $sth = $dbh->prepare(qq(
3315 SELECT description,location FROM locations
3316 WHERE group_id=?
3317 ORDER BY description
3318 ) );
3319 $sth->execute($grp);
3320
3321 my @loclist;
3322 push @loclist, { locname => "(Default/All)", loc => '', selected => ($sel ? 0 : ($sel eq '' ? 1 : 0)) };
3323 while (my ($locname, $loc) = $sth->fetchrow_array) {
3324 my %row = (
3325 locname => $locname,
3326 loc => $loc,
3327 selected => ($sel eq $loc ? 1 : 0)
3328 );
3329 push @loclist, \%row;
3330 }
3331 return \@loclist;
3332} # end getLocDropdown()
3333
3334
3335## DNSDB::getSOA()
3336# Return all suitable fields from an SOA record in separate elements of a hash
3337# Takes a database handle, default/live flag, domain/reverse flag, and parent ID
3338sub getSOA {
3339 $errstr = '';
3340 my $dbh = shift;
3341 my $def = shift;
3342 my $rev = shift;
3343 my $id = shift;
3344
3345 # (ab)use distance and weight columns to store SOA data? can't for default_rev_records...
3346 # - should really attach serial to the zone parent somewhere
3347
3348 my $sql = "SELECT record_id,host,val,ttl from "._rectable($def,$rev).
3349 " WHERE "._recparent($def,$rev)." = ? AND type=$reverse_typemap{SOA}";
3350 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
3351 return if !$ret;
3352##fixme: stick a flag somewhere if the record doesn't exist. by the API, this is an impossible case, but...
3353
3354 ($ret->{contact},$ret->{prins}) = split /:/, $ret->{host};
3355 delete $ret->{host};
3356 ($ret->{refresh},$ret->{retry},$ret->{expire},$ret->{minttl}) = split /:/, $ret->{val};
3357 delete $ret->{val};
3358
3359 return $ret;
3360} # end getSOA()
3361
3362
3363## DNSDB::updateSOA()
3364# Update the specified SOA record
3365# Takes a database handle, default/live flag, forward/reverse flag, and SOA data hash
3366# Returns a two-element list with a result code and message
3367sub updateSOA {
3368 my $dbh = shift;
3369 my $defrec = shift;
3370 my $revrec = shift;
3371
3372 my %soa = @_;
3373
3374 my $oldsoa = getSOA($dbh, $defrec, $revrec, $soa{id});
3375
3376 my $msg;
3377 my %logdata;
3378 if ($defrec eq 'n') {
3379 $logdata{domain_id} = $soa{id} if $revrec eq 'n';
3380 $logdata{rdns_id} = $soa{id} if $revrec eq 'y';
3381 $logdata{group_id} = parentID($dbh, (id => $soa{id}, revrec => $revrec,
3382 type => ($revrec eq 'n' ? 'domain' : 'revzone') ) );
3383 } else {
3384 $logdata{group_id} = $soa{id};
3385 }
3386 my $parname = ($defrec eq 'y' ? groupName($dbh, $soa{id}) :
3387 ($revrec eq 'n' ? domainName($dbh, $soa{id}) : revName($dbh, $soa{id})) );
3388
3389 # Allow transactions, and raise an exception on errors so we can catch it later.
3390 # Use local to make sure these get "reset" properly on exiting this block
3391 local $dbh->{AutoCommit} = 0;
3392 local $dbh->{RaiseError} = 1;
3393
3394 eval {
3395 my $sql = "UPDATE "._rectable($defrec, $revrec)." SET host=?, val=?, ttl=? WHERE record_id=? AND type=6";
3396 $dbh->do($sql, undef, ("$soa{contact}:$soa{prins}", "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}",
3397 $soa{ttl}, $oldsoa->{record_id}) );
3398 $msg = "Updated ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse ' : 'default ') : '').
3399 "SOA for $parname: ".
3400 "(ns $oldsoa->{prins}, contact $oldsoa->{contact}, refresh $oldsoa->{refresh},".
3401 " retry $oldsoa->{retry}, expire $oldsoa->{expire}, minTTL $oldsoa->{minttl}, TTL $oldsoa->{ttl}) to ".
3402 "(ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
3403 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
3404
3405 $logdata{entry} = $msg;
3406 _log($dbh, %logdata);
3407
3408 $dbh->commit;
3409 };
3410 if ($@) {
3411 $msg = $@;
3412 eval { $dbh->rollback; };
3413 $logdata{entry} = "Error updating ".($defrec eq 'y' ? ($revrec eq 'y' ? 'default reverse zone ' : 'default ') : '').
3414 "SOA record for $parname: $msg";
3415 if ($config{log_failures}) {
3416 _log($dbh, %logdata);
3417 $dbh->commit;
3418 }
3419 return ('FAIL', $logdata{entry});
3420 } else {
3421 return ('OK', $msg);
3422 }
3423} # end updateSOA()
3424
3425
3426## DNSDB::getRecLine()
3427# Return all data fields for a zone record in separate elements of a hash
3428# Takes a database handle, default/live flag, forward/reverse flag, and record ID
3429sub getRecLine {
3430 $errstr = '';
3431 my $dbh = shift;
3432 my $defrec = shift;
3433 my $revrec = shift;
3434 my $id = shift;
3435
3436 my $sql = "SELECT record_id,host,type,val,ttl".
3437 ($defrec eq 'n' ? ',location' : '').
3438 ($revrec eq 'n' ? ',distance,weight,port' : '').
3439 (($defrec eq 'y') ? ',group_id FROM ' : ',domain_id,rdns_id FROM ').
3440 _rectable($defrec,$revrec)." WHERE record_id=?";
3441 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
3442
3443 if ($dbh->err) {
3444 $errstr = $DBI::errstr;
3445 return undef;
3446 }
3447
3448 if (!$ret) {
3449 $errstr = "No such record";
3450 return undef;
3451 }
3452
3453 # explicitly set a parent id
3454 if ($defrec eq 'y') {
3455 $ret->{parid} = $ret->{group_id};
3456 } else {
3457 $ret->{parid} = (($revrec eq 'n') ? $ret->{domain_id} : $ret->{rdns_id});
3458 # and a secondary if we have a custom type that lives in both a forward and reverse zone
3459 $ret->{secid} = (($revrec eq 'y') ? $ret->{domain_id} : $ret->{rdns_id}) if $ret->{type} > 65279;
3460 }
3461 $ret->{address} = $ret->{val}; # because.
3462
3463 return $ret;
3464}
3465
3466
3467##fixme: should use above (getRecLine()) to get lines for below?
3468## DNSDB::getDomRecs()
3469# Return records for a domain
3470# Takes a database handle, default/live flag, group/domain ID, start,
3471# number of records, sort field, and sort order
3472# Returns a reference to an array of hashes
3473sub getDomRecs {
3474 $errstr = '';
3475 my $dbh = shift;
3476
3477 my %args = @_;
3478
3479 my @filterargs;
3480
3481 push @filterargs, $args{filter} if $args{filter};
3482
3483 # protection against bad or missing arguments
3484 $args{sortorder} = 'ASC' if !$args{sortorder};
3485 $args{sortby} = 'host' if !$args{sortby} && $args{revrec} eq 'n'; # default sort by host on domain record list
3486 $args{sortby} = 'val' if !$args{sortby} && $args{revrec} eq 'y'; # default sort by IP on revzone record list
3487 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
3488
3489 # sort reverse zones on IP, correctly
3490 # do other fiddling with $args{sortby} while we're at it.
3491 # whee! multisort means just passing comma-separated fields in sortby!
3492 my $newsort = '';
3493 foreach my $sf (split /,/, $args{sortby}) {
3494 $sf = "r.$sf";
3495 $sf =~ s/r\.val/CAST (r.val AS inet)/
3496 if $args{revrec} eq 'y' && $args{defrec} eq 'n';
3497 $sf =~ s/r\.type/t.alphaorder/;
3498 $newsort .= ",$sf";
3499 }
3500 $newsort =~ s/^,//;
3501
3502 my $sql = "SELECT r.record_id,r.host,r.type,r.val,r.ttl";
3503 $sql .= ",l.description AS locname" if $args{defrec} eq 'n';
3504 $sql .= ",r.distance,r.weight,r.port" if $args{revrec} eq 'n';
3505 $sql .= " FROM "._rectable($args{defrec},$args{revrec})." r ";
3506 $sql .= "INNER JOIN rectypes t ON r.type=t.val "; # for sorting by type alphabetically
3507 $sql .= "LEFT JOIN locations l ON r.location=l.location " if $args{defrec} eq 'n';
3508 $sql .= "WHERE "._recparent($args{defrec},$args{revrec})." = ?";
3509 $sql .= " AND NOT r.type=$reverse_typemap{SOA}";
3510 $sql .= " AND (r.host ~* ? OR r.val ~* ?)" if $args{filter};
3511 $sql .= " ORDER BY $newsort $args{sortorder}";
3512 # ensure consistent ordering by sorting on record_id too
3513 $sql .= ", record_id $args{sortorder}";
3514 $sql .= ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage} OFFSET ".$args{offset}*$config{perpage});
3515
3516 my @bindvars = ($args{id});
3517 push @bindvars, ($args{filter},$args{filter}) if $args{filter};
3518
3519 my $ret = $dbh->selectall_arrayref($sql, { Slice => {} }, (@bindvars) );
3520 return $ret;
3521} # end getDomRecs()
3522
3523
3524## DNSDB::getRecCount()
3525# Return count of non-SOA records in zone (or default records in a group)
3526# Takes a database handle, default/live flag, reverse/forward flag, group/domain ID,
3527# and optional filtering modifier
3528# Returns the count
3529sub getRecCount {
3530 my $dbh = shift;
3531 my $defrec = shift;
3532 my $revrec = shift;
3533 my $id = shift;
3534 my $filter = shift || '';
3535
3536 # keep the nasties down, since we can't ?-sub this bit. :/
3537 # note this is chars allowed in DNS hostnames
3538 $filter =~ s/[^a-zA-Z0-9_.:-]//g;
3539
3540 my @bindvars = ($id);
3541 push @bindvars, $filter if $filter;
3542 my $sql = "SELECT count(*) FROM ".
3543 _rectable($defrec,$revrec).
3544 " WHERE "._recparent($defrec,$revrec)."=? ".
3545 "AND NOT type=$reverse_typemap{SOA}".
3546 ($filter ? " AND host ~* ?" : '');
3547 my ($count) = $dbh->selectrow_array($sql, undef, (@bindvars) );
3548
3549 return $count;
3550
3551} # end getRecCount()
3552
3553
3554## DNSDB::addRec()
3555# Add a new record to a domain or a group's default records
3556# Takes a database handle, default/live flag, group/domain ID,
3557# host, type, value, and TTL
3558# Some types require additional detail: "distance" for MX and SRV,
3559# and weight/port for SRV
3560# Returns a status code and detail message in case of error
3561##fixme: pass a hash with the record data, not a series of separate values
3562sub addRec {
3563 $errstr = '';
3564 my $dbh = shift;
3565 my $defrec = shift;
3566 my $revrec = shift;
3567 my $id = shift; # parent (group_id for defrecs, rdns_id for reverse records,
3568 # domain_id for domain records)
3569
3570 my $host = shift;
3571 my $rectype = shift; # reference so we can coerce it if "+"-types can't find both zones
3572 my $val = shift;
3573 my $ttl = shift;
3574 my $location = shift;
3575 $location = '' if !$location;
3576
3577 # Spaces are evil.
3578 $$host =~ s/^\s+//;
3579 $$host =~ s/\s+$//;
3580 if ($typemap{$$rectype} ne 'TXT') {
3581 # Leading or trailng spaces could be legit in TXT records.
3582 $$val =~ s/^\s+//;
3583 $$val =~ s/\s+$//;
3584 }
3585
3586 # prep for validation
3587 my $addr = NetAddr::IP->new($$val);
3588 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
3589
3590 my $domid = 0;
3591 my $revid = 0;
3592
3593 my $retcode = 'OK'; # assume everything will go OK
3594 my $retmsg = '';
3595
3596 # do simple validation first
3597 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^\d+$/;
3598
3599 # Quick check on hostname parts. Note the regex is more forgiving than the error message;
3600 # domain names technically are case-insensitive, and we use printf-like % codes for a couple
3601 # of types. Other things may also be added to validate default records of several flavours.
3602 return ('FAIL', "Hostnames may not contain anything other than (0-9 a-z . _)")
3603 if $defrec eq 'n' && ($revrec eq 'y' ? $$rectype != $reverse_typemap{TXT} : 1) &&
3604 $$host !~ /^[0-9a-z_%.-]+$/i;
3605
3606 # Collect these even if we're only doing a simple A record so we can call *any* validation sub
3607 my $dist = shift;
3608 my $weight = shift;
3609 my $port = shift;
3610
3611 my $fields;
3612 my @vallist;
3613
3614 # Call the validation sub for the type requested.
3615 ($retcode,$retmsg) = $validators{$$rectype}($dbh, (defrec => $defrec, revrec => $revrec, id => $id,
3616 host => $host, rectype => $rectype, val => $val, addr => $addr,
3617 dist => \$dist, port => \$port, weight => \$weight,
3618 fields => \$fields, vallist => \@vallist) );
3619
3620 return ($retcode,$retmsg) if $retcode eq 'FAIL';
3621
3622 # Set up database fields and bind parameters
3623 $fields .= "host,type,val,ttl,location,"._recparent($defrec,$revrec);
3624 push @vallist, ($$host,$$rectype,$$val,$ttl,$location,$id);
3625 my $vallen = '?'.(',?'x$#vallist);
3626
3627 # Put together the success log entry. We have to use this horrible kludge
3628 # because domain_id and rdns_id may or may not be present, and if they are,
3629 # they're not at a guaranteed consistent index in the array. wheee!
3630 my %logdata;
3631 my @ftmp = split /,/, $fields;
3632 for (my $i=0; $i <= $#vallist; $i++) {
3633 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
3634 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
3635 }
3636 $logdata{group_id} = $id if $defrec eq 'y';
3637 $logdata{group_id} = parentID($dbh,
3638 (id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) )
3639 if $defrec eq 'n';
3640 $logdata{entry} = "Added ".($defrec eq 'y' ? 'default record' : 'record');
3641 # NS records for revzones get special treatment
3642 if ($revrec eq 'y' && $$rectype == 2) {
3643 $logdata{entry} .= " '$$val $typemap{$$rectype} $$host";
3644 } else {
3645 $logdata{entry} .= " '$$host $typemap{$$rectype} $$val";
3646 }
3647
3648 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
3649 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]"
3650 if $typemap{$$rectype} eq 'SRV';
3651 $logdata{entry} .= "', TTL $ttl";
3652 $logdata{entry} .= ", location ".getLoc($dbh, $location)->{description} if $location;
3653
3654 # Allow transactions, and raise an exception on errors so we can catch it later.
3655 # Use local to make sure these get "reset" properly on exiting this block
3656 local $dbh->{AutoCommit} = 0;
3657 local $dbh->{RaiseError} = 1;
3658
3659 eval {
3660 $dbh->do("INSERT INTO "._rectable($defrec, $revrec)." ($fields) VALUES ($vallen)",
3661 undef, @vallist);
3662 _log($dbh, %logdata);
3663 $dbh->commit;
3664 };
3665 if ($@) {
3666 my $msg = $@;
3667 eval { $dbh->rollback; };
3668 if ($config{log_failures}) {
3669 $logdata{entry} = "Failed adding ".($defrec eq 'y' ? 'default ' : '').
3670 "record '$$host $typemap{$$rectype} $$val', TTL $ttl ($msg)";
3671 _log($dbh, %logdata);
3672 $dbh->commit;
3673 }
3674 return ('FAIL',$msg);
3675 }
3676
3677 $resultstr = $logdata{entry};
3678 return ($retcode, $retmsg);
3679
3680} # end addRec()
3681
3682
3683## DNSDB::updateRec()
3684# Update a record
3685# Takes a database handle, default and reverse flags, record ID, immediate parent ID, and new record data.
3686# Returns a status code and message
3687sub updateRec {
3688 $errstr = '';
3689
3690 my $dbh = shift;
3691 my $defrec = shift;
3692 my $revrec = shift;
3693 my $id = shift;
3694 my $parid = shift; # immediate parent entity that we're descending from to update the record
3695
3696 # all records have these
3697 my $host = shift;
3698 my $hostbk = $$host; # Keep a backup copy of the original, so we can WARN if the update mangles the domain
3699 my $rectype = shift;
3700 my $val = shift;
3701 my $ttl = shift;
3702 my $location = shift; # may be empty/null/undef depending on caller
3703 $location = '' if !$location;
3704
3705 # Spaces are evil.
3706 $$host =~ s/^\s+//;
3707 $$host =~ s/\s+$//;
3708 if ($typemap{$$rectype} ne 'TXT') {
3709 # Leading or trailng spaces could be legit in TXT records.
3710 $$val =~ s/^\s+//;
3711 $$val =~ s/\s+$//;
3712 }
3713
3714 # prep for validation
3715 my $addr = NetAddr::IP->new($$val);
3716 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
3717
3718 my $domid = 0;
3719 my $revid = 0;
3720
3721 my $retcode = 'OK'; # assume everything will go OK
3722 my $retmsg = '';
3723
3724 # do simple validation first
3725 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^\d+$/;
3726
3727 # Quick check on hostname parts. Note the regex is more forgiving than the error message;
3728 # domain names technically are case-insensitive, and we use printf-like % codes for a couple
3729 # of types. Other things may also be added to validate default records of several flavours.
3730 return ('FAIL', "Hostnames may not contain anything other than (0-9 a-z - . _)")
3731 if $defrec eq 'n' && ($revrec eq 'y' ? $$rectype != $reverse_typemap{TXT} : 1) &&
3732 $$host !~ /^[0-9a-z_%.-]+$/i;
3733
3734 # only MX and SRV will use these
3735 my $dist = shift || 0;
3736 my $weight = shift || 0;
3737 my $port = shift || 0;
3738
3739 my $fields;
3740 my @vallist;
3741
3742 # get old record data so we have the right parent ID
3743 # and for logging (eventually)
3744 my $oldrec = getRecLine($dbh, $defrec, $revrec, $id);
3745
3746 # Call the validation sub for the type requested.
3747 # Note the ID to pass here is the *parent*, not the record
3748 ($retcode,$retmsg) = $validators{$$rectype}($dbh, (defrec => $defrec, revrec => $revrec,
3749 id => ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})),
3750 host => $host, rectype => $rectype, val => $val, addr => $addr,
3751 dist => \$dist, port => \$port, weight => \$weight,
3752 fields => \$fields, vallist => \@vallist,
3753 update => $id) );
3754
3755 return ($retcode,$retmsg) if $retcode eq 'FAIL';
3756
3757 # Set up database fields and bind parameters. Note only the optional fields
3758 # (distance, weight, port, secondary parent ID) are added in the validation call above
3759 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
3760 push @vallist, ($$host,$$rectype,$$val,$ttl,
3761 ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})) );
3762
3763 # locations are not for default records, silly coder!
3764 if ($defrec eq 'n') {
3765 $fields .= ",location";
3766 push @vallist, $location;
3767 }
3768
3769 # hack hack PTHUI
3770 # need to forcibly make sure we disassociate a record with a parent it's no longer related to.
3771 # eg, PTR records may not have a domain parent, or A/AAAA records may not have a revzone parent.
3772 # mainly needed for crossover types that got coerced down to "standard" types
3773 if ($defrec eq 'n') {
3774 if ($$rectype == $reverse_typemap{PTR}) {
3775 $fields .= ",domain_id";
3776 push @vallist, 0;
3777 }
3778 if ($$rectype == $reverse_typemap{A} || $$rectype == $reverse_typemap{AAAA}) {
3779 $fields .= ",rdns_id";
3780 push @vallist, 0;
3781 }
3782 }
3783 # fix fat-finger-originated record type changes
3784 if ($$rectype == 65285) {
3785 $fields .= ",rdns_id" if $revrec eq 'n';
3786 $fields .= ",domain_id" if $revrec eq 'y';
3787 push @vallist, 0;
3788 }
3789 if ($defrec eq 'n') {
3790 $domid = $parid if $revrec eq 'n';
3791 $revid = $parid if $revrec eq 'y';
3792 }
3793
3794 # Put together the success log entry. Horrible kludge from addRec() copied as-is since
3795 # we don't know whether the passed arguments or retrieved values for domain_id and rdns_id
3796 # will be maintained (due to "not-in-zone" validation changes)
3797 my %logdata;
3798 $logdata{domain_id} = $domid;
3799 $logdata{rdns_id} = $revid;
3800 my @ftmp = split /,/, $fields;
3801 for (my $i=0; $i <= $#vallist; $i++) {
3802 $logdata{domain_id} = $vallist[$i] if $ftmp[$i] eq 'domain_id';
3803 $logdata{rdns_id} = $vallist[$i] if $ftmp[$i] eq 'rdns_id';
3804 }
3805 $logdata{group_id} = $parid if $defrec eq 'y';
3806 $logdata{group_id} = parentID($dbh,
3807 (id => $parid, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) )
3808 if $defrec eq 'n';
3809 $logdata{entry} = "Updated ".($defrec eq 'y' ? 'default record' : 'record')." from\n";
3810 # NS records for revzones get special treatment
3811 if ($revrec eq 'y' && $$rectype == 2) {
3812 $logdata{entry} .= " '$oldrec->{val} $typemap{$oldrec->{type}} $oldrec->{host}";
3813 } else {
3814 $logdata{entry} .= " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
3815 }
3816 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
3817 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
3818 if $typemap{$oldrec->{type}} eq 'SRV';
3819 $logdata{entry} .= "', TTL $oldrec->{ttl}";
3820 $logdata{entry} .= ", location ".getLoc($dbh, $oldrec->{location})->{description} if $oldrec->{location};
3821 $logdata{entry} .= "\nto\n";
3822 # More NS special
3823 if ($revrec eq 'y' && $$rectype == 2) {
3824 $logdata{entry} .= "'$$val $typemap{$$rectype} $$host";
3825 } else {
3826 $logdata{entry} .= "'$$host $typemap{$$rectype} $$val";
3827 }
3828 $logdata{entry} .= " [distance $dist]" if $typemap{$$rectype} eq 'MX';
3829 $logdata{entry} .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$$rectype} eq 'SRV';
3830 $logdata{entry} .= "', TTL $ttl";
3831 $logdata{entry} .= ", location ".getLoc($dbh, $location)->{description} if $location;
3832
3833 local $dbh->{AutoCommit} = 0;
3834 local $dbh->{RaiseError} = 1;
3835
3836 # Fiddle the field list into something suitable for updates
3837 $fields =~ s/,/=?,/g;
3838 $fields .= "=?";
3839
3840 eval {
3841 $dbh->do("UPDATE "._rectable($defrec,$revrec)." SET $fields WHERE record_id=?", undef, (@vallist, $id) );
3842 _log($dbh, %logdata);
3843 $dbh->commit;
3844 };
3845 if ($@) {
3846 my $msg = $@;
3847 eval { $dbh->rollback; };
3848 if ($config{log_failures}) {
3849 $logdata{entry} = "Failed updating ".($defrec eq 'y' ? 'default ' : '').
3850 "record '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
3851 _log($dbh, %logdata);
3852 $dbh->commit;
3853 }
3854 return ('FAIL', $msg);
3855 }
3856
3857 $resultstr = $logdata{entry};
3858 return ($retcode, $retmsg);
3859} # end updateRec()
3860
3861
3862## DNSDB::downconvert()
3863# A mostly internal (not exported) semiutilty sub to downconvert from pseudotype <x>
3864# to a compatible component type. Only a handful of operations are valid, anything
3865# else is a null-op.
3866# Takes the record ID and the new type. Returns boolean.
3867sub downconvert {
3868 my $dbh = shift;
3869 my $recid = shift;
3870 my $newtype = shift;
3871
3872 # also, only work on live records; little to no value trying to do this on default records.
3873 my $rec = getRecLine($dbh, 'n', 'y', $recid);
3874
3875 # hm?
3876 #return 1 if !$rec;
3877
3878 return 1 if $rec->{type} < 65000; # Only the reverse-record pseudotypes can be downconverted
3879 return 1 if $rec->{type} == 65282; # Nowhere to go
3880
3881 my $delpar;
3882 my @sqlargs;
3883 if ($rec->{type} == 65280) {
3884 return 1 if $newtype != 1 && $newtype != 12;
3885 $delpar = ($newtype == 1 ? 'rdns_id' : 'domain_id');
3886 push @sqlargs, 0, $newtype, $recid;
3887 } elsif ($rec->{type} == 65281) {
3888 return 1 if $newtype != 28 && $newtype != 12;
3889 $delpar = ($newtype == 28 ? 'rdns_id' : 'domain_id');
3890 push @sqlargs, 0, $newtype, $recid;
3891 } elsif ($rec->{type} == 65283) {
3892 return 1 if $newtype != 65282;
3893 $delpar = 'rdns_id';
3894 } elsif ($rec->{type} == 65284) {
3895 return 1 if $newtype != 65282;
3896 $delpar = 'rdns_id';
3897 } else {
3898 # Your llama is on fire.
3899 }
3900
3901 local $dbh->{AutoCommit} = 0;
3902 local $dbh->{RaiseError} = 1;
3903
3904 eval {
3905 $dbh->do("UPDATE records SET $delpar = ?, type = ? WHERE record_id = ?", undef, @sqlargs);
3906 $dbh->commit;
3907 };
3908 if ($@) {
3909 $errstr = $@;
3910 eval { $dbh->rollback; };
3911 return 0;
3912 }
3913 return 1;
3914} # end downconvert()
3915
3916
3917## DNSDB::delRec()
3918# Delete a record.
3919sub delRec {
3920 $errstr = '';
3921 my $dbh = shift;
3922 my $defrec = shift;
3923 my $revrec = shift;
3924 my $id = shift;
3925
3926 my $oldrec = getRecLine($dbh, $defrec, $revrec, $id);
3927
3928 # Allow transactions, and raise an exception on errors so we can catch it later.
3929 # Use local to make sure these get "reset" properly on exiting this block
3930 local $dbh->{AutoCommit} = 0;
3931 local $dbh->{RaiseError} = 1;
3932
3933 # Put together the log entry
3934 my %logdata;
3935 $logdata{domain_id} = $oldrec->{domain_id};
3936 $logdata{rdns_id} = $oldrec->{rdns_id};
3937 $logdata{group_id} = $oldrec->{group_id} if $defrec eq 'y';
3938 $logdata{group_id} = parentID($dbh,
3939 (id => $oldrec->{domain_id}, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) )
3940 if $defrec eq 'n';
3941 $logdata{entry} = "Deleted ".($defrec eq 'y' ? 'default record ' : 'record ').
3942 "'$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}";
3943 $logdata{entry} .= " [distance $oldrec->{distance}]" if $typemap{$oldrec->{type}} eq 'MX';
3944 $logdata{entry} .= " [priority $oldrec->{distance}] [weight $oldrec->{weight}] [port $oldrec->{port}]"
3945 if $typemap{$oldrec->{type}} eq 'SRV';
3946 $logdata{entry} .= "', TTL $oldrec->{ttl}";
3947 $logdata{entry} .= ", location ".getLoc($dbh, $oldrec->{location})->{description} if $oldrec->{location};
3948
3949 eval {
3950 my $sth = $dbh->do("DELETE FROM "._rectable($defrec,$revrec)." WHERE record_id=?", undef, ($id));
3951 _log($dbh, %logdata);
3952 $dbh->commit;
3953 };
3954 if ($@) {
3955 my $msg = $@;
3956 eval { $dbh->rollback; };
3957 if ($config{log_failures}) {
3958 $logdata{entry} = "Error deleting ".($defrec eq 'y' ? 'default record' : 'record').
3959 " '$oldrec->{host} $typemap{$oldrec->{type}} $oldrec->{val}', TTL $oldrec->{ttl} ($msg)";
3960 _log($dbh, %logdata);
3961 $dbh->commit;
3962 }
3963 return ('FAIL', $msg);
3964 }
3965
3966 return ('OK',$logdata{entry});
3967} # end delRec()
3968
3969
3970## DNSDB::getLogCount()
3971# Get a count of log entries
3972# Takes a database handle and a hash containing at least:
3973# - Entity ID and entity type as the primary log "slice"
3974sub getLogCount {
3975 my $dbh = shift;
3976
3977 my %args = @_;
3978
3979 my @filterargs;
3980##fixme: which fields do we want to filter on?
3981# push @filterargs,
3982
3983 $errstr = 'Missing primary parent ID and/or type';
3984 # fail early if we don't have a "prime" ID to look for log entries for
3985 return if !$args{id};
3986
3987 # or if the prime id type is missing or invalid
3988 return if !$args{logtype};
3989 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
3990 $args{logtype} = 'domain' if $args{logtype} eq 'dom'; # hack pthui
3991 return if !grep /^$args{logtype}$/, ('group', 'domain', 'revzone', 'user');
3992
3993 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
3994
3995 my $sql = "SELECT count(*) FROM log ".
3996 "WHERE $id_col{$args{logtype}}=?".
3997 ($args{filter} ? " AND entry ~* ?" : '');
3998 my ($count) = $dbh->selectrow_array($sql, undef, ($args{id}, @filterargs) );
3999 $errstr = $dbh->errstr if !$count;
4000 return $count;
4001} # end getLogCount()
4002
4003
4004## DNSDB::getLogEntries()
4005# Get a list of log entries
4006# Takes arguments as with getLogCount() above, plus optional:
4007# - sort field
4008# - sort order
4009# - offset for pagination
4010sub getLogEntries {
4011 my $dbh = shift;
4012
4013 my %args = @_;
4014
4015 my @filterargs;
4016
4017 # fail early if we don't have a "prime" ID to look for log entries for
4018 return if !$args{id};
4019
4020 # or if the prime id type is missing or invalid
4021 return if !$args{logtype};
4022 $args{logtype} = 'revzone' if $args{logtype} eq 'rdns'; # hack pthui
4023 $args{logtype} = 'domain' if $args{logtype} eq 'dom'; # hack pthui
4024 return if !grep /^$args{logtype}$/, ('group', 'domain', 'revzone', 'user');
4025
4026 # Sorting defaults
4027 $args{sortby} = 'stamp' if !$args{sortby};
4028 $args{sortorder} = 'DESC' if !$args{sortorder};
4029 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
4030
4031 my %sortmap = (fname => 'name', username => 'email', entry => 'entry', stamp => 'stamp');
4032 $args{sortby} = $sortmap{$args{sortby}};
4033
4034 my $sql = "SELECT user_id AS userid, email AS useremail, name AS userfname, entry AS logentry, ".
4035 "date_trunc('second',stamp) AS logtime ".
4036 "FROM log ".
4037 "WHERE $id_col{$args{logtype}}=?".
4038 ($args{filter} ? " AND entry ~* ?" : '').
4039 " ORDER BY $args{sortby} $args{sortorder}, log_id $args{sortorder}".
4040 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage} OFFSET ".$args{offset}*$config{perpage});
4041 my $loglist = $dbh->selectall_arrayref($sql, { Slice => {} }, ($args{id}, @filterargs) );
4042 $errstr = $dbh->errstr if !$loglist;
4043 return $loglist;
4044} # end getLogEntries()
4045
4046
4047## IPDB::getRevPattern()
4048# Get the narrowest template pattern applicable to a passed CIDR address (may be a netblock or an IP)
4049sub getRevPattern {
4050 my $dbh = shift;
4051 my $cidr = shift;
4052 my $group = shift || 1; # just in case
4053
4054 # for speed! Casting and comparing even ~7K records takes ~2.5s, so narrow it down to one revzone first.
4055 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >>= ? AND group_id = ?",
4056 undef, ($cidr, $group) );
4057
4058##fixme? may need to narrow things down more by octet-chopping and doing text comparisons before casting.
4059 my ($revpatt) = $dbh->selectrow_array("SELECT host FROM records ".
4060 "WHERE (type in (12,65280,65281,65282,65283,65284)) AND rdns_id = ? AND CAST (val AS inet) >>= ? ".
4061 "ORDER BY CAST (val AS inet) DESC LIMIT 1", undef, ($revid, $cidr) );
4062 return $revpatt;
4063} # end getRevPattern()
4064
4065
4066## DNSDB::getTypelist()
4067# Get a list of record types for various UI dropdowns
4068# Takes database handle, forward/reverse/lookup flag, and optional "tag as selected" indicator (defaults to A)
4069# Returns an arrayref to list of hashrefs perfect for HTML::Template
4070sub getTypelist {
4071 my $dbh = shift;
4072 my $recgroup = shift;
4073 my $type = shift || $reverse_typemap{A};
4074
4075 # also accepting $webvar{revrec}!
4076 $recgroup = 'f' if $recgroup eq 'n';
4077 $recgroup = 'r' if $recgroup eq 'y';
4078
4079 my $sql = "SELECT val,name FROM rectypes WHERE ";
4080 if ($recgroup eq 'r') {
4081 # reverse zone types
4082 $sql .= "stdflag=2 OR stdflag=3";
4083 } elsif ($recgroup eq 'l') {
4084 # DNS lookup types. Note we avoid our custom types >= 65280, since those are entirely internal.
4085 $sql .= "(stdflag=1 OR stdflag=2 OR stdflag=3) AND val < 65280";
4086 } else {
4087 # default; forward zone types. technically $type eq 'f' but not worth the error message.
4088 $sql .= "stdflag=1 OR stdflag=2";
4089 }
4090 $sql .= " ORDER BY listorder";
4091
4092 my $sth = $dbh->prepare($sql);
4093 $sth->execute;
4094 my @typelist;
4095 while (my ($rval,$rname) = $sth->fetchrow_array()) {
4096 my %row = ( recval => $rval, recname => $rname );
4097 $row{tselect} = 1 if $rval == $type;
4098 push @typelist, \%row;
4099 }
4100
4101 # Add SOA on lookups since it's not listed in other dropdowns.
4102 if ($recgroup eq 'l') {
4103 my %row = ( recval => $reverse_typemap{SOA}, recname => 'SOA' );
4104 $row{tselect} = 1 if $reverse_typemap{SOA} == $type;
4105 push @typelist, \%row;
4106 }
4107
4108 return \@typelist;
4109} # end getTypelist()
4110
4111
4112## DNSDB::parentID()
4113# Get ID of entity that is nearest parent to requested id
4114# Takes a database handle and a hash of entity ID, entity type, optional parent type flag
4115# (domain/reverse zone or group), and optional default/live and forward/reverse flags
4116# Returns the ID or undef on failure
4117sub parentID {
4118 my $dbh = shift;
4119
4120 my %args = @_;
4121
4122 # clean up the parent-type. Set it to group if not set; coerce revzone to domain for simpler logic
4123 $args{partype} = 'group' if !$args{partype};
4124 $args{partype} = 'domain' if $args{partype} eq 'revzone';
4125
4126 # clean up defrec and revrec. default to live record, forward zone
4127 $args{defrec} = 'n' if !$args{defrec};
4128 $args{revrec} = 'n' if !$args{revrec};
4129
4130 if ($par_type{$args{partype}} eq 'domain') {
4131 # only live records can have a domain/zone parent
4132 return unless ($args{type} eq 'record' && $args{defrec} eq 'n');
4133 my $result = $dbh->selectrow_hashref("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
4134 " FROM records WHERE record_id = ?",
4135 undef, ($args{id}) ) or return;
4136 return $result;
4137 } else {
4138 # snag some arguments that will either fall through or be overwritten to save some code duplication
4139 my $tmpid = $args{id};
4140 my $type = $args{type};
4141 if ($type eq 'record' && $args{defrec} eq 'n') {
4142 # Live records go through the records table first.
4143 ($tmpid) = $dbh->selectrow_array("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
4144 " FROM records WHERE record_id = ?",
4145 undef, ($args{id}) ) or return;
4146 $type = ($args{revrec} eq 'n' ? 'domain' : 'revzone');
4147 }
4148 my ($result) = $dbh->selectrow_array("SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?",
4149 undef, ($tmpid) );
4150 return $result;
4151 }
4152# should be impossible to get here with even remotely sane arguments
4153 return;
4154} # end parentID()
4155
4156
4157## DNSDB::isParent()
4158# Returns true if $id1 is a parent of $id2, false otherwise
4159sub isParent {
4160 my $self = shift;
4161 my $dbh = $self->{dbh};
4162 my $id1 = shift;
4163 my $type1 = shift;
4164 my $id2 = shift;
4165 my $type2 = shift;
4166##todo: immediate, secondary, full (default)
4167
4168 # Return false on invalid types
4169 return 0 if !grep /^$type1$/, ('record','defrec','defrevrec','user','domain','revzone','group');
4170 return 0 if !grep /^$type2$/, ('record','defrec','defrevrec','user','domain','revzone','group');
4171
4172 # Return false on impossible relations
4173 return 0 if $type1 eq 'record'; # nothing may be a child of a record
4174 return 0 if $type1 eq 'defrec'; # nothing may be a child of a record
4175 return 0 if $type1 eq 'defrevrec'; # nothing may be a child of a record
4176 return 0 if $type1 eq 'user'; # nothing may be child of a user
4177 return 0 if $type1 eq 'domain' && $type2 ne 'record'; # domain may not be a parent of anything other than a record
4178 return 0 if $type1 eq 'revzone' && $type2 ne 'record';# reverse zone may not be a parent of anything other than a record
4179
4180 # ennnhhhh.... if we're passed an id of 0, it will never be found. usual
4181 # case would be the UI creating a new <thing>, and so we don't have an ID for
4182 # <thing> to look up yet. in that case the UI should check the parent as well.
4183 return 0 if $id1 == 0; # nothing can have a parent id of 0
4184 return 1 if $id2 == 0; # anything could have a child id of 0 (or "unknown")
4185
4186 # group 1 is the ultimate root parent
4187 return 1 if $type1 eq 'group' && $id1 == 1;
4188
4189 # groups are always (a) parent of themselves
4190 return 1 if $type1 eq 'group' && $type2 eq 'group' && $id1 == $id2;
4191
4192 my $id = $id2;
4193 my $type = $type2;
4194 my $foundparent = 0;
4195
4196 # Records are the only entity with two possible parents. We need to split the parent checks on
4197 # domain/rdns.
4198 if ($type eq 'record') {
4199 my ($dom,$rdns) = $dbh->selectrow_array("SELECT domain_id,rdns_id FROM records WHERE record_id=?",
4200 undef, ($id));
4201 # check immediate parent against request
4202 return 1 if $type1 eq 'domain' && $id1 == $dom;
4203 return 1 if $type1 eq 'revzone' && $id1 == $rdns;
4204 # if request is group, check *both* parents. Only check if the parent is nonzero though.
4205 return 1 if $dom && $self->isParent($id1, $type1, $dom, 'domain');
4206 return 1 if $rdns && $self->isParent($id1, $type1, $rdns, 'revzone');
4207 # exit here since we've executed the loop below by proxy in the above recursive calls.
4208 return 0;
4209 }
4210
4211# almost the same loop as getParents() above
4212 my $limiter = 0;
4213 while (1) {
4214 my $sql = "SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?";
4215 my $result = $dbh->selectrow_hashref($sql,
4216 undef, ($id) );
4217 if (!$result) {
4218 $limiter++;
4219##fixme: how often will this happen on a live site? fail at max limiter <n>?
4220 warn "no results looking for $sql with id $id (depth $limiter)\n";
4221 last;
4222 }
4223 if ($result && $result->{$par_col{$type}} == $id1) {
4224 $foundparent = 1;
4225 last;
4226 } else {
4227##fixme: do we care about trying to return a "no such record/domain/user/group" error?
4228# should be impossible to create an inconsistent DB just with API calls.
4229 warn $dbh->errstr." $sql, $id" if $dbh->errstr;
4230 }
4231 # group 1 is its own parent. need this here more to break strange loops than for detecting a parent
4232 last if $result->{$par_col{$type}} == 1;
4233 $id = $result->{$par_col{$type}};
4234 $type = $par_type{$type};
4235 }
4236
4237 return $foundparent;
4238} # end isParent()
4239
4240
4241## DNSDB::zoneStatus()
4242# Returns and optionally sets a zone's status
4243# Takes a database handle, domain/revzone ID, forward/reverse flag, and optionally a status argument
4244# Returns status, or undef on errors.
4245sub zoneStatus {
4246 my $dbh = shift;
4247 my $id = shift;
4248 my $revrec = shift;
4249 my $newstatus = shift || 'mu';
4250
4251 return undef if $id !~ /^\d+$/;
4252
4253 # Allow transactions, and raise an exception on errors so we can catch it later.
4254 # Use local to make sure these get "reset" properly on exiting this block
4255 local $dbh->{AutoCommit} = 0;
4256 local $dbh->{RaiseError} = 1;
4257
4258 if ($newstatus ne 'mu') {
4259 # ooo, fun! let's see what we were passed for status
4260 eval {
4261 $newstatus = 0 if $newstatus eq 'domoff';
4262 $newstatus = 1 if $newstatus eq 'domon';
4263 $dbh->do("UPDATE ".($revrec eq 'n' ? 'domains' : 'revzones')." SET status=? WHERE ".
4264 ($revrec eq 'n' ? 'domain_id' : 'rdns_id')."=?", undef, ($newstatus,$id) );
4265
4266##fixme switch to more consise "Enabled <domain"/"Disabled <domain>" as with users?
4267 $resultstr = "Changed ".($revrec eq 'n' ? domainName($dbh, $id) : revName($dbh, $id)).
4268 " state to ".($newstatus ? 'active' : 'inactive');
4269
4270 my %loghash;
4271 $loghash{domain_id} = $id if $revrec eq 'n';
4272 $loghash{rdns_id} = $id if $revrec eq 'y';
4273 $loghash{group_id} = parentID($dbh,
4274 (id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) );
4275 $loghash{entry} = $resultstr;
4276 _log($dbh, %loghash);
4277
4278 $dbh->commit;
4279 };
4280 if ($@) {
4281 my $msg = $@;
4282 eval { $dbh->rollback; };
4283 $resultstr = '';
4284 $errstr = $msg;
4285 return;
4286 }
4287 }
4288
4289 my ($status) = $dbh->selectrow_array("SELECT status FROM ".
4290 ($revrec eq 'n' ? "domains WHERE domain_id=?" : "revzones WHERE rdns_id=?"),
4291 undef, ($id) );
4292 return $status;
4293} # end zoneStatus()
4294
4295
4296## DNSDB::getZonesByCIDR()
4297# Get a list of zone names and IDs that records for a passed CIDR block are within.
4298sub getZonesByCIDR {
4299 my $dbh = shift;
4300 my %args = @_;
4301
4302 my $result = $dbh->selectall_arrayref("SELECT rdns_id,revnet FROM revzones WHERE revnet >>= ? OR revnet <<= ?",
4303 { Slice => {} }, ($args{cidr}, $args{cidr}) );
4304 return $result;
4305} # end getZonesByCIDR()
4306
4307
4308## DNSDB::importAXFR
4309# Import a domain via AXFR
4310# Takes AXFR host, domain to transfer, group to put the domain in,
4311# and optionally:
4312# - active/inactive state flag (defaults to active)
4313# - overwrite-SOA flag (defaults to off)
4314# - overwrite-NS flag (defaults to off, doesn't affect subdomain NS records)
4315# Returns a status code (OK, WARN, or FAIL) and message - message should be blank
4316# if status is OK, but WARN includes conditions that are not fatal but should
4317# really be reported.
4318sub importAXFR {
4319 my $dbh = shift;
4320 my $ifrom_in = shift;
4321 my $zone = shift;
4322 my $group = shift;
4323 my $status = shift;
4324 $status = (defined($status) ? $status : 0); # force sane semantics, and allow passing "null" (inactive) status
4325 my $rwsoa = shift || 0;
4326 my $rwns = shift || 0;
4327 my $newttl = shift;
4328 my $merge = shift || 0; # do we attempt to merge A/AAAA and PTR records whenever possible?
4329 # do we overload this with the fixme below?
4330##fixme: add mode to delete&replace, merge+overwrite, merge new?
4331
4332 my $nrecs = 0;
4333 my $soaflag = 0;
4334 my $nsflag = 0;
4335 my $warnmsg = '';
4336 my $ifrom;
4337
4338 my $rev = 'n';
4339 my $code = 'OK';
4340 my $msg = 'foobar?';
4341
4342 # choke on possible bad setting in ifrom
4343 # IPv4 and v6, and valid hostnames!
4344 ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
4345 return ('FAIL', "Bad AXFR source host $ifrom")
4346 unless ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
4347
4348 my $errmsg;
4349
4350 my $zone_id;
4351 my $domain_id = 0;
4352 my $rdns_id = 0;
4353 my $cidr;
4354
4355# magic happens! detect if we're importing a domain or a reverse zone
4356# while we're at it, figure out what the CIDR netblock is (if we got a .arpa)
4357# or what the formal .arpa zone is (if we got a CIDR netblock)
4358# Handles sub-octet v4 zones in the format specified in the Cricket Book, 2nd Ed, p217-218
4359
4360 if ($zone =~ m{(?:\.arpa\.?|/\d+)$}) {
4361 # we seem to have a reverse zone
4362 $rev = 'y';
4363
4364 if ($zone =~ /\.arpa\.?$/) {
4365 # we have a formal reverse zone. call _zone2cidr and get the CIDR block.
4366 ($code,$msg) = _zone2cidr($zone);
4367 return ($code, $msg) if $code eq 'FAIL';
4368 $cidr = $msg;
4369 } elsif ($zone =~ m|^[\d.]+/\d+$|) {
4370 # v4 revzone, CIDR netblock
4371 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4372 $zone = _ZONE($cidr, 'ZONE.in-addr.arpa', 'r', '.');
4373 } elsif ($zone =~ m|^[a-fA-F\d:]+/\d+$|) {
4374 # v6 revzone, CIDR netblock
4375 $cidr = NetAddr::IP->new($zone) or return ('FAIL',"$zone is not a valid CIDR block");
4376 return ('FAIL', "$zone is not a nibble-aligned block") if $cidr->masklen % 4 != 0;
4377 $zone = _ZONE($cidr, 'ZONE.ip6.arpa', 'r', '.');
4378 } else {
4379 # there is. no. else!
4380 return ('FAIL', "Unknown zone name format");
4381 }
4382
4383 # quick check to start to see if we've already got one
4384
4385 ($zone_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?",
4386 undef, ("$cidr"));
4387 $rdns_id = $zone_id;
4388 } else {
4389 # default to domain
4390 ($zone_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE lower(domain) = lower(?)",
4391 undef, ($zone));
4392 $domain_id = $zone_id;
4393 }
4394
4395 return ('FAIL', ($rev eq 'n' ? 'Domain' : 'Reverse zone')." already exists") if $zone_id;
4396
4397 # little local utility sub to swap $val and $host for revzone records.
4398 sub _revswap {
4399 my $rechost = shift;
4400 my $recdata = shift;
4401
4402 if ($rechost =~ /\.in-addr\.arpa\.?$/) {
4403 $rechost =~ s/\.in-addr\.arpa\.?$//;
4404 $rechost = join '.', reverse split /\./, $rechost;
4405 } else {
4406 $rechost =~ s/\.ip6\.arpa\.?$//;
4407 my @nibs = reverse split /\./, $rechost;
4408 $rechost = '';
4409 my $nc;
4410 foreach (@nibs) {
4411 $rechost.= $_;
4412 $rechost .= ":" if ++$nc % 4 == 0 && $nc < 32;
4413 }
4414 $rechost .= ":" if $nc < 32 && $rechost !~ /\*$/; # close netblock records?
4415##fixme: there's a case that ends up with a partial entry here:
4416# ip:add:re:ss::
4417# can't reproduce after letting it sit overnight after discovery. :(
4418#print "$rechost\n";
4419 # canonicalize with NetAddr::IP
4420 $rechost = NetAddr::IP->new($rechost)->addr unless $rechost =~ /\*$/;
4421 }
4422 return ($recdata,$rechost)
4423 }
4424
4425
4426 # Allow transactions, and raise an exception on errors so we can catch it later.
4427 # Use local to make sure these get "reset" properly on exiting this block
4428 local $dbh->{AutoCommit} = 0;
4429 local $dbh->{RaiseError} = 1;
4430
4431 my $sth;
4432 eval {
4433
4434 if ($rev eq 'n') {
4435##fixme: serial
4436 $dbh->do("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)", undef, ($zone,$group,$status) );
4437 # get domain id so we can do the records
4438 ($zone_id) = $dbh->selectrow_array("SELECT currval('domains_domain_id_seq')");
4439 $domain_id = $zone_id;
4440 _log($dbh, (group_id => $group, domain_id => $domain_id,
4441 entry => "[Added ".($status ? 'active' : 'inactive')." domain $zone via AXFR]") );
4442 } else {
4443##fixme: serial
4444 $dbh->do("INSERT INTO revzones (revnet,group_id,status) VALUES (?,?,?)", undef, ($cidr,$group,$status) );
4445 # get revzone id so we can do the records
4446 ($zone_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
4447 $rdns_id = $zone_id;
4448 _log($dbh, (group_id => $group, rdns_id => $rdns_id,
4449 entry => "[Added ".($status ? 'active' : 'inactive')." reverse zone $cidr via AXFR]") );
4450 }
4451
4452## bizarre DBI<->Net::DNS interaction bug:
4453## sometimes a zone will cause an immediate commit-and-exit (sort of) of the while()
4454## fixed, apparently I was doing *something* odd, but not certain what it was that
4455## caused a commit instead of barfing
4456
4457 my $res = Net::DNS::Resolver->new;
4458 $res->nameservers($ifrom);
4459 $res->axfr_start($zone)
4460 or die "Couldn't begin AXFR\n";
4461
4462 $sth = $dbh->prepare("INSERT INTO records (domain_id,rdns_id,host,type,val,distance,weight,port,ttl)".
4463 " VALUES (?,?,?,?,?,?,?,?,?)");
4464
4465 # Stash info about sub-octet v4 revzones here so we don't have
4466 # to store the CNAMEs used to delegate a suboctet zone
4467 # $suboct{zone}{ns}[] -> array of nameservers
4468 # $suboct{zone}{cname}[] -> array of extant CNAMEs (Just In Case someone did something bizarre)
4469## commented pending actual use of this data. for now, we'll just
4470## auto-(re)create the CNAMEs in revzones on export
4471# my %suboct;
4472
4473 while (my $rr = $res->axfr_next()) {
4474
4475 my $val;
4476 my $distance = 0;
4477 my $weight = 0;
4478 my $port = 0;
4479 my $logfrag = '';
4480
4481 my $type = $rr->type;
4482 my $host = $rr->name;
4483 my $ttl = ($newttl ? $newttl : $rr->ttl); # allow force-override TTLs
4484
4485 $soaflag = 1 if $type eq 'SOA';
4486 $nsflag = 1 if $type eq 'NS';
4487
4488# "Primary" types:
4489# A, NS, CNAME, SOA, PTR(warn in forward), MX, TXT, AAAA, SRV, A6(ob), SPF
4490# maybe KEY
4491
4492# BIND supports:
4493# [standard]
4494# A AAAA CNAME MX NS PTR SOA TXT
4495# [variously experimental, obsolete, or obscure]
4496# 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
4497# ... if one can ever find the right magic to format them correctly
4498
4499# Net::DNS supports:
4500# RRSIG SIG NSAP NS NIMLOC NAPTR MX MR MINFO MG MB LOC ISDN IPSECKEY HINFO
4501# EID DNAME CNAME CERT APL AFSDB AAAA A DS NXT NSEC3PARAM NSEC3 NSEC KEY
4502# DNSKEY DLV X25 TXT TSIG TKEY SSHFP SRV SPF SOA RT RP PX PTR NULL APL::AplItem
4503
4504# nasty big ugly case-like thing here, since we have to do *some* different
4505# processing depending on the record. le sigh.
4506
4507##fixme: what record types other than TXT can/will have >255-byte payloads?
4508
4509 if ($type eq 'A') {
4510 $val = $rr->address;
4511 } elsif ($type eq 'NS') {
4512# hmm. should we warn here if subdomain NS'es are left alone?
4513 next if ($rwns && ($rr->name eq $zone));
4514 if ($rev eq 'y') {
4515 # revzones have records more or less reversed from forward zones.
4516 my ($tmpcode,$tmpmsg) = _zone2cidr($host);
4517 die "Error converting NS record: $tmpmsg\n" if $tmpcode eq 'FAIL'; # hmm. may not make sense...
4518 $val = "$tmpmsg";
4519 $host = $rr->nsdname;
4520 $logfrag = "Added record '$val $type $host', TTL $ttl";
4521# Tag and preserve. For now this is commented for a no-op, but we have Ideas for
4522# another custom storage type ("DELEGATE") that will use these subzone-delegation records
4523#if ($val ne "$cidr") {
4524# push @{$suboct{$val}{ns}}, $host;
4525#}
4526 } else {
4527 $val = $rr->nsdname;
4528 }
4529 $nsflag = 1;
4530 } elsif ($type eq 'CNAME') {
4531 if ($rev eq 'y') {
4532 # hmm. do we even want to bother with storing these at this level? Sub-octet delegation
4533 # by CNAME is essentially a record-publication hack, and we want to just represent the
4534 # "true" logical intentions as far down the stack as we can from the UI.
4535 ($host,$val) = _revswap($host,$rr->cname);
4536 $logfrag = "Added record '$val $type $host', TTL $ttl";
4537# Tag and preserve in case we want to commit them as-is later, but mostly we don't care.
4538# Commented pending actually doing something with possibly new type DELEGATE
4539#my $tmprev = $host;
4540#$tmprev =~ s/^\d+\.//;
4541#($code,$tmprev) = _zone2cidr($tmprev);
4542#push @{$suboct{"$tmprev"}{cname}}, $val;
4543 # Silently skip CNAMEs in revzones.
4544 next;
4545 } else {
4546 $val = $rr->cname;
4547 }
4548 } elsif ($type eq 'SOA') {
4549 next if $rwsoa;
4550 $host = $rr->rname.":".$rr->mname;
4551 $val = $rr->refresh.":".$rr->retry.":".$rr->expire.":".$rr->minimum;
4552 $soaflag = 1;
4553 } elsif ($type eq 'PTR') {
4554 ($host,$val) = _revswap($host,$rr->ptrdname);
4555 $logfrag = "Added record '$val $type $host', TTL $ttl";
4556 # hmm. PTR records should not be in forward zones.
4557 } elsif ($type eq 'MX') {
4558 $val = $rr->exchange;
4559 $distance = $rr->preference;
4560 } elsif ($type eq 'TXT') {
4561##fixme: Net::DNS docs say this should be deprecated for rdatastr() or char_str_list(),
4562## but don't really seem enthusiastic about it.
4563#print "should use rdatastr:\n\t".$rr->rdatastr."\n or char_str_list:\n\t".join(' ',$rr->char_str_list())."\n";
4564# rdatastr returns a BIND-targetted logical string, including opening and closing quotes
4565# char_str_list returns a list of the individual string fragments in the record
4566# txtdata returns the more useful all-in-one form (since we want to push such protocol
4567# details as far down the stack as we can)
4568# NB: this may turn out to be more troublesome if we ever have need of >512-byte TXT records.
4569 if ($rev eq 'y') {
4570 ($host,$val) = _revswap($host,$rr->txtdata);
4571 $logfrag = "Added record '$val $type $host', TTL $ttl";
4572 } else {
4573 $val = $rr->txtdata;
4574 }
4575 } elsif ($type eq 'SPF') {
4576##fixme: and the same caveat here, since it is apparently a clone of ::TXT
4577 $val = $rr->txtdata;
4578 } elsif ($type eq 'AAAA') {
4579 $val = $rr->address;
4580 } elsif ($type eq 'SRV') {
4581 $val = $rr->target;
4582 $distance = $rr->priority;
4583 $weight = $rr->weight;
4584 $port = $rr->port;
4585 } elsif ($type eq 'KEY') {
4586 # we don't actually know what to do with these...
4587 $val = $rr->flags.":".$rr->protocol.":".$rr->algorithm.":".$rr->key.":".$rr->keytag.":".$rr->privatekeyname;
4588 } else {
4589 $val = $rr->rdatastr;
4590 # Finding a different record type is not fatal.... just problematic.
4591 # We may not be able to export it correctly.
4592 $warnmsg .= "Unusual record ".$rr->name." ($type) found\n";
4593 }
4594
4595 my $logentry = "[AXFR ".($rev eq 'n' ? $zone : $cidr)."] ";
4596
4597 if ($merge) {
4598 if ($rev eq 'n') {
4599 # importing a domain; we have A and AAAA records that could be merged with matching PTR records
4600 my $etype;
4601 my ($erdns,$erid,$ettl) = $dbh->selectrow_array("SELECT rdns_id,record_id,ttl FROM records ".
4602 "WHERE host=? AND val=? AND type=12",
4603 undef, ($host, $val) );
4604 if ($erid) {
4605 if ($type eq 'A') { # PTR -> A+PTR
4606 $etype = 65280;
4607 $logentry .= "Merged A record with existing PTR record '$host A+PTR $val', TTL $ettl";
4608 }
4609 if ($type eq 'AAAA') { # PTR -> AAAA+PTR
4610 $etype = 65281;
4611 $logentry .= "Merged AAAA record with existing PTR record '$host AAAA+PTR $val', TTL $ettl";
4612 }
4613 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
4614 $dbh->do("UPDATE records SET domain_id=?,ttl=?,type=? WHERE record_id=?", undef,
4615 ($domain_id, $ettl, $etype, $erid));
4616 $nrecs++;
4617 _log($dbh, (group_id => $group, domain_id => $domain_id, rdns_id => $erdns, entry => $logentry) );
4618 next; # while axfr_next
4619 }
4620 } # $rev eq 'n'
4621 else {
4622 # importing a revzone, we have PTR records that could be merged with matching A/AAAA records
4623 my ($domid,$erid,$ettl,$etype) = $dbh->selectrow_array("SELECT domain_id,record_id,ttl,type FROM records ".
4624 "WHERE host=? AND val=? AND (type=1 OR type=28)",
4625 undef, ($host, $val) );
4626 if ($erid) {
4627 if ($etype == 1) { # A -> A+PTR
4628 $etype = 65280;
4629 $logentry .= "Merged PTR record with existing matching A record '$host A+PTR $val', TTL $ettl";
4630 }
4631 if ($etype == 28) { # AAAA -> AAAA+PTR
4632 $etype = 65281;
4633 $logentry .= "Merged PTR record with existing matching AAAA record '$host AAAA+PTR $val', TTL $ettl";
4634 }
4635 $ettl = ($ettl < $ttl ? $ettl : $ttl); # use lower TTL
4636 $dbh->do("UPDATE records SET rdns_id=?,ttl=?,type=? WHERE record_id=?", undef,
4637 ($rdns_id, $ettl, $etype, $erid));
4638 $nrecs++;
4639 _log($dbh, (group_id => $group, domain_id => $domid, rdns_id => $rdns_id, entry => $logentry) );
4640 next; # while axfr_next
4641 }
4642 } # $rev eq 'y'
4643 } # if $merge
4644
4645 # Insert the new record
4646 $sth->execute($domain_id, $rdns_id, $host, $reverse_typemap{$type}, $val,
4647 $distance, $weight, $port, $ttl);
4648
4649 $nrecs++;
4650
4651 if ($type eq 'SOA') {
4652 # also !$rwsoa, but if that's set, it should be impossible to get here.
4653 my @tmp1 = split /:/, $host;
4654 my @tmp2 = split /:/, $val;
4655 $logentry .= "Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
4656 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl";
4657 } elsif ($logfrag) {
4658 # special case for log entries we need to meddle with a little.
4659 $logentry .= $logfrag;
4660 } else {
4661 $logentry .= "Added record '$host $type";
4662 $logentry .= " [distance $distance]" if $type eq 'MX';
4663 $logentry .= " [priority $distance] [weight $weight] [port $port]" if $type eq 'SRV';
4664 $logentry .= " $val', TTL $ttl";
4665 }
4666 _log($dbh, (group_id => $group, domain_id => $domain_id, rdns_id => $rdns_id, entry => $logentry) );
4667
4668 } # while axfr_next
4669
4670# Detect and handle delegated subzones
4671# Placeholder for when we decide what to actually do with this, see previous comments in NS and CNAME handling.
4672#foreach (keys %suboct) {
4673# print "found ".($suboct{$_}{ns} ? @{$suboct{$_}{ns}} : '0')." NS records and ".
4674# ($suboct{$_}{cname} ? @{$suboct{$_}{cname}} : '0')." CNAMEs for $_\n";
4675#}
4676
4677 # Overwrite SOA record
4678 if ($rwsoa) {
4679 $soaflag = 1;
4680 my $sthgetsoa = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
4681 my $sthputsoa = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
4682 $sthgetsoa->execute($group,$reverse_typemap{SOA});
4683 while (my ($host,$val,$ttl) = $sthgetsoa->fetchrow_array()) {
4684 $host =~ s/DOMAIN/$zone/g;
4685 $val =~ s/DOMAIN/$zone/g;
4686 $sthputsoa->execute($zone_id,$host,$reverse_typemap{SOA},$val,$ttl);
4687 }
4688 }
4689
4690 # Overwrite NS records
4691 if ($rwns) {
4692 $nsflag = 1;
4693 my $sthgetns = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
4694 my $sthputns = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
4695 $sthgetns->execute($group,$reverse_typemap{NS});
4696 while (my ($host,$val,$ttl) = $sthgetns->fetchrow_array()) {
4697 $host =~ s/DOMAIN/$zone/g;
4698 $val =~ s/DOMAIN/$zone/g;
4699 $sthputns->execute($zone_id,$host,$reverse_typemap{NS},$val,$ttl);
4700 }
4701 }
4702
4703 die "No records found; either $ifrom is not authoritative or doesn't allow transfers\n" if !$nrecs;
4704 die "Bad zone: No SOA record!\n" if !$soaflag;
4705 die "Bad zone: No NS records!\n" if !$nsflag;
4706
4707 $dbh->commit;
4708
4709 };
4710
4711 if ($@) {
4712 my $msg = $@;
4713 eval { $dbh->rollback; };
4714 return ('FAIL',$msg." $warnmsg");
4715 } else {
4716 return ('WARN', $warnmsg) if $warnmsg;
4717 return ('OK',"Imported OK");
4718 }
4719
4720 # it should be impossible to get here.
4721 return ('WARN',"OOOK!");
4722} # end importAXFR()
4723
4724
4725## DNSDB::importBIND()
4726sub importBIND {
4727} # end importBIND()
4728
4729
4730## DNSDB::import_tinydns()
4731sub import_tinydns {
4732} # end import_tinydns()
4733
4734
4735## DNSDB::export()
4736# Export the DNS database, or a part of it
4737# Takes database handle, export type, optional arguments depending on type
4738# Writes zone data to targets as appropriate for type
4739sub export {
4740 my $dbh = shift;
4741 my $target = shift;
4742
4743 if ($target eq 'tiny') {
4744 __export_tiny($dbh,@_);
4745 }
4746# elsif ($target eq 'foo') {
4747# __export_foo($dbh,@_);
4748#}
4749# etc
4750
4751} # end export()
4752
4753
4754## DNSDB::__export_tiny
4755# Internal sub to implement tinyDNS (compatible) export
4756# Takes database handle, filehandle to write export to, optional argument(s)
4757# to determine which data gets exported
4758sub __export_tiny {
4759 my $dbh = shift;
4760 my $datafile = shift;
4761
4762##fixme: slurp up further options to specify particular zone(s) to export
4763
4764##fixme: fail if $datafile isn't an open, writable file
4765
4766 # easy case - export all evarything
4767 # not-so-easy case - export item(s) specified
4768 # todo: figure out what kind of list we use to export items
4769
4770# raw packet in unknown format: first byte indicates length
4771# of remaining data, allows up to 255 raw bytes
4772
4773 # Locations/views - worth including in the caching setup?
4774 my $lochash = $dbh->selectall_hashref("SELECT location,iplist FROM locations", 'location');
4775 foreach my $location (keys %$lochash) {
4776 foreach my $ipprefix (split /[,\s]+/, $lochash->{$location}{iplist}) {
4777 $ipprefix =~ s/\s+//g;
4778 $ipprefix = new NetAddr::IP $ipprefix;
4779##fixme: how to handle IPv6?
4780next if $ipprefix->{isv6};
4781 # have to account for /nn CIDR entries. tinydns only speaks octet-sliced prefix.
4782 if ($ipprefix->masklen <= 8) {
4783 foreach ($ipprefix->split(8)) {
4784 my $tmp = $_->addr;
4785 $tmp =~ s/\.\d+\.\d+\.\d+$//;
4786 print $datafile "%$location:$tmp\n";
4787 }
4788 } elsif ($ipprefix->masklen <= 16) {
4789 foreach ($ipprefix->split(16)) {
4790 my $tmp = $_->addr;
4791 $tmp =~ s/\.\d+\.\d+$//;
4792 print $datafile "%$location:$tmp\n";
4793 }
4794 } elsif ($ipprefix->masklen <= 24) {
4795 foreach ($ipprefix->split(24)) {
4796 my $tmp = $_->addr;
4797 $tmp =~ s/\.\d+$//;
4798 print $datafile "%$location:$tmp\n";
4799 }
4800 } else {
4801 foreach ($ipprefix->split(32)) {
4802 print $datafile "%$location:".$_->addr."\n";
4803 }
4804 }
4805 }
4806 print $datafile "%$location\n" if !$lochash->{$location}{iplist};
4807 }
4808
4809 # tracking hash so we don't double-export A+PTR or AAAA+PTR records.
4810 my %recflags;
4811
4812 my $domsth = $dbh->prepare("SELECT domain_id,domain,status,changed FROM domains WHERE status=1");
4813 my $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
4814 "FROM records WHERE domain_id=? AND type < 65280"); # Just exclude all types relating to rDNS
4815 my $zonesth = $dbh->prepare("UPDATE domains SET changed='n' WHERE domain_id=?");
4816 $domsth->execute();
4817 while (my ($domid,$dom,$domstat,$changed) = $domsth->fetchrow_array) {
4818##fixme: need to find a way to block opening symlinked files without introducing a race.
4819# O_NOFOLLOW
4820# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
4821# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
4822# still be followed.
4823# but that doesn't help other platforms. :/
4824 sysopen(ZONECACHE, "$config{exportcache}/$dom", O_RDWR|O_CREAT);
4825 flock(ZONECACHE, LOCK_EX);
4826 if ($changed || -s "$config{exportcache}/$dom" == 0) {
4827 $recsth->execute($domid);
4828 while (my ($host,$type,$val,$dist,$weight,$port,$ttl,$recid,$loc) = $recsth->fetchrow_array) {
4829 next if $recflags{$recid};
4830
4831 $loc = '' if !$loc; # de-nullify - just in case
4832##fixme: handle case of record-with-location-that-doesn't-exist better.
4833# note this currently fails safe (tested) - records with a location that
4834# doesn't exist will not be sent to any client
4835# $loc = '' if !$lochash->{$loc};
4836
4837##fixme: record validity timestamp. tinydns supports fiddling with timestamps.
4838# note $ttl must be set to 0 if we want to use tinydns's auto-expiring timestamps.
4839# timestamps are TAI64
4840# ~~ 2^62 + time()
4841 my $stamp = '';
4842
4843 # support tinydns' auto-TTL
4844 $ttl = '' if $ttl == '0';
4845
4846 # Spaces are evil.
4847 $host =~ s/^\s+//;
4848 $host =~ s/\s+$//;
4849 if ($typemap{$type} ne 'TXT') {
4850 # Leading or trailng spaces could be legit in TXT records.
4851 $val =~ s/^\s+//;
4852 $val =~ s/\s+$//;
4853 }
4854
4855 _printrec_tiny(*ZONECACHE, 'n', \%recflags,
4856 $dom, $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp)
4857 if *ZONECACHE;
4858
4859 # in case the zone shrunk, get rid of garbage at the end of the file.
4860 truncate(ZONECACHE, tell(ZONECACHE));
4861
4862 $recflags{$recid} = 1;
4863 } # while ($recsth)
4864 }
4865 # stream from cache, whether freshly created or existing
4866 print $datafile $_ while <ZONECACHE>;
4867 close ZONECACHE;
4868 # mark domain as unmodified
4869 $zonesth->execute($domid);
4870 } # while ($domsth)
4871
4872 my $revsth = $dbh->prepare("SELECT rdns_id,revnet,status,changed FROM revzones WHERE status=1 ".
4873 "ORDER BY masklen(revnet) DESC");
4874
4875# For reasons unknown, we can't sanely UNION these statements. Feh.
4876# Supposedly it should work though (note last 3 lines):
4877## PG manual
4878#UNION Clause
4879#
4880#The UNION clause has this general form:
4881#
4882# select_statement UNION [ ALL ] select_statement
4883#
4884#select_statement is any SELECT statement without an ORDER BY, LIMIT, FOR UPDATE, or FOR SHARE clause. (ORDER BY
4885#and LIMIT can be attached to a subexpression if it is enclosed in parentheses. Without parentheses, these
4886#clauses will be taken to apply to the result of the UNION, not to its right-hand input expression.)
4887 my $soasth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
4888 "FROM records WHERE rdns_id=? AND type=6");
4889 $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl,record_id,location ".
4890 "FROM records WHERE rdns_id=? AND not type=6 ".
4891 "ORDER BY masklen(CAST(val AS inet)) DESC, CAST(val AS inet)");
4892 $zonesth = $dbh->prepare("UPDATE revzones SET changed='n' WHERE rdns_id=?");
4893 $revsth->execute();
4894 while (my ($revid,$revzone,$revstat,$changed) = $revsth->fetchrow_array) {
4895##fixme: need to find a way to block opening symlinked files without introducing a race.
4896# O_NOFOLLOW
4897# If pathname is a symbolic link, then the open fails. This is a FreeBSD extension, which was
4898# added to Linux in version 2.1.126. Symbolic links in earlier components of the pathname will
4899# still be followed.
4900# but that doesn't help other platforms. :/
4901 my $tmpzone = NetAddr::IP->new($revzone);
4902 sysopen(ZONECACHE, "$config{exportcache}/".$tmpzone->network->addr, O_RDWR|O_CREAT);
4903 flock(ZONECACHE, LOCK_EX);
4904 if ($changed || -s "$config{exportcache}/".$tmpzone->network->addr == 0) {
4905 # need to fetch this separately since the rest of the records all (should) have real IPs in val
4906 $soasth->execute($revid);
4907 my (@zsoa) = $soasth->fetchrow_array();
4908 _printrec_tiny(*ZONECACHE,'y',\%recflags,$revzone,
4909 $zsoa[0],$zsoa[1],$zsoa[2],$zsoa[3],$zsoa[4],$zsoa[5],$zsoa[6],$zsoa[8],'');
4910
4911 $recsth->execute($revid);
4912 while (my ($host,$type,$val,$dist,$weight,$port,$ttl,$recid,$loc) = $recsth->fetchrow_array) {
4913 next if $recflags{$recid};
4914
4915 $loc = '' if !$loc; # de-nullify - just in case
4916##fixme: handle case of record-with-location-that-doesn't-exist better.
4917# note this currently fails safe (tested) - records with a location that
4918# doesn't exist will not be sent to any client
4919# $loc = '' if !$lochash->{$loc};
4920
4921##fixme: record validity timestamp. tinydns supports fiddling with timestamps.
4922# note $ttl must be set to 0 if we want to use tinydns's auto-expiring timestamps.
4923# timestamps are TAI64
4924# ~~ 2^62 + time()
4925 my $stamp = '';
4926
4927 # support tinydns' auto-TTL
4928 $ttl = '' if $ttl == '0';
4929
4930 _printrec_tiny(*ZONECACHE, 'y', \%recflags, $revzone,
4931 $host, $type, $val, $dist, $weight, $port, $ttl, $loc, $stamp)
4932 if *ZONECACHE;
4933
4934 # in case the zone shrunk, get rid of garbage at the end of the file.
4935 truncate(ZONECACHE, tell(ZONECACHE));
4936
4937 $recflags{$recid} = 1;
4938 } # while ($recsth)
4939 }
4940 # stream from cache, whether freshly created or existing
4941 print $datafile $_ while <ZONECACHE>;
4942 close ZONECACHE;
4943 # mark zone as unmodified
4944 $zonesth->execute($revid);
4945 } # while ($domsth)
4946
4947} # end __export_tiny()
4948
4949
4950# Utility sub for __export_tiny above
4951sub _printrec_tiny {
4952 my ($datafile,$revrec,$recflags,$zone,$host,$type,$val,$dist,$weight,$port,$ttl,$loc,$stamp) = @_;
4953
4954 ## Convert a bare number into an octal-coded pair of octets.
4955 # Take optional arg to indicate a decimal or hex input. Defaults to hex.
4956 sub octalize {
4957 my $tmp = shift;
4958 my $srctype = shift || 'h'; # default assumes hex string
4959 $tmp = sprintf "%0.4x", hex($tmp) if $srctype eq 'h'; # 0-pad hex to 4 digits
4960 $tmp = sprintf "%0.4x", $tmp if $srctype eq 'd'; # 0-pad decimal to 4 hex digits
4961 my @o = ($tmp =~ /^(..)(..)$/); # split into octets
4962 return sprintf "\\%0.3o\\%0.3o", hex($o[0]), hex($o[1]);;
4963 }
4964
4965## WARNING: This works to export even the whole Internet's worth of IP space...
4966## if you have the disk/RAM to handle the dataset, and you call this sub based on /16-sized chunks
4967## A /16 took ~3 seconds with a handful of separate records; adding a /8 pushed export time out to ~13m:40s
4968## 0/0 is estimated to take ~54 hours and ~256G of disk
4969## RAM usage depends on how many non-template entries you have in the set.
4970## This should probably be done on record addition rather than export; large blocks may need to be done in a
4971## forked process
4972 sub __publish_subnet {
4973 my $sub = shift;
4974 my $recflags = shift;
4975 my $hpat = shift;
4976 my $fh = shift;
4977 my $ttl = shift;
4978 my $stamp = shift;
4979 my $loc = shift;
4980 my $ptronly = shift || 0;
4981
4982 my $iplist = $sub->splitref(32);
4983 foreach (@$iplist) {
4984 my $ip = $_->addr;
4985 # make as if we split the non-octet-aligned block into octet-aligned blocks as with SOA
4986 next if $ip =~ /\.(0|255)$/;
4987 next if $$recflags{$ip};
4988 $$recflags{$ip}++;
4989 next if $hpat eq '%blank%'; # Allows blanking a subnet so no records are published.
4990 my $rec = $hpat; # start fresh with the template for each IP
4991 _template4_expand(\$rec, $ip);
4992 print $fh ($ptronly ? "^"._ZONE($_, 'ZONE.in-addr.arpa', 'r', '.').":$rec" : "=$rec:$ip").
4993 ":$ttl:$stamp:$loc\n";
4994 }
4995 }
4996
4997##fixme? append . to all host/val hostnames
4998 if ($typemap{$type} eq 'SOA') {
4999
5000 # host contains pri-ns:responsible
5001 # val is abused to contain refresh:retry:expire:minttl
5002##fixme: "manual" serial vs tinydns-autoserial
5003 # let's be explicit about abusing $host and $val
5004 my ($email, $primary) = (split /:/, $host)[0,1];
5005 my ($refresh, $retry, $expire, $min_ttl) = (split /:/, $val)[0,1,2,3];
5006 if ($revrec eq 'y') {
5007##fixme: have to publish SOA records for each v4 /24 in sub-/16, and each /16 in sub-/8
5008# what about v6?
5009# -> only need SOA for local chunks offset from reverse delegation boundaries, so v6 is fine
5010 $zone = NetAddr::IP->new($zone);
5011 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
5012 if (!$zone->{isv6} && ($zone->masklen < 24) && ($zone->masklen % 8 != 0)) {
5013 foreach my $szone ($zone->split($zone->masklen + (8 - $zone->masklen % 8))) {
5014 $szone = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
5015 print $datafile "Z$szone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n";
5016 }
5017 return; # skips "default" bits just below
5018 }
5019 $zone = _ZONE($zone, 'ZONE', 'r', '.').($zone->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
5020 }
5021 print $datafile "Z$zone:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n";
5022
5023 } elsif ($typemap{$type} eq 'A') {
5024
5025 print $datafile "+$host:$val:$ttl:$stamp:$loc\n";
5026
5027 } elsif ($typemap{$type} eq 'NS') {
5028
5029 if ($revrec eq 'y') {
5030 $val = NetAddr::IP->new($val);
5031 # handle split-n-multiply SOA for off-octet (8 < mask < 16) or (16 < mask < 24) v4 zones
5032 if (!$val->{isv6} && ($val->masklen < 24) && ($val->masklen % 8 != 0)) {
5033 foreach my $szone ($val->split($val->masklen + (8 - $val->masklen % 8))) {
5034 my $szone2 = _ZONE($szone, 'ZONE.in-addr.arpa', 'r', '.');
5035 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
5036 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n";
5037 $$recflags{$szone2} = $val->masklen;
5038 }
5039 } elsif ($val->{isv6} && ($val->masklen < 64) && ($val->masklen % 4 !=0)) {
5040 foreach my $szone ($val->split($val->masklen + (4 - $val->masklen % 4))) {
5041 my $szone2 = _ZONE($szone, 'ZONE.ip6.arpa', 'r', '.');
5042 next if $$recflags{$szone2} && $$recflags{$szone2} > $val->masklen;
5043 print $datafile "\&$szone2"."::$host:$ttl:$stamp:$loc\n";
5044 $$recflags{$szone2} = $val->masklen;
5045 }
5046 } else {
5047 my $val2 = _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa');
5048 print $datafile "\&$val2"."::$host:$ttl:$stamp:$loc\n";
5049 $$recflags{$val2} = $val->masklen;
5050 }
5051 } else {
5052 print $datafile "\&$host"."::$val:$ttl:$stamp:$loc\n";
5053 }
5054
5055 } elsif ($typemap{$type} eq 'AAAA') {
5056
5057 print $datafile ":$host:28:";
5058 my $altgrp = 0;
5059 my @altconv;
5060 # Split in to up to 8 groups of hex digits (allows for IPv6 :: 0-collapsing)
5061 foreach (split /:/, $val) {
5062 if (/^$/) {
5063 # flag blank entry; this is a series of 0's of (currently) unknown length
5064 $altconv[$altgrp++] = 's';
5065 } else {
5066 # call sub to convert 1-4 hex digits to 2 string-rep octal bytes
5067 $altconv[$altgrp++] = octalize($_)
5068 }
5069 }
5070 foreach my $octet (@altconv) {
5071 # if not 's', output
5072 print $datafile $octet unless $octet =~ /^s$/;
5073 # if 's', output (9-array length)x literal '\000\000'
5074 print $datafile '\000\000'x(9-$altgrp) if $octet =~ /^s$/;
5075 }
5076 print $datafile ":$ttl:$stamp:$loc\n";
5077
5078 } elsif ($typemap{$type} eq 'MX') {
5079
5080 print $datafile "\@$host"."::$val:$dist:$ttl:$stamp:$loc\n";
5081
5082 } elsif ($typemap{$type} eq 'TXT') {
5083
5084##fixme: split v-e-r-y long TXT strings? will need to do so for BIND export, at least
5085 if ($revrec eq 'n') {
5086 $val =~ s/:/\\072/g; # may need to replace other symbols
5087 print $datafile "'$host:$val:$ttl:$stamp:$loc\n";
5088 } else {
5089 $host =~ s/:/\\072/g; # may need to replace other symbols
5090 my $val2 = NetAddr::IP->new($val);
5091 print $datafile "'"._ZONE($val2, 'ZONE', 'r', '.').($val2->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5092 ":$host:$ttl:$stamp:$loc\n";
5093 }
5094
5095# by-hand TXT
5096#:deepnet.cx:16:2v\075spf1\040a\040a\072bacon.deepnet.cx\040a\072home.deepnet.cx\040-all:3600
5097#@ IN TXT "v=spf1 a a:bacon.deepnet.cx a:home.deepnet.cx -all"
5098#'deepnet.cx:v=spf1 a a\072bacon.deepnet.cx a\072home.deepnet.cx -all:3600
5099
5100#txttest IN TXT "v=foo bar:bob kn;ob' \" !@#$%^&*()-=_+[]{}<>?"
5101#: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
5102
5103# very long TXT record as brought in by axfr-get
5104# note tinydns does not support >512-byte RR data, need axfr-dns (for TCP support) for that
5105# also note, tinydns does not seem to support <512, >256-byte RRdata from axfr-get either. :/
5106#:longtxt.deepnet.cx:16:
5107#\170this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
5108#\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.
5109#\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.
5110#:3600
5111
5112 } elsif ($typemap{$type} eq 'CNAME') {
5113
5114 if ($revrec eq 'n') {
5115 print $datafile "C$host:$val:$ttl:$stamp:$loc\n";
5116 } else {
5117 my $val2 = NetAddr::IP->new($val);
5118 print $datafile "C"._ZONE($val2, 'ZONE', 'r', '.').($val2->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5119 ":$host:$ttl:$stamp:$loc\n";
5120 }
5121
5122 } elsif ($typemap{$type} eq 'SRV') {
5123
5124 # data is two-byte values for priority, weight, port, in that order,
5125 # followed by length/string data
5126
5127 print $datafile ":$host:33:".octalize($dist,'d').octalize($weight,'d').octalize($port,'d');
5128
5129 $val .= '.' if $val !~ /\.$/;
5130 foreach (split /\./, $val) {
5131 printf $datafile "\\%0.3o%s", length($_), $_;
5132 }
5133 print $datafile "\\000:$ttl:$stamp:$loc\n";
5134
5135 } elsif ($typemap{$type} eq 'RP') {
5136
5137 # RP consists of two mostly free-form strings.
5138 # The first is supposed to be an email address with @ replaced by . (as with the SOA contact)
5139 # The second is the "hostname" of a TXT record with more info.
5140 print $datafile ":$host:17:";
5141 my ($who,$what) = split /\s/, $val;
5142 foreach (split /\./, $who) {
5143 printf $datafile "\\%0.3o%s", length($_), $_;
5144 }
5145 print $datafile '\000';
5146 foreach (split /\./, $what) {
5147 printf $datafile "\\%0.3o%s", length($_), $_;
5148 }
5149 print $datafile "\\000:$ttl:$stamp:$loc\n";
5150
5151 } elsif ($typemap{$type} eq 'PTR') {
5152
5153 $zone = NetAddr::IP->new($zone);
5154 $$recflags{$val}++;
5155 if (!$zone->{isv6} && $zone->masklen > 24) {
5156 ($val) = ($val =~ /\.(\d+)$/);
5157 print $datafile "^$val."._ZONE($zone, 'ZONE', 'r', '.').'.in-addr.arpa'.
5158 ":$host:ttl:$stamp:$loc\n";
5159 } else {
5160 $val = NetAddr::IP->new($val);
5161 print $datafile "^".
5162 _ZONE($val, 'ZONE', 'r', '.').($val->{isv6} ? '.ip6.arpa' : '.in-addr.arpa').
5163 ":$host:$ttl:$stamp:$loc\n";
5164 }
5165
5166 } elsif ($type == 65280) { # A+PTR
5167
5168 $$recflags{$val}++;
5169 print $datafile "=$host:$val:$ttl:$stamp:$loc\n";
5170
5171 } elsif ($type == 65281) { # AAAA+PTR
5172
5173#$$recflags{$val}++;
5174 # treat these as two separate records. since tinydns doesn't have
5175 # a native combined type, we have to create them separately anyway.
5176 if ($revrec eq 'n') {
5177 $type = 28;
5178 } else {
5179 $type = 12;
5180 }
5181 _printrec_tiny($datafile,$revrec,$recflags,$zone,$host,$type,$val,$dist,$weight,$port,$ttl,$loc,$stamp);
5182##fixme: add a config flag to indicate use of the patch from http://www.fefe.de/dns/
5183# type 6 is for AAAA+PTR, type 3 is for AAAA
5184
5185 } elsif ($type == 65282) { # PTR template
5186
5187 # only useful for v4 with standard DNS software, since this expands all
5188 # IPs in $zone (or possibly $val?) with autogenerated records
5189 $val = NetAddr::IP->new($val);
5190 return if $val->{isv6};
5191
5192 if ($val->masklen <= 16) {
5193 foreach my $sub ($val->split(16)) {
5194 __publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, 1);
5195 }
5196 } else {
5197 __publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, 1);
5198 }
5199
5200 } elsif ($type == 65283) { # A+PTR template
5201
5202 $val = NetAddr::IP->new($val);
5203 # Just In Case. An A+PTR should be impossible to add to a v6 revzone via API.
5204 return if $val->{isv6};
5205
5206 if ($val->masklen <= 16) {
5207 foreach my $sub ($val->split(16)) {
5208 __publish_subnet($sub, $recflags, $host, $datafile, $ttl, $stamp, $loc, 0);
5209 }
5210 } else {
5211 __publish_subnet($val, $recflags, $host, $datafile, $ttl, $stamp, $loc, 0);
5212 }
5213
5214 } elsif ($type == 65284) { # AAAA+PTR template
5215 # Stub for completeness. Could be exported to DNS software that supports
5216 # some degree of internal automagic in generic-record-creation
5217 # (eg http://search.cpan.org/dist/AllKnowingDNS/ )
5218
5219 } elsif ($type == 65285) { # Delegation
5220 # This is intended for reverse zones, but may prove useful in forward zones.
5221
5222 # All delegations need to create one or more NS records. The NS record handler knows what to do.
5223 _printrec_tiny($datafile,$revrec,$recflags,$zone,$host,$reverse_typemap{'NS'},
5224 $val,$dist,$weight,$port,$ttl,$loc,$stamp);
5225 if ($revrec eq 'y') {
5226 # In the case of a sub-/24 v4 reverse delegation, we need to generate CNAMEs
5227 # to redirect all of the individual IP lookups as well.
5228 # Not sure how this would actually resolve if a /24 or larger was delegated
5229 # one way, and a sub-/24 in that >=/24 was delegated elsewhere...
5230 my $dblock = NetAddr::IP->new($val);
5231 if (!$dblock->{isv6} && $dblock->masklen > 24) {
5232 my @subs = $dblock->split;
5233 foreach (@subs) {
5234 next if $$recflags{"$_"};
5235 my ($oct) = ($_->addr =~ /(\d+)$/);
5236 print $datafile "C"._ZONE($_, 'ZONE.in-addr.arpa', 'r', '.').":$oct.".
5237 _ZONE($dblock, 'ZONE.in-addr.arpa', 'r', '.').":$ttl:$stamp:$loc\n";
5238 $$recflags{"$_"}++;
5239 }
5240 }
5241 }
5242
5243##
5244## Uncommon types. These will need better UI support Any Day Sometime Maybe(TM).
5245##
5246
5247 } elsif ($type == 44) { # SSHFP
5248 my ($algo,$fpt,$fp) = split /\s+/, $val;
5249
5250 my $rec = sprintf ":$host:44:\\%0.3o\\%0.3o", $algo, $fpt;
5251 while (my ($byte) = ($fp =~ /^(..)/) ) {
5252 $rec .= sprintf "\\%0.3o", hex($byte);
5253 $fp =~ s/^..//;
5254 }
5255 print $datafile "$rec:$ttl:$stamp:$loc\n";
5256
5257 } else {
5258 # raw record. we don't know what's in here, so we ASS-U-ME the user has
5259 # put it in correctly, since either the user is messing directly with the
5260 # database, or the record was imported via AXFR
5261 # <split by char>
5262 # convert anything not a-zA-Z0-9.- to octal coding
5263
5264##fixme: add flag to export "unknown" record types - note we'll probably end up
5265# mangling them since they were written to the DB from Net::DNS::RR::<type>->rdatastr.
5266 #print $datafile ":$host:$type:$val:$ttl:$stamp:$loc\n";
5267
5268 } # record type if-else
5269
5270} # end _printrec_tiny()
5271
5272
5273## DNSDB::mailNotify()
5274# Sends notification mail to recipients regarding a DNSDB operation
5275sub mailNotify {
5276 my $dbh = shift;
5277 my ($subj,$message) = @_;
5278
5279 return if $config{mailhost} eq 'smtp.example.com'; # do nothing if still using default SMTP host.
5280
5281 my $mailer = Net::SMTP->new($config{mailhost}, Hello => "dnsadmin.$config{domain}");
5282
5283 my $mailsender = ($config{mailsender} ? $config{mailsender} : $config{mailnotify});
5284
5285 $mailer->mail($mailsender);
5286 $mailer->to($config{mailnotify});
5287 $mailer->data("From: \"$config{mailname}\" <$mailsender>\n",
5288 "To: <$config{mailnotify}>\n",
5289 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
5290 "Subject: $subj\n",
5291 "X-Mailer: DNSAdmin Notify v".sprintf("%.1d",$DNSDB::VERSION)."\n",
5292 "Organization: $config{orgname}\n",
5293 "\n$message\n");
5294 $mailer->quit;
5295}
5296
5297# shut Perl up
52981;
Note: See TracBrowser for help on using the repository browser.