doc/apps/dsaparam.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 dsaparam - DSA parameter manipulation and generation
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl dsaparam>
  10 [B<-help>]
  11 [B<-inform DER|PEM>]
  12 [B<-outform DER|PEM>]
  13 [B<-in filename>]
  14 [B<-out filename>]
  15 [B<-noout>]
  16 [B<-text>]
  17 [B<-C>]
  18 [B<-rand file(s)>]
  19 [B<-genkey>]
  20 [B<-engine id>]
  21 [B<numbits>]
  22
  23 =head1 DESCRIPTION
  24
  25 This command is used to manipulate or generate DSA parameter files.
  26
  27 =head1 OPTIONS
  28
  29 =over 4
  30
  31 =item B<-help>
  32
  33 Print out a usage message.
  34
  35 =item B<-inform DER|PEM>
  36
  37 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  38 form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
  39 of p, q and g respectively. The PEM form is the default format: it consists
  40 of the B<DER> format base64 encoded with additional header and footer lines.
  41
  42 =item B<-outform DER|PEM>
  43
  44 This specifies the output format, the options have the same meaning as the
  45 B<-inform> option.
  46
  47 =item B<-in filename>
  48
  49 This specifies the input filename to read parameters from or standard input if
  50 this option is not specified. If the B<numbits> parameter is included then
  51 this option will be ignored.
  52
  53 =item B<-out filename>
  54
  55 This specifies the output filename parameters to. Standard output is used
  56 if this option is not present. The output filename should B<not> be the same
  57 as the input filename.
  58
  59 =item B<-noout>
  60
  61 this option inhibits the output of the encoded version of the parameters.
  62
  63 =item B<-text>
  64
  65 this option prints out the DSA parameters in human readable form.
  66
  67 =item B<-C>
  68
  69 this option converts the parameters into C code. The parameters can then
  70 be loaded by calling the get_dsaXXX() function.
  71
  72 =item B<-genkey>
  73
  74 this option will generate a DSA either using the specified or generated
  75 parameters.
  76
  77 =item B<-rand file(s)>
  78
  79 a file or files containing random data used to seed the random number
  80 generator, or an EGD socket (see L<RAND_egd(3)>).
  81 Multiple files can be specified separated by an OS-dependent character.
  82 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  83 all others.
  84
  85 =item B<numbits>
  86
  87 this option specifies that a parameter set should be generated of size
  88 B<numbits>. It must be the last option. If this option is included then
  89 the input file (if any) is ignored.
  90
  91 =item B<-engine id>
  92
  93 specifying an engine (by its unique B<id> string) will cause B<dsaparam>
  94 to attempt to obtain a functional reference to the specified engine,
  95 thus initialising it if needed. The engine will then be set as the default
  96 for all available algorithms.
  97
  98 =back
  99
 100 =head1 NOTES
 101
 102 PEM format DSA parameters use the header and footer lines:
 103
 104  -----BEGIN DSA PARAMETERS-----
 105  -----END DSA PARAMETERS-----
 106
 107 DSA parameter generation is a slow process and as a result the same set of
 108 DSA parameters is often used to generate several distinct keys.
 109
 110 =head1 SEE ALSO
 111
 112 L<gendsa(1)>, L<dsa(1)>, L<genrsa(1)>,
 113 L<rsa(1)>
 114
 115 =cut