Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_keylog_callback.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_CTX_SET_KEYLOG_CALLBACK 3SSL"
58 .TH SSL_CTX_SET_KEYLOG_CALLBACK 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_CTX_set_keylog_callback, SSL_CTX_get_keylog_callback,
65 SSL_CTX_keylog_cb_func \- logging TLS key material
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& typedef void (*SSL_CTX_keylog_cb_func)(const SSL *ssl, const char *line);
72 \&
73 \& void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb);
74 \& SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBSSL_CTX_set_keylog_callback()\fR sets the TLS key logging callback. This callback
79 is called whenever TLS key material is generated or received, in order to allow
80 applications to store this keying material for debugging purposes.
81 .PP
82 \&\fBSSL_CTX_get_keylog_callback()\fR retrieves the previously set TLS key logging
83 callback. If no callback has been set, this will return NULL. When there is no
84 key logging callback, or if SSL_CTX_set_keylog_callback is called with NULL as
85 the value of cb, no logging of key material will be done.
86 .PP
87 The key logging callback is called with two items: the \fBssl\fR object associated
88 with the connection, and \fBline\fR, a string containing the key material in the
89 format used by NSS for its \fBSSLKEYLOGFILE\fR debugging output. To recreate that
90 file, the key logging callback should log \fBline\fR, followed by a newline.
91 \&\fBline\fR will always be a NUL-terminated string.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 \&\fBSSL_CTX_get_keylog_callback()\fR returns a pointer to \fBSSL_CTX_keylog_cb_func\fR or
95 NULL if the callback is not set.
96 .SH "SEE ALSO"
97 .IX Header "SEE ALSO"
98 \&\fBssl\fR\|(7)
99 .SH COPYRIGHT
100 .IX Header "COPYRIGHT"
101 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
102 .PP
103 Licensed under the Apache License 2.0 (the "License"). You may not use
104 this file except in compliance with the License. You can obtain a copy
105 in the file LICENSE in the source distribution or at
106 <https://www.openssl.org/source/license.html>.