doc/man1/openssl-ecparam.pod.in

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