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

   1 .\" Copyright (C) 2009-2011 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$
  16 .\"
  17 .hy 0
  18 .ad l
  19 .\"     Title: dnssec\-settime
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  22 .\"      Date: July 15, 2009
  23 .\"    Manual: BIND9
  24 .\"    Source: BIND9
  25 .\"
  26 .TH "DNSSEC\-SETTIME" "8" "July 15, 2009" "BIND9" "BIND9"
  27 .\" disable hyphenation
  28 .nh
  29 .\" disable justification (adjust text to left margin only)
  30 .ad l
  31 .SH "NAME"
  32 dnssec\-settime \- Set the key timing metadata for a DNSSEC key
  33 .SH "SYNOPSIS"
  34 .HP 15
  35 \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\-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}
  36 .SH "DESCRIPTION"
  37 .PP
  38 \fBdnssec\-settime\fR
  39 reads a DNSSEC private key file and sets the key timing metadata as specified by the
  40 \fB\-P\fR,
  41 \fB\-A\fR,
  42 \fB\-R\fR,
  43 \fB\-I\fR, and
  44 \fB\-D\fR
  45 options. The metadata can then be used by
  46 \fBdnssec\-signzone\fR
  47 or other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc.
  48 .PP
  49 If none of these options is set on the command line, then
  50 \fBdnssec\-settime\fR
  51 simply prints the key timing metadata already stored in the key.
  52 .PP
  53 When key metadata fields are changed, both files of a key pair (\fIKnnnn.+aaa+iiiii.key\fR
  54 and
  55 \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. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600).
  56 .SH "OPTIONS"
  57 .PP
  58 \-f
  59 .RS 4
  60 Force an update of an old\-format key with no metadata fields. Without this option,
  61 \fBdnssec\-settime\fR
  62 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. If no other values are specified, then the key's publication and activation dates will also be set to the present time.
  63 .RE
  64 .PP
  65 \-K \fIdirectory\fR
  66 .RS 4
  67 Sets the directory in which the key files are to reside.
  68 .RE
  69 .PP
  70 \-L \fIttl\fR
  71 .RS 4
  72 Sets 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. Setting the default TTL to
  73 0
  74 or
  75 none
  76 removes it.
  77 .RE
  78 .PP
  79 \-h
  80 .RS 4
  81 Emit usage message and exit.
  82 .RE
  83 .PP
  84 \-v \fIlevel\fR
  85 .RS 4
  86 Sets the debugging level.
  87 .RE
  88 .PP
  89 \-E \fIengine\fR
  90 .RS 4
  91 Use the given OpenSSL engine. When compiled with PKCS#11 support it defaults to pkcs11; the empty name resets it to no engine.
  92 .RE
  93 .SH "TIMING OPTIONS"
  94 .PP
  95 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'.
  96 .PP
  97 \-P \fIdate/offset\fR
  98 .RS 4
  99 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.
 100 .RE
 101 .PP
 102 \-A \fIdate/offset\fR
 103 .RS 4
 104 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.
 105 .RE
 106 .PP
 107 \-R \fIdate/offset\fR
 108 .RS 4
 109 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.
 110 .RE
 111 .PP
 112 \-I \fIdate/offset\fR
 113 .RS 4
 114 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.
 115 .RE
 116 .PP
 117 \-D \fIdate/offset\fR
 118 .RS 4
 119 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.)
 120 .RE
 121 .PP
 122 \-S \fIpredecessor key\fR
 123 .RS 4
 124 Select 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.
 125 .RE
 126 .PP
 127 \-i \fIinterval\fR
 128 .RS 4
 129 Sets 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't, 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't, then activation will be set to this much time after publication.
 130 .sp
 131 If 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.
 132 .sp
 133 As with date offsets, if the argument is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds.
 134 .RE
 135 .SH "PRINTING OPTIONS"
 136 .PP
 137 \fBdnssec\-settime\fR
 138 can also be used to print the timing metadata associated with a key.
 139 .PP
 140 \-u
 141 .RS 4
 142 Print times in UNIX epoch format.
 143 .RE
 144 .PP
 145 \-p \fIC/P/A/R/I/D/all\fR
 146 .RS 4
 147 Print a specific metadata value or set of metadata values. The
 148 \fB\-p\fR
 149 option may be followed by one or more of the following letters to indicate which value or values to print:
 150 \fBC\fR
 151 for the creation date,
 152 \fBP\fR
 153 for the publication date,
 154 \fBA\fR
 155 for the activation date,
 156 \fBR\fR
 157 for the revocation date,
 158 \fBI\fR
 159 for the inactivation date, or
 160 \fBD\fR
 161 for the deletion date. To print all of the metadata, use
 162 \fB\-p all\fR.
 163 .RE
 164 .SH "SEE ALSO"
 165 .PP
 166 \fBdnssec\-keygen\fR(8),
 167 \fBdnssec\-signzone\fR(8),
 168 BIND 9 Administrator Reference Manual,
 169 RFC 5011.
 170 .SH "AUTHOR"
 171 .PP
 172 Internet Systems Consortium
 173 .SH "COPYRIGHT"
 174 Copyright \(co 2009\-2011 Internet Systems Consortium, Inc. ("ISC")
 175 .br