'\" te

.\" Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")

.\" Permission to use, copy, modify, and/or distribute this software for any purpose  with or without fee is hereby granted, provided that the above copyright notice  and this permission notice appear in all copies.  THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING  FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE  USE OR PERFORMANCE OF THIS SOFTWARE.

.\" Portions Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved.

.TH dnssec-keygen 8 "19 Oct 2015" "SunOS 5.12" "System Administration Commands"

.SH NAME

dnssec-keygen \- DNSSEC key generation tool

.SH SYNOPSIS

.LP

.nf

\fBdnssec-keygen\fR \fB-a\fR \fIalgorithm\fR \fB-b\fR \fIkeysize\fR \fB-n\fR \fInametype\fR [\fB-ehk\fR] 

     [\fB-c\fR \fIclass\fR] [\fB-f\fR \fIflag\fR] [\fB-g\fR \fIgenerator\fR] [\fB-p\fR \fIprotocol\fR] 

     [\fB-r\fR \fIrandomdev\fR] [\fB-s\fR \fIstrength\fR] [\fB-t\fR \fItype\fR] [\fB-v\fR \fIlevel\fR] \fIname\fR

.fi

.SH DESCRIPTION

.sp

.LP

The \fBdnssec-keygen\fR utility generates keys for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034. It can also generate keys for use with TSIG (Transaction Signatures), as defined in RFC 2845.

.SH OPTIONS

.sp

.LP

The following options are supported:

.sp

.ne 2

.mk

.na

\fB\fB-a\fR \fIalgorithm\fR\fR

.ad

.sp .6

.RS 4n

Select the cryptographic algorithm. The value of algorithm must be one of RSAMD5 (RSA) or RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, \fBDH\fR (Diffie-Hellman), or HMAC-MD5. These values are case insensitive.

.sp

For DNSSEC, RSASHA1 is a mandatory-to-implement algorithm and DSA is recommended. For TSIG, HMAC-MD5 is mandatory.

.LP

Note - 

.sp

.RS 2

HMAC-MD5 and DH automatically set the \fB-k\fR flag.

.RE

.RE

.sp

.ne 2

.mk

.na

\fB\fB-b\fR \fIkeysize\fR\fR

.ad

.sp .6

.RS 4n

Specify the number of bits in the key. The choice of key size depends on the algorithm used. RSAMD5 and RSASHA1 keys must be between 512 and 2048 bits. Diffie-Hellman keys must be between 128 and 4096 bits. DSA keys must be between 512 and 1024 bits and an exact multiple of 64. HMAC-MD5 keys must be between 1 and 512 bits.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-c\fR \fIclass\fR\fR

.ad

.sp .6

.RS 4n

Indicate that the DNS record containing the key should have the specified class. If not specified, class IN is used.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-e\fR\fR

.ad

.sp .6

.RS 4n

Use a large exponent if generating an RSAMD5 or RSASHA1 key.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-f\fR \fIflag\fR\fR

.ad

.sp .6

.RS 4n

Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flag is KSK (Key Signing Key) DNSKEY.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-g\fR \fIgenerator\fR\fR

.ad

.sp .6

.RS 4n

Use this \fIgenerator\fR if generating a Diffie Hellman key. Allowed values are 2 and 5. If no generator is specified, a known prime from RFC 2539 will be used if possible; otherwise the default is 2.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-h\fR\fR

.ad

.sp .6

.RS 4n

Print a short summary of the options and arguments to \fBdnssec-keygen\fR.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-k\fR\fR

.ad

.sp .6

.RS 4n

Generate KEY records rather than DNSKEY records.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-n\fR \fInametype\fR\fR

.ad

.sp .6

.RS 4n

Specify the owner type of the key. The value of \fInametype\fR must either be \fBZONE\fR (for a DNSSEC zone key (KEY/DNSKEY)), \fBHOST\fR or \fBENTITY\fR (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)), or \fBOTHER\fR (DNSKEY). These values are case insensitive. Defaults to ZONE for DNSKEY generation.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-p\fR \fIprotocol\fR\fR

.ad

.sp .6

.RS 4n

Set the protocol value for the generated key. The \fIprotocol\fR argument is a number between 0 and 255. The default is 3 (DNSSEC) Other possible values for this argument are listed in RFC 2535 and its successors.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-r\fR \fIrandomdev\fR\fR

.ad

.sp .6

.RS 4n

Specify the source of randomness. If the operating system does not provide a \fB/dev/random\fR or equivalent device, the default source of randomness is keyboard input. \fIrandomdev\fR specifies the name of a character device or file containing random data to be used instead of the default. The special value "\fBkeyboard\fR" indicates that keyboard input should be used.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-s\fR \fIstrength\fR\fR

.ad

.sp .6

.RS 4n

Specify the strength value of the key. The \fIstrength\fR argument is a number between 0 and 15, and currently has no defined purpose in DNSSEC.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-t\fR \fItype\fR\fR

.ad

.sp .6

.RS 4n

Indicate the use of the key. \fBtype\fR must be one of \fBAUTHCONF\fR, \fBNOAUTHCONF\fR, \fBNOAUTH\fR, or \fBNOCONF\fR. The default is \fBAUTHCONF\fR. \fBAUTH\fR refers to the ability to authenticate data, and \fBCONF\fR the ability to encrypt data.

.RE

.sp

.ne 2

.mk

.na

\fB\fB-v\fR \fIlevel\fR\fR

.ad

.sp .6

.RS 4n

Set the debugging level.

.RE

.SH GENERATED KEYS

.sp

.LP

When \fBdnssec-keygen\fR completes successfully, it prints a string of the form \fBK\fInnnn\fR.+\fIaaa\fR+\fIiiiii\fR\fR to the standard output. This is an identification string for the key it has generated.

.RS +4

.TP

.ie t \(bu

.el o

\fInnnn\fR is the key name.

.RE

.RS +4

.TP

.ie t \(bu

.el o

\fIaaa\fR is the numeric representation of the algorithm.

.RE

.RS +4

.TP

.ie t \(bu

.el o

\fIiiiii\fR is the key identifier (or footprint).

.RE

.sp

.LP

The \fBdnssec-keygen\fR utility creates two files, with names based on the printed string. 

.RS +4

.TP

.ie t \(bu

.el o

\fBK\fR\fInnnn\fR.+\fIaaa\fR+\fIiiiii\fR.\fBkey\fR contains the public key.

.RE

.RS +4

.TP

.ie t \(bu

.el o

\fBK\fR\fInnnn\fR.+\fIaaa\fR+\fIiiiii\fR.\fBprivate\fR contains the private key.

.RE

.sp

.LP

The \fB\&.key\fR file contains a DNS \fBKEY\fR record that can be inserted into a zone file (directly or with a \fB$INCLUDE\fR statement).

.sp

.LP

The \fB\&.private\fR file contains algorithm specific fields. For obvious security reasons, this file does not have general read permission.

.sp

.LP

Both \fB\&.key\fR and \fB\&.private\fR files are generated for symmetric encryption algorithm such as HMAC-MD5, even though the public and private key are equivalent.

.SH EXAMPLES

.LP

\fBExample 1 \fRGenerating a 768-bit DSA Key

.sp

.LP

To generate a 768-bit DSA key for the domain \fBexample.com\fR, the following command would be issued:

.sp

.in +2

.nf

dnssec-keygen -a DSA -b 768 -n ZONE example.com

.fi

.in -2

.sp

.sp

.LP

The command would print a string of the form:

.sp

.in +2

.nf

Kexample.com.+003+26160

.fi

.in -2

.sp

.sp

.LP

The following files would be created:

.sp

.in +2

.nf

Kexample.com.+003+26160.key

Kexample.com.+003+26160.private

.fi

.in -2

.sp

.SH ATTRIBUTES

.sp

.LP

See \fBattributes\fR(5) for descriptions of the following attributes:

.sp

.sp

.TS

tab() box;

cw(2.75i) |cw(2.75i) 

lw(2.75i) |lw(2.75i) 

.

ATTRIBUTE TYPEATTRIBUTE VALUE

_

Availabilityservice/network/dns/bind

_

Interface StabilityVolatile

.TE

.SH SEE ALSO

.sp

.LP

\fBdnssec-signzone\fR(8), \fBattributes\fR(5)

.sp

.LP

\fIRFC 2539\fR, \fIRFC 2845\fR, \fIRFC 4033\fR

.sp

.LP

See the BIND 9 \fIAdministrator's Reference Manual\fR. As of the date of publication of this man page, this document is available at https://www.isc.org/software/bind/documentation\&.