.\" -*- 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 "GENKRF 1"
.TH GENKRF 1 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
genkrf \- Generate a keyrec file from Key Signing Key (KSK)
and/or Zone Signing Key (ZSK) files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  genkrf [options] <zone\-file> [<signed\-zone\-file>]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgenkrf\fR generates a \fIkeyrec\fR file from KSK and/or ZSK files.  It
generates new KSK and ZSK keys if needed.
.PP
The name of the \fIkeyrec\fR file to be generated is given by the \fB\-krfile\fR
option.  If this option is not specified, \fBzone\-name.krf\fR is used as the name
of the \fIkeyrec\fR file.  If the \fIkeyrec\fR file already exists, it will be
overwritten with new \fIkeyrec\fR definitions.
.PP
The \fIzone-file\fR argument is required.  It specifies the name of the zone file
from which the signed zone file was created.  The optional \fIsigned-zone-file\fR
argument specifies the name of the signed zone file.  If it is not given, then
it defaults to \fBzone\-file.signed\fR.  The signed zone file field is, in effect,
a dummy field as the zone file is not actually signed.
.SH OPTIONS
.IX Header "OPTIONS"
\&\fBgenkrf\fR has a number of options that assist in creation of the \fIkeyrec\fR
file.  These options will be set to the first value found from this search
path:
.PP
.Vb 3
\&    command line options
\&    DNSSEC\-Tools configuration file
\&    DNSSEC\-Tools defaults
.Ve
.PP
See \fR\f(BItooloptions.pm\fR\fI\|(3)\fR for more details.
Exceptions to this are given in the option descriptions.
.PP
The \fBgenkrf\fR options are described below.
.SS "General \fBgenkrf\fP Options"
.IX Subsection "General genkrf Options"
.IP "\fB\-zone zone-name\fR" 4
.IX Item "-zone zone-name"
This option specifies the name of the zone.  If it is not given then
\&\fIzone-file\fR will be used as the name of the zone.
.IP "\fB\-krfile keyrec-file\fR" 4
.IX Item "-krfile keyrec-file"
This option specifies the name of the \fIkeyrec\fR file to be generated.
If it is not given, then \fBzone\-name.krf\fR will be used.
.IP "\fB\-algorithm algorithm\fR" 4
.IX Item "-algorithm algorithm"
This option specifies the algorithm used to generate encryption keys.
.IP "\fB\-endtime endtime\fR" 4
.IX Item "-endtime endtime"
This option specifies the time that the signature on the zone expires,
measured in seconds.
.IP "\fB\-random random-device\fR" 4
.IX Item "-random random-device"
Source of randomness used to generate the zone's keys. See the man
page for \fBdnssec-signzone\fR for the valid format of this field.
.IP \fB\-verbose\fR 4
.IX Item "-verbose"
Display additional messages during processing.  If this option is given at
least once, then a message will be displayed indicating the successful
generation of the \fIkeyrec\fR file.  If it is given twice, then the values of
all options will also be displayed.
.IP \fB\-Version\fR 4
.IX Item "-Version"
Displays the version information for \fBgenkrf\fR and the DNSSEC-Tools package.
.IP \fB\-help\fR 4
.IX Item "-help"
Display a usage message.
.SS "KSK-related Options"
.IX Subsection "KSK-related Options"
.IP "\fB\-kskcur KSK-name\fR" 4
.IX Item "-kskcur KSK-name"
This option specifies the Current KSK's key file being used to sign the zone.
If this option is not given, a new KSK will be created.
.IP "\fB\-kskcount KSK-count\fR" 4
.IX Item "-kskcount KSK-count"
This option specifies the number of KSK keys that will be generated.  If this
option is not given, the default given in the DNSSEC-Tools configuration file
will be used.
.IP "\fB\-kskdir KSK-directory\fR" 4
.IX Item "-kskdir KSK-directory"
This option specifies the absolute or relative path of the directory
where the KSK resides.  If this option is not given, it defaults to
the current directory ".".
.IP "\fB\-ksklength KSK-length\fR" 4
.IX Item "-ksklength KSK-length"
This option specifies the length of the KSK encryption key.
.IP "\fB\-ksklife KSK-lifespan\fR" 4
.IX Item "-ksklife KSK-lifespan"
This option specifies the lifespan of the KSK encryption key.  This lifespan
is \fBnot\fR inherent to the key itself.  It is \fBonly\fR used to determine when
the KSK must be rolled over.
.SS "ZSK-related Options"
.IX Subsection "ZSK-related Options"
.IP "\fB\-zskcur ZSK-name\fR" 4
.IX Item "-zskcur ZSK-name"
This option specifies the current ZSK being used to sign the zone.
If this option is not given, a new ZSK will be created.
.IP "\fB\-zskpub ZSK-name\fR" 4
.IX Item "-zskpub ZSK-name"
This option specifies the published ZSK for the zone.  If this option
is not given, a new ZSK will be created.
.IP "\fB\-zskcount ZSK-count\fR" 4
.IX Item "-zskcount ZSK-count"
This option specifies the number of current and published ZSK keys that will
be generated.  If this option is not given, the default given in the
DNSSEC-Tools configuration file will be used.
.IP "\fB\-zskdir ZSK-directory\fR" 4
.IX Item "-zskdir ZSK-directory"
This option specifies the absolute or relative path of the directory
where the ZSKs reside.  If this option is not given, it defaults to
the current directory ".".
.IP "\fB\-zsklength ZSK-length\fR" 4
.IX Item "-zsklength ZSK-length"
This option specifies the length of the ZSK encryption key.
.IP "\fB\-zsklife ZSK-lifespan\fR" 4
.IX Item "-zsklife ZSK-lifespan"
This option specifies the lifespan of the ZSK encryption key.  This lifespan
is \fBnot\fR inherent to the key itself.  It is \fBonly\fR used to determine when
the ZSK must be rolled over.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-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
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdnssec\-keygen\|(8)\fR,
\&\fBdnssec\-signzone\|(8)\fR,
\&\fBzonesigner\|(8)\fR
.PP
\&\fBNet::DNS::SEC::Tools::conf.pm\|(3)\fR,
\&\fBNet::DNS::SEC::Tools::defaults.pm\|(3)\fR,
\&\fBNet::DNS::SEC::Tools::keyrec.pm\|(3)\fR
.PP
\&\fBconf\|(5)\fR,
\&\fBkeyrec\|(5)\fR