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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .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 "ECPARAM 1"
 136 .TH ECPARAM 1 "2020-04-21" "1.1.1g" "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 openssl\-ecparam, ecparam \- EC parameter manipulation and generation
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl ecparam\fR
 146 [\fB\-help\fR]
 147 [\fB\-inform DER|PEM\fR]
 148 [\fB\-outform DER|PEM\fR]
 149 [\fB\-in filename\fR]
 150 [\fB\-out filename\fR]
 151 [\fB\-noout\fR]
 152 [\fB\-text\fR]
 153 [\fB\-C\fR]
 154 [\fB\-check\fR]
 155 [\fB\-name arg\fR]
 156 [\fB\-list_curves\fR]
 157 [\fB\-conv_form arg\fR]
 158 [\fB\-param_enc arg\fR]
 159 [\fB\-no_seed\fR]
 160 [\fB\-rand file...\fR]
 161 [\fB\-writerand file\fR]
 162 [\fB\-genkey\fR]
 163 [\fB\-engine id\fR]
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 This command is used to manipulate or generate \s-1EC\s0 parameter files.
 167 .SH "OPTIONS"
 168 .IX Header "OPTIONS"
 169 .IP "\fB\-help\fR" 4
 170 .IX Item "-help"
 171 Print out a usage message.
 172 .IP "\fB\-inform DER|PEM\fR" 4
 173 .IX Item "-inform DER|PEM"
 174 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN.1 DER\s0 encoded
 175 form compatible with \s-1RFC 3279\s0 EcpkParameters. The \s-1PEM\s0 form is the default
 176 format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with additional
 177 header and footer lines.
 178 .IP "\fB\-outform DER|PEM\fR" 4
 179 .IX Item "-outform DER|PEM"
 180 This specifies the output format, the options have the same meaning and default
 181 as the \fB\-inform\fR option.
 182 .IP "\fB\-in filename\fR" 4
 183 .IX Item "-in filename"
 184 This specifies the input filename to read parameters from or standard input if
 185 this option is not specified.
 186 .IP "\fB\-out filename\fR" 4
 187 .IX Item "-out filename"
 188 This specifies the output filename parameters to. Standard output is used
 189 if this option is not present. The output filename should \fBnot\fR be the same
 190 as the input filename.
 191 .IP "\fB\-noout\fR" 4
 192 .IX Item "-noout"
 193 This option inhibits the output of the encoded version of the parameters.
 194 .IP "\fB\-text\fR" 4
 195 .IX Item "-text"
 196 This option prints out the \s-1EC\s0 parameters in human readable form.
 197 .IP "\fB\-C\fR" 4
 198 .IX Item "-C"
 199 This option converts the \s-1EC\s0 parameters into C code. The parameters can then
 200 be loaded by calling the \fBget_ec_group_XXX()\fR function.
 201 .IP "\fB\-check\fR" 4
 202 .IX Item "-check"
 203 Validate the elliptic curve parameters.
 204 .IP "\fB\-name arg\fR" 4
 205 .IX Item "-name arg"
 206 Use the \s-1EC\s0 parameters with the specified 'short' name. Use \fB\-list_curves\fR
 207 to get a list of all currently implemented \s-1EC\s0 parameters.
 208 .IP "\fB\-list_curves\fR" 4
 209 .IX Item "-list_curves"
 210 If this options is specified \fBecparam\fR will print out a list of all
 211 currently implemented \s-1EC\s0 parameters names and exit.
 212 .IP "\fB\-conv_form\fR" 4
 213 .IX Item "-conv_form"
 214 This specifies how the points on the elliptic curve are converted
 215 into octet strings. Possible values are: \fBcompressed\fR, \fBuncompressed\fR (the
 216 default value) and \fBhybrid\fR. For more information regarding
 217 the point conversion forms please read the X9.62 standard.
 218 \&\fBNote\fR Due to patent issues the \fBcompressed\fR option is disabled
 219 by default for binary curves and can be enabled by defining
 220 the preprocessor macro \fB\s-1OPENSSL_EC_BIN_PT_COMP\s0\fR at compile time.
 221 .IP "\fB\-param_enc arg\fR" 4
 222 .IX Item "-param_enc arg"
 223 This specifies how the elliptic curve parameters are encoded.
 224 Possible value are: \fBnamed_curve\fR, i.e. the ec parameters are
 225 specified by an \s-1OID,\s0 or \fBexplicit\fR where the ec parameters are
 226 explicitly given (see \s-1RFC 3279\s0 for the definition of the
 227 \&\s-1EC\s0 parameters structures). The default value is \fBnamed_curve\fR.
 228 \&\fBNote\fR the \fBimplicitlyCA\fR alternative, as specified in \s-1RFC 3279,\s0
 229 is currently not implemented in OpenSSL.
 230 .IP "\fB\-no_seed\fR" 4
 231 .IX Item "-no_seed"
 232 This option inhibits that the 'seed' for the parameter generation
 233 is included in the ECParameters structure (see \s-1RFC 3279\s0).
 234 .IP "\fB\-genkey\fR" 4
 235 .IX Item "-genkey"
 236 This option will generate an \s-1EC\s0 private key using the specified parameters.
 237 .IP "\fB\-rand file...\fR" 4
 238 .IX Item "-rand file..."
 239 A file or files containing random data used to seed the random number
 240 generator.
 241 Multiple files can be specified separated by an OS-dependent character.
 242 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 243 all others.
 244 .IP "[\fB\-writerand file\fR]" 4
 245 .IX Item "[-writerand file]"
 246 Writes random data to the specified \fIfile\fR upon exit.
 247 This can be used with a subsequent \fB\-rand\fR flag.
 248 .IP "\fB\-engine id\fR" 4
 249 .IX Item "-engine id"
 250 Specifying an engine (by its unique \fBid\fR string) will cause \fBecparam\fR
 251 to attempt to obtain a functional reference to the specified engine,
 252 thus initialising it if needed. The engine will then be set as the default
 253 for all available algorithms.
 254 .SH "NOTES"
 255 .IX Header "NOTES"
 256 \&\s-1PEM\s0 format \s-1EC\s0 parameters use the header and footer lines:
 257 .PP
 258 .Vb 2
 259 \& \-\-\-\-\-BEGIN EC PARAMETERS\-\-\-\-\-
 260 \& \-\-\-\-\-END EC PARAMETERS\-\-\-\-\-
 261 .Ve
 262 .PP
 263 OpenSSL is currently not able to generate new groups and therefore
 264 \&\fBecparam\fR can only create \s-1EC\s0 parameters from known (named) curves.
 265 .SH "EXAMPLES"
 266 .IX Header "EXAMPLES"
 267 To create \s-1EC\s0 parameters with the group 'prime192v1':
 268 .PP
 269 .Vb 1
 270 \&  openssl ecparam \-out ec_param.pem \-name prime192v1
 271 .Ve
 272 .PP
 273 To create \s-1EC\s0 parameters with explicit parameters:
 274 .PP
 275 .Vb 1
 276 \&  openssl ecparam \-out ec_param.pem \-name prime192v1 \-param_enc explicit
 277 .Ve
 278 .PP
 279 To validate given \s-1EC\s0 parameters:
 280 .PP
 281 .Vb 1
 282 \&  openssl ecparam \-in ec_param.pem \-check
 283 .Ve
 284 .PP
 285 To create \s-1EC\s0 parameters and a private key:
 286 .PP
 287 .Vb 1
 288 \&  openssl ecparam \-out ec_key.pem \-name prime192v1 \-genkey
 289 .Ve
 290 .PP
 291 To change the point encoding to 'compressed':
 292 .PP
 293 .Vb 1
 294 \&  openssl ecparam \-in ec_in.pem \-out ec_out.pem \-conv_form compressed
 295 .Ve
 296 .PP
 297 To print out the \s-1EC\s0 parameters to standard output:
 298 .PP
 299 .Vb 1
 300 \&  openssl ecparam \-in ec_param.pem \-noout \-text
 301 .Ve
 302 .SH "SEE ALSO"
 303 .IX Header "SEE ALSO"
 304 \&\fBec\fR\|(1), \fBdsaparam\fR\|(1)
 305 .SH "COPYRIGHT"
 306 .IX Header "COPYRIGHT"
 307 Copyright 2003\-2018 The OpenSSL Project Authors. All Rights Reserved.
 308 .PP
 309 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 310 this file except in compliance with the License.  You can obtain a copy
 311 in the file \s-1LICENSE\s0 in the source distribution or at
 312 <https://www.openssl.org/source/license.html>.