doc/man1/pkey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 pkey - public or private key processing tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<pkey>
  10 [B<-help>]
  11 [B<-inform PEM|DER>]
  12 [B<-outform PEM|DER>]
  13 [B<-in filename>]
  14 [B<-passin arg>]
  15 [B<-out filename>]
  16 [B<-passout arg>]
  17 [B<-traditional>]
  18 [B<-I<cipher>>]
  19 [B<-text>]
  20 [B<-text_pub>]
  21 [B<-noout>]
  22 [B<-pubin>]
  23 [B<-pubout>]
  24 [B<-engine id>]
  25 [B<-check>]
  26
  27 =head1 DESCRIPTION
  28
  29 The B<pkey> command processes public or private keys. They can be converted
  30 between various forms and their components printed out.
  31
  32 =head1 OPTIONS
  33
  34 =over 4
  35
  36 =item B<-help>
  37
  38 Print out a usage message.
  39
  40 =item B<-inform DER|PEM>
  41
  42 This specifies the input format DER or PEM. The default format is PEM.
  43
  44 =item B<-outform DER|PEM>
  45
  46 This specifies the output format, the options have the same meaning and default
  47 as the B<-inform> option.
  48
  49 =item B<-in filename>
  50
  51 This specifies the input filename to read a key from or standard input if this
  52 option is not specified. If the key is encrypted a pass phrase will be
  53 prompted for.
  54
  55 =item B<-passin arg>
  56
  57 The input file password source. For more information about the format of B<arg>
  58 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  59
  60 =item B<-out filename>
  61
  62 This specifies the output filename to write a key to or standard output if this
  63 option is not specified. If any encryption options are set then a pass phrase
  64 will be prompted for. The output filename should B<not> be the same as the input
  65 filename.
  66
  67 =item B<-passout password>
  68
  69 The output file password source. For more information about the format of B<arg>
  70 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  71
  72 =item B<-traditional>
  73
  74 Normally a private key is written using standard format: this is PKCS#8 form
  75 with the appropriate encryption algorithm (if any). If the B<-traditional>
  76 option is specified then the older "traditional" format is used instead.
  77
  78 =item B<-I<cipher>>
  79
  80 These options encrypt the private key with the supplied cipher. Any algorithm
  81 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
  82
  83 =item B<-text>
  84
  85 Prints out the various public or private key components in
  86 plain text in addition to the encoded version.
  87
  88 =item B<-text_pub>
  89
  90 Print out only public key components even if a private key is being processed.
  91
  92 =item B<-noout>
  93
  94 Do not output the encoded version of the key.
  95
  96 =item B<-pubin>
  97
  98 By default a private key is read from the input file: with this
  99 option a public key is read instead.
 100
 101 =item B<-pubout>
 102
 103 By default a private key is output: with this option a public
 104 key will be output instead. This option is automatically set if
 105 the input is a public key.
 106
 107 =item B<-engine id>
 108
 109 Specifying an engine (by its unique B<id> string) will cause B<pkey>
 110 to attempt to obtain a functional reference to the specified engine,
 111 thus initialising it if needed. The engine will then be set as the default
 112 for all available algorithms.
 113
 114 =item B<-check>
 115
 116 This option checks the consistency of a key pair for both public and private
 117 components.
 118
 119 =back
 120
 121 =head1 EXAMPLES
 122
 123 To remove the pass phrase on an RSA private key:
 124
 125  openssl pkey -in key.pem -out keyout.pem
 126
 127 To encrypt a private key using triple DES:
 128
 129  openssl pkey -in key.pem -des3 -out keyout.pem
 130
 131 To convert a private key from PEM to DER format:
 132
 133  openssl pkey -in key.pem -outform DER -out keyout.der
 134
 135 To print out the components of a private key to standard output:
 136
 137  openssl pkey -in key.pem -text -noout
 138
 139 To print out the public components of a private key to standard output:
 140
 141  openssl pkey -in key.pem -text_pub -noout
 142
 143 To just output the public part of a private key:
 144
 145  openssl pkey -in key.pem -pubout -out pubkey.pem
 146
 147 =head1 SEE ALSO
 148
 149 L<genpkey(1)>, L<rsa(1)>, L<pkcs8(1)>,
 150 L<dsa(1)>, L<genrsa(1)>, L<gendsa(1)>
 151
 152 =head1 COPYRIGHT
 153
 154 Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
 155
 156 Licensed under the OpenSSL license (the "License").  You may not use
 157 this file except in compliance with the License.  You can obtain a copy
 158 in the file LICENSE in the source distribution or at
 159 L<https://www.openssl.org/source/license.html>.
 160
 161 =cut