Introduce the provider property
[openssl.git] / doc / man7 / openssl-env.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-env - OpenSSL environment variables
6
7 =head1 DESCRIPTION
8
9 The OpenSSL libraries use environment variables to override the
10 compiled-in default paths for various data.
11 To avoid security risks, the environment is usually not consulted when
12 the executable is set-user-ID or set-group-ID.
13
14 =over 4
15
16 =item B<CTLOG_FILE>
17
18 Specifies the path to a certificate transparency log list.
19 See L<CTLOG_STORE_new(3)>.
20
21 =item B<OPENSSL>
22
23 Specifies the path to the B<openssl> executable. Only used by
24 the B<rehash> script.
25 See L<openssl-rehash(1)/Script Configuration>.
26
27 =item B<OPENSSL_CONF>
28
29 Specifies the path to a configuration file.
30 See L<openssl(1)> and L<config(5)>.
31
32 =item B<OPENSSL_ENGINES>
33
34 Specifies the directory from which dynamic engines are loaded.
35 See L<openssl-engine(1)>.
36
37 =item B<OPENSSL_MALLOC_FD>, B<OPENSSL_MALLOC_FAILURES>
38
39 If built with debugging, this allows memory allocation to fail.
40 See L<OPENSSL_malloc(3)>.
41
42 =item B<OPENSSL_MODULES>
43
44 Specifies the directory from which cryptographic providers are loaded.
45 See L<openssl-provider(1)>.
46
47 =item B<OPENSSL_WIN32_UTF8>
48
49 If set, then L<UI_OpenSSL(3)> returns UTF-8 encoded strings, rather than
50 ones encoded in the current code page, and
51 the L<openssl(1)> program also transcodes the command-line parameters
52 from the current code page to UTF-8.
53 This environment variable is only checked on Microsoft Windows platforms.
54
55 =item B<RANDFILE>
56
57 The state file for the random number generator.
58 This should not be needed in normal use.
59 See L<RAND_load_file(3)>.
60
61 =item B<SSL_CERT_DIR>, B<SSL_CERT_FILE>
62
63 Specify the default directory or file containing CA certificates.
64 See L<SSL_CTX_load_verify_locations(3)>.
65
66 =item B<TSGET>
67
68 Additional arguments for the L<tsget(1)> command.
69
70 =back
71
72 =head1 COPYRIGHT
73
74 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
75
76 Licensed under the Apache License 2.0 (the "License").  You may not use
77 this file except in compliance with the License.  You can obtain a copy
78 in the file LICENSE in the source distribution or at
79 L<https://www.openssl.org/source/license.html>.
80
81 =cut