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

   1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-05-25" "1.0.2l" "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 dsaparam \- DSA parameter manipulation and generation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl dsaparam\fR
 142 [\fB\-inform DER|PEM\fR]
 143 [\fB\-outform DER|PEM\fR]
 144 [\fB\-in filename\fR]
 145 [\fB\-out filename\fR]
 146 [\fB\-noout\fR]
 147 [\fB\-text\fR]
 148 [\fB\-C\fR]
 149 [\fB\-rand file(s)\fR]
 150 [\fB\-genkey\fR]
 151 [\fB\-engine id\fR]
 152 [\fBnumbits\fR]
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 This command is used to manipulate or generate \s-1DSA\s0 parameter files.
 156 .SH "OPTIONS"
 157 .IX Header "OPTIONS"
 158 .IP "\fB\-inform DER|PEM\fR" 4
 159 .IX Item "-inform DER|PEM"
 160 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 161 form compatible with \s-1RFC2459 \s0(\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
 162 of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
 163 of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
 164 .IP "\fB\-outform DER|PEM\fR" 4
 165 .IX Item "-outform DER|PEM"
 166 This specifies the output format, the options have the same meaning as the
 167 \&\fB\-inform\fR option.
 168 .IP "\fB\-in filename\fR" 4
 169 .IX Item "-in filename"
 170 This specifies the input filename to read parameters from or standard input if
 171 this option is not specified. If the \fBnumbits\fR parameter is included then
 172 this option will be ignored.
 173 .IP "\fB\-out filename\fR" 4
 174 .IX Item "-out filename"
 175 This specifies the output filename parameters to. Standard output is used
 176 if this option is not present. The output filename should \fBnot\fR be the same
 177 as the input filename.
 178 .IP "\fB\-noout\fR" 4
 179 .IX Item "-noout"
 180 this option inhibits the output of the encoded version of the parameters.
 181 .IP "\fB\-text\fR" 4
 182 .IX Item "-text"
 183 this option prints out the \s-1DSA\s0 parameters in human readable form.
 184 .IP "\fB\-C\fR" 4
 185 .IX Item "-C"
 186 this option converts the parameters into C code. The parameters can then
 187 be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
 188 .IP "\fB\-genkey\fR" 4
 189 .IX Item "-genkey"
 190 this option will generate a \s-1DSA\s0 either using the specified or generated
 191 parameters.
 192 .IP "\fB\-rand file(s)\fR" 4
 193 .IX Item "-rand file(s)"
 194 a file or files containing random data used to seed the random number
 195 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 196 Multiple files can be specified separated by a OS-dependent character.
 197 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 198 all others.
 199 .IP "\fBnumbits\fR" 4
 200 .IX Item "numbits"
 201 this option specifies that a parameter set should be generated of size
 202 \&\fBnumbits\fR. It must be the last option. If this option is included then
 203 the input file (if any) is ignored.
 204 .IP "\fB\-engine id\fR" 4
 205 .IX Item "-engine id"
 206 specifying an engine (by its unique \fBid\fR string) will cause \fBdsaparam\fR
 207 to attempt to obtain a functional reference to the specified engine,
 208 thus initialising it if needed. The engine will then be set as the default
 209 for all available algorithms.
 210 .SH "NOTES"
 211 .IX Header "NOTES"
 212 \&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
 213 .PP
 214 .Vb 2
 215 \& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
 216 \& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
 217 .Ve
 218 .PP
 219 \&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
 220 \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
 221 .SH "SEE ALSO"
 222 .IX Header "SEE ALSO"
 223 \&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 224 \&\fIrsa\fR\|(1)