dnssec-dsfromkey.8 5.31 KB
Newer Older
Tinderbox User's avatar
Tinderbox User committed
1
.\" Copyright (C) 2008-2012, 2014-2016, 2018 Internet Systems Consortium, Inc. ("ISC")
Automatic Updater's avatar
Automatic Updater committed
2
.\" 
Tinderbox User's avatar
Tinderbox User committed
3 4 5
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 7 8
.\"
.hy 0
.ad l
Tinderbox User's avatar
Tinderbox User committed
9 10
'\" t
.\"     Title: dnssec-dsfromkey
Automatic Updater's avatar
regen  
Automatic Updater committed
11
.\"    Author: 
Tinderbox User's avatar
Tinderbox User committed
12
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Tinderbox User's avatar
Tinderbox User committed
13
.\"      Date: 2012-05-02
Automatic Updater's avatar
regen  
Automatic Updater committed
14
.\"    Manual: BIND9
Tinderbox User's avatar
Tinderbox User committed
15 16
.\"    Source: ISC
.\"  Language: English
Automatic Updater's avatar
regen  
Automatic Updater committed
17
.\"
Tinderbox User's avatar
Tinderbox User committed
18 19 20 21 22 23 24 25 26 27 28 29 30
.TH "DNSSEC\-DSFROMKEY" "8" "2012\-05\-02" "ISC" "BIND9"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Automatic Updater's avatar
regen  
Automatic Updater committed
31 32 33 34
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
Tinderbox User's avatar
Tinderbox User committed
35 36 37
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
Automatic Updater's avatar
regen  
Automatic Updater committed
38
.SH "NAME"
Tinderbox User's avatar
Tinderbox User committed
39
dnssec-dsfromkey \- DNSSEC DS RR generation tool
40
.SH "SYNOPSIS"
Tinderbox User's avatar
Tinderbox User committed
41
.HP \w'\fBdnssec\-dsfromkey\fR\ 'u
Tinderbox User's avatar
Tinderbox User committed
42
\fBdnssec\-dsfromkey\fR [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-1\fR] [\fB\-2\fR] [\fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-C\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] {keyfile}
Tinderbox User's avatar
Tinderbox User committed
43
.HP \w'\fBdnssec\-dsfromkey\fR\ 'u
Automatic Updater's avatar
Automatic Updater committed
44
\fBdnssec\-dsfromkey\fR {\-s} [\fB\-1\fR] [\fB\-2\fR] [\fB\-a\ \fR\fB\fIalg\fR\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-l\ \fR\fB\fIdomain\fR\fR] [\fB\-s\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-T\ \fR\fB\fITTL\fR\fR] [\fB\-f\ \fR\fB\fIfile\fR\fR] [\fB\-A\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] {dnsname}
Tinderbox User's avatar
Tinderbox User committed
45
.HP \w'\fBdnssec\-dsfromkey\fR\ 'u
Tinderbox User's avatar
Tinderbox User committed
46
\fBdnssec\-dsfromkey\fR [\fB\-h\fR] [\fB\-V\fR]
47 48
.SH "DESCRIPTION"
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
49
\fBdnssec\-dsfromkey\fR
Tinderbox User's avatar
Tinderbox User committed
50
outputs the Delegation Signer (DS) resource record (RR), as defined in RFC 3658 and RFC 4509, for the given key(s)\&.
51
.SH "OPTIONS"
Automatic Updater's avatar
regen  
Automatic Updater committed
52
.PP
53
\-1
Automatic Updater's avatar
regen  
Automatic Updater committed
54
.RS 4
Tinderbox User's avatar
Tinderbox User committed
55
Use SHA\-1 as the digest algorithm (the default is to use both SHA\-1 and SHA\-256)\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
56 57
.RE
.PP
58
\-2
Automatic Updater's avatar
regen  
Automatic Updater committed
59
.RS 4
Tinderbox User's avatar
Tinderbox User committed
60
Use SHA\-256 as the digest algorithm\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
61 62
.RE
.PP
63
\-a \fIalgorithm\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
64
.RS 4
Tinderbox User's avatar
Tinderbox User committed
65
Select the digest algorithm\&. The value of
Automatic Updater's avatar
regen  
Automatic Updater committed
66
\fBalgorithm\fR
Evan Hunt's avatar
Evan Hunt committed
67
must be one of SHA\-1 (SHA1), SHA\-256 (SHA256) or SHA\-384 (SHA384)\&. These values are case insensitive\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
68 69
.RE
.PP
Tinderbox User's avatar
Tinderbox User committed
70 71
\-C
.RS 4
Tinderbox User's avatar
Tinderbox User committed
72
Generate CDS records rather than DS records\&. This is mutually exclusive with generating lookaside records\&.
Tinderbox User's avatar
Tinderbox User committed
73 74
.RE
.PP
Automatic Updater's avatar
Automatic Updater committed
75 76
\-T \fITTL\fR
.RS 4
Tinderbox User's avatar
Tinderbox User committed
77
Specifies the TTL of the DS records\&.
Automatic Updater's avatar
Automatic Updater committed
78 79
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
80
\-K \fIdirectory\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
81
.RS 4
Automatic Updater's avatar
regen  
Automatic Updater committed
82
Look for key files (or, in keyset mode,
Tinderbox User's avatar
Tinderbox User committed
83
keyset\-
Automatic Updater's avatar
regen  
Automatic Updater committed
84
files) in
Tinderbox User's avatar
Tinderbox User committed
85
\fBdirectory\fR\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
86 87 88 89 90
.RE
.PP
\-f \fIfile\fR
.RS 4
Zone file mode: in place of the keyfile name, the argument is the DNS domain name of a zone master file, which can be read from
Tinderbox User's avatar
Tinderbox User committed
91 92
\fBfile\fR\&. If the zone name is the same as
\fBfile\fR, then it may be omitted\&.
Automatic Updater's avatar
Automatic Updater committed
93 94 95 96
.sp
If
\fBfile\fR
is set to
Tinderbox User's avatar
Tinderbox User committed
97
"\-", then the zone data is read from the standard input\&. This makes it possible to use the output of the
Automatic Updater's avatar
Automatic Updater committed
98 99 100
\fBdig\fR
command as input, as in:
.sp
Tinderbox User's avatar
Tinderbox User committed
101
\fBdig dnskey example\&.com | dnssec\-dsfromkey \-f \- example\&.com\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
102 103 104 105
.RE
.PP
\-A
.RS 4
Tinderbox User's avatar
Tinderbox User committed
106
Include ZSKs when generating DS records\&. Without this option, only keys which have the KSK flag set will be converted to DS records and printed\&. Useful only in zone file mode\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
107 108
.RE
.PP
109
\-l \fIdomain\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
110
.RS 4
Tinderbox User's avatar
Tinderbox User committed
111
Generate a DLV set instead of a DS set\&. The specified
Automatic Updater's avatar
regen  
Automatic Updater committed
112
\fBdomain\fR
Tinderbox User's avatar
Tinderbox User committed
113
is appended to the name for each record in the set\&. The DNSSEC Lookaside Validation (DLV) RR is described in RFC 4431\&. This is mutually exclusive with generating CDS records\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
114 115
.RE
.PP
116
\-s
Automatic Updater's avatar
regen  
Automatic Updater committed
117
.RS 4
Tinderbox User's avatar
Tinderbox User committed
118
Keyset mode: in place of the keyfile name, the argument is the DNS domain name of a keyset file\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
119 120
.RE
.PP
121
\-c \fIclass\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
122
.RS 4
Tinderbox User's avatar
Tinderbox User committed
123
Specifies the DNS class (default is IN)\&. Useful only in keyset or zone file mode\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
124 125
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
126
\-v \fIlevel\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
127
.RS 4
Tinderbox User's avatar
Tinderbox User committed
128
Sets the debugging level\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
129
.RE
Tinderbox User's avatar
Tinderbox User committed
130 131 132
.PP
\-h
.RS 4
Tinderbox User's avatar
Tinderbox User committed
133
Prints usage information\&.
Tinderbox User's avatar
Tinderbox User committed
134 135 136 137
.RE
.PP
\-V
.RS 4
Tinderbox User's avatar
Tinderbox User committed
138
Prints version information\&.
Tinderbox User's avatar
Tinderbox User committed
139
.RE
140 141
.SH "EXAMPLE"
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
142
To build the SHA\-256 DS RR from the
Tinderbox User's avatar
Tinderbox User committed
143
\fBKexample\&.com\&.+003+26160\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
144
keyfile name, the following command would be issued:
145
.PP
Tinderbox User's avatar
Tinderbox User committed
146
\fBdnssec\-dsfromkey \-2 Kexample\&.com\&.+003+26160\fR
147 148 149
.PP
The command would print something like:
.PP
Tinderbox User's avatar
Tinderbox User committed
150
\fBexample\&.com\&. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0 C5EA0B94\fR
151 152
.SH "FILES"
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
153
The keyfile can be designed by the key identification
Tinderbox User's avatar
Tinderbox User committed
154
Knnnn\&.+aaa+iiiii
Automatic Updater's avatar
regen  
Automatic Updater committed
155
or the full file name
Tinderbox User's avatar
Tinderbox User committed
156
Knnnn\&.+aaa+iiiii\&.key
Automatic Updater's avatar
regen  
Automatic Updater committed
157
as generated by
Tinderbox User's avatar
Tinderbox User committed
158
dnssec\-keygen(8)\&.
159
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
160 161
The keyset file name is built from the
\fBdirectory\fR, the string
Tinderbox User's avatar
Tinderbox User committed
162
keyset\-
Automatic Updater's avatar
regen  
Automatic Updater committed
163
and the
Tinderbox User's avatar
Tinderbox User committed
164
\fBdnsname\fR\&.
165 166
.SH "CAVEAT"
.PP
Tinderbox User's avatar
Tinderbox User committed
167
A keyfile error can give a "file not found" even if the file exists\&.
168 169
.SH "SEE ALSO"
.PP
Tinderbox User's avatar
Tinderbox User committed
170 171
\fBdnssec-keygen\fR(8),
\fBdnssec-signzone\fR(8),
Automatic Updater's avatar
regen  
Automatic Updater committed
172 173
BIND 9 Administrator Reference Manual,
RFC 3658,
Tinderbox User's avatar
Tinderbox User committed
174 175
RFC 4431\&.
RFC 4509\&.
176 177
.SH "AUTHOR"
.PP
Tinderbox User's avatar
Tinderbox User committed
178
\fBInternet Systems Consortium, Inc\&.\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
179
.SH "COPYRIGHT"
Tinderbox User's avatar
Tinderbox User committed
180
.br
Tinderbox User's avatar
Tinderbox User committed
181
Copyright \(co 2008-2012, 2014-2016, 2018 Internet Systems Consortium, Inc. ("ISC")
Automatic Updater's avatar
regen  
Automatic Updater committed
182
.br