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