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