doc/man1/openssl-ec.pod.in

   1 =pod
   2
   3 =begin comment
   4 {- join("\n", @autowarntext) -}
   5
   6 =end comment
   7
   8 =head1 NAME
   9
  10 openssl-ec - EC key processing
  11
  12 =head1 SYNOPSIS
  13
  14 B<openssl> B<ec>
  15 [B<-help>]
  16 [B<-inform> B<DER>|B<PEM>]
  17 [B<-outform> B<DER>|B<PEM>]
  18 [B<-in> I<filename>]
  19 [B<-passin> I<arg>]
  20 [B<-out> I<filename>]
  21 [B<-passout> I<arg>]
  22 [B<-des>]
  23 [B<-des3>]
  24 [B<-idea>]
  25 [B<-text>]
  26 [B<-noout>]
  27 [B<-param_out>]
  28 [B<-pubin>]
  29 [B<-pubout>]
  30 [B<-conv_form> I<arg>]
  31 [B<-param_enc> I<arg>]
  32 [B<-no_public>]
  33 [B<-check>]
  34 {- $OpenSSL::safe::opt_engine_synopsis -}
  35
  36 =for openssl ifdef engine
  37
  38 =head1 DESCRIPTION
  39
  40 The L<openssl-ec(1)> command processes EC keys. They can be converted between
  41 various forms and their components printed out. B<Note> OpenSSL uses the
  42 private key format specified in 'SEC 1: Elliptic Curve Cryptography'
  43 (http://www.secg.org/). To convert an OpenSSL EC private key into the
  44 PKCS#8 private key format use the L<openssl-pkcs8(1)> command.
  45
  46 =head1 OPTIONS
  47
  48 =over 4
  49
  50 =item B<-help>
  51
  52 Print out a usage message.
  53
  54 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
  55
  56 The input and formats; the default is B<PEM>.
  57 See L<openssl(1)/Format Options> for details.
  58
  59 Private keys are an SEC1 private key or PKCS#8 format.
  60 Public keys are a B<SubjectPublicKeyInfo> as specified in IETF RFC 3280.
  61
  62 =item B<-in> I<filename>
  63
  64 This specifies the input filename to read a key from or standard input if this
  65 option is not specified. If the key is encrypted a pass phrase will be
  66 prompted for.
  67
  68 =item B<-out> I<filename>
  69
  70 This specifies the output filename to write a key to or standard output by
  71 is not specified. If any encryption options are set then a pass phrase will be
  72 prompted for. The output filename should B<not> be the same as the input
  73 filename.
  74
  75 =item B<-passin> I<arg>, B<-passout> I<arg>
  76
  77 The password source for the input and output file.
  78 For more information about the format of B<arg>
  79 see L<openssl(1)/Pass Phrase Options>.
  80
  81 =item B<-des>|B<-des3>|B<-idea>
  82
  83 These options encrypt the private key with the DES, triple DES, IDEA or
  84 any other cipher supported by OpenSSL before outputting it. A pass phrase is
  85 prompted for.
  86 If none of these options is specified the key is written in plain text. This
  87 means that using this command to read in an encrypted key with no
  88 encryption option can be used to remove the pass phrase from a key, or by
  89 setting the encryption options it can be use to add or change the pass phrase.
  90 These options can only be used with PEM format output files.
  91
  92 =item B<-text>
  93
  94 Prints out the public, private key components and parameters.
  95
  96 =item B<-noout>
  97
  98 This option prevents output of the encoded version of the key.
  99
 100 =item B<-pubin>
 101
 102 By default, a private key is read from the input file. With this option a
 103 public key is read instead.
 104
 105 =item B<-pubout>
 106
 107 By default a private key is output. With this option a public
 108 key will be output instead. This option is automatically set if the input is
 109 a public key.
 110
 111 =item B<-conv_form> I<arg>
 112
 113 This specifies how the points on the elliptic curve are converted
 114 into octet strings. Possible values are: B<compressed> (the default
 115 value), B<uncompressed> and B<hybrid>. For more information regarding
 116 the point conversion forms please read the X9.62 standard.
 117 B<Note> Due to patent issues the B<compressed> option is disabled
 118 by default for binary curves and can be enabled by defining
 119 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
 120
 121 =item B<-param_enc> I<arg>
 122
 123 This specifies how the elliptic curve parameters are encoded.
 124 Possible value are: B<named_curve>, i.e. the ec parameters are
 125 specified by an OID, or B<explicit> where the ec parameters are
 126 explicitly given (see RFC 3279 for the definition of the
 127 EC parameters structures). The default value is B<named_curve>.
 128 B<Note> the B<implicitlyCA> alternative, as specified in RFC 3279,
 129 is currently not implemented in OpenSSL.
 130
 131 =item B<-no_public>
 132
 133 This option omits the public key components from the private key output.
 134
 135 =item B<-check>
 136
 137 This option checks the consistency of an EC private or public key.
 138
 139 {- $OpenSSL::safe::opt_engine_item -}
 140
 141 =back
 142
 143 =head1 EXAMPLES
 144
 145 To encrypt a private key using triple DES:
 146
 147  openssl ec -in key.pem -des3 -out keyout.pem
 148
 149 To convert a private key from PEM to DER format:
 150
 151  openssl ec -in key.pem -outform DER -out keyout.der
 152
 153 To print out the components of a private key to standard output:
 154
 155  openssl ec -in key.pem -text -noout
 156
 157 To just output the public part of a private key:
 158
 159  openssl ec -in key.pem -pubout -out pubkey.pem
 160
 161 To change the parameters encoding to B<explicit>:
 162
 163  openssl ec -in key.pem -param_enc explicit -out keyout.pem
 164
 165 To change the point conversion form to B<compressed>:
 166
 167  openssl ec -in key.pem -conv_form compressed -out keyout.pem
 168
 169 =head1 SEE ALSO
 170
 171 L<openssl(1)>,
 172 L<openssl-ecparam(1)>,
 173 L<openssl-dsa(1)>,
 174 L<openssl-rsa(1)>
 175
 176 =head1 COPYRIGHT
 177
 178 Copyright 2003-2019 The OpenSSL Project Authors. All Rights Reserved.
 179
 180 Licensed under the Apache License 2.0 (the "License").  You may not use
 181 this file except in compliance with the License.  You can obtain a copy
 182 in the file LICENSE in the source distribution or at
 183 L<https://www.openssl.org/source/license.html>.
 184
 185 =cut