contrib/bind9/bin/dnssec/dnssec-keyfromlabel.8

   1 .\" Copyright (C) 2008, 2010 Internet Systems Consortium, Inc. ("ISC")
   2 .\"
   3 .\" Permission to use, copy, modify, and/or distribute this software for any
   4 .\" purpose with or without fee is hereby granted, provided that the above
   5 .\" copyright notice and this permission notice appear in all copies.
   6 .\"
   7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   8 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   9 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  10 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  11 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  12 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  13 .\" PERFORMANCE OF THIS SOFTWARE.
  14 .\"
  15 .\" $Id: dnssec-keyfromlabel.8,v 1.6.14.3 2010/01/16 01:55:32 tbox Exp $
  16 .\"
  17 .hy 0
  18 .ad l
  19 .\"     Title: dnssec\-keyfromlabel
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  22 .\"      Date: February 8, 2008
  23 .\"    Manual: BIND9
  24 .\"    Source: BIND9
  25 .\"
  26 .TH "DNSSEC\-KEYFROMLABEL" "8" "February 8, 2008" "BIND9" "BIND9"
  27 .\" disable hyphenation
  28 .nh
  29 .\" disable justification (adjust text to left margin only)
  30 .ad l
  31 .SH "NAME"
  32 dnssec\-keyfromlabel \- DNSSEC key generation tool
  33 .SH "SYNOPSIS"
  34 .HP 20
  35 \fBdnssec\-keyfromlabel\fR {\-a\ \fIalgorithm\fR} {\-l\ \fIlabel\fR} [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIflag\fR\fR] [\fB\-k\fR] [\fB\-n\ \fR\fB\fInametype\fR\fR] [\fB\-p\ \fR\fB\fIprotocol\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] {name}
  36 .SH "DESCRIPTION"
  37 .PP
  38 \fBdnssec\-keyfromlabel\fR
  39 gets keys with the given label from a crypto hardware and builds key files for DNSSEC (Secure DNS), as defined in RFC 2535 and RFC 4034.
  40 .SH "OPTIONS"
  41 .PP
  42 \-a \fIalgorithm\fR
  43 .RS 4
  44 Selects the cryptographic algorithm. The value of
  45 \fBalgorithm\fR
  46 must be one of RSAMD5, RSASHA1, DSA, NSEC3RSASHA1, NSEC3DSA, RSASHA256, RSASHA512 or DH (Diffie Hellman). These values are case insensitive.
  47 .sp
  48 If no algorithm is specified, then RSASHA1 will be used by default, unless the
  49 \fB\-3\fR
  50 option is specified, in which case NSEC3RSASHA1 will be used instead. (If
  51 \fB\-3\fR
  52 is used and an algorithm is specified, that algorithm will be checked for compatibility with NSEC3.)
  53 .sp
  54 Note 1: that for DNSSEC, RSASHA1 is a mandatory to implement algorithm, and DSA is recommended.
  55 .sp
  56 Note 2: DH automatically sets the \-k flag.
  57 .RE
  58 .PP
  59 \-l \fIlabel\fR
  60 .RS 4
  61 Specifies the label of keys in the crypto hardware (PKCS#11 device).
  62 .RE
  63 .PP
  64 \-n \fInametype\fR
  65 .RS 4
  66 Specifies the owner type of the key. The value of
  67 \fBnametype\fR
  68 must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user(KEY)) or OTHER (DNSKEY). These values are case insensitive.
  69 .RE
  70 .PP
  71 \-c \fIclass\fR
  72 .RS 4
  73 Indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used.
  74 .RE
  75 .PP
  76 \-f \fIflag\fR
  77 .RS 4
  78 Set the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flag is KSK (Key Signing Key) DNSKEY.
  79 .RE
  80 .PP
  81 \-h
  82 .RS 4
  83 Prints a short summary of the options and arguments to
  84 \fBdnssec\-keygen\fR.
  85 .RE
  86 .PP
  87 \-k
  88 .RS 4
  89 Generate KEY records rather than DNSKEY records.
  90 .RE
  91 .PP
  92 \-p \fIprotocol\fR
  93 .RS 4
  94 Sets the protocol value for the generated key. The protocol 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.
  95 .RE
  96 .PP
  97 \-t \fItype\fR
  98 .RS 4
  99 Indicates the use of the key.
 100 \fBtype\fR
 101 must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF the ability to encrypt data.
 102 .RE
 103 .PP
 104 \-v \fIlevel\fR
 105 .RS 4
 106 Sets the debugging level.
 107 .RE
 108 .SH "GENERATED KEY FILES"
 109 .PP
 110 When
 111 \fBdnssec\-keyfromlabel\fR
 112 completes successfully, it prints a string of the form
 113 \fIKnnnn.+aaa+iiiii\fR
 114 to the standard output. This is an identification string for the key files it has generated.
 115 .TP 4
 116 \(bu
 117 \fInnnn\fR
 118 is the key name.
 119 .TP 4
 120 \(bu
 121 \fIaaa\fR
 122 is the numeric representation of the algorithm.
 123 .TP 4
 124 \(bu
 125 \fIiiiii\fR
 126 is the key identifier (or footprint).
 127 .PP
 128 \fBdnssec\-keyfromlabel\fR
 129 creates two files, with names based on the printed string.
 130 \fIKnnnn.+aaa+iiiii.key\fR
 131 contains the public key, and
 132 \fIKnnnn.+aaa+iiiii.private\fR
 133 contains the private key.
 134 .PP
 135 The
 136 \fI.key\fR
 137 file contains a DNS KEY record that can be inserted into a zone file (directly or with a $INCLUDE statement).
 138 .PP
 139 The
 140 \fI.private\fR
 141 file contains algorithm specific fields. For obvious security reasons, this file does not have general read permission.
 142 .SH "SEE ALSO"
 143 .PP
 144 \fBdnssec\-keygen\fR(8),
 145 \fBdnssec\-signzone\fR(8),
 146 BIND 9 Administrator Reference Manual,
 147 RFC 4034.
 148 .SH "AUTHOR"
 149 .PP
 150 Internet Systems Consortium
 151 .SH "COPYRIGHT"
 152 Copyright \(co 2008, 2010 Internet Systems Consortium, Inc. ("ISC")
 153 .br