openssl-rand.1ossl 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  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 "OPENSSL-RAND 1ossl"
  136. .TH OPENSSL-RAND 1ossl "2025-06-29" "3.3.2" "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\-rand \- generate pseudo\-random bytes
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl rand\fR
  146. [\fB\-help\fR]
  147. [\fB\-out\fR \fIfile\fR]
  148. [\fB\-base64\fR]
  149. [\fB\-hex\fR]
  150. [\fB\-engine\fR \fIid\fR]
  151. [\fB\-rand\fR \fIfiles\fR]
  152. [\fB\-writerand\fR \fIfile\fR]
  153. [\fB\-provider\fR \fIname\fR]
  154. [\fB\-provider\-path\fR \fIpath\fR]
  155. [\fB\-propquery\fR \fIpropq\fR]
  156. \&\fInum\fR[K|M|G|T]
  157. .SH "DESCRIPTION"
  158. .IX Header "DESCRIPTION"
  159. This command generates \fInum\fR random bytes using a cryptographically
  160. secure pseudo random number generator (\s-1CSPRNG\s0). A suffix [K|M|G|T] may be
  161. appended to the num value to indicate the requested value be scaled as a
  162. multiple of KiB/MiB/GiB/TiB respectively. Note that suffixes are case
  163. sensitive, and that the suffixes represent binary multiples
  164. (K = 1024 bytes, M = 1024*1024 bytes, etc).
  165. .PP
  166. The string 'max' may be substituted for a numerical value in num, to request the
  167. maximum number of bytes the \s-1CSPRNG\s0 can produce per instantiation. Currently,
  168. this is restricted to 2^61 bytes as per \s-1NIST SP 800\-90C.\s0
  169. .PP
  170. The random bytes are generated using the \fBRAND_bytes\fR\|(3) function,
  171. which provides a security level of 256 bits, provided it managed to
  172. seed itself successfully from a trusted operating system entropy source.
  173. Otherwise, the command will fail with a nonzero error code.
  174. For more details, see \fBRAND_bytes\fR\|(3), \s-1\fBRAND\s0\fR\|(7), and \s-1\fBEVP_RAND\s0\fR\|(7).
  175. .SH "OPTIONS"
  176. .IX Header "OPTIONS"
  177. .IP "\fB\-help\fR" 4
  178. .IX Item "-help"
  179. Print out a usage message.
  180. .IP "\fB\-out\fR \fIfile\fR" 4
  181. .IX Item "-out file"
  182. Write to \fIfile\fR instead of standard output.
  183. .IP "\fB\-base64\fR" 4
  184. .IX Item "-base64"
  185. Perform base64 encoding on the output.
  186. .IP "\fB\-hex\fR" 4
  187. .IX Item "-hex"
  188. Show the output as a hex string.
  189. .IP "\fB\-engine\fR \fIid\fR" 4
  190. .IX Item "-engine id"
  191. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  192. This option is deprecated.
  193. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
  194. .IX Item "-rand files, -writerand file"
  195. See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details.
  196. .IP "\fB\-provider\fR \fIname\fR" 4
  197. .IX Item "-provider name"
  198. .PD 0
  199. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  200. .IX Item "-provider-path path"
  201. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  202. .IX Item "-propquery propq"
  203. .PD
  204. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  205. .SH "SEE ALSO"
  206. .IX Header "SEE ALSO"
  207. \&\fBopenssl\fR\|(1),
  208. \&\fBRAND_bytes\fR\|(3),
  209. \&\s-1\fBRAND\s0\fR\|(7),
  210. \&\s-1\fBEVP_RAND\s0\fR\|(7)
  211. .SH "HISTORY"
  212. .IX Header "HISTORY"
  213. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  214. .SH "COPYRIGHT"
  215. .IX Header "COPYRIGHT"
  216. Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
  217. .PP
  218. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  219. this file except in compliance with the License. You can obtain a copy
  220. in the file \s-1LICENSE\s0 in the source distribution or at
  221. <https://www.openssl.org/source/license.html>.