| 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.5.6 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 use environment variables to override the |
| 68 |
compiled-in default paths for various data. |
| 69 |
To avoid security risks, the environment is usually not consulted when |
| 70 |
the executable is set-user-ID or set-group-ID. |
| 71 |
.IP \fBCTLOG_FILE\fR 4 |
| 72 |
.IX Item "CTLOG_FILE" |
| 73 |
Specifies the path to a certificate transparency log list. |
| 74 |
See \fBCTLOG_STORE_new\fR\|(3). |
| 75 |
.IP \fBOPENSSL\fR 4 |
| 76 |
.IX Item "OPENSSL" |
| 77 |
Specifies the path to the \fBopenssl\fR executable. Used by |
| 78 |
the \fBrehash\fR script (see "Script Configuration" in \fBopenssl\-rehash\fR\|(1)) |
| 79 |
and by the \fBCA.pl\fR script (see "NOTES" in \fBCA.pl\fR\|(1) |
| 80 |
.IP "\fBOPENSSL_CONF\fR, \fBOPENSSL_CONF_INCLUDE\fR" 4 |
| 81 |
.IX Item "OPENSSL_CONF, OPENSSL_CONF_INCLUDE" |
| 82 |
Specifies the path to a configuration file and the directory for |
| 83 |
included files. |
| 84 |
See \fBconfig\fR\|(5). |
| 85 |
.IP \fBOPENSSL_CONFIG\fR 4 |
| 86 |
.IX Item "OPENSSL_CONFIG" |
| 87 |
Specifies a configuration option and filename for the \fBreq\fR and \fBca\fR |
| 88 |
commands invoked by the \fBCA.pl\fR script. |
| 89 |
See \fBCA.pl\fR\|(1). |
| 90 |
.IP \fBOPENSSL_ENGINES\fR 4 |
| 91 |
.IX Item "OPENSSL_ENGINES" |
| 92 |
Specifies the directory from which dynamic engines are loaded. |
| 93 |
See \fBopenssl\-engine\fR\|(1). |
| 94 |
.IP "\fBOPENSSL_MALLOC_FD\fR, \fBOPENSSL_MALLOC_FAILURES\fR" 4 |
| 95 |
.IX Item "OPENSSL_MALLOC_FD, OPENSSL_MALLOC_FAILURES" |
| 96 |
If built with debugging, this allows memory allocation to fail. |
| 97 |
See \fBOPENSSL_malloc\fR\|(3). |
| 98 |
.IP \fBOPENSSL_MODULES\fR 4 |
| 99 |
.IX Item "OPENSSL_MODULES" |
| 100 |
Specifies the directory from which cryptographic providers are loaded. |
| 101 |
Equivalently, the generic \fB\-provider\-path\fR command-line option may be used. |
| 102 |
.IP \fBOPENSSL_TRACE\fR 4 |
| 103 |
.IX Item "OPENSSL_TRACE" |
| 104 |
By default the OpenSSL trace feature is disabled statically. |
| 105 |
To enable it, OpenSSL must be built with tracing support, |
| 106 |
which may be configured like this: \f(CW\*(C`./config enable\-trace\*(C'\fR |
| 107 |
.Sp |
| 108 |
Unless OpenSSL tracing support is generally disabled, |
| 109 |
enable trace output of specific parts of OpenSSL libraries, by name. |
| 110 |
This output usually makes sense only if you know OpenSSL internals well. |
| 111 |
.Sp |
| 112 |
The value of this environment variable is a comma-separated list of names, |
| 113 |
with the following available: |
| 114 |
.IP \fBOPENSSL_RUNNING_UNIT_TESTS\fR 4 |
| 115 |
.IX Item "OPENSSL_RUNNING_UNIT_TESTS" |
| 116 |
This environment variable is used to flag the fact that unit tests are being run |
| 117 |
(i.e. `make test`). It is used to detect when the OpenSSL should behave in a special |
| 118 |
manner during unit tests (i.e. when unit tests are being run on fuzzing builds). It should |
| 119 |
generally not be set by users. |
| 120 |
.RS 4 |
| 121 |
.IP \fBTRACE\fR 4 |
| 122 |
.IX Item "TRACE" |
| 123 |
Traces the OpenSSL trace API itself. |
| 124 |
.IP \fBINIT\fR 4 |
| 125 |
.IX Item "INIT" |
| 126 |
Traces OpenSSL library initialization and cleanup. |
| 127 |
.IP \fBTLS\fR 4 |
| 128 |
.IX Item "TLS" |
| 129 |
Traces the TLS/SSL protocol. |
| 130 |
.IP \fBTLS_CIPHER\fR 4 |
| 131 |
.IX Item "TLS_CIPHER" |
| 132 |
Traces the ciphers used by the TLS/SSL protocol. |
| 133 |
.IP \fBCONF\fR 4 |
| 134 |
.IX Item "CONF" |
| 135 |
Show details about provider and engine configuration. |
| 136 |
.IP \fBENGINE_TABLE\fR 4 |
| 137 |
.IX Item "ENGINE_TABLE" |
| 138 |
The function that is used by RSA, DSA (etc) code to select registered |
| 139 |
ENGINEs, cache defaults and functional references (etc), will generate |
| 140 |
debugging summaries. |
| 141 |
.IP \fBENGINE_REF_COUNT\fR 4 |
| 142 |
.IX Item "ENGINE_REF_COUNT" |
| 143 |
Reference counts in the ENGINE structure will be monitored with a line |
| 144 |
of generated for each change. |
| 145 |
.IP \fBPKCS5V2\fR 4 |
| 146 |
.IX Item "PKCS5V2" |
| 147 |
Traces PKCS#5 v2 key generation. |
| 148 |
.IP \fBPKCS12_KEYGEN\fR 4 |
| 149 |
.IX Item "PKCS12_KEYGEN" |
| 150 |
Traces PKCS#12 key generation. |
| 151 |
.IP \fBPKCS12_DECRYPT\fR 4 |
| 152 |
.IX Item "PKCS12_DECRYPT" |
| 153 |
Traces PKCS#12 decryption. |
| 154 |
.IP \fBX509V3_POLICY\fR 4 |
| 155 |
.IX Item "X509V3_POLICY" |
| 156 |
Generates the complete policy tree at various points during X.509 v3 |
| 157 |
policy evaluation. |
| 158 |
.IP \fBBN_CTX\fR 4 |
| 159 |
.IX Item "BN_CTX" |
| 160 |
Traces BIGNUM context operations. |
| 161 |
.IP \fBCMP\fR 4 |
| 162 |
.IX Item "CMP" |
| 163 |
Traces CMP client and server activity. |
| 164 |
.IP \fBSTORE\fR 4 |
| 165 |
.IX Item "STORE" |
| 166 |
Traces STORE operations. |
| 167 |
.IP \fBDECODER\fR 4 |
| 168 |
.IX Item "DECODER" |
| 169 |
Traces decoder operations. |
| 170 |
.IP \fBENCODER\fR 4 |
| 171 |
.IX Item "ENCODER" |
| 172 |
Traces encoder operations. |
| 173 |
.IP \fBREF_COUNT\fR 4 |
| 174 |
.IX Item "REF_COUNT" |
| 175 |
Traces decrementing certain ASN.1 structure references. |
| 176 |
.IP \fBHTTP\fR 4 |
| 177 |
.IX Item "HTTP" |
| 178 |
Traces the HTTP client and server, such as messages being sent and received. |
| 179 |
.RE |
| 180 |
.RS 4 |
| 181 |
.RE |
| 182 |
.IP \fBOPENSSL_WIN32_UTF8\fR 4 |
| 183 |
.IX Item "OPENSSL_WIN32_UTF8" |
| 184 |
If set, then \fBUI_OpenSSL\fR\|(3) returns UTF\-8 encoded strings, rather than |
| 185 |
ones encoded in the current code page, and |
| 186 |
the \fBopenssl\fR\|(1) program also transcodes the command-line parameters |
| 187 |
from the current code page to UTF\-8. |
| 188 |
This environment variable is only checked on Microsoft Windows platforms. |
| 189 |
.IP \fBRANDFILE\fR 4 |
| 190 |
.IX Item "RANDFILE" |
| 191 |
The state file for the random number generator. |
| 192 |
This should not be needed in normal use. |
| 193 |
See \fBRAND_load_file\fR\|(3). |
| 194 |
.IP "\fBSSL_CERT_DIR\fR, \fBSSL_CERT_FILE\fR" 4 |
| 195 |
.IX Item "SSL_CERT_DIR, SSL_CERT_FILE" |
| 196 |
Specify the default directory or file containing CA certificates. |
| 197 |
See \fBSSL_CTX_load_verify_locations\fR\|(3). |
| 198 |
.IP \fBTSGET\fR 4 |
| 199 |
.IX Item "TSGET" |
| 200 |
Additional arguments for the \fBtsget\fR\|(1) command. |
| 201 |
.IP "\fBOPENSSL_ia32cap\fR, \fBOPENSSL_sparcv9cap\fR, \fBOPENSSL_ppccap\fR, \fBOPENSSL_armcap\fR, \fBOPENSSL_s390xcap\fR, \fBOPENSSL_riscvcap\fR" 4 |
| 202 |
.IX Item "OPENSSL_ia32cap, OPENSSL_sparcv9cap, OPENSSL_ppccap, OPENSSL_armcap, OPENSSL_s390xcap, OPENSSL_riscvcap" |
| 203 |
OpenSSL supports a number of different algorithm implementations for |
| 204 |
various machines and, by default, it determines which to use based on the |
| 205 |
processor capabilities and run time feature enquiry. These environment |
| 206 |
variables can be used to exert more control over this selection process. |
| 207 |
See \fBOPENSSL_ia32cap\fR\|(3), \fBOPENSSL_ppccap\fR\|(3), \fBOPENSSL_riscvcap\fR\|(3), |
| 208 |
and \fBOPENSSL_s390xcap\fR\|(3). |
| 209 |
.IP "\fBNO_PROXY\fR, \fBHTTPS_PROXY\fR, \fBHTTP_PROXY\fR" 4 |
| 210 |
.IX Item "NO_PROXY, HTTPS_PROXY, HTTP_PROXY" |
| 211 |
Specify a proxy hostname. |
| 212 |
See \fBOSSL_HTTP_parse_url\fR\|(3). |
| 213 |
.IP \fBQLOGDIR\fR 4 |
| 214 |
.IX Item "QLOGDIR" |
| 215 |
Specifies a QUIC qlog output directory. See \fBopenssl\-qlog\fR\|(7). |
| 216 |
.IP \fBOSSL_QFILTER\fR 4 |
| 217 |
.IX Item "OSSL_QFILTER" |
| 218 |
Used to set a QUIC qlog filter specification. See \fBopenssl\-qlog\fR\|(7). |
| 219 |
.IP \fBSSLKEYLOGFILE\fR 4 |
| 220 |
.IX Item "SSLKEYLOGFILE" |
| 221 |
Used to produce the standard format output file for SSL key logging. Optionally |
| 222 |
set this variable to a filename to log all secrets produced by SSL connections. |
| 223 |
Note, use of the environment variable is predicated on configuring OpenSSL at |
| 224 |
build time with the enable-sslkeylog feature. The file format standard can be |
| 225 |
found at <https://datatracker.ietf.org/doc/draft\-ietf\-tls\-keylogfile/>. |
| 226 |
Note: the use of \fBSSLKEYLOGFILE\fR poses an explicit security risk. By recording |
| 227 |
the exchanged keys during an SSL session, it allows any available party with |
| 228 |
read access to the file to decrypt application traffic sent over that session. |
| 229 |
Use of this feature should be restricted to test and debug environments only. |
| 230 |
.SH COPYRIGHT |
| 231 |
.IX Header "COPYRIGHT" |
| 232 |
Copyright 2019\-2026 The OpenSSL Project Authors. All Rights Reserved. |
| 233 |
.PP |
| 234 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 235 |
this file except in compliance with the License. You can obtain a copy |
| 236 |
in the file LICENSE in the source distribution or at |
| 237 |
<https://www.openssl.org/source/license.html>. |