From: Neil Horman <nhorman@openssl.org>
Date: Mon, 26 Aug 2024 22:33:14 +0000 (-0400)
Subject: Add documentation for SSLKEYLOGFILE
X-Git-Tag: openssl-3.5.0-alpha1~997
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97d4b67ccaa0d700c23377faf668a47d37e568b5;p=thirdparty%2Fopenssl.git

Add documentation for SSLKEYLOGFILE

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Hugo Landau <hlandau@devever.net>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25297)
---

diff --git a/doc/man7/openssl-env.pod b/doc/man7/openssl-env.pod
index 2d80ae6e1b6..b10ced0876a 100644
--- a/doc/man7/openssl-env.pod
+++ b/doc/man7/openssl-env.pod
@@ -188,6 +188,14 @@ Specifies a QUIC qlog output directory. See L<openssl-qlog(7)>.
 
 Used to set a QUIC qlog filter specification. See L<openssl-qlog(7)>.
 
+=item B<SSLKEYLOGFILE>
+
+Used to produce the standard format output file for SSL key logging.  Optionally
+set this variable to a filename to log all secrets produced by SSL connections.
+Note, use of the environment variable is predicated on configuring OpenSSL at
+build time with the enable-sslkeylog feature.  The file format standard can be
+found at L<https://datatracker.ietf.org/doc/draft-ietf-tls-keylogfile/>
+
 =back
 
 =head1 COPYRIGHT