1<!-- 2 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC") 3 - Copyright (C) 2000-2003 Internet Software Consortium. 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$ --> 18<html> 19<head> 20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 21<title>dnssec-settime</title> 22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 23<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual"> 24<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages"> 25<link rel="prev" href="man.dnssec-revoke.html" title="dnssec-revoke"> 26<link rel="next" href="man.dnssec-signzone.html" title="dnssec-signzone"> 27</head> 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 29<div class="navheader"> 30<table width="100%" summary="Navigation header"> 31<tr><th colspan="3" align="center"><span class="application">dnssec-settime</span></th></tr> 32<tr> 33<td width="20%" align="left"> 34<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td> 35<th width="60%" align="center">Manual pages</th> 36<td width="20%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a> 37</td> 38</tr> 39</table> 40<hr> 41</div> 42<div class="refentry" lang="en"> 43<a name="man.dnssec-settime"></a><div class="titlepage"></div> 44<div class="refnamediv"> 45<h2>Name</h2> 46<p><span class="application">dnssec-settime</span> — Set the key timing metadata for a DNSSEC key</p> 47</div> 48<div class="refsynopsisdiv"> 49<h2>Synopsis</h2> 50<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">-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 <em class="replaceable"><code>level</code></em></code>] [<code class="option">-E <em class="replaceable"><code>engine</code></em></code>] {keyfile}</p></div> 51</div> 52<div class="refsect1" lang="en"> 53<a name="id2615924"></a><h2>DESCRIPTION</h2> 54<p><span><strong class="command">dnssec-settime</strong></span> 55 reads a DNSSEC private key file and sets the key timing metadata 56 as specified by the <code class="option">-P</code>, <code class="option">-A</code>, 57 <code class="option">-R</code>, <code class="option">-I</code>, and <code class="option">-D</code> 58 options. The metadata can then be used by 59 <span><strong class="command">dnssec-signzone</strong></span> or other signing software to 60 determine when a key is to be published, whether it should be 61 used for signing a zone, etc. 62 </p> 63<p> 64 If none of these options is set on the command line, 65 then <span><strong class="command">dnssec-settime</strong></span> simply prints the key timing 66 metadata already stored in the key. 67 </p> 68<p> 69 When key metadata fields are changed, both files of a key 70 pair (<code class="filename">Knnnn.+aaa+iiiii.key</code> and 71 <code class="filename">Knnnn.+aaa+iiiii.private</code>) are regenerated. 72 Metadata fields are stored in the private file. A human-readable 73 description of the metadata is also placed in comments in the key 74 file. The private file's permissions are always set to be 75 inaccessible to anyone other than the owner (mode 0600). 76 </p> 77</div> 78<div class="refsect1" lang="en"> 79<a name="id2616051"></a><h2>OPTIONS</h2> 80<div class="variablelist"><dl> 81<dt><span class="term">-f</span></dt> 82<dd><p> 83 Force an update of an old-format key with no metadata fields. 84 Without this option, <span><strong class="command">dnssec-settime</strong></span> will 85 fail when attempting to update a legacy key. With this option, 86 the key will be recreated in the new format, but with the 87 original key data retained. The key's creation date will be 88 set to the present time. If no other values are specified, 89 then the key's publication and activation dates will also 90 be set to the present time. 91 </p></dd> 92<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt> 93<dd><p> 94 Sets the directory in which the key files are to reside. 95 </p></dd> 96<dt><span class="term">-h</span></dt> 97<dd><p> 98 Emit usage message and exit. 99 </p></dd> 100<dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt> 101<dd><p> 102 Sets the debugging level. 103 </p></dd> 104<dt><span class="term">-E <em class="replaceable"><code>engine</code></em></span></dt> 105<dd><p> 106 Use the given OpenSSL engine. When compiled with PKCS#11 support 107 it defaults to pkcs11; the empty name resets it to no engine. 108 </p></dd> 109</dl></div> 110</div> 111<div class="refsect1" lang="en"> 112<a name="id2616145"></a><h2>TIMING OPTIONS</h2> 113<p> 114 Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. 115 If the argument begins with a '+' or '-', it is interpreted as 116 an offset from the present time. For convenience, if such an offset 117 is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', 118 then the offset is computed in years (defined as 365 24-hour days, 119 ignoring leap years), months (defined as 30 24-hour days), weeks, 120 days, hours, or minutes, respectively. Without a suffix, the offset 121 is computed in seconds. To unset a date, use 'none'. 122 </p> 123<div class="variablelist"><dl> 124<dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt> 125<dd><p> 126 Sets the date on which a key is to be published to the zone. 127 After that date, the key will be included in the zone but will 128 not be used to sign it. 129 </p></dd> 130<dt><span class="term">-A <em class="replaceable"><code>date/offset</code></em></span></dt> 131<dd><p> 132 Sets the date on which the key is to be activated. After that 133 date, the key will be included in the zone and used to sign 134 it. 135 </p></dd> 136<dt><span class="term">-R <em class="replaceable"><code>date/offset</code></em></span></dt> 137<dd><p> 138 Sets the date on which the key is to be revoked. After that 139 date, the key will be flagged as revoked. It will be included 140 in the zone and will be used to sign it. 141 </p></dd> 142<dt><span class="term">-I <em class="replaceable"><code>date/offset</code></em></span></dt> 143<dd><p> 144 Sets the date on which the key is to be retired. After that 145 date, the key will still be included in the zone, but it 146 will not be used to sign it. 147 </p></dd> 148<dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt> 149<dd><p> 150 Sets the date on which the key is to be deleted. After that 151 date, the key will no longer be included in the zone. (It 152 may remain in the key repository, however.) 153 </p></dd> 154<dt><span class="term">-S <em class="replaceable"><code>predecessor key</code></em></span></dt> 155<dd><p> 156 Select a key for which the key being modified will be an 157 explicit successor. The name, algorithm, size, and type of the 158 predecessor key must exactly match those of the key being 159 modified. The activation date of the successor key will be set 160 to the inactivation date of the predecessor. The publication 161 date will be set to the activation date minus the prepublication 162 interval, which defaults to 30 days. 163 </p></dd> 164<dt><span class="term">-i <em class="replaceable"><code>interval</code></em></span></dt> 165<dd> 166<p> 167 Sets the prepublication interval for a key. If set, then 168 the publication and activation dates must be separated by at least 169 this much time. If the activation date is specified but the 170 publication date isn't, then the publication date will default 171 to this much time before the activation date; conversely, if 172 the publication date is specified but activation date isn't, 173 then activation will be set to this much time after publication. 174 </p> 175<p> 176 If the key is being set to be an explicit successor to another 177 key, then the default prepublication interval is 30 days; 178 otherwise it is zero. 179 </p> 180<p> 181 As with date offsets, if the argument is followed by one of 182 the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the 183 interval is measured in years, months, weeks, days, hours, 184 or minutes, respectively. Without a suffix, the interval is 185 measured in seconds. 186 </p> 187</dd> 188</dl></div> 189</div> 190<div class="refsect1" lang="en"> 191<a name="id2616488"></a><h2>PRINTING OPTIONS</h2> 192<p> 193 <span><strong class="command">dnssec-settime</strong></span> can also be used to print the 194 timing metadata associated with a key. 195 </p> 196<div class="variablelist"><dl> 197<dt><span class="term">-u</span></dt> 198<dd><p> 199 Print times in UNIX epoch format. 200 </p></dd> 201<dt><span class="term">-p <em class="replaceable"><code>C/P/A/R/I/D/all</code></em></span></dt> 202<dd><p> 203 Print a specific metadata value or set of metadata values. 204 The <code class="option">-p</code> option may be followed by one or more 205 of the following letters to indicate which value or values to print: 206 <code class="option">C</code> for the creation date, 207 <code class="option">P</code> for the publication date, 208 <code class="option">A</code> for the activation date, 209 <code class="option">R</code> for the revocation date, 210 <code class="option">I</code> for the inactivation date, or 211 <code class="option">D</code> for the deletion date. 212 To print all of the metadata, use <code class="option">-p all</code>. 213 </p></dd> 214</dl></div> 215</div> 216<div class="refsect1" lang="en"> 217<a name="id2616636"></a><h2>SEE ALSO</h2> 218<p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>, 219 <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>, 220 <em class="citetitle">BIND 9 Administrator Reference Manual</em>, 221 <em class="citetitle">RFC 5011</em>. 222 </p> 223</div> 224<div class="refsect1" lang="en"> 225<a name="id2617693"></a><h2>AUTHOR</h2> 226<p><span class="corpauthor">Internet Systems Consortium</span> 227 </p> 228</div> 229</div> 230<div class="navfooter"> 231<hr> 232<table width="100%" summary="Navigation footer"> 233<tr> 234<td width="40%" align="left"> 235<a accesskey="p" href="man.dnssec-revoke.html">Prev</a>�</td> 236<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td> 237<td width="40%" align="right">�<a accesskey="n" href="man.dnssec-signzone.html">Next</a> 238</td> 239</tr> 240<tr> 241<td width="40%" align="left" valign="top"> 242<span class="application">dnssec-revoke</span>�</td> 243<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td> 244<td width="40%" align="right" valign="top">�<span class="application">dnssec-signzone</span> 245</td> 246</tr> 247</table> 248</div> 249</body> 250</html> 251