secure/usr.bin/openssl/man/dsaparam.1

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "DSAPARAM 1"
 132 .TH DSAPARAM 1 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-dsaparam, dsaparam \- DSA parameter manipulation and generation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl dsaparam\fR
 142 [\fB\-help\fR]
 143 [\fB\-inform DER|PEM\fR]
 144 [\fB\-outform DER|PEM\fR]
 145 [\fB\-in filename\fR]
 146 [\fB\-out filename\fR]
 147 [\fB\-noout\fR]
 148 [\fB\-text\fR]
 149 [\fB\-C\fR]
 150 [\fB\-rand file...\fR]
 151 [\fB\-writerand file\fR]
 152 [\fB\-genkey\fR]
 153 [\fB\-engine id\fR]
 154 [\fBnumbits\fR]
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 This command is used to manipulate or generate \s-1DSA\s0 parameter files.
 158 .SH "OPTIONS"
 159 .IX Header "OPTIONS"
 160 .IP "\fB\-help\fR" 4
 161 .IX Item "-help"
 162 Print out a usage message.
 163 .IP "\fB\-inform DER|PEM\fR" 4
 164 .IX Item "-inform DER|PEM"
 165 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 166 form compatible with \s-1RFC2459\s0 (\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
 167 of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
 168 of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
 169 .IP "\fB\-outform DER|PEM\fR" 4
 170 .IX Item "-outform DER|PEM"
 171 This specifies the output format, the options have the same meaning and default
 172 as the \fB\-inform\fR option.
 173 .IP "\fB\-in filename\fR" 4
 174 .IX Item "-in filename"
 175 This specifies the input filename to read parameters from or standard input if
 176 this option is not specified. If the \fBnumbits\fR parameter is included then
 177 this option will be ignored.
 178 .IP "\fB\-out filename\fR" 4
 179 .IX Item "-out filename"
 180 This specifies the output filename parameters to. Standard output is used
 181 if this option is not present. The output filename should \fBnot\fR be the same
 182 as the input filename.
 183 .IP "\fB\-noout\fR" 4
 184 .IX Item "-noout"
 185 This option inhibits the output of the encoded version of the parameters.
 186 .IP "\fB\-text\fR" 4
 187 .IX Item "-text"
 188 This option prints out the \s-1DSA\s0 parameters in human readable form.
 189 .IP "\fB\-C\fR" 4
 190 .IX Item "-C"
 191 This option converts the parameters into C code. The parameters can then
 192 be loaded by calling the \fIget_dsaXXX()\fR function.
 193 .IP "\fB\-genkey\fR" 4
 194 .IX Item "-genkey"
 195 This option will generate a \s-1DSA\s0 either using the specified or generated
 196 parameters.
 197 .IP "\fB\-rand file...\fR" 4
 198 .IX Item "-rand file..."
 199 A file or files containing random data used to seed the random number
 200 generator.
 201 Multiple files can be specified separated by an OS-dependent character.
 202 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 203 all others.
 204 .IP "[\fB\-writerand file\fR]" 4
 205 .IX Item "[-writerand file]"
 206 Writes random data to the specified \fIfile\fR upon exit.
 207 This can be used with a subsequent \fB\-rand\fR flag.
 208 .IP "\fBnumbits\fR" 4
 209 .IX Item "numbits"
 210 This option specifies that a parameter set should be generated of size
 211 \&\fBnumbits\fR. It must be the last option. If this option is included then
 212 the input file (if any) is ignored.
 213 .IP "\fB\-engine id\fR" 4
 214 .IX Item "-engine id"
 215 Specifying an engine (by its unique \fBid\fR string) will cause \fBdsaparam\fR
 216 to attempt to obtain a functional reference to the specified engine,
 217 thus initialising it if needed. The engine will then be set as the default
 218 for all available algorithms.
 219 .SH "NOTES"
 220 .IX Header "NOTES"
 221 \&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
 222 .PP
 223 .Vb 2
 224 \& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
 225 \& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
 226 .Ve
 227 .PP
 228 \&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
 229 \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 233 \&\fIrsa\fR\|(1)
 234 .SH "COPYRIGHT"
 235 .IX Header "COPYRIGHT"
 236 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
 237 .PP
 238 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 239 this file except in compliance with the License.  You can obtain a copy
 240 in the file \s-1LICENSE\s0 in the source distribution or at
 241 <https://www.openssl.org/source/license.html>.