doc/apps/genpkey.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 genpkey - generate a private key
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<genpkey>
  10 [B<-out filename>]
  11 [B<-outform PEM|DER>]
  12 [B<-pass arg>]
  13 [B<-cipher>]
  14 [B<-engine id>]
  15 [B<-paramfile file>]
  16 [B<-algorithm alg>]
  17 [B<-pkeyopt opt:value>]
  18 [B<-genparam>]
  19 [B<-text>]
  20
  21 =head1 DESCRIPTION
  22
  23 The B<genpkey> command generates a private key.
  24
  25 =head1 OPTIONS
  26
  27 =over 4
  28
  29 =item B<-out filename>
  30
  31 the output filename. If this argument is not specified then standard output is
  32 used.
  33
  34 =item B<-outform DER|PEM>
  35
  36 This specifies the output format DER or PEM.
  37
  38 =item B<-pass arg>
  39
  40 the output file password source. For more information about the format of B<arg>
  41 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
  42
  43 =item B<-cipher>
  44
  45 This option encrypts the private key with the supplied cipher. Any algorithm
  46 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
  47
  48 =item B<-engine id>
  49
  50 specifying an engine (by it's unique B<id> string) will cause B<req>
  51 to attempt to obtain a functional reference to the specified engine,
  52 thus initialising it if needed. The engine will then be set as the default
  53 for all available algorithms.
  54
  55 =item B<-algorithm alg>
  56
  57 public key algorithm to use such as RSA, DSA or DH.
  58
  59 =item B<-pkeyopt opt:value>
  60
  61 set the public key algorithm option B<opt> to B<value>. The precise set of
  62 options supported depends on the public key algorithm used and its
  63 implementation. See B<KEY GENERATION OPTIONS> below for more details.
  64
  65 =item B<-genparam>
  66
  67 generate a set of parameters instead of a private key.
  68
  69 =item B<-paramfile filename>
  70
  71 Some public key algorithms generate a private key based on a set of parameters.
  72 They can be supplied using this option. If this option is used the public
  73 key algorithm used is determined by the parameters.
  74
  75 =back
  76
  77 =head1 KEY GENERATION OPTIONS
  78
  79 The options supported by each algorith and indeed each implementation of an
  80 algorithm can vary. The options for the OpenSSL implementations are detailed
  81 below.
  82
  83 =head1 RSA KEY GENERATION OPTIONS
  84
  85 =over 4
  86
  87 =item B<rsa_keygen_bits:numbits>
  88
  89 The number of bits in the generated key. If not specified 1024 is used.
  90
  91 =item B<rsa_keygen_pubexp:value>
  92
  93 The RSA public exponent value. This can be a large decimal or
  94 hexadecimal value if preceded by B<0x>. Default value is 65537.
  95
  96 =back
  97
  98 =head1 DSA PARAMETER GENERATION OPTIONS
  99
 100 =over 4
 101
 102 =item B<dsa_paramgen_bits:numbits>
 103
 104 The number of bits in the generated parameters. If not specified 1024 is used.
 105
 106 =head1 DH PARAMETER GENERATION OPTIONS
 107
 108 =over 4
 109
 110 =item B<dh_paramgen_prime_len:numbits>
 111
 112 The number of bits in the prime parameter B<p>.
 113
 114 =item B<dh_paramgen_generator:value>
 115
 116 The value to use for the generator B<g>.
 117
 118 =back
 119
 120 =head1 EC PARAMETER GENERATION OPTIONS
 121
 122 =over 4
 123
 124 =item B<ec_paramgen_curve:curve>
 125
 126 the EC curve to use.
 127
 128 =back
 129
 130 =head1 NOTES
 131
 132 The use of the genpkey program is encouraged over the algorithm specific
 133 utilities because additional algorithm options and ENGINE provided algorithms
 134 can be used.
 135
 136 =head1 EXAMPLES
 137
 138 Generate an RSA private key using default parameters:
 139
 140  openssl genpkey -algoritm RSA -out key.pem
 141
 142 Encrypt output private key using 128 bit AES and the passphrase "hello":
 143
 144  openssl genpkey -algoritm RSA -out key.pem -aes-128-cbc -pass pass:hello
 145
 146 Generate a 2048 bit RSA key using 3 as the public exponent:
 147
 148  openssl genpkey -algoritm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048 \
 149                                                 -pkeyopt rsa_keygen_pubexp:3
 150
 151 Generate 1024 bit DSA parameters:
 152
 153  openssl genpkey -genparam -algorithm DSA -out dsap.pem \
 154                                                 -pkeyopt dsa_paramgen_bits:1024
 155
 156 Generate DSA key from parameters:
 157
 158  openssl genpkey -paramfile dsap.pem -out dsakey.pem
 159
 160 Generate 1024 bit DH parameters:
 161
 162  openssl genpkey -genparam -algorithm DH -out dhp.pem \
 163                                         -pkeyopt dh_paramgen_prime_len:1024
 164
 165 Generate DH key from parameters:
 166
 167  openssl genpkey -paramfile dhp.pem -out dhkey.pem
 168
 169
 170 =cut
 171