examples/ldns-keygen.1

   1 .TH ldns-keygen 1 "27 May 2008"
   2 .SH NAME
   3 ldns-keygen \- generate a DNSSEC key pair
   4 .SH SYNOPSIS
   5 .B ldns-keygen
   6 [
   7 .IR OPTION
   8 ]
   9 .IR DOMAIN
  10
  11 .SH DESCRIPTION
  12 \fBldns-keygen\fR is used to generate a private/public keypair. When run, it
  13 will create 3 files; a .key file with the public DNSKEY, a .private
  14 file with the private keydata and a .ds with the DS record of the
  15 DNSKEY record.
  16
  17 \fBldns-keygen\fR can also be used to create symmetric keys (for TSIG) by
  18 selecting the appropriate algorithm: \%\fIhmac-md5.sig-alg.reg.int\fR,
  19 \%\fIhmac-sha1\fR or \%\fIhmac-sha256\fR.
  20 In that case no DS record will be created and no .ds file.
  21
  22 \fBldns-keygen\fR prints the basename for the key files:
  23 K<name>+<alg>+<id>
  24
  25 .SH OPTIONS
  26 .TP
  27 \fB-a \fI<algorithm>\fR
  28 Create a key with this algorithm. Specifying 'list' here gives a list of supported algorithms.
  29 Several alias names are also accepted (from older versions and other software),
  30 the list gives names from the RFC.  Also the plain algo number is accepted.
  31
  32 .TP
  33 \fB-b \fI<bits>\fR
  34 Use this many bits for the key length.
  35
  36 .TP
  37 \fB-k\fR
  38 When given, generate a key signing key. This just sets the flag field to
  39 257 instead of 256 in the DNSKEY RR in the .key file.
  40
  41 .TP
  42 \fB-r \fIdevice\fR
  43 Make ldns-keygen use this file to seed the random generator with. This will
  44 default to /dev/random.
  45
  46 .TP
  47 \fB-v\fR
  48 Show the version and exit
  49
  50 .SH AUTHOR
  51 Written by the ldns team as an example for ldns usage.
  52
  53 .SH REPORTING BUGS
  54 Report bugs to <ldns-team@nlnetlabs.nl>.
  55
  56 .SH COPYRIGHT
  57 Copyright (C) 2005-2008 NLnet Labs. This is free software. There is NO
  58 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
  59 PURPOSE.