| blob | 3e130b92cf61a0d794c20c8d988c363bbef98b8d |
1 .\" $NetBSD$
2 .\"
3 .\" Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
4 .\"
5 .\" Permission to use, copy, modify, and/or distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 .\" PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .\" Id: dnssec-settime.8,v 1.9 2009/11/03 21:58:30 tbox Exp
18 .\"
19 .hy 0
20 .ad l
21 .\" Title: dnssec\-settime
22 .\" Author:
23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
24 .\" Date: July 15, 2009
25 .\" Manual: BIND9
26 .\" Source: BIND9
27 .\"
28 .TH "DNSSEC\-SETTIME" "8" "July 15, 2009" "BIND9" "BIND9"
29 .\" disable hyphenation
30 .nh
31 .\" disable justification (adjust text to left margin only)
32 .ad l
33 .SH "NAME"
34 dnssec\-settime \- Set the key timing metadata for a DNSSEC key
35 .SH "SYNOPSIS"
36 .HP 15
37 \fBdnssec\-settime\fR [\fB\-f\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-A\ \fR\fB\fIdate/offset\fR\fR] [\fB\-R\ \fR\fB\fIdate/offset\fR\fR] [\fB\-I\ \fR\fB\fIdate/offset\fR\fR] [\fB\-D\ \fR\fB\fIdate/offset\fR\fR] [\fB\-h\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] {keyfile}
38 .SH "DESCRIPTION"
39 .PP
40 \fBdnssec\-settime\fR
41 reads a DNSSEC private key file and sets the key timing metadata as specified by the
42 \fB\-P\fR,
43 \fB\-A\fR,
44 \fB\-R\fR,
45 \fB\-I\fR, and
46 \fB\-D\fR
47 options. The metadata can then be used by
48 \fBdnssec\-signzone\fR
49 or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc.
50 .PP
51 If none of these options is set on the command line, then
52 \fBdnssec\-settime\fR
53 simply prints the key timing metadata already stored in the key.
54 .PP
55 When key metadata fields are changed, both files of a key pair (\fIKnnnn.+aaa+iiiii.key\fR
56 and
57 \fIKnnnn.+aaa+iiiii.private\fR) are regenerated. Metadata fields are stored in the private file. A human\-readable description of the metadata is also placed in comments in the key file.
58 .SH "OPTIONS"
59 .PP
60 \-f
61 .RS 4
62 Force an update of an old\-format key with no metadata fields. Without this option,
63 \fBdnssec\-settime\fR
64 will fail when attempting to update a legacy key. With this option, the key will be recreated in the new format, but with the original key data retained. The key's creation date will be set to the present time.
65 .RE
66 .PP
67 \-K \fIdirectory\fR
68 .RS 4
69 Sets the directory in which the key files are to reside.
70 .RE
71 .PP
72 \-h
73 .RS 4
74 Emit usage message and exit.
75 .RE
76 .PP
77 \-v \fIlevel\fR
78 .RS 4
79 Sets the debugging level.
80 .RE
81 .PP
82 \-E \fIengine\fR
83 .RS 4
84 Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine.
85 .RE
86 .SH "TIMING OPTIONS"
87 .PP
88 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the argument begins with a '+' or '\-', it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is computed in years (defined as 365 24\-hour days, ignoring leap years), months (defined as 30 24\-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To unset a date, use 'none'.
89 .PP
90 \-P \fIdate/offset\fR
91 .RS 4
92 Sets the date on which a key is to be published to the zone. After that date, the key will be included in the zone but will not be used to sign it.
93 .RE
94 .PP
95 \-A \fIdate/offset\fR
96 .RS 4
97 Sets the date on which the key is to be activated. After that date, the key will be included in the zone and used to sign it.
98 .RE
99 .PP
100 \-R \fIdate/offset\fR
101 .RS 4
102 Sets the date on which the key is to be revoked. After that date, the key will be flagged as revoked. It will be included in the zone and will be used to sign it.
103 .RE
104 .PP
105 \-I \fIdate/offset\fR
106 .RS 4
107 Sets the date on which the key is to be retired. After that date, the key will still be included in the zone, but it will not be used to sign it.
108 .RE
109 .PP
110 \-D \fIdate/offset\fR
111 .RS 4
112 Sets the date on which the key is to be deleted. After that date, the key will no longer be included in the zone. (It may remain in the key repository, however.)
113 .RE
114 .SH "PRINTING OPTIONS"
115 .PP
116 \fBdnssec\-settime\fR
117 can also be used to print the timing metadata associated with a key.
118 .PP
119 \-u
120 .RS 4
121 Print times in UNIX epoch format.
122 .RE
123 .PP
124 \-p \fIC/P/A/R/U/D/all\fR
125 .RS 4
126 Print a specific metadata value or set of metadata values. The
127 \fB\-p\fR
128 option may be followed by one or more of the following letters to indicate which value or values to print:
129 \fBC\fR
130 for the creation date,
131 \fBP\fR
132 for the publication date,
133 \fBA\fR
134 for the activation date,
135 \fBR\fR
136 for the revokation date,
137 \fBU\fR
138 for the unpublication date, or
139 \fBD\fR
140 for the deletion date. To print all of the metadata, use
141 \fB\-p all\fR.
142 .RE
143 .SH "SEE ALSO"
144 .PP
145 \fBdnssec\-keygen\fR(8),
146 \fBdnssec\-signzone\fR(8),
147 BIND 9 Administrator Reference Manual,
148 RFC 5011.
149 .SH "AUTHOR"
150 .PP
151 Internet Systems Consortium
152 .SH "COPYRIGHT"
153 Copyright \(co 2009 Internet Systems Consortium, Inc. ("ISC")
154 .br