source: trunk/DNSDB.pm@ 437

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

/trunk

Fix bug in AXFR import (couldn't import as inactive)
Extend AXFR import to allow overriding TTLs. Note this is all-or-nothing.

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