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