Update repub branch u/fanf2/patch to rebasing branch u/fanf2/rebasing revision v9_13_...
[ipreg/bind9.git] / bin / dnssec / dnssec-settime.8
CommitLineData
b4d3f782 1.\" Copyright (C) 2009-2011, 2014-2019 Internet Systems Consortium, Inc. ("ISC")
bef75d63 2.\"
6807a2dc
TU
3.\" This Source Code Form is subject to the terms of the Mozilla Public
4.\" License, v. 2.0. If a copy of the MPL was not distributed with this
5.\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
553ead32 6.\"
553ead32
EH
7.hy 0
8.ad l
2eeb74d1
TU
9'\" t
10.\" Title: dnssec-settime
0a7ed886 11.\" Author:
19ed6f8f 12.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
e62b9c9c 13.\" Date: 2015-08-21
0a7ed886 14.\" Manual: BIND9
2eeb74d1
TU
15.\" Source: ISC
16.\" Language: English
0a7ed886 17.\"
e62b9c9c 18.TH "DNSSEC\-SETTIME" "8" "2015\-08\-21" "ISC" "BIND9"
2eeb74d1
TU
19.\" -----------------------------------------------------------------
20.\" * Define some portability stuff
21.\" -----------------------------------------------------------------
22.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23.\" http://bugs.debian.org/507673
24.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
25.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26.ie \n(.g .ds Aq \(aq
27.el .ds Aq '
28.\" -----------------------------------------------------------------
29.\" * set default formatting
30.\" -----------------------------------------------------------------
0a7ed886
AU
31.\" disable hyphenation
32.nh
33.\" disable justification (adjust text to left margin only)
34.ad l
2eeb74d1
TU
35.\" -----------------------------------------------------------------
36.\" * MAIN CONTENT STARTS HERE *
37.\" -----------------------------------------------------------------
0a7ed886 38.SH "NAME"
dec590a3 39dnssec-settime \- set the key timing metadata for a DNSSEC key
553ead32 40.SH "SYNOPSIS"
19ed6f8f 41.HP \w'\fBdnssec\-settime\fR\ 'u
2a08a599 42\fBdnssec\-settime\fR [\fB\-f\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-L\ \fR\fB\fIttl\fR\fR] [\fB\-P\ \fR\fB\fIdate/offset\fR\fR] [\fB\-P\ sync\ \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\-D\ sync\ \fR\fB\fIdate/offset\fR\fR] [\fB\-S\ \fR\fB\fIkey\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-h\fR] [\fB\-V\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] {keyfile}
553ead32
EH
43.SH "DESCRIPTION"
44.PP
0a7ed886
AU
45\fBdnssec\-settime\fR
46reads a DNSSEC private key file and sets the key timing metadata as specified by the
47\fB\-P\fR,
48\fB\-A\fR,
49\fB\-R\fR,
f8e3e03c 50\fB\-I\fR, and
0a7ed886 51\fB\-D\fR
2eeb74d1 52options\&. The metadata can then be used by
0a7ed886 53\fBdnssec\-signzone\fR
2eeb74d1 54or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc\&.
553ead32 55.PP
0a7ed886
AU
56If none of these options is set on the command line, then
57\fBdnssec\-settime\fR
2eeb74d1 58simply prints the key timing metadata already stored in the key\&.
0a7ed886 59.PP
2eeb74d1 60When key metadata fields are changed, both files of a key pair (Knnnn\&.+aaa+iiiii\&.key
0a7ed886 61and
2eeb74d1 62Knnnn\&.+aaa+iiiii\&.private) 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\&. The private file\*(Aqs permissions are always set to be inaccessible to anyone other than the owner (mode 0600)\&.
553ead32 63.SH "OPTIONS"
0a7ed886
AU
64.PP
65\-f
66.RS 4
2eeb74d1 67Force an update of an old\-format key with no metadata fields\&. Without this option,
0a7ed886 68\fBdnssec\-settime\fR
2eeb74d1 69will 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\*(Aqs creation date will be set to the present time\&. If no other values are specified, then the key\*(Aqs publication and activation dates will also be set to the present time\&.
0a7ed886
AU
70.RE
71.PP
553ead32 72\-K \fIdirectory\fR
0a7ed886 73.RS 4
2eeb74d1 74Sets the directory in which the key files are to reside\&.
0a7ed886
AU
75.RE
76.PP
a3f8c8e2
AU
77\-L \fIttl\fR
78.RS 4
2eeb74d1 79Sets the default TTL to use for this key when it is converted into a DNSKEY RR\&. If the key is imported into a zone, this is the TTL that will be used for it, unless there was already a DNSKEY RRset in place, in which case the existing TTL would take precedence\&. If this value is not set and there is no existing DNSKEY RRset, the TTL will default to the SOA TTL\&. Setting the default TTL to
a3f8c8e2
AU
800
81or
82none
2eeb74d1 83removes it from the key\&.
a3f8c8e2
AU
84.RE
85.PP
0a7ed886
AU
86\-h
87.RS 4
2eeb74d1 88Emit usage message and exit\&.
0a7ed886
AU
89.RE
90.PP
6f120589
TU
91\-V
92.RS 4
2eeb74d1 93Prints version information\&.
6f120589
TU
94.RE
95.PP
0a7ed886
AU
96\-v \fIlevel\fR
97.RS 4
2eeb74d1 98Sets the debugging level\&.
0a7ed886 99.RE
8ec3c085
AU
100.PP
101\-E \fIengine\fR
102.RS 4
2eeb74d1 103Specifies the cryptographic hardware to use, when applicable\&.
6ea23853 104.sp
2eeb74d1 105When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
8ec3c085 106.RE
0a7ed886
AU
107.SH "TIMING OPTIONS"
108.PP
2eeb74d1 109Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS\&. If the argument begins with a \*(Aq+\*(Aq or \*(Aq\-\*(Aq, it is interpreted as an offset from the present time\&. For convenience, if such an offset is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, 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 \*(Aqnone\*(Aq or \*(Aqnever\*(Aq\&.
0a7ed886 110.PP
553ead32 111\-P \fIdate/offset\fR
0a7ed886 112.RS 4
2eeb74d1 113Sets 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\&.
0a7ed886
AU
114.RE
115.PP
e62b9c9c
TU
116\-P sync \fIdate/offset\fR
117.RS 4
118Sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone\&.
119.RE
120.PP
553ead32 121\-A \fIdate/offset\fR
0a7ed886 122.RS 4
2eeb74d1 123Sets 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\&.
0a7ed886
AU
124.RE
125.PP
553ead32 126\-R \fIdate/offset\fR
0a7ed886 127.RS 4
2eeb74d1 128Sets 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\&.
0a7ed886
AU
129.RE
130.PP
f8e3e03c 131\-I \fIdate/offset\fR
0a7ed886 132.RS 4
2eeb74d1 133Sets 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\&.
0a7ed886
AU
134.RE
135.PP
553ead32 136\-D \fIdate/offset\fR
0a7ed886 137.RS 4
2eeb74d1 138Sets 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\&.)
0a7ed886 139.RE
3acf5eb9 140.PP
e62b9c9c
TU
141\-D sync \fIdate/offset\fR
142.RS 4
143Sets the date on which the CDS and CDNSKEY records that match this key are to be deleted\&.
144.RE
145.PP
3acf5eb9
AU
146\-S \fIpredecessor key\fR
147.RS 4
2eeb74d1 148Select a key for which the key being modified will be an explicit successor\&. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified\&. The activation date of the successor key will be set to the inactivation date of the predecessor\&. The publication date will be set to the activation date minus the prepublication interval, which defaults to 30 days\&.
3acf5eb9
AU
149.RE
150.PP
151\-i \fIinterval\fR
152.RS 4
2eeb74d1 153Sets the prepublication interval for a key\&. If set, then the publication and activation dates must be separated by at least this much time\&. If the activation date is specified but the publication date isn\*(Aqt, then the publication date will default to this much time before the activation date; conversely, if the publication date is specified but activation date isn\*(Aqt, then activation will be set to this much time after publication\&.
3acf5eb9 154.sp
2eeb74d1 155If the key is being set to be an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero\&.
3acf5eb9 156.sp
2eeb74d1 157As with date offsets, if the argument is followed by one of the suffixes \*(Aqy\*(Aq, \*(Aqmo\*(Aq, \*(Aqw\*(Aq, \*(Aqd\*(Aq, \*(Aqh\*(Aq, or \*(Aqmi\*(Aq, then the interval is measured in years, months, weeks, days, hours, or minutes, respectively\&. Without a suffix, the interval is measured in seconds\&.
3acf5eb9 158.RE
2895f101
AU
159.SH "PRINTING OPTIONS"
160.PP
161\fBdnssec\-settime\fR
2eeb74d1 162can also be used to print the timing metadata associated with a key\&.
2895f101
AU
163.PP
164\-u
165.RS 4
2eeb74d1 166Print times in UNIX epoch format\&.
2895f101
AU
167.RE
168.PP
e62b9c9c 169\-p \fIC/P/Psync/A/R/I/D/Dsync/all\fR
2895f101 170.RS 4
2eeb74d1 171Print a specific metadata value or set of metadata values\&. The
2895f101 172\fB\-p\fR
e62b9c9c 173option may be followed by one or more of the following letters or strings to indicate which value or values to print:
2895f101
AU
174\fBC\fR
175for the creation date,
176\fBP\fR
177for the publication date,
e62b9c9c
TU
178\fBPsync\fR
179for the CDS and CDNSKEY publication date,
2895f101
AU
180\fBA\fR
181for the activation date,
182\fBR\fR
44d0f025 183for the revocation date,
83f43b00 184\fBI\fR
e62b9c9c 185for the inactivation date,
2895f101 186\fBD\fR
e62b9c9c
TU
187for the deletion date, and
188\fBDsync\fR
189for the CDS and CDNSKEY deletion date To print all of the metadata, use
2eeb74d1 190\fB\-p all\fR\&.
2895f101 191.RE
553ead32
EH
192.SH "SEE ALSO"
193.PP
2eeb74d1
TU
194\fBdnssec-keygen\fR(8),
195\fBdnssec-signzone\fR(8),
0a7ed886 196BIND 9 Administrator Reference Manual,
2eeb74d1 197RFC 5011\&.
553ead32
EH
198.SH "AUTHOR"
199.PP
2eeb74d1 200\fBInternet Systems Consortium, Inc\&.\fR
0a7ed886 201.SH "COPYRIGHT"
2eeb74d1 202.br
b4d3f782 203Copyright \(co 2009-2011, 2014-2019 Internet Systems Consortium, Inc. ("ISC")
0a7ed886 204.br