doc/apps/pkey.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 pkey - public or private key processing tool
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<pkey>
  11 [B<-help>]
  12 [B<-inform PEM|DER>]
  13 [B<-outform PEM|DER>]
  14 [B<-in filename>]
  15 [B<-passin arg>]
  16 [B<-out filename>]
  17 [B<-passout arg>]
  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<-cipher>
  72
  73 These options encrypt the private key with the supplied cipher. Any algorithm
  74 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
  75
  76 =item B<-text>
  77
  78 prints out the various public or private key components in
  79 plain text in addition to the encoded version.
  80
  81 =item B<-text_pub>
  82
  83 print out only public key components even if a private key is being processed.
  84
  85 =item B<-noout>
  86
  87 do not output the encoded version of the key.
  88
  89 =item B<-pubin>
  90
  91 by default a private key is read from the input file: with this
  92 option a public key is read instead.
  93
  94 =item B<-pubout>
  95
  96 by default a private key is output: with this option a public
  97 key will be output instead. This option is automatically set if
  98 the input is a public key.
  99
 100 =item B<-engine id>
 101
 102 specifying an engine (by its unique B<id> string) will cause B<pkey>
 103 to attempt to obtain a functional reference to the specified engine,
 104 thus initialising it if needed. The engine will then be set as the default
 105 for all available algorithms.
 106
 107 =back
 108
 109 =head1 EXAMPLES
 110
 111 To remove the pass phrase on an RSA private key:
 112
 113  openssl pkey -in key.pem -out keyout.pem
 114
 115 To encrypt a private key using triple DES:
 116
 117  openssl pkey -in key.pem -des3 -out keyout.pem
 118
 119 To convert a private key from PEM to DER format:
 120
 121  openssl pkey -in key.pem -outform DER -out keyout.der
 122
 123 To print out the components of a private key to standard output:
 124
 125  openssl pkey -in key.pem -text -noout
 126
 127 To print out the public components of a private key to standard output:
 128
 129  openssl pkey -in key.pem -text_pub -noout
 130
 131 To just output the public part of a private key:
 132
 133  openssl pkey -in key.pem -pubout -out pubkey.pem
 134
 135 =head1 SEE ALSO
 136
 137 L<genpkey(1)>, L<rsa(1)>, L<pkcs8(1)>,
 138 L<dsa(1)>, L<genrsa(1)>, L<gendsa(1)>
 139
 140 =cut
 141
 142 =head1 COPYRIGHT
 143
 144 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
 145
 146 Licensed under the OpenSSL license (the "License").  You may not use
 147 this file except in compliance with the License.  You can obtain a copy
 148 in the file LICENSE in the source distribution or at
 149 L<https://www.openssl.org/source/license.html>.
 150
 151 =cut