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