doc/man1/openssl-pkey.pod.in

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