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

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   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 turned on, 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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "DSAPARAM 1"
 136 .TH DSAPARAM 1 "2015-06-11" "1.0.1n" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 dsaparam \- DSA parameter manipulation and generation
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl dsaparam\fR
 146 [\fB\-inform DER|PEM\fR]
 147 [\fB\-outform DER|PEM\fR]
 148 [\fB\-in filename\fR]
 149 [\fB\-out filename\fR]
 150 [\fB\-noout\fR]
 151 [\fB\-text\fR]
 152 [\fB\-C\fR]
 153 [\fB\-rand file(s)\fR]
 154 [\fB\-genkey\fR]
 155 [\fB\-engine id\fR]
 156 [\fBnumbits\fR]
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 This command is used to manipulate or generate \s-1DSA\s0 parameter files.
 160 .SH "OPTIONS"
 161 .IX Header "OPTIONS"
 162 .IP "\fB\-inform DER|PEM\fR" 4
 163 .IX Item "-inform DER|PEM"
 164 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 165 form compatible with \s-1RFC2459 \s0(\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
 166 of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
 167 of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
 168 .IP "\fB\-outform DER|PEM\fR" 4
 169 .IX Item "-outform DER|PEM"
 170 This specifies the output format, the options have the same meaning as the
 171 \&\fB\-inform\fR option.
 172 .IP "\fB\-in filename\fR" 4
 173 .IX Item "-in filename"
 174 This specifies the input filename to read parameters from or standard input if
 175 this option is not specified. If the \fBnumbits\fR parameter is included then
 176 this option will be ignored.
 177 .IP "\fB\-out filename\fR" 4
 178 .IX Item "-out filename"
 179 This specifies the output filename parameters to. Standard output is used
 180 if this option is not present. The output filename should \fBnot\fR be the same
 181 as the input filename.
 182 .IP "\fB\-noout\fR" 4
 183 .IX Item "-noout"
 184 this option inhibits the output of the encoded version of the parameters.
 185 .IP "\fB\-text\fR" 4
 186 .IX Item "-text"
 187 this option prints out the \s-1DSA\s0 parameters in human readable form.
 188 .IP "\fB\-C\fR" 4
 189 .IX Item "-C"
 190 this option converts the parameters into C code. The parameters can then
 191 be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
 192 .IP "\fB\-genkey\fR" 4
 193 .IX Item "-genkey"
 194 this option will generate a \s-1DSA\s0 either using the specified or generated
 195 parameters.
 196 .IP "\fB\-rand file(s)\fR" 4
 197 .IX Item "-rand file(s)"
 198 a file or files containing random data used to seed the random number
 199 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 200 Multiple files can be specified separated by a OS-dependent character.
 201 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 202 all others.
 203 .IP "\fBnumbits\fR" 4
 204 .IX Item "numbits"
 205 this option specifies that a parameter set should be generated of size
 206 \&\fBnumbits\fR. It must be the last option. If this option is included then
 207 the input file (if any) is ignored.
 208 .IP "\fB\-engine id\fR" 4
 209 .IX Item "-engine id"
 210 specifying an engine (by its unique \fBid\fR string) will cause \fBdsaparam\fR
 211 to attempt to obtain a functional reference to the specified engine,
 212 thus initialising it if needed. The engine will then be set as the default
 213 for all available algorithms.
 214 .SH "NOTES"
 215 .IX Header "NOTES"
 216 \&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
 217 .PP
 218 .Vb 2
 219 \& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
 220 \& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
 221 .Ve
 222 .PP
 223 \&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
 224 \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
 225 .SH "SEE ALSO"
 226 .IX Header "SEE ALSO"
 227 \&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
 228 \&\fIrsa\fR\|(1)