net::dns::sec::tools::dnssectools(3pm) [debian man page]
dnssectools(3pm) User Contributed Perl Documentation dnssectools(3pm) NAME
Net::DNS::SEC::Tools::dnssectools - General routines for the DNSSEC-Tools package. SYNOPSIS
use Net::DNS::SEC::Tools::dnssectools; dt_adminmail($subject,$msgbody,$recipient); $zspath = dt_cmdpath('zonesigner'); $ftype = dt_findtype($path); DESCRIPTION
The dnssectools module provides a general set of methods for use with DNSSEC-Tools utilities. INTERFACES
The interfaces to the dnssectools module are given below. dt_adminmail(subject,msgbody,recipient) This routine emails a message to the administrative user listed in the DNSSEC-Tools configuration file. dt_adminmail() requires two parameters, both scalars. The subject parameter is the subject for the mail message. The msgbody parameter is the body of the mail message. A third parameter, recipient, may be given to specify the message's recipient. If this is not given, then the recipient will be taken from the admin-email record of the DNSSEC-Tools configuration file. If recipient 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: admin-email The email address that the mail should come from. mailer-type Should be one of: sendmail, smtp, qmail. This option is not required and will default to trying sendmail and qmail to deliever the mail. If mailer-server is set to a defined value but mailer-type is not, then mailer-type will default to mailer-server The server, if admin-mail is set to smtp, that the mail should be delivered to. dt_cmdpath(command) This routine returns the path to a specified DNSSEC-Tools command. command 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. dt_filetype(path) This routine returns the type of the file named in path. 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. COPYRIGHT
Copyright 2006-2012 SPARTA, Inc. All rights reserved. See the COPYING file included with the DNSSEC-Tools package for details. AUTHOR
Wayne Morrison, tewok@tislabs.com SEE ALSO
Mail::Send.pm(3), Net::DNS::SEC::Tools::conf.pm(3) POD ERRORS
Hey! The above document had some coding errors, which are explained below: Around line 309: =back without =over perl v5.14.2 2012-06-28 dnssectools(3pm)
Check Out this Related Man Page
KEYMOD(1p) User Contributed Perl Documentation KEYMOD(1p) NAME
keymod - Modifies key parameters in a DNSSEC-Tools keyrec file SYNOPSIS
keymod [options] keyrec1 ... keyrecN DESCRIPTION
keymod modifies the key parameters in a keyrec file that are used to generate cryptographics keys used to sign zones. The new parameters will be used by zonesigner when generating new keys. It has no effect on existing keys. zonesigner will use the new parameter for a zone the next time it generates a key that requires that parameter. This means that, for example, a new ZSK length will not be used during the next invocation of zonesigner if that invocation will be performing KSK-rollover actions. The following fields may be modified: kskcount - count of KSK keys ksklength - length of KSK keys ksklife - lifetime of KSK keys random - random number generator device file revperiod - revocation period for KSK keys zskcount - count of ZSK keys zsklength - length of ZSK keys zsklife - lifetime of ZSK keys New key/value fields will be added to a zone keyrec file to inform zonesigner that new values should be used. The key portion of the added fields will begin with "new_". For example, a new KSK length of 2048 will be written to the keyrec file as: new_ksklength 2048 All zone records in the specified keyrec file will be modified, unless the -zone option is given. In that case, only the named zone will be modified. If a zone keyrec already contains a new key/value field, then the value will be modified on subsequent runs of keymod. OPTIONS
keymod recognizes the following options. Multiple options may be combined in a single keymod execution. All numeric values must be positive or zero. If a new key/value field should be deleted from a zone keyrec, then a zero or empty string value should be specified for the appropriate option. -zone zonename The zone keyrec whose name matches zonename is selected as the only keyrec that will be modified. If this name is not given, then all zone keyrec records will be modified. -ksklength ksklength The ksklength field will be modified in the selected keyrec records to the given value. This is a numeric field whose values depend on the cryptographic algorithm to be used to generate keys for the zone. -kskcount kskcount The kskcount field will be modified in the selected keyrec records to the given value. This is a numeric field. -ksklife ksklife The ksklife field will be modified in the selected keyrec records to the given value. This is a numeric field. -random random The random field will be modified in the selected keyrec records to the given value. This is a text field that will be passed to the key generator. -revperiod revperiod The revperiod field will be modified in the selected keyrec records to the given value. This is a numeric field. -zskcount zskcount The zskcount field will be modified in the selected keyrec records to the given value. This is a numeric field. -zsklength zsklength The zsklength field will be modified in the selected keyrec records to the given value. This is a numeric field whose values depend on the cryptographic algorithm to be used to generate keys for the zone. -zsklife zsklife The zsklife field will be modified in the selected keyrec records to the given value. This is a numeric field. -nocheck If this option is given, the krfcheck command will not be run on the modified keyrec file. -verbose Display information about every modification made to the keyrec file. -Version Displays the version information for keymod and the DNSSEC-Tools package. -help Display a usage message. COPYRIGHT
Copyright 2012 SPARTA, Inc. All rights reserved. See the COPYING file included with the DNSSEC-Tools package for details. AUTHOR
Wayne Morrison, tewok@tislabs.com SEE ALSO
zonesigner(8), krfcheck(8) Net::DNS::SEC::Tools::keyrec.pm(3) file-keyrec(5) perl v5.14.2 2012-06-21 KEYMOD(1p)