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