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