source: trunk/DNSDB.pm@ 257

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

/trunk

Fix update to calls to _log from r256. See #26

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