doc/man1/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...>]
  19 [B<-writerand file>]
  20 [B<-genkey>]
  21 [B<-engine id>]
  22 [B<numbits>]
  23
  24 =head1 DESCRIPTION
  25
  26 This command is used to manipulate or generate DSA parameter files.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-help>
  33
  34 Print out a usage message.
  35
  36 =item B<-inform DER|PEM>
  37
  38 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  39 form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
  40 of p, q and g respectively. The PEM form is the default format: it consists
  41 of the B<DER> format base64 encoded with additional header and footer lines.
  42
  43 =item B<-outform DER|PEM>
  44
  45 This specifies the output format, the options have the same meaning as the
  46 B<-inform> option.
  47
  48 =item B<-in filename>
  49
  50 This specifies the input filename to read parameters from or standard input if
  51 this option is not specified. If the B<numbits> parameter is included then
  52 this option will be ignored.
  53
  54 =item B<-out filename>
  55
  56 This specifies the output filename parameters to. Standard output is used
  57 if this option is not present. The output filename should B<not> be the same
  58 as the input filename.
  59
  60 =item B<-noout>
  61
  62 This option inhibits the output of the encoded version of the parameters.
  63
  64 =item B<-text>
  65
  66 This option prints out the DSA parameters in human readable form.
  67
  68 =item B<-C>
  69
  70 This option converts the parameters into C code. The parameters can then
  71 be loaded by calling the get_dsaXXX() function.
  72
  73 =item B<-genkey>
  74
  75 This option will generate a DSA either using the specified or generated
  76 parameters.
  77
  78 =item B<-rand file...>
  79
  80 A file or files containing random data used to seed the random number
  81 generator.
  82 Multiple files can be specified separated by an OS-dependent character.
  83 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  84 all others.
  85
  86 =item [B<-writerand file>]
  87
  88 Writes random data to the specified I<file> upon exit.
  89 This can be used with a subsequent B<-rand> flag.
  90
  91 =item B<numbits>
  92
  93 This option specifies that a parameter set should be generated of size
  94 B<numbits>. It must be the last option. If this option is included then
  95 the input file (if any) is ignored.
  96
  97 =item B<-engine id>
  98
  99 Specifying an engine (by its unique B<id> string) will cause B<dsaparam>
 100 to attempt to obtain a functional reference to the specified engine,
 101 thus initialising it if needed. The engine will then be set as the default
 102 for all available algorithms.
 103
 104 =back
 105
 106 =head1 NOTES
 107
 108 PEM format DSA parameters use the header and footer lines:
 109
 110  -----BEGIN DSA PARAMETERS-----
 111  -----END DSA PARAMETERS-----
 112
 113 DSA parameter generation is a slow process and as a result the same set of
 114 DSA parameters is often used to generate several distinct keys.
 115
 116 =head1 SEE ALSO
 117
 118 L<gendsa(1)>, L<dsa(1)>, L<genrsa(1)>,
 119 L<rsa(1)>
 120
 121 =head1 COPYRIGHT
 122
 123 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 124
 125 Licensed under the OpenSSL license (the "License").  You may not use
 126 this file except in compliance with the License.  You can obtain a copy
 127 in the file LICENSE in the source distribution or at
 128 L<https://www.openssl.org/source/license.html>.
 129
 130 =cut