genrsa.1 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "GENRSA 1"
  136. .TH GENRSA 1 "2022-03-15" "1.1.1n" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-genrsa, genrsa \- generate an RSA private key
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl\fR \fBgenrsa\fR
  146. [\fB\-help\fR]
  147. [\fB\-out filename\fR]
  148. [\fB\-passout arg\fR]
  149. [\fB\-aes128\fR]
  150. [\fB\-aes192\fR]
  151. [\fB\-aes256\fR]
  152. [\fB\-aria128\fR]
  153. [\fB\-aria192\fR]
  154. [\fB\-aria256\fR]
  155. [\fB\-camellia128\fR]
  156. [\fB\-camellia192\fR]
  157. [\fB\-camellia256\fR]
  158. [\fB\-des\fR]
  159. [\fB\-des3\fR]
  160. [\fB\-idea\fR]
  161. [\fB\-f4\fR]
  162. [\fB\-3\fR]
  163. [\fB\-rand file...\fR]
  164. [\fB\-writerand file\fR]
  165. [\fB\-engine id\fR]
  166. [\fB\-primes num\fR]
  167. [\fBnumbits\fR]
  168. .SH "DESCRIPTION"
  169. .IX Header "DESCRIPTION"
  170. The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
  171. .SH "OPTIONS"
  172. .IX Header "OPTIONS"
  173. .IP "\fB\-help\fR" 4
  174. .IX Item "-help"
  175. Print out a usage message.
  176. .IP "\fB\-out filename\fR" 4
  177. .IX Item "-out filename"
  178. Output the key to the specified file. If this argument is not specified then
  179. standard output is used.
  180. .IP "\fB\-passout arg\fR" 4
  181. .IX Item "-passout arg"
  182. The output file password source. For more information about the format
  183. of \fBarg\fR see \*(L"Pass Phrase Options\*(R" in \fBopenssl\fR\|(1).
  184. .IP "\fB\-aes128\fR, \fB\-aes192\fR, \fB\-aes256\fR, \fB\-aria128\fR, \fB\-aria192\fR, \fB\-aria256\fR, \fB\-camellia128\fR, \fB\-camellia192\fR, \fB\-camellia256\fR, \fB\-des\fR, \fB\-des3\fR, \fB\-idea\fR" 4
  185. .IX Item "-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea"
  186. These options encrypt the private key with specified
  187. cipher before outputting it. If none of these options is
  188. specified no encryption is used. If encryption is used a pass phrase is prompted
  189. for if it is not supplied via the \fB\-passout\fR argument.
  190. .IP "\fB\-F4|\-3\fR" 4
  191. .IX Item "-F4|-3"
  192. The public exponent to use, either 65537 or 3. The default is 65537.
  193. .IP "\fB\-rand file...\fR" 4
  194. .IX Item "-rand file..."
  195. A file or files containing random data used to seed the random number
  196. generator.
  197. Multiple files can be specified separated by an OS-dependent character.
  198. The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
  199. all others.
  200. .IP "[\fB\-writerand file\fR]" 4
  201. .IX Item "[-writerand file]"
  202. Writes random data to the specified \fIfile\fR upon exit.
  203. This can be used with a subsequent \fB\-rand\fR flag.
  204. .IP "\fB\-engine id\fR" 4
  205. .IX Item "-engine id"
  206. Specifying an engine (by its unique \fBid\fR string) will cause \fBgenrsa\fR
  207. to attempt to obtain a functional reference to the specified engine,
  208. thus initialising it if needed. The engine will then be set as the default
  209. for all available algorithms.
  210. .IP "\fB\-primes num\fR" 4
  211. .IX Item "-primes num"
  212. Specify the number of primes to use while generating the \s-1RSA\s0 key. The \fBnum\fR
  213. parameter must be a positive integer that is greater than 1 and less than 16.
  214. If \fBnum\fR is greater than 2, then the generated key is called a 'multi\-prime'
  215. \&\s-1RSA\s0 key, which is defined in \s-1RFC 8017.\s0
  216. .IP "\fBnumbits\fR" 4
  217. .IX Item "numbits"
  218. The size of the private key to generate in bits. This must be the last option
  219. specified. The default is 2048 and values less than 512 are not allowed.
  220. .SH "NOTES"
  221. .IX Header "NOTES"
  222. \&\s-1RSA\s0 private key generation essentially involves the generation of two or more
  223. prime numbers. When generating a private key various symbols will be output to
  224. indicate the progress of the generation. A \fB.\fR represents each number which
  225. has passed an initial sieve test, \fB+\fR means a number has passed a single
  226. round of the Miller-Rabin primality test, \fB*\fR means the current prime starts
  227. a regenerating progress due to some failed tests. A newline means that the number
  228. has passed all the prime tests (the actual number depends on the key size).
  229. .PP
  230. Because key generation is a random process the time taken to generate a key
  231. may vary somewhat. But in general, more primes lead to less generation time
  232. of a key.
  233. .SH "SEE ALSO"
  234. .IX Header "SEE ALSO"
  235. \&\fBgendsa\fR\|(1)
  236. .SH "COPYRIGHT"
  237. .IX Header "COPYRIGHT"
  238. Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
  239. .PP
  240. Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
  241. this file except in compliance with the License. You can obtain a copy
  242. in the file \s-1LICENSE\s0 in the source distribution or at
  243. <https://www.openssl.org/source/license.html>.