openssl-env.7ossl 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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-ENV 7ossl"
  136. .TH OPENSSL-ENV 7ossl "2024-09-03" "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\-env \- OpenSSL environment variables
  143. .SH "DESCRIPTION"
  144. .IX Header "DESCRIPTION"
  145. The OpenSSL libraries use environment variables to override the
  146. compiled-in default paths for various data.
  147. To avoid security risks, the environment is usually not consulted when
  148. the executable is set-user-ID or set-group-ID.
  149. .IP "\fB\s-1CTLOG_FILE\s0\fR" 4
  150. .IX Item "CTLOG_FILE"
  151. Specifies the path to a certificate transparency log list.
  152. See \fBCTLOG_STORE_new\fR\|(3).
  153. .IP "\fB\s-1OPENSSL\s0\fR" 4
  154. .IX Item "OPENSSL"
  155. Specifies the path to the \fBopenssl\fR executable. Used by
  156. the \fBrehash\fR script (see \*(L"Script Configuration\*(R" in \fBopenssl\-rehash\fR\|(1))
  157. and by the \fB\s-1CA\s0.pl\fR script (see \*(L"\s-1NOTES\*(R"\s0 in \s-1\fBCA\s0.pl\fR\|(1)
  158. .IP "\fB\s-1OPENSSL_CONF\s0\fR, \fB\s-1OPENSSL_CONF_INCLUDE\s0\fR" 4
  159. .IX Item "OPENSSL_CONF, OPENSSL_CONF_INCLUDE"
  160. Specifies the path to a configuration file and the directory for
  161. included files.
  162. See \fBconfig\fR\|(5).
  163. .IP "\fB\s-1OPENSSL_CONFIG\s0\fR" 4
  164. .IX Item "OPENSSL_CONFIG"
  165. Specifies a configuration option and filename for the \fBreq\fR and \fBca\fR
  166. commands invoked by the \fB\s-1CA\s0.pl\fR script.
  167. See \s-1\fBCA\s0.pl\fR\|(1).
  168. .IP "\fB\s-1OPENSSL_ENGINES\s0\fR" 4
  169. .IX Item "OPENSSL_ENGINES"
  170. Specifies the directory from which dynamic engines are loaded.
  171. See \fBopenssl\-engine\fR\|(1).
  172. .IP "\fB\s-1OPENSSL_MALLOC_FD\s0\fR, \fB\s-1OPENSSL_MALLOC_FAILURES\s0\fR" 4
  173. .IX Item "OPENSSL_MALLOC_FD, OPENSSL_MALLOC_FAILURES"
  174. If built with debugging, this allows memory allocation to fail.
  175. See \fBOPENSSL_malloc\fR\|(3).
  176. .IP "\fB\s-1OPENSSL_MODULES\s0\fR" 4
  177. .IX Item "OPENSSL_MODULES"
  178. Specifies the directory from which cryptographic providers are loaded.
  179. Equivalently, the generic \fB\-provider\-path\fR command-line option may be used.
  180. .IP "\fB\s-1OPENSSL_WIN32_UTF8\s0\fR" 4
  181. .IX Item "OPENSSL_WIN32_UTF8"
  182. If set, then \fBUI_OpenSSL\fR\|(3) returns \s-1UTF\-8\s0 encoded strings, rather than
  183. ones encoded in the current code page, and
  184. the \fBopenssl\fR\|(1) program also transcodes the command-line parameters
  185. from the current code page to \s-1UTF\-8.\s0
  186. This environment variable is only checked on Microsoft Windows platforms.
  187. .IP "\fB\s-1RANDFILE\s0\fR" 4
  188. .IX Item "RANDFILE"
  189. The state file for the random number generator.
  190. This should not be needed in normal use.
  191. See \fBRAND_load_file\fR\|(3).
  192. .IP "\fB\s-1SSL_CERT_DIR\s0\fR, \fB\s-1SSL_CERT_FILE\s0\fR" 4
  193. .IX Item "SSL_CERT_DIR, SSL_CERT_FILE"
  194. Specify the default directory or file containing \s-1CA\s0 certificates.
  195. See \fBSSL_CTX_load_verify_locations\fR\|(3).
  196. .IP "\fB\s-1TSGET\s0\fR" 4
  197. .IX Item "TSGET"
  198. Additional arguments for the \fBtsget\fR\|(1) command.
  199. .IP "\fBOPENSSL_ia32cap\fR, \fBOPENSSL_sparcv9cap\fR, \fBOPENSSL_ppccap\fR, \fBOPENSSL_armcap\fR, \fBOPENSSL_s390xcap\fR, \fBOPENSSL_riscvcap\fR" 4
  200. .IX Item "OPENSSL_ia32cap, OPENSSL_sparcv9cap, OPENSSL_ppccap, OPENSSL_armcap, OPENSSL_s390xcap, OPENSSL_riscvcap"
  201. OpenSSL supports a number of different algorithm implementations for
  202. various machines and, by default, it determines which to use based on the
  203. processor capabilities and run time feature enquiry. These environment
  204. variables can be used to exert more control over this selection process.
  205. See \fBOPENSSL_ia32cap\fR\|(3), \fBOPENSSL_s390xcap\fR\|(3).
  206. .IP "\fB\s-1NO_PROXY\s0\fR, \fB\s-1HTTPS_PROXY\s0\fR, \fB\s-1HTTP_PROXY\s0\fR" 4
  207. .IX Item "NO_PROXY, HTTPS_PROXY, HTTP_PROXY"
  208. Specify a proxy hostname.
  209. See \fBOSSL_HTTP_parse_url\fR\|(3).
  210. .IP "\fB\s-1QLOGDIR\s0\fR" 4
  211. .IX Item "QLOGDIR"
  212. Specifies a \s-1QUIC\s0 qlog output directory. See \fBopenssl\-qlog\fR\|(7).
  213. .IP "\fB\s-1OSSL_QFILTER\s0\fR" 4
  214. .IX Item "OSSL_QFILTER"
  215. Used to set a \s-1QUIC\s0 qlog filter specification. See \fBopenssl\-qlog\fR\|(7).
  216. .SH "COPYRIGHT"
  217. .IX Header "COPYRIGHT"
  218. Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved.
  219. .PP
  220. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  221. this file except in compliance with the License. You can obtain a copy
  222. in the file \s-1LICENSE\s0 in the source distribution or at
  223. <https://www.openssl.org/source/license.html>.