source: trunk/DNSDB.pm@ 372

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

/trunk

Checkpoint adding location/view support. See #10.

  • minor location list template tweak
  • extend importer to deal with locations on records, and location definitions
  • extend exporter to handle locations

Also:

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