source: branches/stable/DNSDB.pm@ 701

Last change on this file since 701 was 696, checked in by Kris Deugau, 9 years ago

/branches/stable

Now we need to get the versioning right so DNSDB.pm isn't mangled fresh
out of the tarball.

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