# # Copyright 2006-2011 SPARTA, Inc. All rights reserved. See the COPYING # file distributed with this software for details # # DNSSEC Tools # # dnssectools.pm - General functions for DNSSEC-Tools. # # This module provides a place for disparate interfaces needed by # DNSSEC-Tools programs. # package Net::DNS::SEC::Tools::dnssectools; require Exporter; use strict; use Mail::Send; use Net::DNS::SEC::Tools::conf; use Net::DNS::SEC::Tools::defaults; use Net::DNS::SEC::Tools::keyrec; use Net::DNS::SEC::Tools::rollrec; our $VERSION = "1.9"; our $MODULE_VERSION = "1.9.0"; our @ISA = qw(Exporter); our @EXPORT = qw( dt_adminmail dt_cmdpath dt_filetype ); # # List of valid DNSSEC-Tools commands. Used by dt_cmdpath(). # my %dtcmds = ( "blinkenlights" => 1, "cleanarch" => 1, "cleankrf" => 1, "dtconf" => 1, "dtconfchk" => 1, "dtdefs" => 1, "dtinitconf" => 1, "expchk" => 1, "fixkrf" => 1, "genkrf" => 1, "getdnskeys" => 1, "keyarch" => 1, "krfcheck" => 1, "lskrf" => 1, "lsroll" => 1, "rollchk" => 1, "rollctl" => 1, "rollerd" => 1, "rollinit" => 1, "rolllog" => 1, "rollrec-editor" => 1, "rollset" => 1, "signset-editor" => 1, "tachk" => 1, "timetrans" => 1, "trustman" => 1, "zonesigner" => 1, ); #----------------------------------------------------------------------------- # # Routine: dt_adminmail() # # Purpose: This routine emails a message to the administrative user # listed in the DNSSEC-Tools configuration file. # sub dt_adminmail { my $subject = shift; # Message subject. my $msgbody = shift; # Message body. my $sendto = ""; # Message recipient. my $msg; # Message object. my $mh; # Mail handler. my %dtconf; # DNSSEC-Tools config file. my @mailargs; # # Get the message recipient. If the caller didn't specify one, # we'll use the default recipient from the config file. # if(@_) { $sendto = shift; } else { # # Get the default DNSEEC-Tools administrative contact. # %dtconf = parseconfig(); return(0) if(!defined($dtconf{'admin-email'})); $sendto = $dtconf{'admin-email'}; } # # Ensure we really have a recipient. # return(0) if($sendto eq ""); # # If things are configured to not send email, we'll return success. # return(1) if($sendto eq "nomail"); # # Create the message object. # $msg = new Mail::Send; # # Add some message headers. # $msg->to($sendto); $msg->subject($subject); # # Open the "connection" and add the message body. # push @mailargs, $dtconf{'mailer-type'} if(defined($dtconf{'mailer-type'})); push @mailargs, 'smtp' if(!defined($dtconf{'mailer-type'}) && defined($dtconf{'mailer-server'})); push @mailargs, Server => $dtconf{'mailer-server'} if(defined($dtconf{'mailer-server'})); eval { $mh = $msg->open(@mailargs); }; return(0) if $@; print $mh $msgbody . "\n"; # # Complete the message and send it. # eval { $mh->close; }; return(0) if $@; return(1); } #----------------------------------------------------------------------------- # Routine: dt_cmdpath() # # Purpose: This routine returns the path to a DNSSEC-Tools command. # Null is returned if the command isn't a valid DNSSEC-Tools # command. Otherwise, the command's path is returned. # sub dt_cmdpath { my $cmd = shift; # Command to pathenate. return('') if($cmd eq ''); return('') if(!$dtcmds{$cmd}); return(dnssec_tools_default($cmd)); } #----------------------------------------------------------------------------- # Routine: dt_filetype() # # Purpose: This routine returns the type of a DNSSEC-Tools file. # It is given a path and it counts the rollrec and keyrec # records contained therein. # # The following return values are possible: # # "keyrec" At least one keyrec record was found # and no rollrec records were found. # # "rollrec" At least one rollrec record was found # and no keyrec records were found. # # "mixed" At least one rollrec record and at # least one keyrec record were found. # This is most likely an erroneous file. # # "unknown" No rollrec records nor keyrec records # were found. # # "nofile" The file doesn't exist. # # Interpretation of the result is application dependent. # sub dt_filetype { my $path = shift; # File to check. my @names; # Record names in file. my $rcnt = 0; # Count of rollrec records. my $kcnt = 0; # Count of keyrec records. # # Ensure the file exists. # return("nofile") if(!-e $path); # # Get the record names as if it were a rollrec file. # @names = (); rollrec_read($path); @names = rollrec_names(); rollrec_close(); # # Count the valid record names. # foreach my $name (sort (@names)) { $rcnt++ if($name ne ""); } # # Get the record names as if it were a keyrec file. # @names = (); keyrec_read($path); @names = keyrec_names(); keyrec_close(); # # Count the valid record names. # foreach my $name (sort (@names)) { $kcnt++ if($name ne ""); } # print "keyrec count - $kcnt\trollrec count - $rcnt\n"; # # Return the type of file we found this to be. # return("rollrec") if( $rcnt && !$kcnt); return("keyrec") if(!$rcnt && $kcnt); return("mixed") if( $rcnt && $kcnt); return("unknown"); } 1; ############################################################################# =pod =head1 NAME Net::DNS::SEC::Tools::dnssectools - General routines for the DNSSEC-Tools package. =head1 SYNOPSIS use Net::DNS::SEC::Tools::dnssectools; dt_adminmail($subject,$msgbody,$recipient); $zspath = dt_cmdpath('zonesigner'); $ftype = dt_findtype($path); =head1 DESCRIPTION The B module provides a general set of methods for use with DNSSEC-Tools utilities. =head1 INTERFACES The interfaces to the B module are given below. =over 4 =item I This routine emails a message to the administrative user listed in the DNSSEC-Tools configuration file. I requires two parameters, both scalars. The I parameter is the subject for the mail message. The I parameter is the body of the mail message. A third parameter, I, may be given to specify the message's recipient. If this is not given, then the recipient will be taken from the I record of the DNSSEC-Tools configuration file. If I is "nomail", then no message will be sent and success will be returned. Return values: 1 - the message was created and sent. 0 - an invalid recipient was specified. It relies on the the following dnssec-tools.conf configuration parameters: =back =over 4 =item I The email address that the mail should come from. =item I Should be one of: I. This option is not required and will default to trying sendmail and qmail to deliever the mail. If I is set to a defined value but I is not, then I will default to =item I The server, if I is set to I, that the mail should be delivered to. =item I This routine returns the path to a specified DNSSEC-Tools command. I should be the name only, without any leading directories. The command name is checked to ensure that it is a valid DNSEC-Tools command, Return values: The absolute path to the command is returned if the command is valid. Null is returned if the command is not valid. =item I This routine returns the type of the file named in I. The rollrec and keyrec records contained therein are counted and a type determination is made. Return values: "keyrec" - At least one keyrec record was found and no rollrec records were found. "rollrec" - At least one rollrec record was found and no keyrec records were found. "mixed" - At least one rollrec record and at least one keyrec record were found. This is most likely an erroneous file. "unknown" - No rollrec records nor keyrec records were found. "nofile" - The specified file does not exist. =back =head1 COPYRIGHT Copyright 2006-2011 SPARTA, Inc. All rights reserved. See the COPYING file included with the DNSSEC-Tools package for details. =head1 AUTHOR Wayne Morrison, tewok@users.sourceforge.net =head1 SEE ALSO B, B =cut # Local Variables: # tab-width: 4 # cperl-indent-level: 4 # End: