doc/man1/genrsa.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 genrsa - generate an RSA private key
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<genrsa>
  10 [B<-help>]
  11 [B<-out filename>]
  12 [B<-passout arg>]
  13 [B<-aes128>]
  14 [B<-aes192>]
  15 [B<-aes256>]
  16 [B<-aria128>]
  17 [B<-aria192>]
  18 [B<-aria256>]
  19 [B<-camellia128>]
  20 [B<-camellia192>]
  21 [B<-camellia256>]
  22 [B<-des>]
  23 [B<-des3>]
  24 [B<-idea>]
  25 [B<-f4>]
  26 [B<-3>]
  27 [B<-rand file...>]
  28 [B<-writerand file>]
  29 [B<-engine id>]
  30 [B<numbits>]
  31
  32 =head1 DESCRIPTION
  33
  34 The B<genrsa> command generates an RSA private key.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<-help>
  41
  42 Print out a usage message.
  43
  44 =item B<-out filename>
  45
  46 Output the key to the specified file. If this argument is not specified then
  47 standard output is used.
  48
  49 =item B<-passout arg>
  50
  51 The output file password source. For more information about the format
  52 of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  53
  54 =item B<-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
  55
  56 These options encrypt the private key with specified
  57 cipher before outputting it. If none of these options is
  58 specified no encryption is used. If encryption is used a pass phrase is prompted
  59 for if it is not supplied via the B<-passout> argument.
  60
  61 =item B<-F4|-3>
  62
  63 The public exponent to use, either 65537 or 3. The default is 65537.
  64
  65 =item B<-rand file...>
  66
  67 A file or files containing random data used to seed the random number
  68 generator.
  69 Multiple files can be specified separated by an OS-dependent character.
  70 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  71 all others.
  72
  73 =item [B<-writerand file>]
  74
  75 Writes random data to the specified I<file> upon exit.
  76 This can be used with a subsequent B<-rand> flag.
  77
  78 =item B<-engine id>
  79
  80 Specifying an engine (by its unique B<id> string) will cause B<genrsa>
  81 to attempt to obtain a functional reference to the specified engine,
  82 thus initialising it if needed. The engine will then be set as the default
  83 for all available algorithms.
  84
  85 =item B<numbits>
  86
  87 The size of the private key to generate in bits. This must be the last option
  88 specified. The default is 2048.
  89
  90 =back
  91
  92 =head1 NOTES
  93
  94 RSA private key generation essentially involves the generation of two prime
  95 numbers. When generating a private key various symbols will be output to
  96 indicate the progress of the generation. A B<.> represents each number which
  97 has passed an initial sieve test, B<+> means a number has passed a single
  98 round of the Miller-Rabin primality test. A newline means that the number has
  99 passed all the prime tests (the actual number depends on the key size).
 100
 101 Because key generation is a random process the time taken to generate a key
 102 may vary somewhat.
 103
 104 =head1 BUGS
 105
 106 A quirk of the prime generation algorithm is that it cannot generate small
 107 primes. Therefore the number of bits should not be less that 64. For typical
 108 private keys this will not matter because for security reasons they will
 109 be much larger (typically 1024 bits).
 110
 111 =head1 SEE ALSO
 112
 113 L<gendsa(1)>
 114
 115 =head1 COPYRIGHT
 116
 117 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 118
 119 Licensed under the OpenSSL license (the "License").  You may not use
 120 this file except in compliance with the License.  You can obtain a copy
 121 in the file LICENSE in the source distribution or at
 122 L<https://www.openssl.org/source/license.html>.
 123
 124 =cut