doc/man1/openssl-dsaparam.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-dsaparam - DSA parameter manipulation and generation
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl dsaparam>
  10 [B<-help>]
  11 [B<-inform> B<DER>|B<PEM>]
  12 [B<-outform> B<DER>|B<PEM>]
  13 [B<-in> I<filename>]
  14 [B<-out> I<filename>]
  15 [B<-noout>]
  16 [B<-text>]
  17 [B<-C>]
  18 [B<-rand> I<files>]
  19 [B<-writerand> I<file>]
  20 [B<-genkey>]
  21 [B<-engine> I<id>]
  22 [B<-verbose>]
  23 [I<numbits>]
  24
  25 =head1 DESCRIPTION
  26
  27 This command is used to manipulate or generate DSA parameter files.
  28
  29 =head1 OPTIONS
  30
  31 =over 4
  32
  33 =item B<-help>
  34
  35 Print out a usage message.
  36
  37 =item B<-inform> B<DER>|B<PEM>
  38
  39 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  40 form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
  41 of p, q and g respectively. The PEM form is the default format: it consists
  42 of the B<DER> format base64 encoded with additional header and footer lines.
  43
  44 =item B<-outform> B<DER>|B<PEM>
  45
  46 This specifies the output format, the options have the same meaning and default
  47 as the B<-inform> option.
  48
  49 =item B<-in> I<filename>
  50
  51 This specifies the input filename to read parameters from or standard input if
  52 this option is not specified. If the I<numbits> parameter is included then
  53 this option will be ignored.
  54
  55 =item B<-out> I<filename>
  56
  57 This specifies the output filename parameters to. Standard output is used
  58 if this option is not present. The output filename should B<not> be the same
  59 as the input filename.
  60
  61 =item B<-noout>
  62
  63 This option inhibits the output of the encoded version of the parameters.
  64
  65 =item B<-text>
  66
  67 This option prints out the DSA parameters in human readable form.
  68
  69 =item B<-C>
  70
  71 This option converts the parameters into C code. The parameters can then
  72 be loaded by calling the get_dsaXXX() function.
  73
  74 =item B<-genkey>
  75
  76 This option will generate a DSA either using the specified or generated
  77 parameters.
  78
  79 =item B<-rand> I<files>
  80
  81 The files containing random data used to seed the random number 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> I<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<-engine> I<id>
  92
  93 Specifying an engine (by its unique I<id> string) will cause this command
  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 =item B<-verbose>
  99
 100 Print extra details about the operations being performed.
 101
 102 =item I<numbits>
 103
 104 This option specifies that a parameter set should be generated of size
 105 I<numbits>. It must be the last option. If this option is included then
 106 the input file (if any) is ignored.
 107
 108 =back
 109
 110 =head1 NOTES
 111
 112 PEM format DSA parameters use the header and footer lines:
 113
 114  -----BEGIN DSA PARAMETERS-----
 115  -----END DSA PARAMETERS-----
 116
 117 DSA parameter generation is a slow process and as a result the same set of
 118 DSA parameters is often used to generate several distinct keys.
 119
 120 =head1 SEE ALSO
 121
 122 L<openssl(1)>,
 123 L<openssl-gendsa(1)>,
 124 L<openssl-dsa(1)>,
 125 L<openssl-genrsa(1)>,
 126 L<openssl-rsa(1)>
 127
 128 =head1 COPYRIGHT
 129
 130 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 131
 132 Licensed under the Apache License 2.0 (the "License").  You may not use
 133 this file except in compliance with the License.  You can obtain a copy
 134 in the file LICENSE in the source distribution or at
 135 L<https://www.openssl.org/source/license.html>.
 136
 137 =cut