secure/usr.bin/openssl/man/ecparam.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 "ECPARAM 1"
 132 .TH ECPARAM 1 "2018-03-27" "1.0.2o" "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\-ecparam,
 139 ecparam \- EC parameter manipulation and generation
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl ecparam\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\-check\fR]
 151 [\fB\-name arg\fR]
 152 [\fB\-list_curves\fR]
 153 [\fB\-conv_form arg\fR]
 154 [\fB\-param_enc arg\fR]
 155 [\fB\-no_seed\fR]
 156 [\fB\-rand file(s)\fR]
 157 [\fB\-genkey\fR]
 158 [\fB\-engine id\fR]
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 This command is used to manipulate or generate \s-1EC\s0 parameter files.
 162 .SH "OPTIONS"
 163 .IX Header "OPTIONS"
 164 .IP "\fB\-inform DER|PEM\fR" 4
 165 .IX Item "-inform DER|PEM"
 166 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN.1 DER\s0 encoded
 167 form compatible with \s-1RFC 3279\s0 EcpkParameters. The \s-1PEM\s0 form is the default
 168 format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with additional
 169 header and footer lines.
 170 .IP "\fB\-outform DER|PEM\fR" 4
 171 .IX Item "-outform DER|PEM"
 172 This specifies the output format, the options have the same meaning as the
 173 \&\fB\-inform\fR option.
 174 .IP "\fB\-in filename\fR" 4
 175 .IX Item "-in filename"
 176 This specifies the input filename to read parameters from or standard input if
 177 this option is not specified.
 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-1EC\s0 parameters in human readable form.
 189 .IP "\fB\-C\fR" 4
 190 .IX Item "-C"
 191 This option converts the \s-1EC\s0 parameters into C code. The parameters can then
 192 be loaded by calling the \fB\f(BIget_ec_group_XXX()\fB\fR function.
 193 .IP "\fB\-check\fR" 4
 194 .IX Item "-check"
 195 Validate the elliptic curve parameters.
 196 .IP "\fB\-name arg\fR" 4
 197 .IX Item "-name arg"
 198 Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR
 199 to get a list of all currently implemented \s-1EC\s0 parameters.
 200 .IP "\fB\-list_curves\fR" 4
 201 .IX Item "-list_curves"
 202 If this options is specified \fBecparam\fR will print out a list of all
 203 currently implemented \s-1EC\s0 parameters names and exit.
 204 .IP "\fB\-conv_form\fR" 4
 205 .IX Item "-conv_form"
 206 This specifies how the points on the elliptic curve are converted
 207 into octet strings. Possible values are: \fBcompressed\fR, \fBuncompressed\fR (the
 208 default value) and \fBhybrid\fR. For more information regarding
 209 the point conversion forms please read the X9.62 standard.
 210 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
 211 by default for binary curves and can be enabled by defining
 212 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
 213 .IP "\fB\-param_enc arg\fR" 4
 214 .IX Item "-param_enc arg"
 215 This specifies how the elliptic curve parameters are encoded.
 216 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
 217 specified by a \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
 218 explicitly given (see \s-1RFC 3279\s0 for the definition of the
 219 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
 220 \&\fBNote\fR the \fBimplicitlyCA\fR alternative ,as specified in \s-1RFC 3279,\s0
 221 is currently not implemented in OpenSSL.
 222 .IP "\fB\-no_seed\fR" 4
 223 .IX Item "-no_seed"
 224 This option inhibits that the 'seed' for the parameter generation
 225 is included in the ECParameters structure (see \s-1RFC 3279\s0).
 226 .IP "\fB\-genkey\fR" 4
 227 .IX Item "-genkey"
 228 This option will generate a \s-1EC\s0 private key using the specified parameters.
 229 .IP "\fB\-rand file(s)\fR" 4
 230 .IX Item "-rand file(s)"
 231 a file or files containing random data used to seed the random number
 232 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 233 Multiple files can be specified separated by a OS-dependent character.
 234 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 235 all others.
 236 .IP "\fB\-engine id\fR" 4
 237 .IX Item "-engine id"
 238 specifying an engine (by its unique \fBid\fR string) will cause \fBecparam\fR
 239 to attempt to obtain a functional reference to the specified engine,
 240 thus initialising it if needed. The engine will then be set as the default
 241 for all available algorithms.
 242 .SH "NOTES"
 243 .IX Header "NOTES"
 244 \&\s-1PEM\s0 format \s-1EC\s0 parameters use the header and footer lines:
 245 .PP
 246 .Vb 2
 247 \& \-\-\-\-\-BEGIN EC PARAMETERS\-\-\-\-\-
 248 \& \-\-\-\-\-END EC PARAMETERS\-\-\-\-\-
 249 .Ve
 250 .PP
 251 OpenSSL is currently not able to generate new groups and therefore
 252 \&\fBecparam\fR can only create \s-1EC\s0 parameters from known (named) curves.
 253 .SH "EXAMPLES"
 254 .IX Header "EXAMPLES"
 255 To create \s-1EC\s0 parameters with the group 'prime192v1':
 256 .PP
 257 .Vb 1
 258 \&  openssl ecparam \-out ec_param.pem \-name prime192v1
 259 .Ve
 260 .PP
 261 To create \s-1EC\s0 parameters with explicit parameters:
 262 .PP
 263 .Vb 1
 264 \&  openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
 265 .Ve
 266 .PP
 267 To validate given \s-1EC\s0 parameters:
 268 .PP
 269 .Vb 1
 270 \&  openssl ecparam \-in ec_param.pem \-check
 271 .Ve
 272 .PP
 273 To create \s-1EC\s0 parameters and a private key:
 274 .PP
 275 .Vb 1
 276 \&  openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
 277 .Ve
 278 .PP
 279 To change the point encoding to 'compressed':
 280 .PP
 281 .Vb 1
 282 \&  openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
 283 .Ve
 284 .PP
 285 To print out the \s-1EC\s0 parameters to standard output:
 286 .PP
 287 .Vb 1
 288 \&  openssl ecparam \-in ec_param.pem \-noout \-text
 289 .Ve
 290 .SH "SEE ALSO"
 291 .IX Header "SEE ALSO"
 292 \&\fIec\fR\|(1), \fIdsaparam\fR\|(1)
 293 .SH "HISTORY"
 294 .IX Header "HISTORY"
 295 The ecparam command was first introduced in OpenSSL 0.9.8.
 296 .SH "AUTHOR"
 297 .IX Header "AUTHOR"
 298 Nils Larsch for the OpenSSL project (http://www.openssl.org)