openssl-genrsa.pod.in 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-genrsa - generate an RSA private key
  5. =head1 SYNOPSIS
  6. B<openssl> B<genrsa>
  7. [B<-help>]
  8. [B<-out> I<filename>]
  9. [B<-passout> I<arg>]
  10. [B<-aes128>]
  11. [B<-aes192>]
  12. [B<-aes256>]
  13. [B<-aria128>]
  14. [B<-aria192>]
  15. [B<-aria256>]
  16. [B<-camellia128>]
  17. [B<-camellia192>]
  18. [B<-camellia256>]
  19. [B<-des>]
  20. [B<-des3>]
  21. [B<-idea>]
  22. [B<-F4>]
  23. [B<-f4>]
  24. [B<-3>]
  25. [B<-primes> I<num>]
  26. [B<-verbose>]
  27. [B<-traditional>]
  28. {- $OpenSSL::safe::opt_r_synopsis -}
  29. {- $OpenSSL::safe::opt_engine_synopsis -}
  30. {- $OpenSSL::safe::opt_provider_synopsis -}
  31. [B<numbits>]
  32. =for openssl ifdef engine 3
  33. =head1 DESCRIPTION
  34. This command has been deprecated.
  35. The L<openssl-genpkey(1)> command should be used instead.
  36. This command generates an RSA private key.
  37. =head1 OPTIONS
  38. =over 4
  39. =item B<-help>
  40. Print out a usage message.
  41. =item B<-out> I<filename>
  42. Output the key to the specified file. If this argument is not specified then
  43. standard output is used.
  44. =item B<-passout> I<arg>
  45. The output file password source. For more information about the format
  46. see L<openssl(1)/Pass Phrase Options>.
  47. =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
  48. These options encrypt the private key with specified
  49. cipher before outputting it. If none of these options is
  50. specified no encryption is used. If encryption is used a pass phrase is prompted
  51. for if it is not supplied via the B<-passout> argument.
  52. =item B<-F4>, B<-f4>, B<-3>
  53. The public exponent to use, either 65537 or 3. The default is 65537.
  54. The B<-3> option has been deprecated.
  55. =item B<-primes> I<num>
  56. Specify the number of primes to use while generating the RSA key. The I<num>
  57. parameter must be a positive integer that is greater than 1 and less than 16.
  58. If I<num> is greater than 2, then the generated key is called a 'multi-prime'
  59. RSA key, which is defined in RFC 8017.
  60. =item B<-verbose>
  61. Print extra details about the operations being performed.
  62. =item B<-traditional>
  63. Write the key using the traditional PKCS#1 format instead of the PKCS#8 format.
  64. {- $OpenSSL::safe::opt_r_item -}
  65. {- $OpenSSL::safe::opt_engine_item -}
  66. {- $OpenSSL::safe::opt_provider_item -}
  67. =item B<numbits>
  68. The size of the private key to generate in bits. This must be the last option
  69. specified. The default is 2048 and values less than 512 are not allowed.
  70. =back
  71. =head1 NOTES
  72. RSA private key generation essentially involves the generation of two or more
  73. prime numbers. When generating a private key various symbols will be output to
  74. indicate the progress of the generation. A B<.> represents each number which
  75. has passed an initial sieve test, B<+> means a number has passed a single
  76. round of the Miller-Rabin primality test, B<*> means the current prime starts
  77. a regenerating progress due to some failed tests. A newline means that the number
  78. has passed all the prime tests (the actual number depends on the key size).
  79. Because key generation is a random process the time taken to generate a key
  80. may vary somewhat. But in general, more primes lead to less generation time
  81. of a key.
  82. =head1 SEE ALSO
  83. L<openssl(1)>,
  84. L<openssl-genpkey(1)>,
  85. L<openssl-gendsa(1)>
  86. =head1 HISTORY
  87. This command was deprecated in OpenSSL 3.0.
  88. =head1 COPYRIGHT
  89. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  90. Licensed under the Apache License 2.0 (the "License"). You may not use
  91. this file except in compliance with the License. You can obtain a copy
  92. in the file LICENSE in the source distribution or at
  93. L<https://www.openssl.org/source/license.html>.
  94. =cut