dnssec-signzone.docbook 11.5 KB
Newer Older
1
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
Brian Wellington's avatar
Brian Wellington committed
2
<!--
Mark Andrews's avatar
Mark Andrews committed
3 4
 - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2001-2003  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
5 6 7 8 9
 -
 - Permission to use, copy, modify, and distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
Mark Andrews's avatar
Mark Andrews committed
10 11 12 13 14 15 16
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
Brian Wellington's avatar
Brian Wellington committed
17 18
-->

19
<!-- $Id: dnssec-signzone.docbook,v 1.12 2004/06/11 01:12:40 marka Exp $ -->
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

<refentry>
  <refentryinfo>
    <date>June 30, 2000</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>dnssec-signzone</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname><application>dnssec-signzone</application></refname>
    <refpurpose>DNSSEC zone signing tool</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>dnssec-signzone</command>
      <arg><option>-a</option></arg>
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
      <arg><option>-d <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-e <replaceable class="parameter">end-time</replaceable></option></arg>
      <arg><option>-f <replaceable class="parameter">output-file</replaceable></option></arg>
45
      <arg><option>-g</option></arg>
46
      <arg><option>-h</option></arg>
47
      <arg><option>-k <replaceable class="parameter">key</replaceable></option></arg>
48
      <arg><option>-l <replaceable class="parameter">domain</replaceable></option></arg>
49 50 51 52 53
      <arg><option>-i <replaceable class="parameter">interval</replaceable></option></arg>
      <arg><option>-n <replaceable class="parameter">nthreads</replaceable></option></arg>
      <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg>
      <arg><option>-p</option></arg>
      <arg><option>-r <replaceable class="parameter">randomdev</replaceable></option></arg>
54
      <arg><option>-s <replaceable class="parameter">start-time</replaceable></option></arg>
55 56
      <arg><option>-t</option></arg>
      <arg><option>-v <replaceable class="parameter">level</replaceable></option></arg>
57
      <arg><option>-z</option></arg>
58 59 60 61 62 63 64 65
      <arg choice="req">zonefile</arg>
      <arg rep="repeat">key</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
66 67 68 69 70 71
        <command>dnssec-signzone</command> signs a zone.  It generates
	NSEC and RRSIG records and produces a signed version of the
	zone. The security status of delegations from the signed zone
	(that is, whether the child zones are secure or not) is
	determined by the presence or absence of a
	<filename>keyset</filename> file for each child zone.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-a</term>
	<listitem>
	  <para>
	      Verify all generated signatures.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
	<listitem>
	  <para>
	       Specifies the DNS class of the zone.
	  </para>
	</listitem>
      </varlistentry>

97 98 99 100 101 102 103 104 105 106
      <varlistentry>
        <term>-k <replaceable class="parameter">key</replaceable></term>
	<listitem>
	  <para>
	       Treat specified key as a key signing key ignoring any
	       key flags.  This option may be specified multiple times.
	  </para>
	</listitem>
      </varlistentry>

107 108 109 110 111 112 113 114 115 116
      <varlistentry>
        <term>-l <replaceable class="parameter">domain</replaceable></term>
	<listitem>
	  <para>
		Generate a DLV set in addition to the key (DNSKEY) and DS sets.
		The domain is appended to the name of the records.
	  </para>
	</listitem>
      </varlistentry>

117 118 119 120
      <varlistentry>
        <term>-d <replaceable class="parameter">directory</replaceable></term>
	<listitem>
	  <para>
121
	       Look for <filename>keyset</filename> files in
122 123 124 125 126
	       <option>directory</option> as the directory 
	  </para>
	</listitem>
      </varlistentry>

127 128 129 130 131 132 133 134 135 136
      <varlistentry>
        <term>-g</term>
	<listitem>
	  <para>
		Generate DS records for child zones from keyset files.
		Existing DS records will be removed.
	  </para>
	</listitem>
      </varlistentry>

137 138 139 140
      <varlistentry>
        <term>-s <replaceable class="parameter">start-time</replaceable></term>
	<listitem>
	  <para>
141
	       Specify the date and time when the generated RRSIG records
142 143 144 145 146 147
	       become valid.  This can be either an absolute or relative
	       time.  An absolute start time is indicated by a number
	       in YYYYMMDDHHMMSS notation; 20000530144500 denotes
	       14:45:00 UTC on May 30th, 2000.  A relative start time is
	       indicated by +N, which is N seconds from the current time.
	       If no <option>start-time</option> is specified, the current
148
	       time minus 1 hour (to allow for clock skew) is used.
149 150 151 152 153 154 155 156
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-e <replaceable class="parameter">end-time</replaceable></term>
	<listitem>
	  <para>
157
	       Specify the date and time when the generated RRSIG records
158 159 160
	       expire.  As with <option>start-time</option>, an absolute
	       time is indicated in YYYYMMDDHHMMSS notation.  A time relative
	       to the start time is indicated with +N, which is N seconds from
Mark Andrews's avatar
Mark Andrews committed
161
	       the start time.  A time relative to the current time is
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
	       indicated with now+N.  If no <option>end-time</option> is
	       specified, 30 days from the start time is used as a default.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-f <replaceable class="parameter">output-file</replaceable></term>
	<listitem>
	  <para>
	       The name of the output file containing the signed zone.  The
	       default is to append <filename>.signed</filename> to the
	       input file.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-h</term>
	<listitem>
	  <para>
	       Prints a short summary of the options and arguments to
	       <command>dnssec-signzone</command>.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-i <replaceable class="parameter">interval</replaceable></term>
	<listitem>
	  <para>
	       When a previously signed zone is passed as input, records
	       may be resigned.  The <option>interval</option> option
	       specifies the cycle interval as an offset from the current
196
	       time (in seconds).  If a RRSIG record expires after the
197 198 199 200 201 202 203 204 205
	       cycle interval, it is retained.  Otherwise, it is considered
	       to be expiring soon, and it will be replaced.
	  </para>
	  <para>
	       The default cycle interval is one quarter of the difference
	       between the signature end and start times.  So if neither
	       <option>end-time</option> or <option>start-time</option>
	       are specified, <command>dnssec-signzone</command> generates
	       signatures that are valid for 30 days, with a cycle
206
	       interval of 7.5 days.  Therefore, if any existing RRSIG records
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
	       are due to expire in less than 7.5 days, they would be
	       replaced.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-n <replaceable class="parameter">ncpus</replaceable></term>
	<listitem>
	  <para>
	       Specifies the number of threads to use.  By default, one
	       thread is started for each detected CPU.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-o <replaceable class="parameter">origin</replaceable></term>
	<listitem>
	  <para>
	       The zone origin.  If not specified, the name of the zone file
	       is assumed to be the origin.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-p</term>
	<listitem>
	  <para>
	       Use pseudo-random data when signing the zone.  This is faster,
	       but less secure, than using real random data.  This option
	       may be useful when signing large zones or when the entropy
	       source is limited.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-r <replaceable class="parameter">randomdev</replaceable></term>
	<listitem>
	  <para>
	       Specifies the source of randomness.  If the operating
	       system does not provide a <filename>/dev/random</filename>
	       or equivalent device, the default source of randomness
	       is keyboard input.  <filename>randomdev</filename> specifies
	       the name of a character device or file containing random
	       data to be used instead of the default.  The special value
	       <filename>keyboard</filename> indicates that keyboard
	       input should be used.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-t</term>
	<listitem>
	  <para>
	       Print statistics at completion.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-v <replaceable class="parameter">level</replaceable></term>
	<listitem>
	  <para>
	       Sets the debugging level.
	  </para>
	</listitem>
      </varlistentry>

279 280 281 282 283 284 285 286 287
      <varlistentry>
        <term>-z</term>
	<listitem>
	  <para>
	       Ignore KSK flag on key when determining what to sign.
	  </para>
	</listitem>
      </varlistentry>

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
      <varlistentry>
        <term>zonefile</term>
	<listitem>
	  <para>
	       The file containing the zone to be signed.
	       Sets the debugging level.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>key</term>
	<listitem>
	  <para>
	       The keys used to sign the zone.  If no keys are specified, the
	       default all zone keys that have private key files in the
	       current directory.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>EXAMPLE</title>
    <para>
        The following command signs the <userinput>example.com</userinput>
	zone with the DSA key generated in the <command>dnssec-keygen</command>
	man page.  The zone's keys must be in the zone.  If there are
318 319
	<filename>keyset</filename> files associated with child zones,
	they must be in the current directory.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	<userinput>example.com</userinput>, the following command would be
	issued:
    </para>
    <para>
        <userinput>dnssec-signzone -o example.com db.example.com Kexample.com.+003+26160</userinput>
    </para>
    <para>
        The command would print a string of the form:
    </para>
    <para>
        In this example, <command>dnssec-signzone</command> creates
	the file <filename>db.example.com.signed</filename>.  This file
	should be referenced in a zone statement in a
	<filename>named.conf</filename> file.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>dnssec-keygen</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
      <citetitle>RFC 2535</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
Mark Andrews's avatar
Mark Andrews committed
352
        <corpauthor>Internet Systems Consortium</corpauthor>
353 354 355 356 357 358 359 360 361 362
    </para>
  </refsect1>

</refentry>

<!--
 - Local variables:
 - mode: sgml
 - End:
-->