doc/man1/openssl-pkey.pod

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