mirror of
https://github.com/curl/curl.git
synced 2026-04-24 08:32:12 +03:00
3058ed3df8
Backtrack on previous change that aimed to solve the wrong `share.h` being included. It turns out it did not fix this issue. At the same time it introduced relative header filenames and the need to include the same headers differently depending on the source files' location, reducing readability and editability. Replace this method by re-adding curl's lib source directory to the header path and addressing headers by the their full, relative name to that base directory. Aligning with this method already used in src and tests. With these advantages: - makes includes easier to read, recognize, grep, sort, write, and copy between sources, - syncs the way these headers are included across curl components, - avoids the ambiguity between system `schannel.h`, `rustls.h` vs. local headers using the same names in `lib/vtls`, - silences clang-tidy `readability-duplicate-include` checker, which detects the above issue, Ref: https://clang.llvm.org/extra/clang-tidy/checks/readability/duplicate-include.html - possibly silences TIOBE coding standard warnings: `6.10.2.a: Don't use relative paths in #include statements.` - long shot: it works well with concatenated test sources, for clang-tidy-friendly custom unity builds. Ref: #20667 Slight downside: it's not enforced. If there happens to be a collision between a local `lib/*.h` header and a system one, the solution is to rename (possibly with its `.c` counterpart) into the `curl_` namespace. This is also the method used by curl in the past. Also: - curlx/inet_pton: reduce scope of an include. - toolx/tool_time: apply this to an include, and update VS project files accordingly. Also dropping unnecessary lib/curlx header path. - clang-tidy: enable `readability-duplicate-include`. Follow-up to3887069c66#19676 Follow-up to625f2c1644#16991 #16949 Closes #20623
69 lines
2.3 KiB
C
69 lines
2.3 KiB
C
#ifndef HEADER_CURL_KEYLOG_H
|
|
#define HEADER_CURL_KEYLOG_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 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.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.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
#define KEYLOG_LABEL_MAXLEN (sizeof("CLIENT_HANDSHAKE_TRAFFIC_SECRET") - 1)
|
|
|
|
#define CLIENT_RANDOM_SIZE 32
|
|
|
|
/*
|
|
* The master secret in TLS 1.2 and before is always 48 bytes. In TLS 1.3, the
|
|
* secret size depends on the cipher suite's hash function which is 32 bytes
|
|
* for SHA-256 and 48 bytes for SHA-384.
|
|
*/
|
|
#define SECRET_MAXLEN 48
|
|
|
|
/*
|
|
* 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 an 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 */
|