diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-09 15:45:12 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-11-28 13:58:51 +0100 |
commit | 22bb8c254555036725aacb64c056bd8b3379fc4c (patch) | |
tree | 77dfa746455dbde247293d6515bfac5f942648e2 /doc/man7 | |
parent | b7f491cbd65116761da0565895069431b6cb8ef3 (diff) |
Document more env var stuff, fix some typo's
Add openssl-env.pod
Also fix up many other environment page formatting nits.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10135)
Diffstat (limited to 'doc/man7')
-rw-r--r-- | doc/man7/openssl-env.pod | 81 | ||||
-rw-r--r-- | doc/man7/passphrase-encoding.pod | 2 |
2 files changed, 82 insertions, 1 deletions
diff --git a/doc/man7/openssl-env.pod b/doc/man7/openssl-env.pod new file mode 100644 index 0000000000..afad2bdfd2 --- /dev/null +++ b/doc/man7/openssl-env.pod @@ -0,0 +1,81 @@ +=pod + +=head1 NAME + +openssl-env - OpenSSL environment variables + +=head1 DESCRIPTION + +The OpenSSL libraries use environment variables to override the +compiled-in default paths for various data. +To avoid security risks, the environment is usually not consulted when +the executable is set-user-ID or set-group-ID. + +=over 4 + +=item B<CTLOG_FILE> + +Specifies the path to a certificate transparency log list. +See L<CTLOG_STORE_new(3)>. + +=item B<OPENSSL> + +Specifies the path to the B<openssl> executable. Only used by +the B<rehash> script. +See L<openssl-rehash(1)/Script Configuration>. + +=item B<OPENSSL_CONF> + +Specfies the path to a configuration file. +See L<openssl(1)> and L<config(5)>. + +=item B<OPENSSL_ENGINES> + +Specifies the directory from which dynamic engines are loaded. +See L<openssl-engine(1)>. + +=item B<OPENSSL_MALLOC_FD>, B<OPENSSL_MALLOC_FAILURES> + +If built with debugging, this allows memory allocation to fail. +See L<OPENSSSL_malloc(3)>. + +=item B<OPENSSL_MODULES> + +Specifies the directory from which cryptographic providers are loaded. +See L<openssl-provider(1)>. + +=item B<OPENSSL_WIN32_UTF8> + +If set, then L<UI_OpenSSL(3)> returns UTF-8 encoded strings, rather than +ones encoded in the current code page, and +the L<openssl(1)> program also transcodes the command-line parameters +from the current code page to UTF-8. +This environment variable is only checked on Microsoft Windows platforms. + +=item B<RANDFILE> + +The state file for the random number generator. +This should not be needed in normal use. +See L<RAND_load_file(3)>. + +=item B<SSL_CERT_DIR>, B<SSL_CERT_FILE> + +Specify the default directory or file containing CA certificates. +See L<SSL_CTX_load_verify_locations(3)>. + +=item B<TSGET> + +Additional arguments for the L<tsget(1)> command. + +=back + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/doc/man7/passphrase-encoding.pod b/doc/man7/passphrase-encoding.pod index 7f2c2a2f80..4b4732faf2 100644 --- a/doc/man7/passphrase-encoding.pod +++ b/doc/man7/passphrase-encoding.pod @@ -116,7 +116,7 @@ encoded using UTF-8. This is default on most modern Unixes, but may involve an effort on other platforms. Specifically for Windows, setting the environment variable -C<OPENSSL_WIN32_UTF8> will have anything entered on [Windows] console prompt +B<OPENSSL_WIN32_UTF8> will have anything entered on [Windows] console prompt converted to UTF-8 (command line and separately prompted pass phrases alike). =head2 Opening existing objects |