Debian Codegraph @

upstream/debian-unstable/man7/openssl-env.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-ENV 7SSL"
58 .TH OPENSSL-ENV 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-env \- OpenSSL environment variables
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 The OpenSSL libraries and commands use environment variables to override
68 compiled-in defaults for various aspects of their behaviour.
69 To avoid security risks, the environment is not consulted
70 for security-sensitive environment variables when the executable
71 is set-user-ID or set-group-ID.
72 .IP \fBCTLOG_FILE\fR 4
73 .IX Item "CTLOG_FILE"
74 Specifies the path to a certificate transparency log list.
75 See \fBCTLOG_STORE_new\fR\|(3).
76 .Sp
77 This variable is considered a security-sensitive environment variable.
78 .IP "\fBHOME\fR, \fBSYSTEMROOT\fR, \fBUSERPROFILE\fR" 4
79 .IX Item "HOME, SYSTEMROOT, USERPROFILE"
80 Path which \fBRAND_file_name\fR\|(3) uses as a directory for the random seed file
81 name when the \fBRANDFILE\fR environment variable is not set.
82 \&\fBHOME\fR is the only variable that is considered on Unix-like systems;
83 \&\fBUSERPROFILE\fR and \fBSYSTEMROOT\fR are used as fallbacks on Windows platforms.
84 .Sp
85 \&\fBHOME\fR variable is considered a security-sensitive environment variable.
86 .IP "\fBHTTPS_PROXY\fR, \fBHTTP_PROXY\fR, \fBNO_PROXY\fR, \fBhttps_proxy\fR, \fBhttp_proxy\fR, \fBno_proxy\fR" 4
87 .IX Item "HTTPS_PROXY, HTTP_PROXY, NO_PROXY, https_proxy, http_proxy, no_proxy"
88 Specify a proxy hostname.
89 See \fBOSSL_HTTP_parse_url\fR\|(3).
90 .Sp
91 These variables are considered security-sensitive environment variables.
92 .IP \fBLEGACY_GOST_PKCS12\fR 4
93 .IX Item "LEGACY_GOST_PKCS12"
94 Affects the way MAC is generated in PKCS#12 containers for GOST algorithms.
95 See \fBPKCS12_gen_mac\fR\|(3).
96 .Sp
97 This variable is considered a security-sensitive environment variable.
98 .IP \fBOPENSSL\fR 4
99 .IX Item "OPENSSL"
100 Specifies the path to the \fBopenssl\fR executable. Used by
101 the \fBrehash\fR script (see "Script Configuration" in \fBopenssl\-rehash\fR\|(1))
102 and by the \fBCA.pl\fR script (see "NOTES" in \fBCA.pl\fR\|(1)
103 .Sp
104 This variable is not considered security-sensitive.
105 .IP "\fBOPENSSL_CONF\fR, \fBOPENSSL_CONF_INCLUDE\fR" 4
106 .IX Item "OPENSSL_CONF, OPENSSL_CONF_INCLUDE"
107 Specifies the path to a configuration file and the directory for
108 included files.
109 See \fBconfig\fR\|(5).
110 .Sp
111 These variables are considered security-sensitive environment variables.
112 .IP \fBOPENSSL_CONFIG\fR 4
113 .IX Item "OPENSSL_CONFIG"
114 Specifies a configuration option and filename for the \fBreq\fR and \fBca\fR
115 commands invoked by the \fBCA.pl\fR script.
116 See \fBCA.pl\fR\|(1).
117 .Sp
118 This variable is not considered security-sensitive.
119 .IP \fBOPENSSL_DEBUG_DECC_INIT\fR 4
120 .IX Item "OPENSSL_DEBUG_DECC_INIT"
121 On VMS only: if this variable is set, enables verbose output of parsing
122 of \f(CW\*(C`DECC$*\*(C'\fR logical names, that contain C RTL features, during library
123 initialisation (\f(CW\*(C`LIB$INITIALIZE\*(C'\fR). If the value of the variable is more
124 than 1, outputs information about every processed feature.
125 .Sp
126 This variable is not considered security-sensitive.
127 .IP \fBOPENSSL_ENGINES\fR 4
128 .IX Item "OPENSSL_ENGINES"
129 Specifies the directory from which dynamic engines are loaded.
130 See \fBopenssl\-engine\fR\|(1).
131 .Sp
132 This variable is considered a security-sensitive environment variable.
133 .IP "\fBOPENSSL_MALLOC_FAILURES\fR, \fBOPENSSL_MALLOC_FD\fR, \fBOPENSSL_MALLOC_SEED\fR" 4
134 .IX Item "OPENSSL_MALLOC_FAILURES, OPENSSL_MALLOC_FD, OPENSSL_MALLOC_SEED"
135 If built with debugging, this allows memory allocation to fail.
136 See \fBOPENSSL_malloc\fR\|(3).
137 .Sp
138 These variables are not considered security-sensitive.
139 .IP \fBOPENSSL_MODULES\fR 4
140 .IX Item "OPENSSL_MODULES"
141 Specifies the directory from which cryptographic providers are loaded.
142 Equivalently, the generic \fB\-provider\-path\fR command-line option may be used.
143 .Sp
144 This variable is considered a security-sensitive environment variable.
145 .IP \fBOPENSSL_SEC_MEM\fR 4
146 .IX Item "OPENSSL_SEC_MEM"
147 Initializes the secure memory at the beginning of the application which makes
148 the secure memory calls not to fall back to regular memory calls. The value
149 indicates the \fBsize\fR parameter in bytes. The value can be expressed in
150 binary, octal, decimal and hexadecimal. For formatting see \fBstrtol\|(3)\fR.
151 For further restrictions see \fBCRYPTO_secure_malloc_init\fR\|(3).
152 .Sp
153 This variable is not considered security-sensitive.
154 .IP \fBOPENSSL_SEC_MEM_MINSIZE\fR 4
155 .IX Item "OPENSSL_SEC_MEM_MINSIZE"
156 An optional variable used with \fBOPENSSL_SEC_MEM\fR. The value indicates
157 \&\fBminsize\fR parameter in bytes. The same formatting applies as above.
158 Default is 0. For more info see \fBCRYPTO_secure_malloc_init\fR\|(3).
159 .Sp
160 This variable is not considered security-sensitive.
161 .IP \fBOPENSSL_TEST_LIBCTX\fR 4
162 .IX Item "OPENSSL_TEST_LIBCTX"
163 This test-only environment variable, that is recognised by the \fBopenssl\fR\|(1)
164 command, when is set to "1", leads to creation of a nondefault library context
165 by the command, for which the \fB\-config\fR option then takes effect.
166 .Sp
167 This variable is not considered security-sensitive.
168 .IP \fBOPENSSL_TRACE\fR 4
169 .IX Item "OPENSSL_TRACE"
170 By default the OpenSSL trace feature is disabled statically.
171 To enable it, OpenSSL must be built with tracing support,
172 which may be configured like this: \f(CW\*(C`./config enable\-trace\*(C'\fR
173 .Sp
174 Unless OpenSSL tracing support is generally disabled,
175 enable trace output of specific parts of OpenSSL libraries, by name.
176 This output usually makes sense only if you know OpenSSL internals well.
177 .Sp
178 The value of this environment variable is a comma-separated list of names,
179 with the following available:
180 .IP \fBOPENSSL_RUNNING_UNIT_TESTS\fR 4
181 .IX Item "OPENSSL_RUNNING_UNIT_TESTS"
182 This environment variable is used to flag the fact that unit tests are being run
183 (i.e. `make test`). It is used to detect when the OpenSSL should behave in a special
184 manner during unit tests (i.e. when unit tests are being run on fuzzing builds). It should
185 generally not be set by users.
186 .RS 4
187 .IP \fBALL\fR 4
188 .IX Item "ALL"
189 Traces everything.
190 .IP \fBBN_CTX\fR 4
191 .IX Item "BN_CTX"
192 Traces BIGNUM context operations.
193 .IP \fBCMP\fR 4
194 .IX Item "CMP"
195 Traces CMP client and server activity.
196 .IP \fBCONF\fR 4
197 .IX Item "CONF"
198 Show details about provider and engine configuration.
199 .IP \fBDECODER\fR 4
200 .IX Item "DECODER"
201 Traces decoder operations.
202 .IP \fBENCODER\fR 4
203 .IX Item "ENCODER"
204 Traces encoder operations.
205 .IP \fBENGINE_REF_COUNT\fR 4
206 .IX Item "ENGINE_REF_COUNT"
207 Reference counts in the ENGINE structure will be monitored with a line
208 of generated for each change.
209 .IP \fBENGINE_TABLE\fR 4
210 .IX Item "ENGINE_TABLE"
211 The function that is used by RSA, DSA (etc) code to select registered
212 ENGINEs, cache defaults and functional references (etc), will generate
213 debugging summaries.
214 .IP \fBHTTP\fR 4
215 .IX Item "HTTP"
216 Traces the HTTP client and server, such as messages being sent and received.
217 .IP \fBINIT\fR 4
218 .IX Item "INIT"
219 Traces OpenSSL library initialization and cleanup.
220 .IP \fBPKCS12_DECRYPT\fR 4
221 .IX Item "PKCS12_DECRYPT"
222 Traces PKCS#12 decryption.
223 .IP \fBPKCS12_KEYGEN\fR 4
224 .IX Item "PKCS12_KEYGEN"
225 Traces PKCS#12 key generation.
226 .IP \fBPKCS5V2\fR 4
227 .IX Item "PKCS5V2"
228 Traces PKCS#5 v2 key generation.
229 .IP \fBPROVIDER\fR 4
230 .IX Item "PROVIDER"
231 Traces various operations that are performed on OpenSSL providers during their
232 handling by the library (see \fBprovider\fR\|(7)), such as initialisation, tear down,
233 parameter and capability retrieval, self-test, and so on.
234 .IP \fBQUERY\fR 4
235 .IX Item "QUERY"
236 Traces operation related to addition, removal, and fetching of methods
237 in the so-called method store, that holds pointers to functions provided
238 by various providers.
239 .IP \fBREF_COUNT\fR 4
240 .IX Item "REF_COUNT"
241 Traces reference count changes in various structures,
242 including \f(CW\*(C`BIO\*(C'\fR, \f(CW\*(C`DH\*(C'\fR, \f(CW\*(C`DSA\*(C'\fR, \f(CW\*(C`EC_KEY\*(C'\fR, \f(CW\*(C`ECX_KEY\*(C'\fR,
243 \&\f(CW\*(C`EVP_PKEY\*(C'\fR, \f(CW\*(C`EVP_SKEY\*(C'\fR, \f(CW\*(C`RSA\*(C'\fR, \f(CW\*(C`SSL\*(C'\fR, \f(CW\*(C`SSL_CTX\*(C'\fR, \f(CW\*(C`SSL_SESSION\*(C'\fR,
244 \&\f(CW\*(C`X509_CRL\*(C'\fR, \f(CW\*(C`X509_STORE\*(C'\fR, \f(CW\*(C`X509\*(C'\fR, and some others.
245 .IP \fBSTORE\fR 4
246 .IX Item "STORE"
247 Traces STORE operations.
248 .IP \fBTLS\fR 4
249 .IX Item "TLS"
250 Traces the TLS/SSL protocol.
251 .IP \fBTLS_CIPHER\fR 4
252 .IX Item "TLS_CIPHER"
253 Traces the ciphers used by the TLS/SSL protocol.
254 .IP \fBTRACE\fR 4
255 .IX Item "TRACE"
256 Traces the OpenSSL trace API itself.
257 .IP \fBX509V3_POLICY\fR 4
258 .IX Item "X509V3_POLICY"
259 Generates the complete policy tree at various points during X.509 v3
260 policy evaluation.
261 .RE
262 .RS 4
263 .Sp
264 This variable is not considered security-sensitive.
265 .RE
266 .IP \fBOPENSSL_WIN32_UTF8\fR 4
267 .IX Item "OPENSSL_WIN32_UTF8"
268 If set, then \fBUI_OpenSSL\fR\|(3) returns UTF\-8 encoded strings, rather than
269 ones encoded in the current code page, and
270 the \fBopenssl\fR\|(1) program also transcodes the command-line parameters
271 from the current code page to UTF\-8.
272 This environment variable is only checked on Microsoft Windows platforms.
273 .IP "\fBOPENSSL_armcap\fR, \fBOPENSSL_ia32cap\fR, \fBOPENSSL_ppccap\fR, \fBOPENSSL_riscvcap\fR, \fBOPENSSL_s390xcap\fR, \fBOPENSSL_sparcv9cap\fR" 4
274 .IX Item "OPENSSL_armcap, OPENSSL_ia32cap, OPENSSL_ppccap, OPENSSL_riscvcap, OPENSSL_s390xcap, OPENSSL_sparcv9cap"
275 OpenSSL supports a number of different algorithm implementations for
276 various machines and, by default, it determines which to use based on the
277 processor capabilities and run time feature enquiry. These environment
278 variables can be used to exert more control over this selection process.
279 See \fBOPENSSL_ia32cap\fR\|(3), \fBOPENSSL_ppccap\fR\|(3), \fBOPENSSL_riscvcap\fR\|(3),
280 and \fBOPENSSL_s390xcap\fR\|(3).
281 .Sp
282 These variables are not considered security-sensitive.
283 .IP \fBOSSL_QFILTER\fR 4
284 .IX Item "OSSL_QFILTER"
285 Used to set a QUIC qlog filter specification. See \fBopenssl\-qlog\fR\|(7).
286 .Sp
287 This variable is considered a security-sensitive environment variable.
288 .IP \fBQLOGDIR\fR 4
289 .IX Item "QLOGDIR"
290 Specifies a QUIC qlog output directory. See \fBopenssl\-qlog\fR\|(7).
291 .Sp
292 This variable is considered a security-sensitive environment variable.
293 .IP \fBRANDFILE\fR 4
294 .IX Item "RANDFILE"
295 The state file for the random number generator.
296 This should not be needed in normal use.
297 See \fBRAND_load_file\fR\|(3).
298 .Sp
299 This variable is considered a security-sensitive environment variable.
300 .IP \fBSSLKEYLOGFILE\fR 4
301 .IX Item "SSLKEYLOGFILE"
302 Used to produce the standard format output file for SSL key logging. Optionally
303 set this variable to a filename to log all secrets produced by SSL connections.
304 Note, use of the environment variable is predicated on configuring OpenSSL at
305 build time with the enable-sslkeylog feature. The file format standard can be
306 found at <https://datatracker.ietf.org/doc/draft\-ietf\-tls\-keylogfile/>.
307 Note: the use of \fBSSLKEYLOGFILE\fR poses an explicit security risk. By recording
308 the exchanged keys during an SSL session, it allows any available party with
309 read access to the file to decrypt application traffic sent over that session.
310 Use of this feature should be restricted to test and debug environments only.
311 .Sp
312 This variable is considered a security-sensitive environment variable.
313 .IP "\fBSSL_CERT_DIR\fR, \fBSSL_CERT_FILE\fR" 4
314 .IX Item "SSL_CERT_DIR, SSL_CERT_FILE"
315 Specify the default directory or file containing CA certificates.
316 See \fBSSL_CTX_load_verify_locations\fR\|(3).
317 .Sp
318 These variables are considered security-sensitive environment variables,
319 except in \fBopenssl\-rehash\fR\|(1), where \fBSSL_CERT_DIR\fR is not considered
320 security-sensitive.
321 .IP \fBSSL_CIPHER\fR 4
322 .IX Item "SSL_CIPHER"
323 Used by \fBopenssl\-s_time\fR\|(1) in case \fB\-cipher\fR option (that allows modifying
324 TLSv1.2 and below cipher list sent by the client) is not provided,
325 for specification of the aforementioned ciphers.
326 .Sp
327 This variable is not considered security-sensitive.
328 .IP \fBTSGET\fR 4
329 .IX Item "TSGET"
330 Additional arguments for the \fBtsget\fR\|(1) command.
331 .Sp
332 This variable is not considered security-sensitive.
333 .SH HISTORY
334 .IX Header "HISTORY"
335 This section contains environment variables that are no longer considered
336 by the OpenSSL libraries and commands.
337 .IP \fBHARNESS_OSSL_PREFIX\fR 4
338 .IX Item "HARNESS_OSSL_PREFIX"
339 This environment variable, existed in OpenSSL versions from 1.1.1 up to 3.5,
340 allowed specification of a prefix prepended to each line sent to the \fIstdout\fR
341 by \fBopenssl\fR\|(1), used by the test harness to avoid commingling the command
342 under test output with the output for the TAP consumer.
343 .Sp
344 This variable was not considered security-sensitive.
345 .SH COPYRIGHT
346 .IX Header "COPYRIGHT"
347 Copyright 2019\-2026 The OpenSSL Project Authors. All Rights Reserved.
348 .PP
349 Licensed under the Apache License 2.0 (the "License"). You may not use
350 this file except in compliance with the License. You can obtain a copy
351 in the file LICENSE in the source distribution or at
352 <https://www.openssl.org/source/license.html>.