doc/apps/ec.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ec - EC key processing
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<ec>
  10 [B<-inform PEM|DER>]
  11 [B<-outform PEM|DER>]
  12 [B<-in filename>]
  13 [B<-passin arg>]
  14 [B<-out filename>]
  15 [B<-passout arg>]
  16 [B<-des>]
  17 [B<-des3>]
  18 [B<-idea>]
  19 [B<-text>]
  20 [B<-noout>]
  21 [B<-param_out>]
  22 [B<-pubin>]
  23 [B<-pubout>]
  24 [B<-conv_form arg>]
  25 [B<-param_enc arg>]
  26 [B<-no_public>]
  27 [B<-engine id>]
  28
  29 =head1 DESCRIPTION
  30
  31 The B<ec> command processes EC keys. They can be converted between various
  32 forms and their components printed out. B<Note> OpenSSL uses the
  33 private key format specified in 'SEC 1: Elliptic Curve Cryptography'
  34 (http://www.secg.org/). To convert a OpenSSL EC private key into the
  35 PKCS#8 private key format use the B<pkcs8> command.
  36
  37 =head1 COMMAND OPTIONS
  38
  39 =over 4
  40
  41 =item B<-inform DER|PEM>
  42
  43 This specifies the input format. The B<DER> option with a private key uses
  44 an ASN.1 DER encoded SEC1 private key. When used with a public key it
  45 uses the SubjectPublicKeyInfo structure as specified in RFC 3280.
  46 The B<PEM> form is the default format: it consists of the B<DER> format base64
  47 encoded with additional header and footer lines. In the case of a private key
  48 PKCS#8 format is also accepted.
  49
  50 =item B<-outform DER|PEM>
  51
  52 This specifies the output format, the options have the same meaning as the
  53 B<-inform> option.
  54
  55 =item B<-in filename>
  56
  57 This specifies the input filename to read a key from or standard input if this
  58 option is not specified. If the key is encrypted a pass phrase will be
  59 prompted for.
  60
  61 =item B<-passin arg>
  62
  63 the input file password source. For more information about the format of B<arg>
  64 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  65
  66 =item B<-out filename>
  67
  68 This specifies the output filename to write a key to or standard output by
  69 is not specified. If any encryption options are set then a pass phrase will be
  70 prompted for. The output filename should B<not> be the same as the input
  71 filename.
  72
  73 =item B<-passout arg>
  74
  75 the output file password source. For more information about the format of B<arg>
  76 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  77
  78 =item B<-des|-des3|-idea>
  79
  80 These options encrypt the private key with the DES, triple DES, IDEA or
  81 any other cipher supported by OpenSSL before outputting it. A pass phrase is
  82 prompted for.
  83 If none of these options is specified the key is written in plain text. This
  84 means that using the B<ec> utility to read in an encrypted key with no
  85 encryption option can be used to remove the pass phrase from a key, or by
  86 setting the encryption options it can be use to add or change the pass phrase.
  87 These options can only be used with PEM format output files.
  88
  89 =item B<-text>
  90
  91 prints out the public, private key components and parameters.
  92
  93 =item B<-noout>
  94
  95 this option prevents output of the encoded version of the key.
  96
  97 =item B<-modulus>
  98
  99 this option prints out the value of the public key component of the key.
 100
 101 =item B<-pubin>
 102
 103 by default a private key is read from the input file: with this option a
 104 public key is read instead.
 105
 106 =item B<-pubout>
 107
 108 by default a private key is output. With this option a public
 109 key will be output instead. This option is automatically set if the input is
 110 a public key.
 111
 112 =item B<-conv_form>
 113
 114 This specifies how the points on the elliptic curve are converted
 115 into octet strings. Possible values are: B<compressed> (the default
 116 value), B<uncompressed> and B<hybrid>. For more information regarding
 117 the point conversion forms please read the X9.62 standard.
 118 B<Note> Due to patent issues the B<compressed> option is disabled
 119 by default for binary curves and can be enabled by defining
 120 the preprocessor macro B<OPENSSL_EC_BIN_PT_COMP> at compile time.
 121
 122 =item B<-param_enc arg>
 123
 124 This specifies how the elliptic curve parameters are encoded.
 125 Possible value are: B<named_curve>, i.e. the ec parameters are
 126 specified by a OID, or B<explicit> where the ec parameters are
 127 explicitly given (see RFC 3279 for the definition of the
 128 EC parameters structures). The default value is B<named_curve>.
 129 B<Note> the B<implicitlyCA> alternative ,as specified in RFC 3279,
 130 is currently not implemented in OpenSSL.
 131
 132 =item B<-no_public>
 133
 134 This option omits the public key components from the private key output.
 135
 136 =item B<-engine id>
 137
 138 specifying an engine (by its unique B<id> string) will cause B<ec>
 139 to attempt to obtain a functional reference to the specified engine,
 140 thus initialising it if needed. The engine will then be set as the default
 141 for all available algorithms.
 142
 143 =back
 144
 145 =head1 NOTES
 146
 147 The PEM private key format uses the header and footer lines:
 148
 149  -----BEGIN EC PRIVATE KEY-----
 150  -----END EC PRIVATE KEY-----
 151
 152 The PEM public key format uses the header and footer lines:
 153
 154  -----BEGIN PUBLIC KEY-----
 155  -----END PUBLIC KEY-----
 156
 157 =head1 EXAMPLES
 158
 159 To encrypt a private key using triple DES:
 160
 161  openssl ec -in key.pem -des3 -out keyout.pem
 162
 163 To convert a private key from PEM to DER format:
 164
 165  openssl ec -in key.pem -outform DER -out keyout.der
 166
 167 To print out the components of a private key to standard output:
 168
 169  openssl ec -in key.pem -text -noout
 170
 171 To just output the public part of a private key:
 172
 173  openssl ec -in key.pem -pubout -out pubkey.pem
 174
 175 To change the parameters encoding to B<explicit>:
 176
 177  openssl ec -in key.pem -param_enc explicit -out keyout.pem
 178
 179 To change the point conversion form to B<compressed>:
 180
 181  openssl ec -in key.pem -conv_form compressed -out keyout.pem
 182
 183 =head1 SEE ALSO
 184
 185 L<ecparam(1)>, L<dsa(1)>, L<rsa(1)>
 186
 187 =cut