.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "defaults 3"
.TH defaults 3 2023-07-29 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::DNS::SEC::Tools::defaults \- DNSSEC\-Tools default values.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::DNS::SEC::Tools::defaults;
\&
\&  %defs = dnssec_tools_alldefaults();
\&
\&  $defalg = dnssec_tools_default("algorithm");
\&
\&  $cz_path = dnssec_tools_default("zonecheck");
\&
\&  $ksklife = dnssec_tools_default("ksklife");
\&
\&  @default_names = dnssec_tools_defnames();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module maintains a set of default values used by DNSSEC-Tools
programs.  This allows these defaults to be centralized in a single
place and prevents them from being spread around multiple programs.
.SH INTERFACES
.IX Header "INTERFACES"
.IP \fR\f(BIdnssec_tools_alldefaults()\fR\fI\fR 4
.IX Item "dnssec_tools_alldefaults()"
This interface returns a copy of all the DNSSEC-Tools defaults in a hash table.
.IP \fIdnssec_tools_default(default)\fR 4
.IX Item "dnssec_tools_default(default)"
This interface returns the value of a DNSSEC-Tools default.  The interface
is passed \fIdefault\fR, which is the name of a default to look up.  The value
of this default is returned to the caller.
.IP \fR\f(BIdnssec_tools_defnames()\fR\fI\fR 4
.IX Item "dnssec_tools_defnames()"
This interface returns the names of all the DNSSEC-Tools defaults.
No default values are returned, but the default names returned by
\&\fR\f(BIdnssec_tools_defnames()\fR\fI\fR may then be passed to \fI\fR\f(BIdnssec_tools_default()\fR\fI\fR.
.SH "DEFAULT FIELDS"
.IX Header "DEFAULT FIELDS"
The following are the defaults defined for DNSSEC-Tools.
.IP \fBadmin-email\fR 4
.IX Item "admin-email"
This default holds the default email address for the DNSSEC-Tools
administrator.
.IP \fBarchivedir\fR 4
.IX Item "archivedir"
This default holds the default directory in which keys will be archived.
.IP \fBalgorithm\fR 4
.IX Item "algorithm"
This default holds the default encryption algorithm.
.IP \fBenddate\fR 4
.IX Item "enddate"
This default holds the default zone life, in seconds.
.IP \fBentropy_msg\fR 4
.IX Item "entropy_msg"
This default indicates whether or not \fIzonesigner\fR should display an entropy
message.
.IP \fBkeygen\fR 4
.IX Item "keygen"
This default holds the path to the key-generation program.
.IP \fBkeygen-opts\fR 4
.IX Item "keygen-opts"
This default hold a set of options for the key-generation program.
.IP \fBkskcount\fR 4
.IX Item "kskcount"
This default holds the default number of KSK keys to generate for a zone.
.IP \fBksklength\fR 4
.IX Item "ksklength"
This default holds the default length of a KSK key.
.IP \fBksklife\fR 4
.IX Item "ksklife"
This default holds the default lifespan of a KSK key.  This is only used
for determining when to rollover the KSK key.  Keys otherwise have no
concept of a lifespan.  This is measured in seconds.
.IP \fBlifespan-max\fR 4
.IX Item "lifespan-max"
This default is the maximum lifespan of a key.
.IP \fBlifespan-min\fR 4
.IX Item "lifespan-min"
This default is the minimum lifespan of a key.
.IP \fBlog_tz\fR 4
.IX Item "log_tz"
This default is the timezone to be used in log-message timestamps.
.IP \fBmailer-server\fR 4
.IX Item "mailer-server"
The mail server that will be contacted by \fR\f(BIdt_adminmail()\fR\fI\fR.  This is
passed to \fIMail::Send\fR.
.IP \fBmailer-type\fR 4
.IX Item "mailer-type"
The type of mailer that will be contacted by \fR\f(BIdt_adminmail()\fR\fI\fR.  This is
passed to \fIMail::Mailer\fR (by way of \fIMail::Send\fR.)  Any values recognized
by \fIMail::Mailer\fR may be used here.
.IP "\fBprog_ksk1\fR ... \fBprog_ksk7\fR" 4
.IX Item "prog_ksk1 ... prog_ksk7"
These defaults hold the default phase commands to be executed by \fBrollerd\fR
for each phase of KSK rollover.  The \fIdefault\fR keyword indicates that the
normal phase processing should be performed.  Multiple commands may be given,
but they must be separated by bangs.  The \fIdefault\fR keyword may be
combined with other commands.
.IP \fBprog_normal\fR 4
.IX Item "prog_normal"
These defaults hold the default phase commands to be executed by \fBrollerd\fR
when a zone is not in a rollover state.  The \fIdefault\fR keyword indicates that
the normal phase processing should be performed.  Multiple commands may be
given, but they must be separated by bangs.  The \fIdefault\fR keyword may
be combined with other commands.
.IP "\fBprog_zsk1\fR ... \fBprog_zsk7\fR" 4
.IX Item "prog_zsk1 ... prog_zsk7"
These defaults hold the default phase commands to be executed by \fBrollerd\fR
for each phase of ZSK rollover.  The \fIdefault\fR keyword indicates that the
normal phase processing should be performed.  Multiple commands may be given,
but they must be separated by bangs.  The \fIdefault\fR keyword may be
combined with other commands.
.IP \fBrandom\fR 4
.IX Item "random"
This default holds the default random number generator device.
.IP \fBrevperiod\fR 4
.IX Item "revperiod"
This default holds the default revocation period of a KSK key. This is
the minimum period of time a revoked KSK is required to remain in the
signing set so that it is properly observed by resolvers.  This is
measured in seconds.
.IP \fBrndc\fR 4
.IX Item "rndc"
This default is the default path of the BIND \fBrndc\fR program.
.IP \fBroll_loadzone\fR 4
.IX Item "roll_loadzone"
This default is flag indicates if \fBrollerd\fR should have the DNS daemon
reload its zones.
.IP \fBroll_logfile\fR 4
.IX Item "roll_logfile"
This default is the path to \fBrollerd\fR's log file.
.IP \fBroll_loglevel\fR 4
.IX Item "roll_loglevel"
This default is the default logging level for \fBrollerd\fR.
.IP \fBroll_sleeptime\fR 4
.IX Item "roll_sleeptime"
This default holds the default sleep time used by the \fBrollerd\fR rollover
daemon.
.IP \fBsavekeys\fR 4
.IX Item "savekeys"
This default indicates whether or not keys should be deleted when they are no
longer in use.
.IP \fBtacontact\fR 4
.IX Item "tacontact"
This is merely a placeholder for the contact information. There is no useful
default value for this.
.IP \fBtadnsvalconffile\fR 4
.IX Item "tadnsvalconffile"
This default specifies the path of the \fBdnsval\fR configuration file.
.IP \fBtanamedconffile\fR 4
.IX Item "tanamedconffile"
This default specifies the path of the \fBnamed\fR configuration file.
.IP \fBtaresolvconf\fR 4
.IX Item "taresolvconf"
This default specifies the path to the DNS \fBresolv.conf\fR file.
.IP \fBtasleeptime\fR 4
.IX Item "tasleeptime"
This default holds the default value for how long the daemon should sleep.
.IP \fBtasmtpserver\fR 4
.IX Item "tasmtpserver"
This default specifies the name of the SMTP server.
.IP \fBtatmpdir\fR 4
.IX Item "tatmpdir"
This default specifies the location of \fBtrustman\fR's temporary directory.
.IP \fBusegui\fR 4
.IX Item "usegui"
This default indicates whether or not the DNSSEC-Tools GUI should be used for
option entry.
.IP \fBzone_errors\fR 4
.IX Item "zone_errors"
This default holds the maximum number of consecutive errors a particular zone
may have before it is changed to be a \fIskip\fR zone.
.IP \fBzonecheck\fR 4
.IX Item "zonecheck"
This default holds the path to the zone-verification program.
.IP \fBzonecheck-opts\fR 4
.IX Item "zonecheck-opts"
This default hold a set of options for the zone-verification program.
.Sp
This default is set to "\-i local".  This value has been found to greatly
improve the amount of time it takes \fBnamed-checkzone\fR to run.
.IP \fBzonefile-parser\fR 4
.IX Item "zonefile-parser"
This default specifies the parser that will be used to parse zone files.
The default value is to use the \fBNet::DNS::ZoneFile\fR module.
.IP \fBzonesign\fR 4
.IX Item "zonesign"
This default holds the path to the zone-signing program.
.IP \fBzonesign-opts\fR 4
.IX Item "zonesign-opts"
This default hold a set of options for the zone-signing program.
.IP \fBzskcount\fR 4
.IX Item "zskcount"
This default holds the default number of ZSK keys to generate for a zone.
.IP \fBzsklength\fR 4
.IX Item "zsklength"
This default holds the default length of the ZSK key.
.IP \fBzsklife\fR 4
.IX Item "zsklife"
This default holds the default lifespan of the ZSK key.  This is only used
for determining when to rollover the ZSK key.  Keys otherwise have no
concept of a lifespan.  This is measured in seconds.
.SH "DNSSEC-TOOLS PROGRAM FIELDS"
.IX Header "DNSSEC-TOOLS PROGRAM FIELDS"
The following are the defaults holding the paths to the DNSSEC-Tools
programs.
.IP \fBblinkenlights\fR 4
.IX Item "blinkenlights"
This default holds the path to the DNSSEC-Tools \fBblinkenlights\fR program.
.IP \fBcleanarch\fR 4
.IX Item "cleanarch"
This default holds the path to the DNSSEC-Tools \fBcleanarch\fR program.
.IP \fBcleankrf\fR 4
.IX Item "cleankrf"
This default holds the path to the DNSSEC-Tools \fBcleankrf\fR program.
.IP \fBdtconf\fR 4
.IX Item "dtconf"
This default holds the path to the DNSSEC-Tools \fBdtconf\fR program.
.IP \fBdtconfchk\fR 4
.IX Item "dtconfchk"
This default holds the path to the DNSSEC-Tools \fBdtconfchk\fR program.
.IP \fBdtdefs\fR 4
.IX Item "dtdefs"
This default holds the path to the DNSSEC-Tools \fBdtdefs\fR program.
.IP \fBdtinitconf\fR 4
.IX Item "dtinitconf"
This default holds the path to the DNSSEC-Tools \fBdtinitconf\fR program.
.IP \fBexpchk\fR 4
.IX Item "expchk"
This default holds the path to the DNSSEC-Tools \fBexpchk\fR program.
.IP \fBfixkrf\fR 4
.IX Item "fixkrf"
This default holds the path to the DNSSEC-Tools \fBfixkrf\fR program.
.IP \fBgenkrf\fR 4
.IX Item "genkrf"
This default holds the path to the DNSSEC-Tools \fBgenkrf\fR program.
.IP \fBgetdnskeys\fR 4
.IX Item "getdnskeys"
This default holds the path to the DNSSEC-Tools \fBgetdnskeys\fR program.
.IP \fBkeyarch\fR 4
.IX Item "keyarch"
This default holds the path to the DNSSEC-Tools \fBkeyarch\fR program.
.IP \fBkrfcheck\fR 4
.IX Item "krfcheck"
This default holds the path to the DNSSEC-Tools \fBkrfcheck\fR program.
.IP \fBlskrf\fR 4
.IX Item "lskrf"
This default holds the path to the DNSSEC-Tools \fBlskrf\fR program.
.IP \fBlsroll\fR 4
.IX Item "lsroll"
This default holds the path to the DNSSEC-Tools \fBlsroll\fR program.
.IP \fBrollchk\fR 4
.IX Item "rollchk"
This default holds the path to the DNSSEC-Tools \fBrollchk\fR program.
.IP \fBrollctl\fR 4
.IX Item "rollctl"
This default holds the path to the DNSSEC-Tools \fBrollctl\fR program.
.IP \fBrollerd\fR 4
.IX Item "rollerd"
This default holds the path to the DNSSEC-Tools \fBrollerd\fR program.
.IP \fBrollinit\fR 4
.IX Item "rollinit"
This default holds the path to the DNSSEC-Tools \fBrollinit\fR program.
.IP \fBrolllog\fR 4
.IX Item "rolllog"
This default holds the path to the DNSSEC-Tools \fBrolllog\fR program.
.IP \fBrollrec-editor\fR 4
.IX Item "rollrec-editor"
This default holds the path to the DNSSEC-Tools \fBrollrec-editor\fR program.
.IP \fBrollset\fR 4
.IX Item "rollset"
This default holds the path to the DNSSEC-Tools \fBrollset\fR program.
.IP \fBsignset-editor\fR 4
.IX Item "signset-editor"
This default holds the path to the DNSSEC-Tools \fBsignset-editor\fR program.
.IP \fBtachk\fR 4
.IX Item "tachk"
This default holds the path to the DNSSEC-Tools \fBtachk\fR program.
.IP \fBtimetrans\fR 4
.IX Item "timetrans"
This default holds the path to the DNSSEC-Tools \fBtimetrans\fR program.
.IP \fBtrustman\fR 4
.IX Item "trustman"
This default holds the path to the DNSSEC-Tools \fBtrustman\fR program.
.IP \fBzonesigner\fR 4
.IX Item "zonesigner"
This default holds the path to the DNSSEC-Tools \fBzonesigner\fR program.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2006\-2014 SPARTA, Inc.  All rights reserved.
See the COPYING file included with the DNSSEC-Tools package for details.
.SH AUTHOR
.IX Header "AUTHOR"
Wayne Morrison, tewok@tislabs.com