source: trunk/DNSDB.pm@ 409

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

/trunk

Copy munging of "state"/"status" from addDomain() to addUser() for consistency

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