doc/man1/openssl-ecparam.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-ecparam - EC parameter manipulation and generation
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl ecparam>
  10 [B<-help>]
  11 [B<-inform> B<DER>|B<PEM>]
  12 [B<-outform> B<DER>|B<PEM>]
  13 [B<-in> I<filename>]
  14 [B<-out> I<filename>]
  15 [B<-noout>]
  16 [B<-text>]
  17 [B<-C>]
  18 [B<-check>]
  19 [B<-check_named>]
  20 [B<-name> I<arg>]
  21 [B<-list_curves>]
  22 [B<-conv_form> I<arg>]
  23 [B<-param_enc> I<arg>]
  24 [B<-no_seed>]
  25 [B<-rand> I<files>]
  26 [B<-writerand> I<file>]
  27 [B<-genkey>]
  28 [B<-engine> I<id>]
  29
  30 =for openssl ifdef engine
  31
  32 =head1 DESCRIPTION
  33
  34 This command is used to manipulate or generate EC parameter files.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<-help>
  41
  42 Print out a usage message.
  43
  44 =item B<-inform> B<DER>|B<PEM>
  45
  46 This specifies the input format. The B<DER> option uses an ASN.1 DER encoded
  47 form compatible with RFC 3279 EcpkParameters. The PEM form is the default
  48 format: it consists of the B<DER> format base64 encoded with additional
  49 header and footer lines.
  50
  51 =item B<-outform> B<DER>|B<PEM>
  52
  53 This specifies the output format, the options have the same meaning and default
  54 as the B<-inform> option.
  55
  56 =item B<-in> I<filename>
  57
  58 This specifies the input filename to read parameters from or standard input if
  59 this option is not specified.
  60
  61 =item B<-out> I<filename>
  62
  63 This specifies the output filename parameters to. Standard output is used
  64 if this option is not present. The output filename should B<not> be the same
  65 as the input filename.
  66
  67 =item B<-noout>
  68
  69 This option inhibits the output of the encoded version of the parameters.
  70
  71 =item B<-text>
  72
  73 This option prints out the EC parameters in human readable form.
  74
  75 =item B<-C>
  76
  77 This option converts the EC parameters into C code. The parameters can then
  78 be loaded by calling the get_ec_group_XXX() function.
  79
  80 =item B<-check>
  81
  82 Validate the elliptic curve parameters.
  83
  84 =item B<-check_named>
  85
  86 Validate the elliptic name curve parameters by checking if the curve parameters
  87 match any built-in curves.
  88
  89 =item B<-name> I<arg>
  90
  91 Use the EC parameters with the specified 'short' name. Use B<-list_curves>
  92 to get a list of all currently implemented EC parameters.
  93
  94 =item B<-list_curves>
  95
  96 Print out a list of all currently implemented EC parameters names and exit.
  97
  98 =item B<-conv_form> I<arg>
  99
 100 This specifies how the points on the elliptic curve are converted
 101 into octet strings. Possible values are: B<compressed>, B<uncompressed> (the
 102 default value) and B<hybrid>. For more information regarding
 103 the point conversion forms please read the X9.62 standard.
 104 B<Note> Due to patent issues the B<compressed> option is disabled
 105 by default for binary curves and can be enabled by defining
 106 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
 107
 108 =item B<-param_enc> I<arg>
 109
 110 This specifies how the elliptic curve parameters are encoded.
 111 Possible value are: B<named_curve>, i.e. the ec parameters are
 112 specified by an OID, or B<explicit> where the ec parameters are
 113 explicitly given (see RFC 3279 for the definition of the
 114 EC parameters structures). The default value is B<named_curve>.
 115 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
 116 is currently not implemented in OpenSSL.
 117
 118 =item B<-no_seed>
 119
 120 This option inhibits that the 'seed' for the parameter generation
 121 is included in the ECParameters structure (see RFC 3279).
 122
 123 =item B<-genkey>
 124
 125 This option will generate an EC private key using the specified parameters.
 126
 127 =item B<-rand> I<files>
 128
 129 The files containing random data used to seed the random number generator.
 130 Multiple files can be specified separated by an OS-dependent character.
 131 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 132 all others.
 133
 134 =item B<-writerand> I<file>
 135
 136 Writes random data to the specified I<file> upon exit.
 137 This can be used with a subsequent B<-rand> flag.
 138
 139 =item B<-engine> I<id>
 140
 141 Specifying an engine (by its unique I<id> string) will cause B<ecparam>
 142 to attempt to obtain a functional reference to the specified engine,
 143 thus initialising it if needed. The engine will then be set as the default
 144 for all available algorithms.
 145
 146 =back
 147
 148 =head1 NOTES
 149
 150 PEM format EC parameters use the header and footer lines:
 151
 152  -----BEGIN EC PARAMETERS-----
 153  -----END EC PARAMETERS-----
 154
 155 OpenSSL is currently not able to generate new groups and therefore
 156 B<openssl ecparam> can only create EC parameters from known (named) curves.
 157
 158 =head1 EXAMPLES
 159
 160 To create EC parameters with the group 'prime192v1':
 161
 162   openssl ecparam -out ec_param.pem -name prime192v1
 163
 164 To create EC parameters with explicit parameters:
 165
 166   openssl ecparam -out ec_param.pem -name prime192v1 -param_enc explicit
 167
 168 To validate given EC parameters:
 169
 170   openssl ecparam -in ec_param.pem -check
 171
 172 To create EC parameters and a private key:
 173
 174   openssl ecparam -out ec_key.pem -name prime192v1 -genkey
 175
 176 To change the point encoding to 'compressed':
 177
 178   openssl ecparam -in ec_in.pem -out ec_out.pem -conv_form compressed
 179
 180 To print out the EC parameters to standard output:
 181
 182   openssl ecparam -in ec_param.pem -noout -text
 183
 184 =head1 SEE ALSO
 185
 186 L<openssl(1)>,
 187 L<openssl-ec(1)>,
 188 L<openssl-dsaparam(1)>
 189
 190 =head1 COPYRIGHT
 191
 192 Copyright 2003-2019 The OpenSSL Project Authors. All Rights Reserved.
 193
 194 Licensed under the Apache License 2.0 (the "License").  You may not use
 195 this file except in compliance with the License.  You can obtain a copy
 196 in the file LICENSE in the source distribution or at
 197 L<https://www.openssl.org/source/license.html>.
 198
 199 =cut