1<!-- 2 - Copyright (C) 2009-2011, 2014, 2015 Internet Systems Consortium, Inc. ("ISC") 3 - 4 - Permission to use, copy, modify, and/or distribute this software for any 5 - purpose with or without fee is hereby granted, provided that the above 6 - copyright notice and this permission notice appear in all copies. 7 - 8 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 9 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 10 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 11 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 12 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 13 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 14 - PERFORMANCE OF THIS SOFTWARE. 15--> 16<!-- Id --> 17<html> 18<head> 19<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 20<title>dnssec-settime</title> 21<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 22</head> 23<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> 24<a name="man.dnssec-settime"></a><div class="titlepage"></div> 25<div class="refnamediv"> 26<h2>Name</h2> 27<p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p> 28</div> 29<div class="refsynopsisdiv"> 30<h2>Synopsis</h2> 31<div class="cmdsynopsis"><p><code class="command">dnssec-settime</code> [<code class="option">-f</code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-L <em class="replaceable"><code>ttl</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-A <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-R <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-I <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-V</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div> 32</div> 33<div class="refsect1" lang="en"> 34<a name="id2543450"></a><h2>DESCRIPTION</h2> 35<p><span><strong class="command">dnssec-settime</strong></span> 36 reads a DNSSEC private key file and sets the key timing metadata 37 as specified by the <code class="option">-P</code>, <code class="option">-A</code>, 38 <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code> 39 options. The metadata can then be used by 40 <span><strong class="command">dnssec-signzone</strong></span> or other signing software to 41 determine when a key is to be published, whether it should be 42 used for signing a zone, etc. 43 </p> 44<p> 45 If none of these options is set on the command line, 46 then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing 47 metadata already stored in the key. 48 </p> 49<p> 50 When key metadata fields are changed, both files of a key 51 pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and 52 <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated. 53 Metadata fields are stored in the private file. A human-readable 54 description of the metadata is also placed in comments in the key 55 file. The private file's permissions are always set to be 56 inaccessible to anyone other than the owner (mode 0600). 57 </p> 58</div> 59<div class="refsect1" lang="en"> 60<a name="id2543498"></a><h2>OPTIONS</h2> 61<div class="variablelist"><dl> 62<dt><span class="term">-f</span></dt> 63<dd><p> 64 Force an update of an old-format key with no metadata fields. 65 Without this option, <span><strong class="command">dnssec-settime</strong></span> will 66 fail when attempting to update a legacy key. With this option, 67 the key will be recreated in the new format, but with the 68 original key data retained. The key's creation date will be 69 set to the present time. If no other values are specified, 70 then the key's publication and activation dates will also 71 be set to the present time. 72 </p></dd> 73<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 74<dd><p> 75 Sets the directory in which the key files are to reside. 76 </p></dd> 77<dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt> 78<dd><p> 79 Sets the default TTL to use for this key when it is converted 80 into a DNSKEY RR. If the key is imported into a zone, 81 this is the TTL that will be used for it, unless there was 82 already a DNSKEY RRset in place, in which case the existing TTL 83 would take precedence. If this value is not set and there 84 is no existing DNSKEY RRset, the TTL will default to the 85 SOA TTL. Setting the default TTL to <code class="literal">0</code> 86 or <code class="literal">none</code> removes it from the key. 87 </p></dd> 88<dt><span class="term">-h</span></dt> 89<dd><p> 90 Emit usage message and exit. 91 </p></dd> 92<dt><span class="term">-V</span></dt> 93<dd><p> 94 Prints version information. 95 </p></dd> 96<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 97<dd><p> 98 Sets the debugging level. 99 </p></dd> 100<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 101<dd> 102<p> 103 Specifies the cryptographic hardware to use, when applicable. 104 </p> 105<p> 106 When BIND is built with OpenSSL PKCS#11 support, this defaults 107 to the string "pkcs11", which identifies an OpenSSL engine 108 that can drive a cryptographic accelerator or hardware service 109 module. When BIND is built with native PKCS#11 cryptography 110 (--enable-native-pkcs11), it defaults to the path of the PKCS#11 111 provider library specified via "--with-pkcs11". 112 </p> 113</dd> 114</dl></div> 115</div> 116<div class="refsect1" lang="en"> 117<a name="id2543700"></a><h2>TIMING OPTIONS</h2> 118<p> 119 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 120 If the argument begins with a '+' or '-', it is interpreted as 121 an offset from the present time. For convenience, if such an offset 122 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 123 then the offset is computed in years (defined as 365 24-hour days, 124 ignoring leap years), months (defined as 30 24-hour days), weeks, 125 days, hours, or minutes, respectively. Without a suffix, the offset 126 is computed in seconds. To unset a date, use 'none' or 'never'. 127 </p> 128<div class="variablelist"><dl> 129<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 130<dd><p> 131 Sets the date on which a key is to be published to the zone. 132 After that date, the key will be included in the zone but will 133 not be used to sign it. 134 </p></dd> 135<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 136<dd><p> 137 Sets the date on which the key is to be activated. After that 138 date, the key will be included in the zone and used to sign 139 it. 140 </p></dd> 141<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 142<dd><p> 143 Sets the date on which the key is to be revoked. After that 144 date, the key will be flagged as revoked. It will be included 145 in the zone and will be used to sign it. 146 </p></dd> 147<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 148<dd><p> 149 Sets the date on which the key is to be retired. After that 150 date, the key will still be included in the zone, but it 151 will not be used to sign it. 152 </p></dd> 153<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 154<dd><p> 155 Sets the date on which the key is to be deleted. After that 156 date, the key will no longer be included in the zone. (It 157 may remain in the key repository, however.) 158 </p></dd> 159<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt> 160<dd><p> 161 Select a key for which the key being modified will be an 162 explicit successor. The name, algorithm, size, and type of the 163 predecessor key must exactly match those of the key being 164 modified. The activation date of the successor key will be set 165 to the inactivation date of the predecessor. The publication 166 date will be set to the activation date minus the prepublication 167 interval, which defaults to 30 days. 168 </p></dd> 169<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt> 170<dd> 171<p> 172 Sets the prepublication interval for a key. If set, then 173 the publication and activation dates must be separated by at least 174 this much time. If the activation date is specified but the 175 publication date isn't, then the publication date will default 176 to this much time before the activation date; conversely, if 177 the publication date is specified but activation date isn't, 178 then activation will be set to this much time after publication. 179 </p> 180<p> 181 If the key is being set to be an explicit successor to another 182 key, then the default prepublication interval is 30 days; 183 otherwise it is zero. 184 </p> 185<p> 186 As with date offsets, if the argument is followed by one of 187 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the 188 interval is measured in years, months, weeks, days, hours, 189 or minutes, respectively. Without a suffix, the interval is 190 measured in seconds. 191 </p> 192</dd> 193</dl></div> 194</div> 195<div class="refsect1" lang="en"> 196<a name="id2543838"></a><h2>PRINTING OPTIONS</h2> 197<p> 198 <span><strong class="command">dnssec-settime</strong></span> can also be used to print the 199 timing metadata associated with a key. 200 </p> 201<div class="variablelist"><dl> 202<dt><span class="term">-u</span></dt> 203<dd><p> 204 Print times in UNIX epoch format. 205 </p></dd> 206<dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt> 207<dd><p> 208 Print a specific metadata value or set of metadata values. 209 The <code class="option">-p</code> option may be followed by one or more 210 of the following letters to indicate which value or values to print: 211 <code class="option">C</code> for the creation date, 212 <code class="option">P</code> for the publication date, 213 <code class="option">A</code> for the activation date, 214 <code class="option">R</code> for the revocation date, 215 <code class="option">I</code> for the inactivation date, or 216 <code class="option">D</code> for the deletion date. 217 To print all of the metadata, use <code class="option">-p all</code>. 218 </p></dd> 219</dl></div> 220</div> 221<div class="refsect1" lang="en"> 222<a name="id2543916"></a><h2>SEE ALSO</h2> 223<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, 224 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 225 <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 226 <em class="citetitle">RFC 5011</em>. 227 </p> 228</div> 229<div class="refsect1" lang="en"> 230<a name="id2543949"></a><h2>AUTHOR</h2> 231<p><span class="corpauthor">Internet Systems Consortium</span> 232 </p> 233</div> 234</div></body> 235</html> 236