xref: /aosp_15_r20/external/curl/lib/vtls/keylog.h (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker #ifndef HEADER_CURL_KEYLOG_H
2*6236dae4SAndroid Build Coastguard Worker #define HEADER_CURL_KEYLOG_H
3*6236dae4SAndroid Build Coastguard Worker /***************************************************************************
4*6236dae4SAndroid Build Coastguard Worker  *                                  _   _ ____  _
5*6236dae4SAndroid Build Coastguard Worker  *  Project                     ___| | | |  _ \| |
6*6236dae4SAndroid Build Coastguard Worker  *                             / __| | | | |_) | |
7*6236dae4SAndroid Build Coastguard Worker  *                            | (__| |_| |  _ <| |___
8*6236dae4SAndroid Build Coastguard Worker  *                             \___|\___/|_| \_\_____|
9*6236dae4SAndroid Build Coastguard Worker  *
10*6236dae4SAndroid Build Coastguard Worker  * Copyright (C) Daniel Stenberg, <[email protected]>, et al.
11*6236dae4SAndroid Build Coastguard Worker  *
12*6236dae4SAndroid Build Coastguard Worker  * This software is licensed as described in the file COPYING, which
13*6236dae4SAndroid Build Coastguard Worker  * you should have received as part of this distribution. The terms
14*6236dae4SAndroid Build Coastguard Worker  * are also available at https://curl.se/docs/copyright.html.
15*6236dae4SAndroid Build Coastguard Worker  *
16*6236dae4SAndroid Build Coastguard Worker  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17*6236dae4SAndroid Build Coastguard Worker  * copies of the Software, and permit persons to whom the Software is
18*6236dae4SAndroid Build Coastguard Worker  * furnished to do so, under the terms of the COPYING file.
19*6236dae4SAndroid Build Coastguard Worker  *
20*6236dae4SAndroid Build Coastguard Worker  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21*6236dae4SAndroid Build Coastguard Worker  * KIND, either express or implied.
22*6236dae4SAndroid Build Coastguard Worker  *
23*6236dae4SAndroid Build Coastguard Worker  * SPDX-License-Identifier: curl
24*6236dae4SAndroid Build Coastguard Worker  *
25*6236dae4SAndroid Build Coastguard Worker  ***************************************************************************/
26*6236dae4SAndroid Build Coastguard Worker #include "curl_setup.h"
27*6236dae4SAndroid Build Coastguard Worker 
28*6236dae4SAndroid Build Coastguard Worker /*
29*6236dae4SAndroid Build Coastguard Worker  * Opens the TLS key log file if requested by the user. The SSLKEYLOGFILE
30*6236dae4SAndroid Build Coastguard Worker  * environment variable specifies the output file.
31*6236dae4SAndroid Build Coastguard Worker  */
32*6236dae4SAndroid Build Coastguard Worker void Curl_tls_keylog_open(void);
33*6236dae4SAndroid Build Coastguard Worker 
34*6236dae4SAndroid Build Coastguard Worker /*
35*6236dae4SAndroid Build Coastguard Worker  * Closes the TLS key log file if not already.
36*6236dae4SAndroid Build Coastguard Worker  */
37*6236dae4SAndroid Build Coastguard Worker void Curl_tls_keylog_close(void);
38*6236dae4SAndroid Build Coastguard Worker 
39*6236dae4SAndroid Build Coastguard Worker /*
40*6236dae4SAndroid Build Coastguard Worker  * Returns true if the user successfully enabled the TLS key log file.
41*6236dae4SAndroid Build Coastguard Worker  */
42*6236dae4SAndroid Build Coastguard Worker bool Curl_tls_keylog_enabled(void);
43*6236dae4SAndroid Build Coastguard Worker 
44*6236dae4SAndroid Build Coastguard Worker /*
45*6236dae4SAndroid Build Coastguard Worker  * Appends a key log file entry.
46*6236dae4SAndroid Build Coastguard Worker  * Returns true iff the key log file is open and a valid entry was provided.
47*6236dae4SAndroid Build Coastguard Worker  */
48*6236dae4SAndroid Build Coastguard Worker bool Curl_tls_keylog_write(const char *label,
49*6236dae4SAndroid Build Coastguard Worker                            const unsigned char client_random[32],
50*6236dae4SAndroid Build Coastguard Worker                            const unsigned char *secret, size_t secretlen);
51*6236dae4SAndroid Build Coastguard Worker 
52*6236dae4SAndroid Build Coastguard Worker /*
53*6236dae4SAndroid Build Coastguard Worker  * Appends a line to the key log file, ensure it is terminated by a LF.
54*6236dae4SAndroid Build Coastguard Worker  * Returns true iff the key log file is open and a valid line was provided.
55*6236dae4SAndroid Build Coastguard Worker  */
56*6236dae4SAndroid Build Coastguard Worker bool Curl_tls_keylog_write_line(const char *line);
57*6236dae4SAndroid Build Coastguard Worker 
58*6236dae4SAndroid Build Coastguard Worker #endif /* HEADER_CURL_KEYLOG_H */
59