source: trunk/DNSDB.pm@ 283

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

/trunk

Convert zone status change logging to DNSDB-internal. See #35
Add a global for holding general result messages for subs that
return booleans. This allows us to easily display the same text
as was added to the log.
Fix docucomment on mailNotify(); it (still!) referred to its
copy-paste parent in the IP Database.

  • Property svn:keywords set to Date Rev Author Id
File size: 111.4 KB
Line 
1# dns/trunk/DNSDB.pm
2# Abstraction functions for DNS administration
3##
4# $Id: DNSDB.pm 283 2012-03-22 20:12:32Z kdeugau $
5# Copyright 2008-2011 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 vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
33
34$VERSION = 0.1; ##VERSION##
35@ISA = qw(Exporter);
36@EXPORT_OK = qw(
37 &initGlobals &login &initActionLog
38 &initPermissions &getPermissions &changePermissions &comparePermissions
39 &changeGroup
40 &loadConfig &connectDB &finish
41 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
42 &getZoneCount &getZoneList
43 &addGroup &delGroup &getChildren &groupName
44 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
45 &getSOA &updateSOA &getRecLine &getDomRecs &getRecCount
46 &addRec &updateRec &delRec
47 &getTypelist
48 &parentID
49 &isParent
50 &zoneStatus &importAXFR
51 &export
52 &mailNotify
53 %typemap %reverse_typemap %config
54 %permissions @permtypes $permlist
55 );
56
57@EXPORT = (); # Export nothing by default.
58%EXPORT_TAGS = ( ALL => [qw(
59 &initGlobals &login &initActionLog
60 &initPermissions &getPermissions &changePermissions &comparePermissions
61 &changeGroup
62 &loadConfig &connectDB &finish
63 &addDomain &delZone &domainName &revName &domainID &revID &addRDNS
64 &getZoneCount &getZoneList
65 &addGroup &delGroup &getChildren &groupName
66 &addUser &updateUser &delUser &userFullName &userStatus &getUserData
67 &getSOA &updateSOA &getRecLine &getDomRecs &getRecCount
68 &addRec &updateRec &delRec
69 &getTypelist
70 &parentID
71 &isParent
72 &zoneStatus &importAXFR
73 &export
74 &mailNotify
75 %typemap %reverse_typemap %config
76 %permissions @permtypes $permlist
77 )]
78 );
79
80our $group = 1;
81our $errstr = '';
82our $resultstr = '';
83
84# Halfway sane defaults for SOA, TTL, etc.
85# serial defaults to 0 for convenience.
86# value will be either YYYYMMDDNN for BIND/etc, or auto-internal for tinydns
87our %def = qw (
88 contact hostmaster.DOMAIN
89 prins ns1.myserver.com
90 serial 0
91 soattl 86400
92 refresh 10800
93 retry 3600
94 expire 604800
95 minttl 10800
96 ttl 10800
97);
98
99# Arguably defined wholly in the db, but little reason to change without supporting code changes
100our @permtypes = qw (
101 group_edit group_create group_delete
102 user_edit user_create user_delete
103 domain_edit domain_create domain_delete
104 record_edit record_create record_delete
105 self_edit admin
106);
107our $permlist = join(',',@permtypes);
108
109# DNS record type map and reverse map.
110# loaded from the database, from http://www.iana.org/assignments/dns-parameters
111our %typemap;
112our %reverse_typemap;
113
114our %permissions;
115
116# Prepopulate a basic config. Note some of these *will* cause errors if left unset.
117# note: add appropriate stanzas in loadConfig to parse these
118our %config = (
119 # Database connection info
120 dbname => 'dnsdb',
121 dbuser => 'dnsdb',
122 dbpass => 'secret',
123 dbhost => '',
124
125 # Email notice settings
126 mailhost => 'smtp.example.com',
127 mailnotify => 'dnsdb@example.com', # to
128 mailsender => 'dnsdb@example.com', # from
129 mailname => 'DNS Administration',
130 orgname => 'Example Corp',
131 domain => 'example.com',
132
133 # Template directory
134 templatedir => 'templates/',
135# fmeh. this is a real web path, not a logical internal one. hm..
136# cssdir => 'templates/',
137 sessiondir => 'session/',
138
139 # Session params
140 timeout => '3600', # 1 hour default
141
142 # Other miscellanea
143 log_failures => 1, # log all evarthing by default
144 perpage => 15,
145 );
146
147## (Semi)private variables
148
149# Hash of functions for validating record types. Filled in initGlobals() since
150# it relies on visibility flags from the rectypes table in the DB
151my %validators;
152
153# Username, full name, ID - mainly for logging
154my %userdata;
155
156
157##
158## utility functions
159##
160
161## DNSDB::_rectable()
162# Takes default+rdns flags, returns appropriate table name
163sub _rectable {
164 my $def = shift;
165 my $rev = shift;
166
167 return 'records' if $def ne 'y';
168 return 'default_records' if $rev ne 'y';
169 return 'default_rev_records';
170} # end _rectable()
171
172## DNSDB::_recparent()
173# Takes default+rdns flags, returns appropriate parent-id column name
174sub _recparent {
175 my $def = shift;
176 my $rev = shift;
177
178 return 'group_id' if $def eq 'y';
179 return 'rdns_id' if $rev eq 'y';
180 return 'domain_id';
181} # end _recparent()
182
183## DNSDB::_ipparent()
184# Check an IP to be added in a reverse zone to see if it's really in the requested parent.
185# Takes a database handle, default and reverse flags, IP (fragment) to check, parent zone ID,
186# and a reference to a NetAddr::IP object (also used to pass back a fully-reconstructed IP for
187# database insertion)
188sub _ipparent {
189 my $dbh = shift;
190 my $defrec = shift;
191 my $revrec = shift;
192 my $val = shift;
193 my $id = shift;
194 my $addr = shift;
195
196 return if $revrec ne 'y'; # this sub not useful in forward zones
197
198 $$addr = NetAddr::IP->new($$val); #necessary?
199
200 # subsub to split, reverse, and overlay an IP fragment on a netblock
201 sub __rev_overlay {
202 my $splitme = shift; # ':' or '.', m'lud?
203 my $parnet = shift;
204 my $val = shift;
205 my $addr = shift;
206
207 my $joinme = $splitme;
208 $splitme = '\.' if $splitme eq '.';
209 my @working = reverse(split($splitme, $parnet->addr));
210 my @parts = reverse(split($splitme, $$val));
211 for (my $i = 0; $i <= $#parts; $i++) {
212 $working[$i] = $parts[$i];
213 }
214 my $checkme = NetAddr::IP->new(join($joinme, reverse(@working))) or return 0;
215 return 0 unless $checkme->within($parnet);
216 $$addr = $checkme; # force "correct" IP to be recorded.
217 return 1;
218 }
219
220 my ($parstr) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id = ?", undef, ($id));
221 my $parnet = NetAddr::IP->new($parstr);
222
223 # Fail early on v6-in-v4 or v4-in-v6. We're not accepting these ATM.
224 return 0 if $parnet->addr =~ /\./ && $$val =~ /:/;
225 return 0 if $parnet->addr =~ /:/ && $$val =~ /\./;
226
227 if ($$addr && $$val =~ /^[\da-fA-F][\da-fA-F:]+[\da-fA-F]$/) {
228 # the only case where NetAddr::IP's acceptance of legitimate IPs is "correct" is for a proper IPv6 address.
229 # the rest we have to restructure before fiddling. *sigh*
230 return 1 if $$addr->within($parnet);
231 } else {
232 # We don't have a complete IP in $$val (yet)
233 if ($parnet->addr =~ /:/) {
234 $$val =~ s/^:+//; # gotta strip'em all...
235 return __rev_overlay(':', $parnet, $val, $addr);
236 }
237 if ($parnet->addr =~ /\./) {
238 $$val =~ s/^\.+//;
239 return __rev_overlay('.', $parnet, $val, $addr);
240 }
241 # should be impossible to get here...
242 }
243 # ... and here.
244 # can't do nuttin' in forward zones
245} # end _ipparent()
246
247## DNSDB::_hostparent()
248# A little different than _ipparent above; this tries to *find* the parent zone of a hostname
249# Takes a database handle and hostname.
250# Returns the domain ID of the parent domain if one was found.
251sub _hostparent {
252 my $dbh = shift;
253 my $hname = shift;
254
255 my @hostbits = split /\./, $hname;
256 my $sth = $dbh->prepare("SELECT count(*),domain_id FROM domains WHERE domain = ? GROUP BY domain_id");
257 foreach (@hostbits) {
258 $sth->execute($hname);
259 my ($found, $parid) = $sth->fetchrow_array;
260 if ($found) {
261 return $parid;
262 }
263 $hname =~ s/^$_\.//;
264 }
265} # end _hostparent()
266
267## DNSDB::_log()
268# Log an action
269# Takes a database handle and log entry hash containing at least:
270# group_id, log entry
271# and optionally one or more of:
272# domain_id, rdns_id
273# The %userdata hash provides the user ID, username, and fullname
274sub _log {
275 my $dbh = shift;
276
277 my %args = @_;
278
279 $args{rdns_id} = 0 if !$args{rdns_id};
280 $args{domain_id} = 0 if !$args{domain_id};
281
282##fixme: farm out the actual logging to different subs for file, syslog, internal, etc based on config
283# if ($config{log_channel} eq 'sql') {
284 $dbh->do("INSERT INTO log (domain_id,rdns_id,group_id,entry,user_id,email,name) VALUES (?,?,?,?,?,?,?)",
285 undef,
286 ($args{domain_id}, $args{rdns_id}, $args{group_id}, $args{entry},
287 $userdata{userid}, $userdata{username}, $userdata{fullname}) );
288# } elsif ($config{log_channel} eq 'file') {
289# } elsif ($config{log_channel} eq 'syslog') {
290# }
291} # end _log
292
293
294##
295## Record validation subs.
296##
297
298## All of these subs take substantially the same arguments:
299# a database handle
300# a hash containing at least the following keys:
301# - defrec (default/live flag)
302# - revrec (forward/reverse flag)
303# - id (parent entity ID)
304# - host (hostname)
305# - rectype
306# - val (IP, hostname [CNAME/MX/SRV] or text)
307# - addr (NetAddr::IP object from val. May be undef.)
308# MX and SRV record validation also expect distance, and SRV records expect weight and port as well.
309# host, rectype, and addr should be references as these may be modified in validation
310
311# A record
312sub _validate_1 {
313 my $dbh = shift;
314
315 my %args = @_;
316
317 return ('FAIL', 'Reverse zones cannot contain A records') if $args{revrec} eq 'y';
318
319 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
320 # or the intended parent domain for live records.
321 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
322 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
323
324 # Check IP is well-formed, and that it's a v4 address
325 # Fail on "compact" IPv4 variants, because they are not consistent and predictable.
326 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv4 address")
327 unless ${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/;
328 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv4 address")
329 unless $args{addr} && !$args{addr}->{isv6};
330 # coerce IP/value to normalized form for storage
331 ${$args{val}} = $args{addr}->addr;
332
333 return ('OK','OK');
334} # done A record
335
336# NS record
337sub _validate_2 {
338 my $dbh = shift;
339
340 my %args = @_;
341
342 # Coerce the hostname to "DOMAIN" for forward default records, "ZONE" for reverse default records,
343 # or the intended parent zone for live records.
344##fixme: allow for delegating <subdomain>.DOMAIN?
345 if ($args{revrec} eq 'y') {
346 my $pname = ($args{defrec} eq 'y' ? 'ZONE' : revName($dbh,$args{id}));
347 ${$args{host}} = $pname if ${$args{host}} ne $pname;
348 } else {
349 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
350 ${$args{host}} = $pname if ${$args{host}} ne $pname;
351 }
352
353# Let this lie for now. Needs more magic.
354# # Check IP is well-formed, and that it's a v4 address
355# return ('FAIL',"A record must be a valid IPv4 address")
356# unless $addr && !$addr->{isv6};
357# # coerce IP/value to normalized form for storage
358# $$val = $addr->addr;
359
360 return ('OK','OK');
361} # done NS record
362
363# CNAME record
364sub _validate_5 {
365 my $dbh = shift;
366
367 my %args = @_;
368
369# Not really true, but these are only useful for delegating smaller-than-/24 IP blocks.
370# This is fundamentally a messy operation and should really just be taken care of by the
371# export process, not manual maintenance of the necessary records.
372 return ('FAIL', 'Reverse zones cannot contain CNAME records') if $args{revrec} eq 'y';
373
374 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
375 # or the intended parent domain for live records.
376 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
377 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
378
379 return ('OK','OK');
380} # done CNAME record
381
382# SOA record
383sub _validate_6 {
384 # Smart monkeys won't stick their fingers in here; we have
385 # separate dedicated routines to deal with SOA records.
386 return ('OK','OK');
387} # done SOA record
388
389# PTR record
390sub _validate_12 {
391 my $dbh = shift;
392
393 my %args = @_;
394
395 if ($args{revrec} eq 'y') {
396 if ($args{defrec} eq 'n') {
397 return ('FAIL', "IP or IP fragment ${$args{val}} is not within ".revName($dbh, $args{id}))
398 unless _ipparent($dbh, $args{defrec}, $args{revrec}, $args{val}, $args{id}, \$args{addr});
399 ${$args{val}} = $args{addr}->addr;
400 } else {
401 if (${$args{val}} =~ /\./) {
402 # looks like a v4 or fragment
403 if (${$args{val}} =~ /^\d+\.\d+\.\d+\.\d+$/) {
404 # woo! a complete IP! validate it and normalize, or fail.
405 $args{addr} = NetAddr::IP->new(${$args{val}})
406 or return ('FAIL', "IP/value looks like IPv4 but isn't valid");
407 ${$args{val}} = $args{addr}->addr;
408 } else {
409 ${$args{val}} =~ s/^\.*/ZONE./ unless ${$args{val}} =~ /^ZONE/;
410 }
411 } elsif (${$args{val}} =~ /[a-f:]/) {
412 # looks like a v6 or fragment
413 ${$args{val}} =~ s/^:*/ZONE::/ if !$args{addr} && ${$args{val}} !~ /^ZONE/;
414 if ($args{addr}) {
415 if ($args{addr}->addr =~ /^0/) {
416 ${$args{val}} =~ s/^:*/ZONE::/ unless ${$args{val}} =~ /^ZONE/;
417 } else {
418 ${$args{val}} = $args{addr}->addr;
419 }
420 }
421 } else {
422 # bare number (probably). These could be v4 or v6, so we'll
423 # expand on these on creation of a reverse zone.
424 ${$args{val}} = "ZONE,${$args{val}}" unless ${$args{val}} =~ /^ZONE/;
425 }
426 ${$args{host}} =~ s/\.*$/\.$config{domain}/ if ${$args{host}} !~ /(?:$config{domain}|ADMINDOMAIN)$/;
427 }
428
429# Multiple PTR records do NOT generally do what most people believe they do,
430# and tend to fail in the most awkward way possible. Check and warn.
431# We use $val instead of $addr->addr since we may be in a defrec, and may have eg "ZONE::42" or "ZONE.12"
432
433 my @checkvals = (${$args{val}});
434 if (${$args{val}} =~ /,/) {
435 # push . and :: variants into checkvals if val has ,
436 my $tmp;
437 ($tmp = ${$args{val}}) =~ s/,/./;
438 push @checkvals, $tmp;
439 ($tmp = ${$args{val}}) =~ s/,/::/;
440 push @checkvals, $tmp;
441 }
442 my $pcsth = $dbh->prepare("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec})." WHERE val = ?");
443 foreach my $checkme (@checkvals) {
444 if ($args{update}) {
445 # Record update. There should usually be an existing PTR (the record being updated)
446 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
447 " WHERE val = ?", undef, ($checkme)) };
448 return ('WARN', "PTR record for $checkme already exists; adding another will probably not do what you want")
449 if @ptrs && (!grep /^$args{update}$/, @ptrs);
450 } else {
451 # New record. Always warn if a PTR exists
452 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
453 " WHERE val = ?", undef, ($checkme));
454 return ('WARN', "PTR record for $checkme already exists; adding another will probably not do what you want")
455 if $ptrcount;
456 }
457 }
458
459 } else {
460 # Not absolutely true but only useful if you hack things up for sub-/24 v4 reverse delegations
461 # Simpler to just create the reverse zone and grant access for the customer to edit it, and create direct
462 # PTR records on export
463 return ('FAIL',"Forward zones cannot contain PTR records");
464 }
465
466 return ('OK','OK');
467} # done PTR record
468
469# MX record
470sub _validate_15 {
471 my $dbh = shift;
472
473 my %args = @_;
474
475# Not absolutely true but WTF use is an MX record for a reverse zone?
476 return ('FAIL', 'Reverse zones cannot contain MX records') if $args{revrec} eq 'y';
477
478 return ('FAIL', "Distance is required for MX records") unless defined(${$args{dist}});
479 ${$args{dist}} =~ s/\s*//g;
480 return ('FAIL',"Distance is required, and must be numeric") unless ${$args{dist}} =~ /^\d+$/;
481
482 ${$args{fields}} = "distance,";
483 push @{$args{vallist}}, ${$args{dist}};
484
485 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
486 # or the intended parent domain for live records.
487 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
488 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
489
490# hmm.. this might work. except possibly for something pointing to "deadbeef.ca". <g>
491# if ($type == $reverse_typemap{NS} || $type == $reverse_typemap{MX} || $type == $reverse_typemap{SRV}) {
492# if ($val =~ /^\s*[\da-f:.]+\s*$/) {
493# return ('FAIL',"$val is not a valid IP address") if !$addr;
494# }
495# }
496
497 return ('OK','OK');
498} # done MX record
499
500# TXT record
501sub _validate_16 {
502 # Could arguably put a WARN return here on very long (>512) records
503 return ('OK','OK');
504} # done TXT record
505
506# RP record
507sub _validate_17 {
508 # Probably have to validate these some day
509 return ('OK','OK');
510} # done RP record
511
512# AAAA record
513sub _validate_28 {
514 my $dbh = shift;
515
516 my %args = @_;
517
518 return ('FAIL', 'Reverse zones cannot contain AAAA records') if $args{revrec} eq 'y';
519
520 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
521 # or the intended parent domain for live records.
522 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
523 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
524
525 # Check IP is well-formed, and that it's a v6 address
526 return ('FAIL',"$typemap{${$args{rectype}}} record must be a valid IPv6 address")
527 unless $args{addr} && $args{addr}->{isv6};
528 # coerce IP/value to normalized form for storage
529 ${$args{val}} = $args{addr}->addr;
530
531 return ('OK','OK');
532} # done AAAA record
533
534# SRV record
535sub _validate_33 {
536 my $dbh = shift;
537
538 my %args = @_;
539
540# Not absolutely true but WTF use is an SRV record for a reverse zone?
541 return ('FAIL', 'Reverse zones cannot contain SRV records') if $args{revrec} eq 'y';
542
543 return ('FAIL', "Distance is required for SRV records") unless defined(${$args{dist}});
544 ${$args{dist}} =~ s/\s*//g;
545 return ('FAIL',"Distance is required, and must be numeric") unless ${$args{dist}} =~ /^\d+$/;
546
547 return ('FAIL',"SRV records must begin with _service._protocol [${$args{host}}]")
548 unless ${$args{host}} =~ /^_[A-Za-z]+\._[A-Za-z]+\.[a-zA-Z0-9-]+/;
549 return ('FAIL',"Port and weight are required for SRV records")
550 unless defined(${$args{weight}}) && defined(${$args{port}});
551 ${$args{weight}} =~ s/\s*//g;
552 ${$args{port}} =~ s/\s*//g;
553
554 return ('FAIL',"Port and weight are required, and must be numeric")
555 unless ${$args{weight}} =~ /^\d+$/ && ${$args{port}} =~ /^\d+$/;
556
557 ${$args{fields}} = "distance,weight,port,";
558 push @{$args{vallist}}, (${$args{dist}}, ${$args{weight}}, ${$args{port}});
559
560 # Coerce all hostnames to end in ".DOMAIN" for group/default records,
561 # or the intended parent domain for live records.
562 my $pname = ($args{defrec} eq 'y' ? 'DOMAIN' : domainName($dbh,$args{id}));
563 ${$args{host}} =~ s/\.*$/\.$pname/ if ${$args{host}} !~ /$pname$/;
564
565 return ('OK','OK');
566} # done SRV record
567
568# Now the custom types
569
570# A+PTR record. With a very little bit of magic we can also use this sub to validate AAAA+PTR. Whee!
571sub _validate_65280 {
572 my $dbh = shift;
573
574 my %args = @_;
575
576 my $code = 'OK';
577 my $msg = 'OK';
578
579 if ($args{defrec} eq 'n') {
580 # live record; revrec determines whether we validate the PTR or A component first.
581
582 if ($args{revrec} eq 'y') {
583 ($code,$msg) = _validate_12($dbh, %args);
584 return ($code,$msg) if $code eq 'FAIL';
585
586 # Check if the reqested domain exists. If not, coerce the type down to PTR and warn.
587 if (!(${$args{domid}} = _hostparent($dbh, ${$args{host}}))) {
588 my $addmsg = "Record ".($args{update} ? 'updated' : 'added').
589 " as PTR instead of $typemap{${$args{rectype}}}; domain not found for ${$args{host}}";
590 $msg .= "\n$addmsg" if $code eq 'WARN';
591 $msg = $addmsg if $code eq 'OK';
592 ${$args{rectype}} = $reverse_typemap{PTR};
593 return ('WARN', $msg);
594 }
595
596 # Add domain ID to field list and values
597 ${$args{fields}} .= "domain_id,";
598 push @{$args{vallist}}, ${$args{domid}};
599
600 } else {
601 ($code,$msg) = _validate_1($dbh, %args) if ${$args{rectype}} == 65280;
602 ($code,$msg) = _validate_28($dbh, %args) if ${$args{rectype}} == 65281;
603 return ($code,$msg) if $code eq 'FAIL';
604
605 # Check if the requested reverse zone exists - note, an IP fragment won't
606 # work here since we don't *know* which parent to put it in.
607 # ${$args{val}} has been validated as a valid IP by now, in one of the above calls.
608 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet >> ?".
609 " ORDER BY masklen(revnet) DESC", undef, (${$args{val}}));
610 if (!$revid) {
611 $msg = "Record ".($args{update} ? 'updated' : 'added')." as ".(${$args{rectype}} == 65280 ? 'A' : 'AAAA').
612 " instead of $typemap{${$args{rectype}}}; reverse zone not found for ${$args{val}}";
613 ${$args{rectype}} = (${$args{rectype}} == 65280 ? $reverse_typemap{A} : $reverse_typemap{AAAA});
614 return ('WARN', $msg);
615 }
616
617 # Check for duplicate PTRs. Note we don't have to play games with $code and $msg, because
618 # by definition there can't be duplicate PTRs if the reverse zone isn't managed here.
619 if ($args{update}) {
620 # Record update. There should usually be an existing PTR (the record being updated)
621 my @ptrs = @{ $dbh->selectcol_arrayref("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
622 " WHERE val = ?", undef, (${$args{val}})) };
623 if (@ptrs && (!grep /^$args{update}$/, @ptrs)) {
624 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want";
625 $code = 'WARN';
626 }
627 } else {
628 # New record. Always warn if a PTR exists
629 my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
630 " WHERE val = ?", undef, (${$args{val}}));
631 $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want"
632 if $ptrcount;
633 $code = 'WARN' if $ptrcount;
634 }
635
636# my ($ptrcount) = $dbh->selectrow_array("SELECT count(*) FROM "._rectable($args{defrec},$args{revrec}).
637# " WHERE val = ?", undef, ${$args{val}});
638# if ($ptrcount) {
639# my $curid = $dbh->selectrow_array("SELECT record_id FROM "._rectable($args{defrec},$args{revrec}).
640# " WHERE val = ?
641# $msg = "PTR record for ${$args{val}} already exists; adding another will probably not do what you want";
642# $code = 'WARN';
643# }
644
645 ${$args{fields}} .= "rdns_id,";
646 push @{$args{vallist}}, $revid;
647 }
648
649 } else { # defrec eq 'y'
650 if ($args{revrec} eq 'y') {
651 ($code,$msg) = _validate_12($dbh, %args);
652 return ($code,$msg) if $code eq 'FAIL';
653 if (${$args{rectype}} == 65280) {
654 return ('FAIL',"A+PTR record must be a valid IPv4 address or fragment")
655 if ${$args{val}} =~ /:/;
656 ${$args{val}} =~ s/^ZONE,/ZONE./; # Clean up after uncertain IP-fragment-type from _validate_12
657 } elsif (${$args{rectype}} == 65281) {
658 return ('FAIL',"AAAA+PTR record must be a valid IPv6 address or fragment")
659 if ${$args{val}} =~ /\./;
660 ${$args{val}} =~ s/^ZONE,/ZONE::/; # Clean up after uncertain IP-fragment-type from _validate_12
661 }
662 } else {
663 # This is easy. I also can't see a real use-case for A/AAAA+PTR in *all* forward
664 # domains, since you wouldn't be able to substitute both domain and reverse zone
665 # sanely, and you'd end up with guaranteed over-replicated PTR records that would
666 # confuse the hell out of pretty much anything that uses them.
667##fixme: make this a config flag?
668 return ('FAIL', "$typemap{${$args{rectype}}} records not allowed in default domains");
669 }
670 }
671
672 return ($code, $msg);
673} # done A+PTR record
674
675# AAAA+PTR record
676# A+PTR above has been magicked to handle AAAA+PTR as well.
677sub _validate_65281 {
678 return _validate_65280(@_);
679} # done AAAA+PTR record
680
681# PTR template record
682sub _validate_65282 {
683 return ('OK','OK');
684} # done PTR template record
685
686# A+PTR template record
687sub _validate_65283 {
688 return ('OK','OK');
689} # done AAAA+PTR template record
690
691# AAAA+PTR template record
692sub _validate_65284 {
693 return ('OK','OK');
694} # done AAAA+PTR template record
695
696
697##
698## Record data substitution subs
699##
700
701# Replace ZONE in hostname
702sub _ZONE {
703 my $zone = shift;
704 my $string = shift;
705 my $fr = shift || 'f'; # flag for forward/reverse order? nb: ignored for IP
706
707 my $prefix = $zone->network->addr; # Just In Case someone managed to slip in
708 # a funky subnet that had host bits set.
709
710 $string =~ s/,/./ if !$zone->{isv6};
711 $string =~ s/,/::/ if $zone->{isv6};
712
713# if ($zone->{isv6} && ($zone->masklen % 4) != 0) {
714# # grumpyfail, non-nibble zone. shouldn't happen
715# return;
716# }
717
718 # Subbing ZONE in the host. We need to properly ID the netblock range
719 # The subbed text should have "network IP with trailing zeros stripped" for
720 # blocks lined up on octet (for v4) or 16-bit (for v6) boundaries
721 # For blocks that do NOT line up on these boundaries, we tack on an extra "-0",
722 # then take the most significant octet or 16-bit chunk of the "broadcast" IP and
723 # append it after a double-dash
724 # ie:
725 # 8.0.0.0/6 -> 8.0.0.0 -> 11.255.255.255; sub should be 8--11
726 # 10.0.0.0/12 -> 10.0.0.0 -> 10.0.0.0 -> 10.15.255.255; sub should be 10-0--15
727 # 192.168.4.0/22 -> 192.168.4.0 -> 192.168.7.255; sub should be 192-168-4--7
728 # 192.168.0.8/29 -> 192.168.0.8 -> 192.168.0.15; sub should be 192-168-0-8--15
729 # Similar for v6
730 if (!$zone->{isv6}) {
731 my $bc = $zone->broadcast->addr;
732 if ($zone->masklen > 24) {
733 $bc =~ s/^\d+\.\d+\.\d+\.//;
734 } elsif ($zone->masklen > 16) {
735 $prefix =~ s/\.0$//;
736 $bc =~ s/^\d+\.\d+\.//;
737 } elsif ($zone->masklen > 8) {
738 $bc =~ s/^\d+\.//;
739 $prefix =~ s/\.0\.0$//;
740 } else {
741 $prefix =~ s/\.0\.0\.0$//;
742 }
743 if ($zone->masklen % 8) {
744 $bc =~ s/(\.255)+$//;
745 $prefix .= "--$bc"; #"--".zone->masklen; # use range or mask length?
746 }
747 } else {
748 if (($zone->masklen % 16) != 0) {
749 # Strip trailing :0 off $prefix, and :ffff off the broadcast IP
750 # Strip the leading 16-bit chunks off the front of the broadcast IP
751 # Append the remaining 16-bit chunk to the prefix after "--"
752 my $bc = $zone->broadcast->addr;
753 for (my $i=0; $i<(7-int($zone->masklen / 16)); $i++) {
754 $prefix =~ s/:0$//;
755 $bc =~ s/:ffff$//;
756 }
757 $bc =~ s/^([a-f0-9]+:)+//;
758 $prefix .= "--$bc";
759 } else {
760 # Strip off :0 from the end until we reach the netblock length.
761 for (my $i=0; $i<(8-$zone->masklen / 16); $i++) {
762 $prefix =~ s/:0$//;
763 }
764 }
765 }
766
767 # Replace . and : with -
768 # If flagged for reverse-order, split on . or :, reverse, and join with -
769 if ($fr eq 'f') {
770 $prefix =~ s/[:.]+/-/g;
771 } else {
772 $prefix = join('-', reverse(split(/[:.]/, $prefix)));
773 }
774 $string =~ s/ZONE/$prefix/;
775# }
776 return $string;
777} # done _ZONE
778
779
780
781##
782## Initialization and cleanup subs
783##
784
785
786## DNSDB::loadConfig()
787# Load the minimum required initial state (DB connect info) from a config file
788# Load misc other bits while we're at it.
789# Takes an optional basename and config path to look for
790# Populates the %config and %def hashes
791sub loadConfig {
792 my $basename = shift || ''; # this will work OK
793##fixme $basename isn't doing what I think I thought I was trying to do.
794
795 my $deferr = ''; # place to put error from default config file in case we can't find either one
796
797 my $configroot = "/etc/dnsdb"; ##CFG_LEAF##
798 $configroot = '' if $basename =~ m|^/|;
799 $basename .= ".conf" if $basename !~ /\.conf$/;
800 my $defconfig = "$configroot/dnsdb.conf";
801 my $siteconfig = "$configroot/$basename";
802
803 # System defaults
804 __cfgload("$defconfig") or $deferr = $errstr;
805
806 # Per-site-ish settings.
807 if ($basename ne '.conf') {
808 unless (__cfgload("$siteconfig")) {
809 $errstr = ($deferr ? "Error opening default config file $defconfig: $deferr\n" : '').
810 "Error opening site config file $siteconfig";
811 return;
812 }
813 }
814
815 # Munge log_failures.
816 if ($config{log_failures} ne '1' && $config{log_failures} ne '0') {
817 # true/false, on/off, yes/no all valid.
818 if ($config{log_failures} =~ /^(?:true|false|on|off|yes|no)$/) {
819 if ($config{log_failures} =~ /(?:true|on|yes)/) {
820 $config{log_failures} = 1;
821 } else {
822 $config{log_failures} = 0;
823 }
824 } else {
825 $errstr = "Bad log_failures setting $config{log_failures}";
826 $config{log_failures} = 1;
827 # Bad setting shouldn't be fatal.
828 # return 2;
829 }
830 }
831
832 # All good, clear the error and go home.
833 $errstr = '';
834 return 1;
835} # end loadConfig()
836
837
838## DNSDB::__cfgload()
839# Private sub to parse a config file and load it into %config
840# Takes a file handle on an open config file
841sub __cfgload {
842 $errstr = '';
843 my $cfgfile = shift;
844
845 if (open CFG, "<$cfgfile") {
846 while (<CFG>) {
847 chomp;
848 s/^\s*//;
849 next if /^#/;
850 next if /^$/;
851# hmm. more complex bits in this file might require [heading] headers, maybe?
852# $mode = $1 if /^\[(a-z)+]/;
853 # DB connect info
854 $config{dbname} = $1 if /^dbname\s*=\s*([a-z0-9_.-]+)/i;
855 $config{dbuser} = $1 if /^dbuser\s*=\s*([a-z0-9_.-]+)/i;
856 $config{dbpass} = $1 if /^dbpass\s*=\s*([a-z0-9_.-]+)/i;
857 $config{dbhost} = $1 if /^dbhost\s*=\s*([a-z0-9_.-]+)/i;
858 # SOA defaults
859 $def{contact} = $1 if /^contact\s*=\s*([a-z0-9_.-]+)/i;
860 $def{prins} = $1 if /^prins\s*=\s*([a-z0-9_.-]+)/i;
861 $def{soattl} = $1 if /^soattl\s*=\s*(\d+)/i;
862 $def{refresh} = $1 if /^refresh\s*=\s*(\d+)/i;
863 $def{retry} = $1 if /^retry\s*=\s*(\d+)/i;
864 $def{expire} = $1 if /^expire\s*=\s*(\d+)/i;
865 $def{minttl} = $1 if /^minttl\s*=\s*(\d+)/i;
866 $def{ttl} = $1 if /^ttl\s*=\s*(\d+)/i;
867 # Mail settings
868 $config{mailhost} = $1 if /^mailhost\s*=\s*([a-z0-9_.-]+)/i;
869 $config{mailnotify} = $1 if /^mailnotify\s*=\s*([a-z0-9_.\@-]+)/i;
870 $config{mailsender} = $1 if /^mailsender\s*=\s*([a-z0-9_.\@-]+)/i;
871 $config{mailname} = $1 if /^mailname\s*=\s*([a-z0-9\s_.-]+)/i;
872 $config{orgname} = $1 if /^orgname\s*=\s*([a-z0-9\s_.,'-]+)/i;
873 $config{domain} = $1 if /^domain\s*=\s*([a-z0-9_.-]+)/i;
874 # session - note this is fed directly to CGI::Session
875 $config{timeout} = $1 if /^[tT][iI][mM][eE][oO][uU][tT]\s*=\s*(\d+[smhdwMy]?)/;
876 $config{sessiondir} = $1 if m{^sessiondir\s*=\s*([a-z0-9/_.-]+)}i;
877 # misc
878 $config{log_failures} = $1 if /^log_failures\s*=\s*([a-z01]+)/i;
879 $config{perpage} = $1 if /^perpage\s*=\s*(\d+)/i;
880 }
881 close CFG;
882 } else {
883 $errstr = $!;
884 return;
885 }
886 return 1;
887} # end __cfgload()
888
889
890## DNSDB::connectDB()
891# Creates connection to DNS database.
892# Requires the database name, username, and password.
893# Returns a handle to the db.
894# Set up for a PostgreSQL db; could be any transactional DBMS with the
895# right changes.
896sub connectDB {
897 $errstr = '';
898 my $dbname = shift;
899 my $user = shift;
900 my $pass = shift;
901 my $dbh;
902 my $DSN = "DBI:Pg:dbname=$dbname";
903
904 my $host = shift;
905 $DSN .= ";host=$host" if $host;
906
907# Note that we want to autocommit by default, and we will turn it off locally as necessary.
908# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
909 $dbh = DBI->connect($DSN, $user, $pass, {
910 AutoCommit => 1,
911 PrintError => 0
912 })
913 or return (undef, $DBI::errstr) if(!$dbh);
914
915##fixme: initialize the DB if we can't find the table (since, by definition, there's
916# nothing there if we can't select from it...)
917 my $tblsth = $dbh->prepare("SELECT count(*) FROM pg_catalog.pg_class WHERE relkind='r' AND relname=?");
918 my ($tblcount) = $dbh->selectrow_array($tblsth, undef, ('misc'));
919 return (undef,$DBI::errstr) if $dbh->err;
920
921#if ($tblcount == 0) {
922# # create tables one at a time, checking for each.
923# return (undef, "check table misc missing");
924#}
925
926
927# Return here if we can't select.
928# This should retrieve the dbversion key.
929 my $sth = $dbh->prepare("SELECT key,value FROM misc WHERE misc_id=1");
930 $sth->execute();
931 return (undef,$DBI::errstr) if ($sth->err);
932
933##fixme: do stuff to the DB on version mismatch
934# x.y series should upgrade on $DNSDB::VERSION > misc(key=>version)
935# DB should be downward-compatible; column defaults should give sane (if possibly
936# useless-and-needs-help) values in columns an older software stack doesn't know about.
937
938# See if the select returned anything (or null data). This should
939# succeed if the select executed, but...
940 $sth->fetchrow();
941 return (undef,$DBI::errstr) if ($sth->err);
942
943 $sth->finish;
944
945# If we get here, we should be OK.
946 return ($dbh,"DB connection OK");
947} # end connectDB
948
949
950## DNSDB::finish()
951# Cleans up after database handles and so on.
952# Requires a database handle
953sub finish {
954 my $dbh = $_[0];
955 $dbh->disconnect;
956} # end finish
957
958
959## DNSDB::initGlobals()
960# Initialize global variables
961# NB: this does NOT include web-specific session variables!
962# Requires a database handle
963sub initGlobals {
964 my $dbh = shift;
965
966# load record types from database
967 my $sth = $dbh->prepare("SELECT val,name,stdflag FROM rectypes");
968 $sth->execute;
969 while (my ($recval,$recname,$stdflag) = $sth->fetchrow_array()) {
970 $typemap{$recval} = $recname;
971 $reverse_typemap{$recname} = $recval;
972 # now we fill the record validation function hash
973 if ($stdflag < 5) {
974 my $fn = "_validate_$recval";
975 $validators{$recval} = \&$fn;
976 } else {
977 my $fn = "sub { return ('FAIL','Type $recval ($recname) not supported'); }";
978 $validators{$recval} = eval $fn;
979 }
980 }
981} # end initGlobals
982
983
984## DNSDB::login()
985# Takes a database handle, username and password
986# Returns a userdata hash (UID, GID, username, fullname parts) if username exists
987# and password matches the one on file
988# Returns undef otherwise
989sub login {
990 my $dbh = shift;
991 my $user = shift;
992 my $pass = shift;
993
994 my $userinfo = $dbh->selectrow_hashref("SELECT user_id,group_id,password,firstname,lastname FROM users WHERE username=?",
995 undef, ($user) );
996 return if !$userinfo;
997
998 if ($userinfo->{password} =~ m|^\$1\$([A-Za-z0-9/.]+)\$|) {
999 # native passwords (crypt-md5)
1000 return if $userinfo->{password} ne unix_md5_crypt($pass,$1);
1001 } elsif ($userinfo->{password} =~ /^[0-9a-f]{32}$/) {
1002 # VegaDNS import (hex-coded MD5)
1003 return if $userinfo->{password} ne md5_hex($pass);
1004 } else {
1005 # plaintext (convenient now and then)
1006 return if $userinfo->{password} ne $pass;
1007 }
1008
1009 return $userinfo;
1010} # end login()
1011
1012
1013## DNSDB::initActionLog()
1014# Set up action logging. Takes a database handle and user ID
1015# Sets some internal globals and Does The Right Thing to set up a logging channel.
1016# This sets up _log() to spew out log entries to the defined channel without worrying
1017# about having to open a file or a syslog channel
1018##fixme Need to call _initActionLog_blah() for various logging channels, configured
1019# via dnsdb.conf, in $config{log_channel} or something
1020# See https://secure.deepnet.cx/trac/dnsadmin/ticket/21
1021sub initActionLog {
1022 my $dbh = shift;
1023 my $uid = shift;
1024
1025 return if !$uid;
1026
1027 # snag user info for logging. there's got to be a way to not have to pass this back
1028 # and forth from a caller, but web usage means no persistence we can rely on from
1029 # the server side.
1030 my ($username,$fullname) = $dbh->selectrow_array("SELECT username, firstname || ' ' || lastname".
1031 " FROM users WHERE user_id=?", undef, ($uid));
1032##fixme: errors are unpossible!
1033
1034 $userdata{username} = $username;
1035 $userdata{userid} = $uid;
1036 $userdata{fullname} = $fullname;
1037
1038 # convert to real check once we have other logging channels
1039 # if ($config{log_channel} eq 'sql') {
1040 # Open Log, Sez Me!
1041 # }
1042
1043} # end initActionLog
1044
1045
1046## DNSDB::initPermissions()
1047# Set up permissions global
1048# Takes database handle and UID
1049sub initPermissions {
1050 my $dbh = shift;
1051 my $uid = shift;
1052
1053# %permissions = $(getPermissions($dbh,'user',$uid));
1054 getPermissions($dbh, 'user', $uid, \%permissions);
1055
1056} # end initPermissions()
1057
1058
1059## DNSDB::getPermissions()
1060# Get permissions from DB
1061# Requires DB handle, group or user flag, ID, and hashref.
1062sub getPermissions {
1063 my $dbh = shift;
1064 my $type = shift;
1065 my $id = shift;
1066 my $hash = shift;
1067
1068 my $sql = qq(
1069 SELECT
1070 p.admin,p.self_edit,
1071 p.group_create,p.group_edit,p.group_delete,
1072 p.user_create,p.user_edit,p.user_delete,
1073 p.domain_create,p.domain_edit,p.domain_delete,
1074 p.record_create,p.record_edit,p.record_delete
1075 FROM permissions p
1076 );
1077 if ($type eq 'group') {
1078 $sql .= qq(
1079 JOIN groups g ON g.permission_id=p.permission_id
1080 WHERE g.group_id=?
1081 );
1082 } else {
1083 $sql .= qq(
1084 JOIN users u ON u.permission_id=p.permission_id
1085 WHERE u.user_id=?
1086 );
1087 }
1088
1089 my $sth = $dbh->prepare($sql);
1090
1091 $sth->execute($id) or die "argh: ".$sth->errstr;
1092
1093# my $permref = $sth->fetchrow_hashref;
1094# return $permref;
1095# $hash = $permref;
1096# Eww. Need to learn how to forcibly drop a hashref onto an existing hash.
1097 ($hash->{admin},$hash->{self_edit},
1098 $hash->{group_create},$hash->{group_edit},$hash->{group_delete},
1099 $hash->{user_create},$hash->{user_edit},$hash->{user_delete},
1100 $hash->{domain_create},$hash->{domain_edit},$hash->{domain_delete},
1101 $hash->{record_create},$hash->{record_edit},$hash->{record_delete})
1102 = $sth->fetchrow_array;
1103
1104} # end getPermissions()
1105
1106
1107## DNSDB::changePermissions()
1108# Update an ACL entry
1109# Takes a db handle, type, owner-id, and hashref for the changed permissions.
1110sub changePermissions {
1111 my $dbh = shift;
1112 my $type = shift;
1113 my $id = shift;
1114 my $newperms = shift;
1115 my $inherit = shift || 0;
1116
1117 my $failmsg = '';
1118
1119 # see if we're switching from inherited to custom. for bonus points,
1120 # snag the permid and parent permid anyway, since we'll need the permid
1121 # to set/alter custom perms, and both if we're switching from custom to
1122 # inherited.
1123 my $sth = $dbh->prepare("SELECT (u.permission_id=g.permission_id) AS was_inherited,u.permission_id,g.permission_id".
1124 " FROM ".($type eq 'user' ? 'users' : 'groups')." u ".
1125 " JOIN groups g ON u.".($type eq 'user' ? '' : 'parent_')."group_id=g.group_id ".
1126 " WHERE u.".($type eq 'user' ? 'user' : 'group')."_id=?");
1127 $sth->execute($id);
1128
1129 my ($wasinherited,$permid,$parpermid) = $sth->fetchrow_array;
1130
1131# hack phtoui
1132# group id 1 is "special" in that it's it's own parent (err... possibly.)
1133# may make its parent id 0 which doesn't exist, and as a bonus is Perl-false.
1134 $wasinherited = 0 if ($type eq 'group' && $id == 1);
1135
1136 local $dbh->{AutoCommit} = 0;
1137 local $dbh->{RaiseError} = 1;
1138
1139 # Wrap all the SQL in a transaction
1140 eval {
1141 if ($inherit) {
1142
1143 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='t',permission_id=? ".
1144 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($parpermid, $id) );
1145 $dbh->do("DELETE FROM permissions WHERE permission_id=?", undef, ($permid) );
1146
1147 } else {
1148
1149 if ($wasinherited) { # munge new permission entry in if we're switching from inherited perms
1150##fixme: need to add semirecursive bit to properly munge inherited permission ID on subgroups and users
1151# ... if'n'when we have groups with fully inherited permissions.
1152 # SQL is coo
1153 $dbh->do("INSERT INTO permissions ($permlist,".($type eq 'user' ? 'user' : 'group')."_id) ".
1154 "SELECT $permlist,? FROM permissions WHERE permission_id=?", undef, ($id,$permid) );
1155 ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions ".
1156 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($id) );
1157 $dbh->do("UPDATE ".($type eq 'user' ? 'users' : 'groups')." SET inherit_perm='f',permission_id=? ".
1158 "WHERE ".($type eq 'user' ? 'user' : 'group')."_id=?", undef, ($permid, $id) );
1159 }
1160
1161 # and now set the permissions we were passed
1162 foreach (@permtypes) {
1163 if (defined ($newperms->{$_})) {
1164 $dbh->do("UPDATE permissions SET $_=? WHERE permission_id=?", undef, ($newperms->{$_},$permid) );
1165 }
1166 }
1167
1168 } # (inherited->)? custom
1169
1170 $dbh->commit;
1171 }; # end eval
1172 if ($@) {
1173 my $msg = $@;
1174 eval { $dbh->rollback; };
1175 return ('FAIL',"$failmsg: $msg ($permid)");
1176 } else {
1177 return ('OK',$permid);
1178 }
1179
1180} # end changePermissions()
1181
1182
1183## DNSDB::comparePermissions()
1184# Compare two permission hashes
1185# Returns '>', '<', '=', '!'
1186sub comparePermissions {
1187 my $p1 = shift;
1188 my $p2 = shift;
1189
1190 my $retval = '='; # assume equality until proven otherwise
1191
1192 no warnings "uninitialized";
1193
1194 foreach (@permtypes) {
1195 next if $p1->{$_} == $p2->{$_}; # equal is good
1196 if ($p1->{$_} && !$p2->{$_}) {
1197 if ($retval eq '<') { # if we've already found an unequal pair where
1198 $retval = '!'; # $p2 has more access, and we now find a pair
1199 last; # where $p1 has more access, the overall access
1200 } # is neither greater or lesser, it's unequal.
1201 $retval = '>';
1202 }
1203 if (!$p1->{$_} && $p2->{$_}) {
1204 if ($retval eq '>') { # if we've already found an unequal pair where
1205 $retval = '!'; # $p1 has more access, and we now find a pair
1206 last; # where $p2 has more access, the overall access
1207 } # is neither greater or lesser, it's unequal.
1208 $retval = '<';
1209 }
1210 }
1211 return $retval;
1212} # end comparePermissions()
1213
1214
1215## DNSDB::changeGroup()
1216# Change group ID of an entity
1217# Takes a database handle, entity type, entity ID, and new group ID
1218sub changeGroup {
1219 my $dbh = shift;
1220 my $type = shift;
1221 my $id = shift;
1222 my $newgrp = shift;
1223
1224##fixme: fail on not enough args
1225 #return ('FAIL', "Missing
1226
1227 if ($type eq 'domain') {
1228 $dbh->do("UPDATE domains SET group_id=? WHERE domain_id=?", undef, ($newgrp, $id))
1229 or return ('FAIL','Group change failed: '.$dbh->errstr);
1230 } elsif ($type eq 'user') {
1231 $dbh->do("UPDATE users SET group_id=? WHERE user_id=?", undef, ($newgrp, $id))
1232 or return ('FAIL','Group change failed: '.$dbh->errstr);
1233 } elsif ($type eq 'group') {
1234 $dbh->do("UPDATE groups SET parent_group_id=? WHERE group_id=?", undef, ($newgrp, $id))
1235 or return ('FAIL','Group change failed: '.$dbh->errstr);
1236 }
1237 return ('OK','OK');
1238} # end changeGroup()
1239
1240
1241##
1242## Processing subs
1243##
1244
1245## DNSDB::addDomain()
1246# Add a domain
1247# Takes a database handle, domain name, numeric group, boolean(ish) state (active/inactive),
1248# and user info hash (for logging).
1249# Returns a status code and message
1250sub addDomain {
1251 $errstr = '';
1252 my $dbh = shift;
1253 return ('FAIL',"Need database handle") if !$dbh;
1254 my $domain = shift;
1255 return ('FAIL',"Domain must not be blank") if !$domain;
1256 my $group = shift;
1257 return ('FAIL',"Need group") if !defined($group);
1258 my $state = shift;
1259 return ('FAIL',"Need domain status") if !defined($state);
1260
1261 my %userinfo = @_; # remaining bits.
1262# user ID, username, user full name
1263
1264 $state = 1 if $state =~ /^active$/;
1265 $state = 1 if $state =~ /^on$/;
1266 $state = 0 if $state =~ /^inactive$/;
1267 $state = 0 if $state =~ /^off$/;
1268
1269 return ('FAIL',"Invalid domain status") if $state !~ /^\d+$/;
1270
1271 return ('FAIL', "Invalid characters in domain") if $domain !~ /^[a-zA-Z0-9_.-]+$/;
1272
1273 my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
1274 my $dom_id;
1275
1276# quick check to start to see if we've already got one
1277 $sth->execute($domain);
1278 ($dom_id) = $sth->fetchrow_array;
1279
1280 return ('FAIL', "Domain already exists") if $dom_id;
1281
1282 # Allow transactions, and raise an exception on errors so we can catch it later.
1283 # Use local to make sure these get "reset" properly on exiting this block
1284 local $dbh->{AutoCommit} = 0;
1285 local $dbh->{RaiseError} = 1;
1286
1287 # Wrap all the SQL in a transaction
1288 eval {
1289 # insert the domain...
1290 $dbh->do("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)", undef, ($domain, $group, $state));
1291
1292 # get the ID...
1293 ($dom_id) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE domain=?", undef, ($domain));
1294
1295 _log($dbh, (domain_id => $dom_id, user_id => $userinfo{id}, group_id => $group, username => $userinfo{username},
1296 entry => "Added ".($state ? 'active' : 'inactive')." domain $domain"));
1297
1298 # ... and now we construct the standard records from the default set. NB: group should be variable.
1299 my $sth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
1300 my $sth_in = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,distance,weight,port,ttl)".
1301 " VALUES ($dom_id,?,?,?,?,?,?,?)");
1302 $sth->execute($group);
1303 while (my ($host,$type,$val,$dist,$weight,$port,$ttl) = $sth->fetchrow_array()) {
1304 $host =~ s/DOMAIN/$domain/g;
1305 $val =~ s/DOMAIN/$domain/g;
1306 $sth_in->execute($host,$type,$val,$dist,$weight,$port,$ttl);
1307 if ($typemap{$type} eq 'SOA') {
1308 my @tmp1 = split /:/, $host;
1309 my @tmp2 = split /:/, $val;
1310 _log($dbh, (domain_id => $dom_id, user_id => $userinfo{id}, group_id => $group,
1311 username => $userinfo{username}, entry =>
1312 "[new $domain] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
1313 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl"));
1314 } else {
1315 my $logentry = "[new $domain] Added record '$host $typemap{$type}";
1316 $logentry .= " [distance $dist]" if $typemap{$type} eq 'MX';
1317 $logentry .= " [priority $dist] [weight $weight] [port $port]" if $typemap{$type} eq 'SRV';
1318 _log($dbh, (domain_id => $dom_id, user_id => $userinfo{id}, group_id => $group,
1319 username => $userinfo{username}, entry =>
1320 $logentry." $val', TTL $ttl"));
1321 }
1322 }
1323
1324 # once we get here, we should have suceeded.
1325 $dbh->commit;
1326 }; # end eval
1327
1328 if ($@) {
1329 my $msg = $@;
1330 eval { $dbh->rollback; };
1331 return ('FAIL',$msg);
1332 } else {
1333 return ('OK',$dom_id);
1334 }
1335} # end addDomain
1336
1337
1338## DNSDB::delZone()
1339# Delete a forward or reverse zone.
1340# Takes a database handle, zone ID, and forward/reverse flag.
1341# for now, just delete the records, then the domain.
1342# later we may want to archive it in some way instead (status code 2, for example?)
1343sub delZone {
1344 my $dbh = shift;
1345 my $zoneid = shift;
1346 my $revrec = shift;
1347
1348 # Allow transactions, and raise an exception on errors so we can catch it later.
1349 # Use local to make sure these get "reset" properly on exiting this block
1350 local $dbh->{AutoCommit} = 0;
1351 local $dbh->{RaiseError} = 1;
1352
1353 my $failmsg = '';
1354
1355 # Wrap all the SQL in a transaction
1356 eval {
1357 # Disentangle custom record types before removing the
1358 # ones that are only in the zone to be deleted
1359 if ($revrec eq 'n') {
1360 my $sth = $dbh->prepare("UPDATE records SET type=?,domain_id=0 WHERE domain_id=? AND type=?");
1361 $failmsg = "Failure converting multizone types to single-zone";
1362 $sth->execute($reverse_typemap{PTR}, $zoneid, 65280);
1363 $sth->execute($reverse_typemap{PTR}, $zoneid, 65281);
1364 $sth->execute(65282, $zoneid, 65283);
1365 $sth->execute(65282, $zoneid, 65284);
1366 $failmsg = "Failure removing domain records";
1367 $dbh->do("DELETE FROM records WHERE domain_id=?", undef, ($zoneid));
1368 $failmsg = "Failure removing domain";
1369 $dbh->do("DELETE FROM domains WHERE domain_id=?", undef, ($zoneid));
1370 } else {
1371 my $sth = $dbh->prepare("UPDATE records SET type=?,rdns_id=0 WHERE rdns_id=? AND type=?");
1372 $failmsg = "Failure converting multizone types to single-zone";
1373 $sth->execute($reverse_typemap{A}, $zoneid, 65280);
1374 $sth->execute($reverse_typemap{AAAA}, $zoneid, 65281);
1375# We don't have an "A template" or "AAAA template" type, although it might be useful for symmetry.
1376# $sth->execute(65285?, $zoneid, 65283);
1377# $sth->execute(65285?, $zoneid, 65284);
1378 $failmsg = "Failure removing reverse records";
1379 $dbh->do("DELETE FROM records WHERE rdns_id=?", undef, ($zoneid));
1380 $failmsg = "Failure removing reverse zone";
1381 $dbh->do("DELETE FROM revzones WHERE rdns_id=?", undef, ($zoneid));
1382 }
1383
1384 # once we get here, we should have suceeded.
1385 $dbh->commit;
1386 }; # end eval
1387
1388 if ($@) {
1389 my $msg = $@;
1390 eval { $dbh->rollback; };
1391 return ('FAIL',"$failmsg: $msg");
1392 } else {
1393 return ('OK','OK');
1394 }
1395
1396} # end delZone()
1397
1398
1399## DNSDB::domainName()
1400# Return the domain name based on a domain ID
1401# Takes a database handle and the domain ID
1402# Returns the domain name or undef on failure
1403sub domainName {
1404 $errstr = '';
1405 my $dbh = shift;
1406 my $domid = shift;
1407 my ($domname) = $dbh->selectrow_array("SELECT domain FROM domains WHERE domain_id=?", undef, ($domid) );
1408 $errstr = $DBI::errstr if !$domname;
1409 return $domname if $domname;
1410} # end domainName()
1411
1412
1413## DNSDB::revName()
1414# Return the reverse zone name based on an rDNS ID
1415# Takes a database handle and the rDNS ID
1416# Returns the reverse zone name or undef on failure
1417sub revName {
1418 $errstr = '';
1419 my $dbh = shift;
1420 my $revid = shift;
1421 my ($revname) = $dbh->selectrow_array("SELECT revnet FROM revzones WHERE rdns_id=?", undef, ($revid) );
1422 $errstr = $DBI::errstr if !$revname;
1423 return $revname if $revname;
1424} # end revName()
1425
1426
1427## DNSDB::domainID()
1428# Takes a database handle and domain name
1429# Returns the domain ID number
1430sub domainID {
1431 $errstr = '';
1432 my $dbh = shift;
1433 my $domain = shift;
1434 my ($domid) = $dbh->selectrow_array("SELECT domain_id FROM domains WHERE domain=?", undef, ($domain) );
1435 $errstr = $DBI::errstr if !$domid;
1436 return $domid if $domid;
1437} # end domainID()
1438
1439
1440## DNSDB::revID()
1441# Takes a database handle and reverse zone name
1442# Returns the rDNS ID number
1443sub revID {
1444 $errstr = '';
1445 my $dbh = shift;
1446 my $revzone = shift;
1447 my ($revid) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revnet=?", undef, ($revzone) );
1448 $errstr = $DBI::errstr if !$revid;
1449 return $revid if $revid;
1450} # end revID()
1451
1452
1453## DNSDB::addRDNS
1454# Adds a reverse DNS zone
1455# Takes a database handle, CIDR block, numeric group, boolean(ish) state (active/inactive),
1456# and user info hash (for logging).
1457# Returns a status code and message
1458sub addRDNS {
1459 my $dbh = shift;
1460 my $zone = NetAddr::IP->new(shift);
1461 return ('FAIL',"Zone name must be a valid CIDR netblock") unless ($zone && $zone->addr !~ /^0/);
1462 my $revpatt = shift; # construct a custom (A/AAAA+)? PTR template record
1463 my $group = shift;
1464 my $state = shift;
1465
1466 my %userinfo = @_; # remaining bits.
1467# user ID, username, user full name
1468
1469 $state = 1 if $state =~ /^active$/;
1470 $state = 1 if $state =~ /^on$/;
1471 $state = 0 if $state =~ /^inactive$/;
1472 $state = 0 if $state =~ /^off$/;
1473
1474 return ('FAIL',"Invalid zone status") if $state !~ /^\d+$/;
1475
1476# quick check to start to see if we've already got one
1477 my ($rdns_id) = $dbh->selectrow_array("SELECT rdns_id FROM revzones WHERE revzone=?", undef, ("$zone"));
1478
1479 return ('FAIL', "Zone already exists") if $rdns_id;
1480
1481 # Allow transactions, and raise an exception on errors so we can catch it later.
1482 # Use local to make sure these get "reset" properly on exiting this block
1483 local $dbh->{AutoCommit} = 0;
1484 local $dbh->{RaiseError} = 1;
1485
1486 my $warnstr = '';
1487 my $defttl = 3600; # 1 hour should be reasonable. And unless things have gone horribly
1488 # wrong, we should have a value to override this anyway.
1489
1490 # Wrap all the SQL in a transaction
1491 eval {
1492 # insert the domain...
1493 $dbh->do("INSERT INTO revzones (revnet,group_id,status) VALUES (?,?,?)", undef, ($zone, $group, $state));
1494
1495 # get the ID...
1496 ($rdns_id) = $dbh->selectrow_array("SELECT currval('revzones_rdns_id_seq')");
1497
1498 _log($dbh, (rdns_id => $rdns_id, user_id => $userinfo{id}, group_id => $group, username => $userinfo{name},
1499 entry => "Added ".($state ? 'active' : 'inactive')." reverse zone $zone"));
1500
1501 # ... and now we construct the standard records from the default set. NB: group should be variable.
1502 my $sth = $dbh->prepare("SELECT host,type,val,ttl FROM default_rev_records WHERE group_id=?");
1503 my $sth_in = $dbh->prepare("INSERT INTO records (rdns_id,domain_id,host,type,val,ttl)".
1504 " VALUES ($rdns_id,?,?,?,?,?)");
1505 $sth->execute($group);
1506 while (my ($host,$type,$val,$ttl) = $sth->fetchrow_array()) {
1507 # Silently skip v4/v6 mismatches. This is not an error, this is expected.
1508 if ($zone->{isv6}) {
1509 next if ($type == 65280 || $type == 65283);
1510 } else {
1511 next if ($type == 65281 || $type == 65284);
1512 }
1513
1514 $host =~ s/ADMINDOMAIN/$config{domain}/g;
1515
1516 # Check to make sure the IP stubs will fit in the zone. Under most usage failures here should be rare.
1517 # On failure, tack a note on to a warning string and continue without adding this record.
1518 # While we're at it, we substitute $zone for ZONE in the value.
1519 if ($val eq 'ZONE') {
1520 next if $revpatt; # If we've got a pattern, we skip the default record version.
1521##fixme? do we care if we have multiple whole-zone templates?
1522 $val = $zone->network;
1523 } elsif ($val =~ /ZONE/) {
1524 my $tmpval = $val;
1525 $tmpval =~ s/ZONE//;
1526 # Bend the rules and allow single-trailing-number PTR or PTR template records to be inserted
1527 # as either v4 or v6. May make this an off-by-default config flag
1528 # Note that the origin records that may trigger this **SHOULD** already have ZONE,\d
1529 if ($type == 12 || $type == 65282) {
1530 $tmpval =~ s/[,.]/::/ if ($tmpval =~ /^[,.]\d+$/ && $zone->{isv6});
1531 $tmpval =~ s/[,:]+/./ if ($tmpval =~ /^(?:,|::)\d+$/ && !$zone->{isv6});
1532 }
1533 my $addr;
1534 if (_ipparent($dbh, 'n', 'y', \$tmpval, $rdns_id, \$addr)) {
1535 $val = $addr->addr;
1536 } else {
1537 $warnstr .= "\nDefault record '$val $typemap{$type} $host' doesn't fit in $zone, skipping";
1538 next;
1539 }
1540 }
1541
1542 # Substitute $zone for ZONE in the hostname.
1543 $host = _ZONE($zone, $host);
1544
1545 # Fill in the forward domain ID if we can find it, otherwise:
1546 # Coerce type down to PTR or PTR template if we can't
1547 my $domid = 0;
1548 if ($type >= 65280) {
1549 if (!($domid = _hostparent($dbh, $host))) {
1550 $warnstr .= "\nRecord added as PTR instead of $typemap{$type}; domain not found for $host";
1551 $type = $reverse_typemap{PTR};
1552 $domid = 0; # just to be explicit.
1553 }
1554 }
1555
1556 $sth_in->execute($domid,$host,$type,$val,$ttl);
1557
1558 if ($typemap{$type} eq 'SOA') {
1559 my @tmp1 = split /:/, $host;
1560 my @tmp2 = split /:/, $val;
1561 _log($dbh, (rdns_id => $rdns_id, user_id => $userinfo{id}, group_id => $group,
1562 username => $userinfo{name}, entry =>
1563 "[new $zone] Added SOA record [contact $tmp1[0]] [master $tmp1[1]] ".
1564 "[refresh $tmp2[0]] [retry $tmp2[1]] [expire $tmp2[2]] [minttl $tmp2[3]], TTL $ttl"));
1565 $defttl = $tmp2[3];
1566 } else {
1567 my $logentry = "[new $zone] Added record '$host $typemap{$type}";
1568 _log($dbh, (rdns_id => $rdns_id, domain_id => $domid, user_id => $userinfo{id}, group_id => $group,
1569 username => $userinfo{name}, entry =>
1570 $logentry." $val', TTL $ttl"));
1571 }
1572 }
1573
1574 # Generate record based on provided pattern.
1575 if ($revpatt) {
1576 my $host;
1577 my $type = ($zone->{isv6} ? 65284 : 65283);
1578 my $val = $zone->network;
1579
1580 # Substitute $zone for ZONE in the hostname.
1581 $host = _ZONE($zone, $revpatt);
1582
1583 my $domid = 0;
1584 if (!($domid = _hostparent($dbh, $host))) {
1585 $warnstr .= "\nDefault pattern added as PTR template instead of $typemap{$type}; domain not found for $host";
1586 $type = 65282;
1587 $domid = 0; # just to be explicit.
1588 }
1589
1590 $sth_in->execute($domid,$host,$type,$val,$defttl);
1591 }
1592
1593 # If there are warnings (presumably about default records skipped for cause) log them
1594 _log($dbh, (rdns_id => $rdns_id, user_id => $userinfo{id}, group_id => $group,
1595 username => $userinfo{name}, entry => "Warning(s) adding $zone:$warnstr"))
1596 if $warnstr;
1597
1598 # once we get here, we should have suceeded.
1599 $dbh->commit;
1600 }; # end eval
1601
1602 if ($@) {
1603 my $msg = $@;
1604 eval { $dbh->rollback; };
1605 return ('FAIL',$msg);
1606 } else {
1607 return ('OK',$rdns_id);
1608 }
1609
1610} # end addRDNS()
1611
1612
1613## DNSDB::getZoneCount
1614# Get count of zones in group or groups
1615# Takes a database handle and hash containing:
1616# - the "current" group
1617# - an array of "acceptable" groups
1618# - a flag for forward/reverse zones
1619# - Optionally accept a "starts with" and/or "contains" filter argument
1620# Returns an integer count of the resulting zone list.
1621sub getZoneCount {
1622 my $dbh = shift;
1623
1624 my %args = @_;
1625
1626 my @filterargs;
1627 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
1628 push @filterargs, "^$args{startwith}" if $args{startwith};
1629 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
1630 push @filterargs, $args{filter} if $args{filter};
1631
1632 my $sql;
1633 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
1634 if ($args{revrec} eq 'n') {
1635 $sql = "SELECT count(*) FROM domains".
1636 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
1637 ($args{startwith} ? " AND domain ~* ?" : '').
1638 ($args{filter} ? " AND domain ~* ?" : '');
1639 } else {
1640 $sql = "SELECT count(*) FROM revzones".
1641 " WHERE group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
1642 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '').
1643 ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
1644 }
1645 my ($count) = $dbh->selectrow_array($sql, undef, @filterargs);
1646 return $count;
1647} # end getZoneCount()
1648
1649
1650## DNSDB::getZoneList()
1651# Get a list of zones in the specified group(s)
1652# Takes the same arguments as getZoneCount() above
1653# Returns a reference to an array of hashrefs suitable for feeding to HTML::Template
1654sub getZoneList {
1655 my $dbh = shift;
1656
1657 my %args = @_;
1658
1659 my @zonelist;
1660
1661 $args{sortorder} = 'ASC' if !grep $args{sortorder}, ('ASC','DESC');
1662 $args{offset} = 0 if !$args{offset} || $args{offset} !~ /^(?:all|\d+)$/;
1663
1664 my @filterargs;
1665 $args{startwith} = undef if $args{startwith} && $args{startwith} !~ /^(?:[a-z]|0-9)$/;
1666 push @filterargs, "^$args{startwith}" if $args{startwith};
1667 $args{filter} =~ s/\./\[\.\]/g if $args{filter}; # only match literal dots, usually in reverse zones
1668 push @filterargs, $args{filter} if $args{filter};
1669
1670 my $sql;
1671 # Not as compact, and fix-me-twice if the common bits get wrong, but much easier to read
1672 if ($args{revrec} eq 'n') {
1673 $args{sortby} = 'domain' if !grep $args{sortby}, ('revnet','group','status');
1674 $sql = "SELECT domain_id,domain,status,groups.group_name AS group FROM domains".
1675 " INNER JOIN groups ON domains.group_id=groups.group_id".
1676 " WHERE domains.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
1677 ($args{startwith} ? " AND domain ~* ?" : '').
1678 ($args{filter} ? " AND domain ~* ?" : '');
1679 } else {
1680##fixme: arguably startwith here is irrelevant. depends on the UI though.
1681 $args{sortby} = 'revnet' if !grep $args{sortby}, ('domain','group','status');
1682 $sql = "SELECT rdns_id,revnet,status,groups.group_name AS group FROM revzones".
1683 " INNER JOIN groups ON revzones.group_id=groups.group_id".
1684 " WHERE revzones.group_id IN ($args{curgroup}".($args{childlist} ? ",$args{childlist}" : '').")".
1685 ($args{startwith} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '').
1686 ($args{filter} ? " AND CAST(revnet AS VARCHAR) ~* ?" : '');
1687 }
1688 # A common tail.
1689 $sql .= " ORDER BY ".($args{sortby} eq 'group' ? 'groups.group_name' : $args{sortby})." $args{sortorder} ".
1690 ($args{offset} eq 'all' ? '' : " LIMIT $config{perpage}".
1691 " OFFSET ".$args{offset}*$config{perpage});
1692 my $sth = $dbh->prepare($sql);
1693 $sth->execute(@filterargs);
1694 my $rownum = 0;
1695
1696 while (my @data = $sth->fetchrow_array) {
1697 my %row;
1698 $row{domainid} = $data[0];
1699 $row{domain} = $data[1];
1700 $row{status} = $data[2];
1701 $row{group} = $data[3];
1702 push @zonelist, \%row;
1703 }
1704
1705 return \@zonelist;
1706} # end getZoneList()
1707
1708
1709## DNSDB::addGroup()
1710# Add a group
1711# Takes a database handle, group name, parent group, hashref for permissions,
1712# and optional template-vs-cloneme flag
1713# Returns a status code and message
1714sub addGroup {
1715 $errstr = '';
1716 my $dbh = shift;
1717 my $groupname = shift;
1718 my $pargroup = shift;
1719 my $permissions = shift;
1720
1721 # 0 indicates "custom", hardcoded.
1722 # Any other value clones that group's default records, if it exists.
1723 my $inherit = shift || 0;
1724##fixme: need a flag to indicate clone records or <?> ?
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 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE group_name=?");
1732 my $group_id;
1733
1734# quick check to start to see if we've already got one
1735 $sth->execute($groupname);
1736 ($group_id) = $sth->fetchrow_array;
1737
1738 return ('FAIL', "Group already exists") if $group_id;
1739
1740 # Wrap all the SQL in a transaction
1741 eval {
1742 $sth = $dbh->prepare("INSERT INTO groups (parent_group_id,group_name) VALUES (?,?)");
1743 $sth->execute($pargroup,$groupname);
1744
1745 my ($groupid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group_name=?", undef, ($groupname));
1746
1747# Permissions
1748 if ($inherit) {
1749 } else {
1750 my @permvals;
1751 foreach (@permtypes) {
1752 if (!defined ($permissions->{$_})) {
1753 push @permvals, 0;
1754 } else {
1755 push @permvals, $permissions->{$_};
1756 }
1757 }
1758
1759 $sth = $dbh->prepare("INSERT INTO permissions (group_id,$permlist) values (?".',?'x($#permtypes+1).")");
1760 $sth->execute($groupid,@permvals);
1761
1762 $sth = $dbh->prepare("SELECT permission_id FROM permissions WHERE group_id=?");
1763 $sth->execute($groupid);
1764 my ($permid) = $sth->fetchrow_array();
1765
1766 $dbh->do("UPDATE groups SET permission_id=$permid WHERE group_id=$groupid");
1767 } # done permission fiddling
1768
1769# Default records
1770 my $sthf = $dbh->prepare("INSERT INTO default_records (group_id,host,type,val,distance,weight,port,ttl) ".
1771 "VALUES ($groupid,?,?,?,?,?,?,?)");
1772 my $sthr = $dbh->prepare("INSERT INTO default_rev_records (group_id,host,type,val,ttl) ".
1773 "VALUES ($groupid,?,?,?,?)");
1774 if ($inherit) {
1775 # Duplicate records from parent. Actually relying on inherited records feels
1776 # very fragile, and it would be problematic to roll over at a later time.
1777 my $sth2 = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl FROM default_records WHERE group_id=?");
1778 $sth2->execute($pargroup);
1779 while (my @clonedata = $sth2->fetchrow_array) {
1780 $sthf->execute(@clonedata);
1781 }
1782 # And now the reverse records
1783 $sth2 = $dbh->prepare("SELECT group_id,host,type,val,ttl FROM default_rev_records WHERE group_id=?");
1784 $sth2->execute($pargroup);
1785 while (my @clonedata = $sth2->fetchrow_array) {
1786 $sthr->execute(@clonedata);
1787 }
1788 } else {
1789##fixme: Hardcoding is Bad, mmmmkaaaay?
1790 # reasonable basic defaults for SOA, MX, NS, and minimal hosting
1791 # could load from a config file, but somewhere along the line we need hardcoded bits.
1792 $sthf->execute('ns1.example.com:hostmaster.example.com', 6, '10800:3600:604800:10800', 0, 0, 0, 86400);
1793 $sthf->execute('DOMAIN', 1, '192.168.4.2', 0, 0, 0, 7200);
1794 $sthf->execute('DOMAIN', 15, 'mx.example.com', 10, 0, 0, 7200);
1795 $sthf->execute('DOMAIN', 2, 'ns1.example.com', 0, 0, 0, 7200);
1796 $sthf->execute('DOMAIN', 2, 'ns2.example.com', 0, 0, 0, 7200);
1797 $sthf->execute('www.DOMAIN', 5, 'DOMAIN', 0, 0, 0, 7200);
1798 # reasonable basic defaults for generic reverse zone. Same as initial SQL tabledef.
1799 $sthr->execute('hostmaster.ADMINDOMAIN:ns1.ADMINDOMAIN', 6, '10800:3600:604800:10800', 86400);
1800 $sthr->execute('unused-%r.ADMINDOMAIN', 65283, 'ZONE', 3600);
1801 }
1802
1803 # once we get here, we should have suceeded.
1804 $dbh->commit;
1805 }; # end eval
1806
1807 if ($@) {
1808 my $msg = $@;
1809 eval { $dbh->rollback; };
1810 return ('FAIL',$msg);
1811 } else {
1812 return ('OK','OK');
1813 }
1814
1815} # end addGroup()
1816
1817
1818## DNSDB::delGroup()
1819# Delete a group.
1820# Takes a group ID
1821# Returns a status code and message
1822sub delGroup {
1823 my $dbh = shift;
1824 my $groupid = shift;
1825
1826 # Allow transactions, and raise an exception on errors so we can catch it later.
1827 # Use local to make sure these get "reset" properly on exiting this block
1828 local $dbh->{AutoCommit} = 0;
1829 local $dbh->{RaiseError} = 1;
1830
1831##fixme: locate "knowable" error conditions and deal with them before the eval
1832# ... or inside, whatever.
1833# -> domains still exist in group
1834# -> ...
1835 my $failmsg = '';
1836
1837 # Wrap all the SQL in a transaction
1838 eval {
1839 my $sth = $dbh->prepare("SELECT count(*) FROM domains WHERE group_id=?");
1840 $sth->execute($groupid);
1841 my ($domcnt) = $sth->fetchrow_array;
1842 $failmsg = "Can't remove group ".groupName($dbh,$groupid);
1843 die "$domcnt domains still in group\n" if $domcnt;
1844
1845 $sth = $dbh->prepare("delete from default_records where group_id=?");
1846 $failmsg = "Failed to delete default records for ".groupName($dbh,$groupid);
1847 $sth->execute($groupid);
1848 $sth = $dbh->prepare("delete from groups where group_id=?");
1849 $failmsg = "Failed to remove group ".groupName($dbh,$groupid);
1850 $sth->execute($groupid);
1851
1852 # once we get here, we should have suceeded.
1853 $dbh->commit;
1854 }; # end eval
1855
1856 if ($@) {
1857 my $msg = $@;
1858 eval { $dbh->rollback; };
1859 return ('FAIL',"$failmsg: $msg");
1860 } else {
1861 return ('OK','OK');
1862 }
1863} # end delGroup()
1864
1865
1866## DNSDB::getChildren()
1867# Get a list of all groups whose parent^n is group <n>
1868# Takes a database handle, group ID, reference to an array to put the group IDs in,
1869# and an optional flag to return only immediate children or all children-of-children
1870# default to returning all children
1871# Calls itself
1872sub getChildren {
1873 $errstr = '';
1874 my $dbh = shift;
1875 my $rootgroup = shift;
1876 my $groupdest = shift;
1877 my $immed = shift || 'all';
1878
1879 # special break for default group; otherwise we get stuck.
1880 if ($rootgroup == 1) {
1881 # by definition, group 1 is the Root Of All Groups
1882 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE NOT (group_id=1)".
1883 ($immed ne 'all' ? " AND parent_group_id=1" : ''));
1884 $sth->execute;
1885 while (my @this = $sth->fetchrow_array) {
1886 push @$groupdest, @this;
1887 }
1888 } else {
1889 my $sth = $dbh->prepare("SELECT group_id FROM groups WHERE parent_group_id=?");
1890 $sth->execute($rootgroup);
1891 return if $sth->rows == 0;
1892 my @grouplist;
1893 while (my ($group) = $sth->fetchrow_array) {
1894 push @$groupdest, $group;
1895 getChildren($dbh,$group,$groupdest) if $immed eq 'all';
1896 }
1897 }
1898} # end getChildren()
1899
1900
1901## DNSDB::groupName()
1902# Return the group name based on a group ID
1903# Takes a database handle and the group ID
1904# Returns the group name or undef on failure
1905sub groupName {
1906 $errstr = '';
1907 my $dbh = shift;
1908 my $groupid = shift;
1909 my $sth = $dbh->prepare("SELECT group_name FROM groups WHERE group_id=?");
1910 $sth->execute($groupid);
1911 my ($groupname) = $sth->fetchrow_array();
1912 $errstr = $DBI::errstr if !$groupname;
1913 return $groupname if $groupname;
1914} # end groupName
1915
1916
1917## DNSDB::groupID()
1918# Return the group ID based on the group name
1919# Takes a database handle and the group name
1920# Returns the group ID or undef on failure
1921sub groupID {
1922 $errstr = '';
1923 my $dbh = shift;
1924 my $group = shift;
1925 my ($grpid) = $dbh->selectrow_array("SELECT group_id FROM groups WHERE group=?", undef, ($group) );
1926 $errstr = $DBI::errstr if !$grpid;
1927 return $grpid if $grpid;
1928} # end groupID()
1929
1930
1931## DNSDB::addUser()
1932# Add a user.
1933# Takes a DB handle, username, group ID, password, state (active/inactive).
1934# Optionally accepts:
1935# user type (user/admin) - defaults to user
1936# permissions string - defaults to inherit from group
1937# three valid forms:
1938# i - Inherit permissions
1939# c:<user_id> - Clone permissions from <user_id>
1940# C:<permission list> - Set these specific permissions
1941# first name - defaults to username
1942# last name - defaults to blank
1943# phone - defaults to blank (could put other data within column def)
1944# Returns (OK,<uid>) on success, (FAIL,<message>) on failure
1945sub addUser {
1946 $errstr = '';
1947 my $dbh = shift;
1948 my $username = shift;
1949 my $group = shift;
1950 my $pass = shift;
1951 my $state = shift;
1952
1953 return ('FAIL', "Missing one or more required entries") if !defined($state);
1954 return ('FAIL', "Username must not be blank") if !$username;
1955
1956 my $type = shift || 'u'; # create limited users by default - fwiw, not sure yet how this will interact with ACLs
1957
1958 my $permstring = shift || 'i'; # default is to inhert permissions from group
1959
1960 my $fname = shift || $username;
1961 my $lname = shift || '';
1962 my $phone = shift || ''; # not going format-check
1963
1964 my $sth = $dbh->prepare("SELECT user_id FROM users WHERE username=?");
1965 my $user_id;
1966
1967# quick check to start to see if we've already got one
1968 $sth->execute($username);
1969 ($user_id) = $sth->fetchrow_array;
1970
1971 return ('FAIL', "User already exists") if $user_id;
1972
1973 # Allow transactions, and raise an exception on errors so we can catch it later.
1974 # Use local to make sure these get "reset" properly on exiting this block
1975 local $dbh->{AutoCommit} = 0;
1976 local $dbh->{RaiseError} = 1;
1977
1978 my $failmsg = '';
1979
1980 # Wrap all the SQL in a transaction
1981 eval {
1982 # insert the user... note we set inherited perms by default since
1983 # it's simple and cleans up some other bits of state
1984 my $sth = $dbh->prepare("INSERT INTO users ".
1985 "(group_id,username,password,firstname,lastname,phone,type,status,permission_id,inherit_perm) ".
1986 "VALUES (?,?,?,?,?,?,?,?,(SELECT permission_id FROM permissions WHERE group_id=?),'t')");
1987 $sth->execute($group,$username,unix_md5_crypt($pass),$fname,$lname,$phone,$type,$state,$group);
1988
1989 # get the ID...
1990 ($user_id) = $dbh->selectrow_array("SELECT currval('users_user_id_seq')");
1991
1992# Permissions! Gotta set'em all!
1993 die "Invalid permission string $permstring"
1994 if $permstring !~ /^(?:
1995 i # inherit
1996 |c:\d+ # clone
1997 # custom. no, the leading , is not a typo
1998 |C:(?:,(?:group|user|domain|record|self)_(?:edit|create|delete))*
1999 )$/x;
2000# bleh. I'd call another function to do my dirty work, but we're in the middle of a transaction already.
2001 if ($permstring ne 'i') {
2002 # for cloned or custom permissions, we have to create a new permissions entry.
2003 my $clonesrc = $group;
2004 if ($permstring =~ /^c:(\d+)/) { $clonesrc = $1; }
2005 $dbh->do("INSERT INTO permissions ($permlist,user_id) ".
2006 "SELECT $permlist,? FROM permissions WHERE permission_id=".
2007 "(SELECT permission_id FROM permissions WHERE ".($permstring =~ /^c:/ ? 'user' : 'group')."_id=?)",
2008 undef, ($user_id,$clonesrc) );
2009 $dbh->do("UPDATE users SET permission_id=".
2010 "(SELECT permission_id FROM permissions WHERE user_id=?) ".
2011 "WHERE user_id=?", undef, ($user_id, $user_id) );
2012 }
2013 if ($permstring =~ /^C:/) {
2014 # finally for custom permissions, we set the passed-in permissions (and unset
2015 # any that might have been brought in by the clone operation above)
2016 my ($permid) = $dbh->selectrow_array("SELECT permission_id FROM permissions WHERE user_id=?",
2017 undef, ($user_id) );
2018 foreach (@permtypes) {
2019 if ($permstring =~ /,$_/) {
2020 $dbh->do("UPDATE permissions SET $_='t' WHERE permission_id=?", undef, ($permid) );
2021 } else {
2022 $dbh->do("UPDATE permissions SET $_='f' WHERE permission_id=?", undef, ($permid) );
2023 }
2024 }
2025 }
2026
2027 $dbh->do("UPDATE users SET inherit_perm='n' WHERE user_id=?", undef, ($user_id) );
2028
2029##fixme: add another table to hold name/email for log table?
2030
2031 # once we get here, we should have suceeded.
2032 $dbh->commit;
2033 }; # end eval
2034
2035 if ($@) {
2036 my $msg = $@;
2037 eval { $dbh->rollback; };
2038 return ('FAIL',$msg." $failmsg");
2039 } else {
2040 return ('OK',$user_id);
2041 }
2042} # end addUser
2043
2044
2045## DNSDB::checkUser()
2046# Check user/pass combo on login
2047sub checkUser {
2048 my $dbh = shift;
2049 my $user = shift;
2050 my $inpass = shift;
2051
2052 my $sth = $dbh->prepare("SELECT user_id,group_id,password,firstname,lastname FROM users WHERE username=?");
2053 $sth->execute($user);
2054 my ($uid,$gid,$pass,$fname,$lname) = $sth->fetchrow_array;
2055 my $loginfailed = 1 if !defined($uid);
2056
2057 if ($pass =~ m|^\$1\$([A-Za-z0-9/.]+)\$|) {
2058 $loginfailed = 1 if $pass ne unix_md5_crypt($inpass,$1);
2059 } else {
2060 $loginfailed = 1 if $pass ne $inpass;
2061 }
2062
2063 # nnnngggg
2064 return ($uid, $gid);
2065} # end checkUser
2066
2067
2068## DNSDB:: updateUser()
2069# Update general data about user
2070sub updateUser {
2071 my $dbh = shift;
2072
2073##fixme: tweak calling convention so that we can update any given bit of data
2074 my $uid = shift;
2075 my $username = shift;
2076 my $group = shift;
2077 my $pass = shift;
2078 my $state = shift;
2079 my $type = shift || 'u';
2080 my $fname = shift || $username;
2081 my $lname = shift || '';
2082 my $phone = shift || ''; # not going format-check
2083
2084 my $failmsg = '';
2085
2086 # Allow transactions, and raise an exception on errors so we can catch it later.
2087 # Use local to make sure these get "reset" properly on exiting this block
2088 local $dbh->{AutoCommit} = 0;
2089 local $dbh->{RaiseError} = 1;
2090
2091 my $sth;
2092
2093 # Password can be left blank; if so we assume there's one on file.
2094 # Actual blank passwords are bad, mm'kay?
2095 if (!$pass) {
2096 $sth = $dbh->prepare("SELECT password FROM users WHERE user_id=?");
2097 $sth->execute($uid);
2098 ($pass) = $sth->fetchrow_array;
2099 } else {
2100 $pass = unix_md5_crypt($pass);
2101 }
2102
2103 eval {
2104 my $sth = $dbh->prepare(q(
2105 UPDATE users
2106 SET username=?, password=?, firstname=?, lastname=?, phone=?, type=?, status=?
2107 WHERE user_id=?
2108 )
2109 );
2110 $sth->execute($username, $pass, $fname, $lname, $phone, $type, $state, $uid);
2111 $dbh->commit;
2112 };
2113 if ($@) {
2114 my $msg = $@;
2115 eval { $dbh->rollback; };
2116 return ('FAIL',"$failmsg: $msg");
2117 } else {
2118 return ('OK','OK');
2119 }
2120} # end updateUser()
2121
2122
2123## DNSDB::delUser()
2124#
2125sub delUser {
2126 my $dbh = shift;
2127 return ('FAIL',"Need database handle") if !$dbh;
2128 my $userid = shift;
2129 return ('FAIL',"Missing userid") if !defined($userid);
2130
2131 my $sth = $dbh->prepare("delete from users where user_id=?");
2132 $sth->execute($userid);
2133
2134 return ('FAIL',"Couldn't remove user: ".$sth->errstr) if $sth->err;
2135
2136 return ('OK','OK');
2137
2138} # end delUser
2139
2140
2141## DNSDB::userFullName()
2142# Return a pretty string!
2143# Takes a user_id and optional printf-ish string to indicate which pieces where:
2144# %u for the username
2145# %f for the first name
2146# %l for the last name
2147# All other text in the passed string will be left as-is.
2148##fixme: need a "smart" option too, so that missing/null/blank first/last names don't give funky output
2149sub userFullName {
2150 $errstr = '';
2151 my $dbh = shift;
2152 my $userid = shift;
2153 my $fullformat = shift || '%f %l (%u)';
2154 my $sth = $dbh->prepare("select username,firstname,lastname from users where user_id=?");
2155 $sth->execute($userid);
2156 my ($uname,$fname,$lname) = $sth->fetchrow_array();
2157 $errstr = $DBI::errstr if !$uname;
2158
2159 $fullformat =~ s/\%u/$uname/g;
2160 $fullformat =~ s/\%f/$fname/g;
2161 $fullformat =~ s/\%l/$lname/g;
2162
2163 return $fullformat;
2164} # end userFullName
2165
2166
2167## DNSDB::userStatus()
2168# Sets and/or returns a user's status
2169# Takes a database handle, user ID and optionally a status argument
2170# Returns undef on errors.
2171sub userStatus {
2172 my $dbh = shift;
2173 my $id = shift;
2174 my $newstatus = shift;
2175
2176 return undef if $id !~ /^\d+$/;
2177
2178 my $sth;
2179
2180# ooo, fun! let's see what we were passed for status
2181 if ($newstatus) {
2182 $sth = $dbh->prepare("update users set status=? where user_id=?");
2183 # ass-u-me caller knows what's going on in full
2184 if ($newstatus =~ /^[01]$/) { # only two valid for now.
2185 $sth->execute($newstatus,$id);
2186 } elsif ($newstatus =~ /^usero(?:n|ff)$/) {
2187 $sth->execute(($newstatus eq 'useron' ? 1 : 0),$id);
2188 }
2189 }
2190
2191 $sth = $dbh->prepare("select status from users where user_id=?");
2192 $sth->execute($id);
2193 my ($status) = $sth->fetchrow_array;
2194 return $status;
2195} # end userStatus()
2196
2197
2198## DNSDB::getUserData()
2199# Get misc user data for display
2200sub getUserData {
2201 my $dbh = shift;
2202 my $uid = shift;
2203
2204 my $sth = $dbh->prepare("SELECT group_id,username,firstname,lastname,phone,type,status,inherit_perm ".
2205 "FROM users WHERE user_id=?");
2206 $sth->execute($uid);
2207 return $sth->fetchrow_hashref();
2208
2209} # end getUserData()
2210
2211
2212## DNSDB::getSOA()
2213# Return all suitable fields from an SOA record in separate elements of a hash
2214# Takes a database handle, default/live flag, domain/reverse flag, and parent ID
2215sub getSOA {
2216 $errstr = '';
2217 my $dbh = shift;
2218 my $def = shift;
2219 my $rev = shift;
2220 my $id = shift;
2221 my %ret;
2222
2223 # (ab)use distance and weight columns to store SOA data? can't for default_rev_records...
2224 # - should really attach serial to the zone parent somewhere
2225
2226 my $sql = "SELECT record_id,host,val,ttl from "._rectable($def,$rev).
2227 " WHERE "._recparent($def,$rev)." = ? AND type=$reverse_typemap{SOA}";
2228
2229 my $sth = $dbh->prepare($sql);
2230 $sth->execute($id);
2231##fixme: stick a flag somewhere if the record doesn't exist. by the API, this is an impossible case, but...
2232
2233 my ($recid,$host,$val,$ttl) = $sth->fetchrow_array() or return;
2234 my ($contact,$prins) = split /:/, $host;
2235 my ($refresh,$retry,$expire,$minttl) = split /:/, $val;
2236
2237 $ret{recid} = $recid;
2238 $ret{ttl} = $ttl;
2239# $ret{serial} = $serial; # ca't use distance for serial with default_rev_records
2240 $ret{prins} = $prins;
2241 $ret{contact} = $contact;
2242 $ret{refresh} = $refresh;
2243 $ret{retry} = $retry;
2244 $ret{expire} = $expire;
2245 $ret{minttl} = $minttl;
2246
2247 return %ret;
2248} # end getSOA()
2249
2250
2251## DNSDB::updateSOA()
2252# Update the specified SOA record
2253# Takes a database handle, default/live flag, forward/reverse flag, and SOA data hash
2254# Returns a two-element list with a result code and message
2255sub updateSOA {
2256 my $dbh = shift;
2257 my $defrec = shift;
2258 my $revrec = shift;
2259
2260 my %soa = @_;
2261
2262 my %oldsoa = getSOA($dbh, $defrec, $revrec, $soa{recid});
2263
2264 # Allow transactions, and raise an exception on errors so we can catch it later.
2265 # Use local to make sure these get "reset" properly on exiting this block
2266 local $dbh->{AutoCommit} = 0;
2267 local $dbh->{RaiseError} = 1;
2268
2269 my $msg;
2270
2271 eval {
2272##fixme: data validation: make sure {recid} is really the SOA for {parent}
2273 my $sql = "UPDATE "._rectable($defrec, $revrec)." SET host=?, val=?, ttl=? WHERE record_id=? AND type=6";
2274 $dbh->do($sql, undef, ("$soa{contact}:$soa{prins}", "$soa{refresh}:$soa{retry}:$soa{expire}:$soa{minttl}",
2275 $soa{ttl}, $soa{recid}) );
2276
2277 $msg = "Updated ".($defrec eq 'y' ? 'default ' : '')."SOA for ".
2278 ($defrec eq 'y' ? groupName($dbh, $soa{recid}) :
2279 ($revrec eq 'n' ? domainName($dbh, $soa{recid}) : revName($dbh, $soa{recid}) ) ).
2280 ": (ns $oldsoa{prins}, contact $oldsoa{contact}, refresh $oldsoa{refresh},".
2281 " retry $oldsoa{retry}, expire $oldsoa{expire}, minTTL $oldsoa{minttl}, TTL $oldsoa{ttl}) to ".
2282 "(ns $soa{prins}, contact $soa{contact}, refresh $soa{refresh},".
2283 " retry $soa{retry}, expire $soa{expire}, minTTL $soa{minttl}, TTL $soa{ttl})";
2284
2285# _log($dbh, (rdns_id => $rdns_id, user_id => $userinfo{id}, group_id => $group,
2286# username => $userinfo{name}, entry => $msg) );
2287
2288 $dbh->commit;
2289 };
2290 if ($@) {
2291 $msg = $@;
2292 eval { $dbh->rollback; };
2293 return ('FAIL',$msg);
2294 } else {
2295 return ('OK', $msg);
2296 }
2297} # end updateSOA()
2298
2299
2300## DNSDB::getRecLine()
2301# Return all data fields for a zone record in separate elements of a hash
2302# Takes a database handle, default/live flag, forward/reverse flag, and record ID
2303sub getRecLine {
2304 $errstr = '';
2305 my $dbh = shift;
2306 my $defrec = shift;
2307 my $revrec = shift;
2308 my $id = shift;
2309
2310 my $sql = "SELECT record_id,host,type,val,ttl".($revrec eq 'n' ? ',distance,weight,port' : '').
2311 (($defrec eq 'y') ? ',group_id FROM ' : ',domain_id,rdns_id FROM ').
2312 _rectable($defrec,$revrec)." WHERE record_id=?";
2313 my $ret = $dbh->selectrow_hashref($sql, undef, ($id) );
2314
2315 if ($dbh->err) {
2316 $errstr = $DBI::errstr;
2317 return undef;
2318 }
2319
2320 if (!$ret) {
2321 $errstr = "No such record";
2322 return undef;
2323 }
2324
2325 # explicitly set a parent id
2326 if ($defrec eq 'y') {
2327 $ret->{parid} = $ret->{group_id};
2328 } else {
2329 $ret->{parid} = (($revrec eq 'n') ? $ret->{domain_id} : $ret->{rdns_id});
2330 # and a secondary if we have a custom type that lives in both a forward and reverse zone
2331 $ret->{secid} = (($revrec eq 'y') ? $ret->{domain_id} : $ret->{rdns_id}) if $ret->{type} > 65279;
2332 }
2333
2334 return $ret;
2335}
2336
2337
2338##fixme: should use above (getRecLine()) to get lines for below?
2339## DNSDB::getDomRecs()
2340# Return records for a domain
2341# Takes a database handle, default/live flag, group/domain ID, start,
2342# number of records, sort field, and sort order
2343# Returns a reference to an array of hashes
2344sub getDomRecs {
2345 $errstr = '';
2346 my $dbh = shift;
2347 my $def = shift;
2348 my $rev = shift;
2349 my $id = shift;
2350 my $nrecs = shift || 'all';
2351 my $nstart = shift || 0;
2352
2353## for order, need to map input to column names
2354 my $order = shift || 'host';
2355 my $direction = shift || 'ASC';
2356
2357 my $filter = shift || '';
2358
2359 my $sql = "SELECT r.record_id,r.host,r.type,r.val,r.ttl";
2360 $sql .= ",r.distance,r.weight,r.port" if $rev eq 'n';
2361 $sql .= " FROM "._rectable($def,$rev)." r ";
2362 $sql .= "INNER JOIN rectypes t ON r.type=t.val "; # for sorting by type alphabetically
2363 $sql .= "WHERE "._recparent($def,$rev)." = ?";
2364 $sql .= " AND NOT r.type=$reverse_typemap{SOA}";
2365 $sql .= " AND host ~* ?" if $filter;
2366 # use alphaorder column for "correct" ordering of sort-by-type instead of DNS RR type number
2367 $sql .= " ORDER BY ".($order eq 'type' ? 't.alphaorder' : "r.$order")." $direction";
2368
2369 my @bindvars = ($id);
2370 push @bindvars, $filter if $filter;
2371
2372 # just to be ultraparanoid about SQL injection vectors
2373 if ($nstart ne 'all') {
2374 $sql .= " LIMIT ? OFFSET ?";
2375 push @bindvars, $nrecs;
2376 push @bindvars, ($nstart*$nrecs);
2377 }
2378 my $sth = $dbh->prepare($sql) or warn $dbh->errstr;
2379 $sth->execute(@bindvars) or warn "$sql: ".$sth->errstr;
2380
2381 my @retbase;
2382 while (my $ref = $sth->fetchrow_hashref()) {
2383 push @retbase, $ref;
2384 }
2385
2386 my $ret = \@retbase;
2387 return $ret;
2388} # end getDomRecs()
2389
2390
2391## DNSDB::getRecCount()
2392# Return count of non-SOA records in zone (or default records in a group)
2393# Takes a database handle, default/live flag, reverse/forward flag, group/domain ID,
2394# and optional filtering modifier
2395# Returns the count
2396sub getRecCount {
2397 my $dbh = shift;
2398 my $defrec = shift;
2399 my $revrec = shift;
2400 my $id = shift;
2401 my $filter = shift || '';
2402
2403 # keep the nasties down, since we can't ?-sub this bit. :/
2404 # note this is chars allowed in DNS hostnames
2405 $filter =~ s/[^a-zA-Z0-9_.:-]//g;
2406
2407 my @bindvars = ($id);
2408 push @bindvars, $filter if $filter;
2409 my $sql = "SELECT count(*) FROM ".
2410 _rectable($defrec,$revrec).
2411 " WHERE "._recparent($defrec,$revrec)."=? ".
2412 "AND NOT type=$reverse_typemap{SOA}".
2413 ($filter ? " AND host ~* ?" : '');
2414 my ($count) = $dbh->selectrow_array($sql, undef, (@bindvars) );
2415
2416 return $count;
2417
2418} # end getRecCount()
2419
2420
2421## DNSDB::addRec()
2422# Add a new record to a domain or a group's default records
2423# Takes a database handle, default/live flag, group/domain ID,
2424# host, type, value, and TTL
2425# Some types require additional detail: "distance" for MX and SRV,
2426# and weight/port for SRV
2427# Returns a status code and detail message in case of error
2428##fixme: pass a hash with the record data, not a series of separate values
2429sub addRec {
2430 $errstr = '';
2431 my $dbh = shift;
2432 my $defrec = shift;
2433 my $revrec = shift;
2434 my $id = shift; # parent (group_id for defrecs, rdns_id for reverse records,
2435 # domain_id for domain records)
2436
2437 my $host = shift;
2438 my $rectype = shift; # reference so we can coerce it if "+"-types can't find both zones
2439 my $val = shift;
2440 my $ttl = shift;
2441
2442 # prep for validation
2443 my $addr = NetAddr::IP->new($$val);
2444 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
2445
2446 my $domid = 0;
2447 my $revid = 0;
2448
2449 my $retcode = 'OK'; # assume everything will go OK
2450 my $retmsg = '';
2451
2452 # do simple validation first
2453 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^\d+$/;
2454
2455 # Quick check on hostname parts. Note the regex is more forgiving than the error message;
2456 # domain names technically are case-insensitive, and we use printf-like % codes for a couple
2457 # of types. Other things may also be added to validate default records of several flavours.
2458 return ('FAIL', "Hostnames may not contain anything other than (0-9 a-z . _)")
2459 if $defrec eq 'n' && $$host !~ /^[0-9a-z_%.-]+$/i;
2460
2461 # Collect these even if we're only doing a simple A record so we can call *any* validation sub
2462 my $dist = shift;
2463 my $weight = shift;
2464 my $port = shift;
2465
2466 my $fields;
2467 my @vallist;
2468
2469 # Call the validation sub for the type requested.
2470 ($retcode,$retmsg) = $validators{$$rectype}($dbh, (defrec => $defrec, revrec => $revrec, id => $id,
2471 host => $host, rectype => $rectype, val => $val, addr => $addr,
2472 dist => \$dist, port => \$port, weight => \$weight,
2473 fields => \$fields, vallist => \@vallist) );
2474
2475 return ($retcode,$retmsg) if $retcode eq 'FAIL';
2476
2477 # Set up database fields and bind parameters
2478 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
2479 push @vallist, ($$host,$$rectype,$$val,$ttl,$id);
2480 my $vallen = '?'.(',?'x$#vallist);
2481
2482 # Allow transactions, and raise an exception on errors so we can catch it later.
2483 # Use local to make sure these get "reset" properly on exiting this block
2484 local $dbh->{AutoCommit} = 0;
2485 local $dbh->{RaiseError} = 1;
2486
2487 eval {
2488 $dbh->do("INSERT INTO "._rectable($defrec, $revrec)." ($fields) VALUES ($vallen)",
2489 undef, @vallist);
2490 $dbh->commit;
2491 };
2492 if ($@) {
2493 my $msg = $@;
2494 eval { $dbh->rollback; };
2495 return ('FAIL',$msg);
2496 }
2497
2498 return ($retcode, $retmsg);
2499
2500} # end addRec()
2501
2502
2503## DNSDB::updateRec()
2504# Update a record
2505# Takes a database handle, default and reverse flags, record ID, immediate parent ID, and new record data.
2506# Returns a status code and message
2507sub updateRec {
2508 $errstr = '';
2509
2510 my $dbh = shift;
2511 my $defrec = shift;
2512 my $revrec = shift;
2513 my $id = shift;
2514 my $parid = shift; # immediate parent entity that we're descending from to update the record
2515
2516 # all records have these
2517 my $host = shift;
2518 my $hostbk = $$host; # Keep a backup copy of the original, so we can WARN if the update mangles the domain
2519 my $rectype = shift;
2520 my $val = shift;
2521 my $ttl = shift;
2522
2523 # prep for validation
2524 my $addr = NetAddr::IP->new($$val);
2525 $$host =~ s/\.+$//; # FQDNs ending in . are an internal detail, and really shouldn't be exposed in the UI.
2526
2527 my $domid = 0;
2528 my $revid = 0;
2529
2530 my $retcode = 'OK'; # assume everything will go OK
2531 my $retmsg = '';
2532
2533 # do simple validation first
2534 return ('FAIL', "TTL must be numeric") unless $ttl =~ /^\d+$/;
2535
2536 # Quick check on hostname parts. Note the regex is more forgiving than the error message;
2537 # domain names technically are case-insensitive, and we use printf-like % codes for a couple
2538 # of types. Other things may also be added to validate default records of several flavours.
2539 return ('FAIL', "Hostnames may not contain anything other than (0-9 a-z - . _)")
2540 if $defrec eq 'n' && $$host !~ /^[0-9a-z_%.-]+$/i;
2541
2542 # only MX and SRV will use these
2543 my $dist = 0;
2544 my $weight = 0;
2545 my $port = 0;
2546
2547 my $fields;
2548 my @vallist;
2549
2550 # get old record data so we have the right parent ID
2551 # and for logging (eventually)
2552 my $oldrec = getRecLine($dbh, $defrec, $revrec, $id);
2553
2554 # Call the validation sub for the type requested.
2555 # Note the ID to pass here is the *parent*, not the record
2556 ($retcode,$retmsg) = $validators{$$rectype}($dbh, (defrec => $defrec, revrec => $revrec,
2557 id => ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})),
2558 host => $host, rectype => $rectype, val => $val, addr => $addr,
2559 dist => \$dist, port => \$port, weight => \$weight,
2560 fields => \$fields, vallist => \@vallist,
2561 update => $id) );
2562
2563 return ($retcode,$retmsg) if $retcode eq 'FAIL';
2564
2565 # Set up database fields and bind parameters. Note only the optional fields
2566 # (distance, weight, port, secondary parent ID) are added in the validation call above
2567 $fields .= "host,type,val,ttl,"._recparent($defrec,$revrec);
2568 push @vallist, ($$host,$$rectype,$$val,$ttl,
2569 ($defrec eq 'y' ? $oldrec->{group_id} : ($revrec eq 'n' ? $oldrec->{domain_id} : $oldrec->{rdns_id})) );
2570
2571 # hack hack PTHUI
2572 # need to forcibly make sure we disassociate a record with a parent it's no longer related to.
2573 # eg, PTR records may not have a domain parent, or A/AAAA records may not have a revzone parent.
2574 # mainly needed for crossover types that got coerced down to "standard" types
2575 if ($defrec eq 'n') {
2576 if ($$rectype == $reverse_typemap{PTR}) {
2577 $fields .= ",domain_id";
2578 push @vallist, 0;
2579 }
2580 if ($$rectype == $reverse_typemap{A} || $$rectype == $reverse_typemap{AAAA}) {
2581 $fields .= ",rdns_id";
2582 push @vallist, 0;
2583 }
2584 }
2585
2586 # Fiddle the field list into something suitable for updates
2587 $fields =~ s/,/=?,/g;
2588 $fields .= "=?";
2589
2590 local $dbh->{AutoCommit} = 0;
2591 local $dbh->{RaiseError} = 1;
2592
2593 eval {
2594 $dbh->do("UPDATE "._rectable($defrec,$revrec)." SET $fields WHERE record_id=?", undef, (@vallist, $id) );
2595 $dbh->commit;
2596 };
2597 if ($@) {
2598 my $msg = $@;
2599 $dbh->rollback;
2600 return ('FAIL', $msg);
2601 }
2602
2603 return ($retcode, $retmsg);
2604} # end updateRec()
2605
2606
2607## DNSDB::delRec()
2608# Delete a record.
2609sub delRec {
2610 $errstr = '';
2611 my $dbh = shift;
2612 my $defrec = shift;
2613 my $revrec = shift;
2614 my $id = shift;
2615
2616 my $sth = $dbh->prepare("DELETE FROM "._rectable($defrec,$revrec)." WHERE record_id=?");
2617 $sth->execute($id);
2618
2619 return ('FAIL',"Couldn't remove record: ".$sth->errstr) if $sth->err;
2620
2621 return ('OK','OK');
2622} # end delRec()
2623
2624
2625 # Reference hashes.
2626my %par_tbl = (
2627 group => 'groups',
2628 user => 'users',
2629 defrec => 'default_records',
2630 defrevrec => 'default_rev_records',
2631 domain => 'domains',
2632 revzone => 'revzones',
2633 record => 'records'
2634 );
2635my %id_col = (
2636 group => 'group_id',
2637 user => 'user_id',
2638 defrec => 'record_id',
2639 defrevrec => 'record_id',
2640 domain => 'domain_id',
2641 revzone => 'rdns_id',
2642 record => 'record_id'
2643 );
2644my %par_col = (
2645 group => 'parent_group_id',
2646 user => 'group_id',
2647 defrec => 'group_id',
2648 defrevrec => 'group_id',
2649 domain => 'group_id',
2650 revzone => 'group_id',
2651 record => 'domain_id'
2652 );
2653my %par_type = (
2654 group => 'group',
2655 user => 'group',
2656 defrec => 'group',
2657 defrevrec => 'group',
2658 domain => 'group',
2659 revzone => 'group',
2660 record => 'domain'
2661 );
2662
2663
2664## DNSDB::getTypelist()
2665# Get a list of record types for various UI dropdowns
2666# Takes database handle, forward/reverse/lookup flag, and optional "tag as selected" indicator (defaults to A)
2667# Returns an arrayref to list of hashrefs perfect for HTML::Template
2668sub getTypelist {
2669 my $dbh = shift;
2670 my $recgroup = shift;
2671 my $type = shift || $reverse_typemap{A};
2672
2673 # also accepting $webvar{revrec}!
2674 $recgroup = 'f' if $recgroup eq 'n';
2675 $recgroup = 'r' if $recgroup eq 'y';
2676
2677 my $sql = "SELECT val,name FROM rectypes WHERE ";
2678 if ($recgroup eq 'r') {
2679 # reverse zone types
2680 $sql .= "stdflag=2 OR stdflag=3";
2681 } elsif ($recgroup eq 'l') {
2682 # DNS lookup types. Note we avoid our custom types >= 65280, since those are entirely internal.
2683 $sql .= "(stdflag=1 OR stdflag=2 OR stdflag=3) AND val < 65280";
2684 } else {
2685 # default; forward zone types. technically $type eq 'f' but not worth the error message.
2686 $sql .= "stdflag=1 OR stdflag=2";
2687 }
2688 $sql .= " ORDER BY listorder";
2689
2690 my $sth = $dbh->prepare($sql);
2691 $sth->execute;
2692 my @typelist;
2693 while (my ($rval,$rname) = $sth->fetchrow_array()) {
2694 my %row = ( recval => $rval, recname => $rname );
2695 $row{tselect} = 1 if $rval == $type;
2696 push @typelist, \%row;
2697 }
2698
2699 # Add SOA on lookups since it's not listed in other dropdowns.
2700 if ($recgroup eq 'l') {
2701 my %row = ( recval => $reverse_typemap{SOA}, recname => 'SOA' );
2702 $row{tselect} = 1 if $reverse_typemap{SOA} == $type;
2703 push @typelist, \%row;
2704 }
2705
2706 return \@typelist;
2707} # end getTypelist()
2708
2709
2710## DNSDB::parentID()
2711# Get ID of entity that is nearest parent to requested id
2712# Takes a database handle and a hash of entity ID, entity type, optional parent type flag
2713# (domain/reverse zone or group), and optional default/live and forward/reverse flags
2714# Returns the ID or undef on failure
2715sub parentID {
2716 my $dbh = shift;
2717
2718 my %args = @_;
2719
2720 # clean up the parent-type. Set it to group if not set; coerce revzone to domain for simpler logic
2721 $args{partype} = 'group' if !$args{partype};
2722 $args{partype} = 'domain' if $args{partype} eq 'revzone';
2723
2724 # clean up defrec and revrec. default to live record, forward zone
2725 $args{defrec} = 'n' if !$args{defrec};
2726 $args{revrec} = 'n' if !$args{revrec};
2727
2728 if ($par_type{$args{partype}} eq 'domain') {
2729 # only live records can have a domain/zone parent
2730 return unless ($args{type} eq 'record' && $args{defrec} eq 'n');
2731 my $result = $dbh->selectrow_hashref("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
2732 " FROM records WHERE record_id = ?",
2733 undef, ($args{id}) ) or return;
2734 return $result;
2735 } else {
2736 # snag some arguments that will either fall through or be overwritten to save some code duplication
2737 my $tmpid = $args{id};
2738 my $type = $args{type};
2739 if ($type eq 'record' && $args{defrec} eq 'n') {
2740 # Live records go through the records table first.
2741 ($tmpid) = $dbh->selectrow_array("SELECT ".($args{revrec} eq 'n' ? 'domain_id' : 'rdns_id').
2742 " FROM records WHERE record_id = ?",
2743 undef, ($args{id}) ) or return;
2744 $type = ($args{revrec} eq 'n' ? 'domain' : 'revzone');
2745 }
2746 my ($result) = $dbh->selectrow_array("SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?",
2747 undef, ($tmpid) );
2748 return $result;
2749 }
2750# should be impossible to get here with even remotely sane arguments
2751 return;
2752} # end parentID()
2753
2754
2755## DNSDB::isParent()
2756# Returns true if $id1 is a parent of $id2, false otherwise
2757sub isParent {
2758 my $dbh = shift;
2759 my $id1 = shift;
2760 my $type1 = shift;
2761 my $id2 = shift;
2762 my $type2 = shift;
2763##todo: immediate, secondary, full (default)
2764
2765 # Return false on invalid types
2766 return 0 if !grep /^$type1$/, ('record','defrec','defrevrec','user','domain','revzone','group');
2767 return 0 if !grep /^$type2$/, ('record','defrec','defrevrec','user','domain','revzone','group');
2768
2769 # Return false on impossible relations
2770 return 0 if $type1 eq 'record'; # nothing may be a child of a record
2771 return 0 if $type1 eq 'defrec'; # nothing may be a child of a record
2772 return 0 if $type1 eq 'defrevrec'; # nothing may be a child of a record
2773 return 0 if $type1 eq 'user'; # nothing may be child of a user
2774 return 0 if $type1 eq 'domain' && $type2 ne 'record'; # domain may not be a parent of anything other than a record
2775 return 0 if $type1 eq 'revzone' && $type2 ne 'record';# reverse zone may not be a parent of anything other than a record
2776
2777 # ennnhhhh.... if we're passed an id of 0, it will never be found. usual
2778 # case would be the UI creating a new <thing>, and so we don't have an ID for
2779 # <thing> to look up yet. in that case the UI should check the parent as well.
2780 return 0 if $id1 == 0; # nothing can have a parent id of 0
2781 return 1 if $id2 == 0; # anything could have a child id of 0 (or "unknown")
2782
2783 # group 1 is the ultimate root parent
2784 return 1 if $type1 eq 'group' && $id1 == 1;
2785
2786 # groups are always (a) parent of themselves
2787 return 1 if $type1 eq 'group' && $type2 eq 'group' && $id1 == $id2;
2788
2789 my $id = $id2;
2790 my $type = $type2;
2791 my $foundparent = 0;
2792
2793 # Records are the only entity with two possible parents. We need to split the parent checks on
2794 # domain/rdns.
2795 if ($type eq 'record') {
2796 my ($dom,$rdns) = $dbh->selectrow_array("SELECT domain_id,rdns_id FROM records WHERE record_id=?",
2797 undef, ($id));
2798 # check immediate parent against request
2799 return 1 if $type1 eq 'domain' && $id1 == $dom;
2800 return 1 if $type1 eq 'revzone' && $id1 == $rdns;
2801 # if request is group, check *both* parents. Only check if the parent is nonzero though.
2802 return 1 if $dom && isParent($dbh, $id1, $type1, $dom, 'domain');
2803 return 1 if $rdns && isParent($dbh, $id1, $type1, $rdns, 'revzone');
2804 # exit here since we've executed the loop below by proxy in the above recursive calls.
2805 return 0;
2806 }
2807
2808# almost the same loop as getParents() above
2809 my $limiter = 0;
2810 while (1) {
2811 my $sql = "SELECT $par_col{$type} FROM $par_tbl{$type} WHERE $id_col{$type} = ?";
2812 my $result = $dbh->selectrow_hashref($sql,
2813 undef, ($id) );
2814 if (!$result) {
2815 $limiter++;
2816##fixme: how often will this happen on a live site? fail at max limiter <n>?
2817 warn "no results looking for $sql with id $id (depth $limiter)\n";
2818 last;
2819 }
2820 if ($result && $result->{$par_col{$type}} == $id1) {
2821 $foundparent = 1;
2822 last;
2823 } else {
2824##fixme: do we care about trying to return a "no such record/domain/user/group" error?
2825# should be impossible to create an inconsistent DB just with API calls.
2826 warn $dbh->errstr." $sql, $id" if $dbh->errstr;
2827 }
2828 # group 1 is its own parent. need this here more to break strange loops than for detecting a parent
2829 last if $result->{$par_col{$type}} == 1;
2830 $id = $result->{$par_col{$type}};
2831 $type = $par_type{$type};
2832 }
2833
2834 return $foundparent;
2835} # end isParent()
2836
2837
2838## DNSDB::zoneStatus()
2839# Returns and optionally sets a zone's status
2840# Takes a database handle, domain/revzone ID, forward/reverse flag, and optionally a status argument
2841# Returns status, or undef on errors.
2842sub zoneStatus {
2843 my $dbh = shift;
2844 my $id = shift;
2845 my $revrec = shift;
2846 my $newstatus = shift || 'mu';
2847
2848 return undef if $id !~ /^\d+$/;
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 'domoff';
2859 $newstatus = 1 if $newstatus eq 'domon';
2860 $dbh->do("UPDATE ".($revrec eq 'n' ? 'domains' : 'revzones')." SET status=? WHERE ".
2861 ($revrec eq 'n' ? 'domain_id' : 'rdns_id')."=?", undef, ($newstatus,$id) );
2862
2863##fixme switch to more consise "Enabled <domain"/"Disabled <domain>" as with users?
2864 $resultstr = "Changed ".($revrec eq 'n' ? domainName($dbh, $id) : revName($dbh, $id)).
2865 " state to ".($newstatus ? 'active' : 'inactive');
2866
2867 my %loghash;
2868 $loghash{domain_id} = $id if $revrec eq 'n';
2869 $loghash{rdns_id} = $id if $revrec eq 'y';
2870 $loghash{group_id} = parentID($dbh,
2871 (id => $id, type => ($revrec eq 'n' ? 'domain' : 'revzone'), revrec => $revrec) );
2872 $loghash{entry} = $resultstr;
2873 _log($dbh, %loghash);
2874
2875 $dbh->commit;
2876 };
2877 if ($@) {
2878 my $msg = $@;
2879 eval { $dbh->rollback; };
2880 $resultstr = '';
2881 $errstr = $msg;
2882 return;
2883 }
2884 }
2885
2886 my ($status) = $dbh->selectrow_array("SELECT status FROM ".
2887 ($revrec eq 'n' ? "domains WHERE domain_id=?" : "revzones WHERE rdns_id=?"),
2888 undef, ($id) );
2889 return $status;
2890} # end zoneStatus()
2891
2892
2893## DNSDB::importAXFR
2894# Import a domain via AXFR
2895# Takes AXFR host, domain to transfer, group to put the domain in,
2896# and optionally:
2897# - active/inactive state flag (defaults to active)
2898# - overwrite-SOA flag (defaults to off)
2899# - overwrite-NS flag (defaults to off, doesn't affect subdomain NS records)
2900# Returns a status code (OK, WARN, or FAIL) and message - message should be blank
2901# if status is OK, but WARN includes conditions that are not fatal but should
2902# really be reported.
2903sub importAXFR {
2904 my $dbh = shift;
2905 my $ifrom_in = shift;
2906 my $domain = shift;
2907 my $group = shift;
2908 my $status = shift || 1;
2909 my $rwsoa = shift || 0;
2910 my $rwns = shift || 0;
2911
2912##fixme: add mode to delete&replace, merge+overwrite, merge new?
2913
2914 my $nrecs = 0;
2915 my $soaflag = 0;
2916 my $nsflag = 0;
2917 my $warnmsg = '';
2918 my $ifrom;
2919
2920 # choke on possible bad setting in ifrom
2921 # IPv4 and v6, and valid hostnames!
2922 ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
2923 return ('FAIL', "Bad AXFR source host $ifrom")
2924 unless ($ifrom) = ($ifrom_in =~ /^([0-9a-f\:.]+|[0-9a-z_.-]+)$/i);
2925
2926 # Allow transactions, and raise an exception on errors so we can catch it later.
2927 # Use local to make sure these get "reset" properly on exiting this block
2928 local $dbh->{AutoCommit} = 0;
2929 local $dbh->{RaiseError} = 1;
2930
2931 my $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
2932 my $dom_id;
2933
2934# quick check to start to see if we've already got one
2935 $sth->execute($domain);
2936 ($dom_id) = $sth->fetchrow_array;
2937
2938 return ('FAIL', "Domain already exists") if $dom_id;
2939
2940 eval {
2941 # can't do this, can't nest transactions. sigh.
2942 #my ($dcode, $dmsg) = addDomain(dbh, domain, group, status);
2943
2944##fixme: serial
2945 my $sth = $dbh->prepare("INSERT INTO domains (domain,group_id,status) VALUES (?,?,?)");
2946 $sth->execute($domain,$group,$status);
2947
2948## bizarre DBI<->Net::DNS interaction bug:
2949## sometimes a zone will cause an immediate commit-and-exit (sort of) of the while()
2950## fixed, apparently I was doing *something* odd, but not certain what it was that
2951## caused a commit instead of barfing
2952
2953 # get domain id so we can do the records
2954 $sth = $dbh->prepare("SELECT domain_id FROM domains WHERE domain=?");
2955 $sth->execute($domain);
2956 ($dom_id) = $sth->fetchrow_array();
2957
2958 my $res = Net::DNS::Resolver->new;
2959 $res->nameservers($ifrom);
2960 $res->axfr_start($domain)
2961 or die "Couldn't begin AXFR\n";
2962
2963 while (my $rr = $res->axfr_next()) {
2964 my $type = $rr->type;
2965
2966 my $sql = "INSERT INTO records (domain_id,host,type,ttl,val";
2967 my $vallen = "?,?,?,?,?";
2968
2969 $soaflag = 1 if $type eq 'SOA';
2970 $nsflag = 1 if $type eq 'NS';
2971
2972 my @vallist = ($dom_id, $rr->name, $reverse_typemap{$type}, $rr->ttl);
2973
2974# "Primary" types:
2975# A, NS, CNAME, SOA, PTR(warn in forward), MX, TXT, AAAA, SRV, A6(ob), SPF
2976# maybe KEY
2977
2978# nasty big ugly case-like thing here, since we have to do *some* different
2979# processing depending on the record. le sigh.
2980
2981##fixme: what record types other than TXT can/will have >255-byte payloads?
2982
2983 if ($type eq 'A') {
2984 push @vallist, $rr->address;
2985 } elsif ($type eq 'NS') {
2986# hmm. should we warn here if subdomain NS'es are left alone?
2987 next if ($rwns && ($rr->name eq $domain));
2988 push @vallist, $rr->nsdname;
2989 $nsflag = 1;
2990 } elsif ($type eq 'CNAME') {
2991 push @vallist, $rr->cname;
2992 } elsif ($type eq 'SOA') {
2993 next if $rwsoa;
2994 $vallist[1] = $rr->mname.":".$rr->rname;
2995 push @vallist, ($rr->refresh.":".$rr->retry.":".$rr->expire.":".$rr->minimum);
2996 $soaflag = 1;
2997 } elsif ($type eq 'PTR') {
2998 push @vallist, $rr->ptrdname;
2999 # hmm. PTR records should not be in forward zones.
3000 } elsif ($type eq 'MX') {
3001 $sql .= ",distance";
3002 $vallen .= ",?";
3003 push @vallist, $rr->exchange;
3004 push @vallist, $rr->preference;
3005 } elsif ($type eq 'TXT') {
3006##fixme: Net::DNS docs say this should be deprecated for rdatastr() or char_str_list(),
3007## but don't really seem enthusiastic about it.
3008 my $rrdata = $rr->txtdata;
3009 push @vallist, $rrdata;
3010 } elsif ($type eq 'SPF') {
3011##fixme: and the same caveat here, since it is apparently a clone of ::TXT
3012 my $rrdata = $rr->txtdata;
3013 push @vallist, $rrdata;
3014 } elsif ($type eq 'AAAA') {
3015 push @vallist, $rr->address;
3016 } elsif ($type eq 'SRV') {
3017 $sql .= ",distance,weight,port" if $type eq 'SRV';
3018 $vallen .= ",?,?,?" if $type eq 'SRV';
3019 push @vallist, $rr->target;
3020 push @vallist, $rr->priority;
3021 push @vallist, $rr->weight;
3022 push @vallist, $rr->port;
3023 } elsif ($type eq 'KEY') {
3024 # we don't actually know what to do with these...
3025 push @vallist, ($rr->flags.":".$rr->protocol.":".$rr->algorithm.":".$rr->key.":".$rr->keytag.":".$rr->privatekeyname);
3026 } else {
3027 my $rrdata = $rr->rdatastr;
3028 push @vallist, $rrdata;
3029 # Finding a different record type is not fatal.... just problematic.
3030 # We may not be able to export it correctly.
3031 $warnmsg .= "Unusual record ".$rr->name." ($type) found\n";
3032 }
3033
3034# BIND supports:
3035# A CNAME HINFO MB(ex) MD(ob) MF(ob) MG(ex) MINFO(ex) MR(ex) MX NS NULL
3036# PTR SOA TXT WKS AFSDB(ex) ISDN(ex) RP(ex) RT(ex) X25(ex) PX
3037# ... if one can ever find the right magic to format them correctly
3038
3039# Net::DNS supports:
3040# RRSIG SIG NSAP NS NIMLOC NAPTR MX MR MINFO MG MB LOC ISDN IPSECKEY HINFO
3041# EID DNAME CNAME CERT APL AFSDB AAAA A DS NXT NSEC3PARAM NSEC3 NSEC KEY
3042# DNSKEY DLV X25 TXT TSIG TKEY SSHFP SRV SPF SOA RT RP PX PTR NULL APL::AplItem
3043
3044 $sth = $dbh->prepare($sql.") VALUES (".$vallen.")") or die "problem preparing record insert SQL\n";
3045 $sth->execute(@vallist) or die "failed to insert ".$rr->string.": ".$sth->errstr."\n";
3046
3047 $nrecs++;
3048
3049 } # while axfr_next
3050
3051 # Overwrite SOA record
3052 if ($rwsoa) {
3053 $soaflag = 1;
3054 my $sthgetsoa = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
3055 my $sthputsoa = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
3056 $sthgetsoa->execute($group,$reverse_typemap{SOA});
3057 while (my ($host,$val,$ttl) = $sthgetsoa->fetchrow_array()) {
3058 $host =~ s/DOMAIN/$domain/g;
3059 $val =~ s/DOMAIN/$domain/g;
3060 $sthputsoa->execute($dom_id,$host,$reverse_typemap{SOA},$val,$ttl);
3061 }
3062 }
3063
3064 # Overwrite NS records
3065 if ($rwns) {
3066 $nsflag = 1;
3067 my $sthgetns = $dbh->prepare("SELECT host,val,ttl FROM default_records WHERE group_id=? AND type=?");
3068 my $sthputns = $dbh->prepare("INSERT INTO records (domain_id,host,type,val,ttl) VALUES (?,?,?,?,?)");
3069 $sthgetns->execute($group,$reverse_typemap{NS});
3070 while (my ($host,$val,$ttl) = $sthgetns->fetchrow_array()) {
3071 $host =~ s/DOMAIN/$domain/g;
3072 $val =~ s/DOMAIN/$domain/g;
3073 $sthputns->execute($dom_id,$host,$reverse_typemap{NS},$val,$ttl);
3074 }
3075 }
3076
3077 die "No records found; either $ifrom is not authoritative or doesn't allow transfers\n" if !$nrecs;
3078 die "Bad zone: No SOA record!\n" if !$soaflag;
3079 die "Bad zone: No NS records!\n" if !$nsflag;
3080
3081 $dbh->commit;
3082
3083 };
3084
3085 if ($@) {
3086 my $msg = $@;
3087 eval { $dbh->rollback; };
3088 return ('FAIL',$msg." $warnmsg");
3089 } else {
3090 return ('WARN', $warnmsg) if $warnmsg;
3091 return ('OK',"Imported OK");
3092 }
3093
3094 # it should be impossible to get here.
3095 return ('WARN',"OOOK!");
3096} # end importAXFR()
3097
3098
3099## DNSDB::export()
3100# Export the DNS database, or a part of it
3101# Takes database handle, export type, optional arguments depending on type
3102# Writes zone data to targets as appropriate for type
3103sub export {
3104 my $dbh = shift;
3105 my $target = shift;
3106
3107 if ($target eq 'tiny') {
3108 __export_tiny($dbh,@_);
3109 }
3110# elsif ($target eq 'foo') {
3111# __export_foo($dbh,@_);
3112#}
3113# etc
3114
3115} # end export()
3116
3117
3118## DNSDB::__export_tiny
3119# Internal sub to implement tinyDNS (compatible) export
3120# Takes database handle, filehandle to write export to, optional argument(s)
3121# to determine which data gets exported
3122sub __export_tiny {
3123 my $dbh = shift;
3124 my $datafile = shift;
3125
3126##fixme: slurp up further options to specify particular zone(s) to export
3127
3128 ## Convert a bare number into an octal-coded pair of octets.
3129 # Take optional arg to indicate a decimal or hex input. Defaults to hex.
3130 sub octalize {
3131 my $tmp = shift;
3132 my $srctype = shift || 'h'; # default assumes hex string
3133 $tmp = sprintf "%0.4x", hex($tmp) if $srctype eq 'h'; # 0-pad hex to 4 digits
3134 $tmp = sprintf "%0.4x", $tmp if $srctype eq 'd'; # 0-pad decimal to 4 hex digits
3135 my @o = ($tmp =~ /^(..)(..)$/); # split into octets
3136 return sprintf "\\%0.3o\\%0.3o", hex($o[0]), hex($o[1]);;
3137 }
3138
3139##fixme: fail if $datafile isn't an open, writable file
3140
3141 # easy case - export all evarything
3142 # not-so-easy case - export item(s) specified
3143 # todo: figure out what kind of list we use to export items
3144
3145 my $domsth = $dbh->prepare("SELECT domain_id,domain,status FROM domains WHERE status=1");
3146 my $recsth = $dbh->prepare("SELECT host,type,val,distance,weight,port,ttl ".
3147 "FROM records WHERE domain_id=?");
3148 $domsth->execute();
3149 while (my ($domid,$dom,$domstat) = $domsth->fetchrow_array) {
3150 $recsth->execute($domid);
3151 while (my ($host,$type,$val,$dist,$weight,$port,$ttl) = $recsth->fetchrow_array) {
3152##fixme: need to store location in the db, and retrieve it here.
3153# temporarily hardcoded to empty so we can include it further down.
3154my $loc = '';
3155
3156##fixme: record validity timestamp. tinydns supports fiddling with timestamps.
3157# note $ttl must be set to 0 if we want to use tinydns's auto-expiring timestamps.
3158# timestamps are TAI64
3159# ~~ 2^62 + time()
3160my $stamp = '';
3161
3162# raw packet in unknown format: first byte indicates length
3163# of remaining data, allows up to 255 raw bytes
3164
3165##fixme? append . to all host/val hostnames
3166 if ($typemap{$type} eq 'SOA') {
3167
3168 # host contains pri-ns:responsible
3169 # val is abused to contain refresh:retry:expire:minttl
3170##fixme: "manual" serial vs tinydns-autoserial
3171 # let's be explicit about abusing $host and $val
3172 my ($email, $primary) = (split /:/, $host)[0,1];
3173 my ($refresh, $retry, $expire, $min_ttl) = (split /:/, $val)[0,1,2,3];
3174 print $datafile "Z$dom:$primary:$email"."::$refresh:$retry:$expire:$min_ttl:$ttl:$stamp:$loc\n";
3175
3176 } elsif ($typemap{$type} eq 'A') {
3177
3178 print $datafile "+$host:$val:$ttl:$stamp:$loc\n";
3179
3180 } elsif ($typemap{$type} eq 'NS') {
3181
3182 print $datafile "\&$host"."::$val:$ttl:$stamp:$loc\n";
3183
3184 } elsif ($typemap{$type} eq 'AAAA') {
3185
3186 print $datafile ":$host:28:";
3187 my $altgrp = 0;
3188 my @altconv;
3189 # Split in to up to 8 groups of hex digits (allows for IPv6 :: 0-collapsing)
3190 foreach (split /:/, $val) {
3191 if (/^$/) {
3192 # flag blank entry; this is a series of 0's of (currently) unknown length
3193 $altconv[$altgrp++] = 's';
3194 } else {
3195 # call sub to convert 1-4 hex digits to 2 string-rep octal bytes
3196 $altconv[$altgrp++] = octalize($_)
3197 }
3198 }
3199 foreach my $octet (@altconv) {
3200 # if not 's', output
3201 print $datafile $octet unless $octet =~ /^s$/;
3202 # if 's', output (9-array length)x literal '\000\000'
3203 print $datafile '\000\000'x(9-$altgrp) if $octet =~ /^s$/;
3204 }
3205 print $datafile ":$ttl:$stamp:$loc\n";
3206
3207 } elsif ($typemap{$type} eq 'MX') {
3208
3209 print $datafile "\@$host"."::$val:$dist:$ttl:$stamp:$loc\n";
3210
3211 } elsif ($typemap{$type} eq 'TXT') {
3212
3213##fixme: split v-e-r-y long TXT strings? will need to do so for BIND export, at least
3214 $val =~ s/:/\\072/g; # may need to replace other symbols
3215 print $datafile "'$host:$val:$ttl:$stamp:$loc\n";
3216
3217# by-hand TXT
3218#:deepnet.cx:16:2v\075spf1\040a\040a\072bacon.deepnet.cx\040a\072home.deepnet.cx\040-all:3600
3219#@ IN TXT "v=spf1 a a:bacon.deepnet.cx a:home.deepnet.cx -all"
3220#'deepnet.cx:v=spf1 a a\072bacon.deepnet.cx a\072home.deepnet.cx -all:3600
3221
3222#txttest IN TXT "v=foo bar:bob kn;ob' \" !@#$%^&*()-=_+[]{}<>?"
3223#: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
3224
3225# very long TXT record as brought in by axfr-get
3226# note tinydns does not support >512-byte RR data, need axfr-dns (for TCP support) for that
3227# also note, tinydns does not seem to support <512, >256-byte RRdata from axfr-get either. :/
3228#:longtxt.deepnet.cx:16:
3229#\170this is a very long txt record. it is really long. long. very long. really very long. this is a very long txt record.
3230#\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.
3231#\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.
3232#:3600
3233
3234 } elsif ($typemap{$type} eq 'CNAME') {
3235
3236 print $datafile "C$host:$val:$ttl:$stamp:$loc\n";
3237
3238 } elsif ($typemap{$type} eq 'SRV') {
3239
3240 # data is two-byte values for priority, weight, port, in that order,
3241 # followed by length/string data
3242
3243 print $datafile ":$host:33:".octalize($dist,'d').octalize($weight,'d').octalize($port,'d');
3244
3245 $val .= '.' if $val !~ /\.$/;
3246 foreach (split /\./, $val) {
3247 printf $datafile "\\%0.3o%s", length($_), $_;
3248 }
3249 print $datafile "\\000:$ttl:$stamp:$loc\n";
3250
3251 } elsif ($typemap{$type} eq 'RP') {
3252
3253 # RP consists of two mostly free-form strings.
3254 # The first is supposed to be an email address with @ replaced by . (as with the SOA contact)
3255 # The second is the "hostname" of a TXT record with more info.
3256 print $datafile ":$host:17:";
3257 my ($who,$what) = split /\s/, $val;
3258 foreach (split /\./, $who) {
3259 printf $datafile "\\%0.3o%s", length($_), $_;
3260 }
3261 print $datafile '\000';
3262 foreach (split /\./, $what) {
3263 printf $datafile "\\%0.3o%s", length($_), $_;
3264 }
3265 print $datafile "\\000:$ttl:$stamp:$loc\n";
3266
3267 } elsif ($typemap{$type} eq 'PTR') {
3268
3269 # must handle both IPv4 and IPv6
3270##work
3271 # data should already be in suitable reverse order.
3272 print $datafile "^$host:$val:$ttl:$stamp:$loc\n";
3273
3274 } else {
3275 # raw record. we don't know what's in here, so we ASS-U-ME the user has
3276 # put it in correctly, since either the user is messing directly with the
3277 # database, or the record was imported via AXFR
3278 # <split by char>
3279 # convert anything not a-zA-Z0-9.- to octal coding
3280
3281##fixme: add flag to export "unknown" record types - note we'll probably end up
3282# mangling them since they were written to the DB from Net::DNS::RR::<type>->rdatastr.
3283 #print $datafile ":$host:$type:$val:$ttl:$stamp:$loc\n";
3284
3285 } # record type if-else
3286
3287 } # while ($recsth)
3288 } # while ($domsth)
3289} # end __export_tiny()
3290
3291
3292## DNSDB::mailNotify()
3293# Sends notification mail to recipients regarding a DNSDB operation
3294sub mailNotify {
3295 my $dbh = shift;
3296 my ($subj,$message) = @_;
3297
3298 return if $config{mailhost} eq 'smtp.example.com'; # do nothing if still using default SMTP host.
3299
3300 my $mailer = Net::SMTP->new($config{mailhost}, Hello => "dnsadmin.$config{domain}");
3301
3302 my $mailsender = ($config{mailsender} ? $config{mailsender} : $config{mailnotify});
3303
3304 $mailer->mail($mailsender);
3305 $mailer->to($config{mailnotify});
3306 $mailer->data("From: \"$config{mailname}\" <$mailsender>\n",
3307 "To: <$config{mailnotify}>\n",
3308 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
3309 "Subject: $subj\n",
3310 "X-Mailer: DNSAdmin Notify v".sprintf("%.1d",$DNSDB::VERSION)."\n",
3311 "Organization: $config{orgname}\n",
3312 "\n$message\n");
3313 $mailer->quit;
3314}
3315
3316# shut Perl up
33171;
Note: See TracBrowser for help on using the repository browser.