1DNSSEC-SETTIME(8)                    BIND9                   DNSSEC-SETTIME(8)
2
3
4

NAME

6       dnssec-settime - set the key timing metadata for a DNSSEC key
7

SYNOPSIS

9       dnssec-settime [-f] [-K directory] [-L ttl] [-P date/offset]
10                      [-P sync date/offset] [-A date/offset] [-R date/offset]
11                      [-I date/offset] [-D date/offset] [-D sync date/offset]
12                      [-S key] [-i interval] [-h] [-V] [-v level] [-E engine]
13                      {keyfile}
14

DESCRIPTION

16       dnssec-settime reads a DNSSEC private key file and sets the key timing
17       metadata as specified by the -P, -A, -R, -I, and -D options. The
18       metadata can then be used by dnssec-signzone or other signing software
19       to determine when a key is to be published, whether it should be used
20       for signing a zone, etc.
21
22       If none of these options is set on the command line, then
23       dnssec-settime simply prints the key timing metadata already stored in
24       the key.
25
26       When key metadata fields are changed, both files of a key pair
27       (Knnnn.+aaa+iiiii.key and Knnnn.+aaa+iiiii.private) are regenerated.
28       Metadata fields are stored in the private file. A human-readable
29       description of the metadata is also placed in comments in the key file.
30       The private file's permissions are always set to be inaccessible to
31       anyone other than the owner (mode 0600).
32

OPTIONS

34       -f
35           Force an update of an old-format key with no metadata fields.
36           Without this option, dnssec-settime will fail when attempting to
37           update a legacy key. With this option, the key will be recreated in
38           the new format, but with the original key data retained. The key's
39           creation date will be set to the present time. If no other values
40           are specified, then the key's publication and activation dates will
41           also be set to the present time.
42
43       -K directory
44           Sets the directory in which the key files are to reside.
45
46       -L ttl
47           Sets the default TTL to use for this key when it is converted into
48           a DNSKEY RR. If the key is imported into a zone, this is the TTL
49           that will be used for it, unless there was already a DNSKEY RRset
50           in place, in which case the existing TTL would take precedence. If
51           this value is not set and there is no existing DNSKEY RRset, the
52           TTL will default to the SOA TTL. Setting the default TTL to 0 or
53           none removes it from the key.
54
55       -h
56           Emit usage message and exit.
57
58       -V
59           Prints version information.
60
61       -v level
62           Sets the debugging level.
63
64       -E engine
65           Specifies the cryptographic hardware to use, when applicable.
66
67           When BIND is built with OpenSSL PKCS#11 support, this defaults to
68           the string "pkcs11", which identifies an OpenSSL engine that can
69           drive a cryptographic accelerator or hardware service module. When
70           BIND is built with native PKCS#11 cryptography
71           (--enable-native-pkcs11), it defaults to the path of the PKCS#11
72           provider library specified via "--with-pkcs11".
73

TIMING OPTIONS

75       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
76       argument begins with a '+' or '-', it is interpreted as an offset from
77       the present time. For convenience, if such an offset is followed by one
78       of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is
79       computed in years (defined as 365 24-hour days, ignoring leap years),
80       months (defined as 30 24-hour days), weeks, days, hours, or minutes,
81       respectively. Without a suffix, the offset is computed in seconds. To
82       unset a date, use 'none' or 'never'.
83
84       -P date/offset
85           Sets the date on which a key is to be published to the zone. After
86           that date, the key will be included in the zone but will not be
87           used to sign it.
88
89       -P sync date/offset
90           Sets the date on which CDS and CDNSKEY records that match this key
91           are to be published to the zone.
92
93       -A date/offset
94           Sets the date on which the key is to be activated. After that date,
95           the key will be included in the zone and used to sign it.
96
97       -R date/offset
98           Sets the date on which the key is to be revoked. After that date,
99           the key will be flagged as revoked. It will be included in the zone
100           and will be used to sign it.
101
102       -I date/offset
103           Sets the date on which the key is to be retired. After that date,
104           the key will still be included in the zone, but it will not be used
105           to sign it.
106
107       -D date/offset
108           Sets the date on which the key is to be deleted. After that date,
109           the key will no longer be included in the zone. (It may remain in
110           the key repository, however.)
111
112       -D sync date/offset
113           Sets the date on which the CDS and CDNSKEY records that match this
114           key are to be deleted.
115
116       -S predecessor key
117           Select a key for which the key being modified will be an explicit
118           successor. The name, algorithm, size, and type of the predecessor
119           key must exactly match those of the key being modified. The
120           activation date of the successor key will be set to the
121           inactivation date of the predecessor. The publication date will be
122           set to the activation date minus the prepublication interval, which
123           defaults to 30 days.
124
125       -i interval
126           Sets the prepublication interval for a key. If set, then the
127           publication and activation dates must be separated by at least this
128           much time. If the activation date is specified but the publication
129           date isn't, then the publication date will default to this much
130           time before the activation date; conversely, if the publication
131           date is specified but activation date isn't, then activation will
132           be set to this much time after publication.
133
134           If the key is being set to be an explicit successor to another key,
135           then the default prepublication interval is 30 days; otherwise it
136           is zero.
137
138           As with date offsets, if the argument is followed by one of the
139           suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is
140           measured in years, months, weeks, days, hours, or minutes,
141           respectively. Without a suffix, the interval is measured in
142           seconds.
143

PRINTING OPTIONS

145       dnssec-settime can also be used to print the timing metadata associated
146       with a key.
147
148       -u
149           Print times in UNIX epoch format.
150
151       -p C/P/Psync/A/R/I/D/Dsync/all
152           Print a specific metadata value or set of metadata values. The -p
153           option may be followed by one or more of the following letters or
154           strings to indicate which value or values to print: C for the
155           creation date, P for the publication date, Psync for the CDS and
156           CDNSKEY publication date, A for the activation date, R for the
157           revocation date, I for the inactivation date, D for the deletion
158           date, and Dsync for the CDS and CDNSKEY deletion date To print all
159           of the metadata, use -p all.
160

SEE ALSO

162       dnssec-keygen(8), dnssec-signzone(8), BIND 9 Administrator Reference
163       Manual, RFC 5011.
164

AUTHOR

166       Internet Systems Consortium, Inc.
167
169       Copyright © 2009-2011, 2014-2021 Internet Systems Consortium, Inc.
170       ("ISC")
171
172
173
174ISC                               2015-08-21                 DNSSEC-SETTIME(8)
Impressum