mirror of
https://github.com/moparisthebest/curl
synced 2024-12-26 01:58:49 -05:00
6011a986ca
Create a set of routines for TLS key log file handling to enable reuse with other TLS backends. Simplify the OpenSSL backend as follows: - Drop the ENABLE_SSLKEYLOGFILE macro as it is unconditionally enabled. - Do not perform dynamic memory allocation when preparing a log entry. Unless the TLS specifications change we can suffice with a reasonable fixed-size buffer. - Simplify state tracking when SSL_CTX_set_keylog_callback is unavailable. My original sslkeylog.c code included this tracking in order to handle multiple calls to SSL_connect and detect new keys after renegotiation (via SSL_read/SSL_write). For curl however we can be sure that a single master secret eventually becomes available after SSL_connect, so a simple flag is sufficient. An alternative to the flag is examining SSL_state(), but this seems more complex and is not pursued. Capturing keys after server renegotiation was already unsupported in curl and remains unsupported. Tested with curl built against OpenSSL 0.9.8zh, 1.0.2u, and 1.1.1f (`SSLKEYLOGFILE=keys.txt curl -vkso /dev/null https://localhost:4433`) against an OpenSSL 1.1.1f server configured with: # Force non-TLSv1.3, use TLSv1.0 since 0.9.8 fails with 1.1 or 1.2 openssl s_server -www -tls1 # Likewise, but fail the server handshake. openssl s_server -www -tls1 -Verify 2 # TLS 1.3 test. No need to test the failing server handshake. openssl s_server -www -tls1_3 Verify that all secrets (1 for TLS 1.0, 4 for TLS 1.3) are correctly written using Wireshark. For the first and third case, expect four matches per connection (decrypted Server Finished, Client Finished, HTTP Request, HTTP Response). For the second case where the handshake fails, expect a decrypted Server Finished only. tshark -i lo -pf tcp -otls.keylog_file:keys.txt -Tfields \ -eframe.number -eframe.time -etcp.stream -e_ws.col.Info \ -dtls.port==4433,http -ohttp.desegment_body:FALSE \ -Y 'tls.handshake.verify_data or http' A single connection can easily be identified via the `tcp.stream` field.
57 lines
2.0 KiB
C
57 lines
2.0 KiB
C
#ifndef HEADER_CURL_KEYLOG_H
|
|
#define HEADER_CURL_KEYLOG_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.haxx.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
/*
|
|
* Opens the TLS key log file if requested by the user. The SSLKEYLOGFILE
|
|
* environment variable specifies the output file.
|
|
*/
|
|
void Curl_tls_keylog_open(void);
|
|
|
|
/*
|
|
* Closes the TLS key log file if not already.
|
|
*/
|
|
void Curl_tls_keylog_close(void);
|
|
|
|
/*
|
|
* Returns true if the user successfully enabled the TLS key log file.
|
|
*/
|
|
bool Curl_tls_keylog_enabled(void);
|
|
|
|
/*
|
|
* Appends a key log file entry.
|
|
* Returns true iff the key log file is open and a valid entry was provided.
|
|
*/
|
|
bool Curl_tls_keylog_write(const char *label,
|
|
const unsigned char client_random[32],
|
|
const unsigned char *secret, size_t secretlen);
|
|
|
|
/*
|
|
* Appends a line to the key log file, ensure it is terminated by a LF.
|
|
* Returns true iff the key log file is open and a valid line was provided.
|
|
*/
|
|
bool Curl_tls_keylog_write_line(const char *line);
|
|
|
|
#endif /* HEADER_CURL_KEYLOG_H */
|