diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 | 214 |
1 files changed, 75 insertions, 139 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 b/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 index 49e757ae36d0..c2ad7f031504 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_trace_set_channel.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,78 +52,18 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OSSL_TRACE_SET_CHANNEL 3ossl" -.TH OSSL_TRACE_SET_CHANNEL 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH OSSL_TRACE_SET_CHANNEL 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME OSSL_trace_set_channel, OSSL_trace_set_prefix, OSSL_trace_set_suffix, OSSL_trace_set_callback, OSSL_trace_cb \- Enabling trace output -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/trace.h> @@ -152,29 +76,34 @@ OSSL_trace_set_callback, OSSL_trace_cb \- Enabling trace output \& void OSSL_trace_set_suffix(int category, const char *suffix); \& void OSSL_trace_set_callback(int category, OSSL_trace_cb cb, void *data); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -If available (see \*(L"\s-1NOTES\*(R"\s0 below), the application can request +If available (see "Configure Tracing" below), the application can request internal trace output. This output comes in form of free text for humans to read. .PP The trace output is divided into categories which can be enabled individually. -Every category can be enabled individually by attaching a so called -\&\fItrace channel\fR to it, which in the simplest case is just a \s-1BIO\s0 object +Every category can be enabled individually by attaching a so-called +\&\fItrace channel\fR to it, which in the simplest case is just a BIO object to which the application can write the tracing output for this category. Alternatively, the application can provide a tracer callback in order to get more finegrained trace information. This callback will be wrapped -internally by a dedicated \s-1BIO\s0 object. +internally by a dedicated BIO object. .PP For the tracing code, both trace channel types are indistinguishable. These are called a \fIsimple trace channel\fR and a \fIcallback trace channel\fR, respectively. -.SS "Functions" +.PP +\&\fBOSSL_TRACE_ENABLED\fR\|(3) can be used to check whether tracing is currently +enabled for the given category. +Functions like \fBOSSL_TRACE1\fR\|(3) and macros like \fBOSSL_TRACE_BEGIN\fR\|(3) +can be used for producing free-text trace output. +.SS Functions .IX Subsection "Functions" \&\fBOSSL_trace_set_channel()\fR is used to enable the given trace \f(CW\*(C`category\*(C'\fR -by attaching the \fB\s-1BIO\s0\fR \fIbio\fR object as (simple) trace channel. -On success the ownership of the \s-1BIO\s0 is transferred to the channel, +by attaching the \fBBIO\fR \fIbio\fR object as (simple) trace channel. +On success the ownership of the BIO is transferred to the channel, so the caller must not free it directly. .PP \&\fBOSSL_trace_set_prefix()\fR and \fBOSSL_trace_set_suffix()\fR can be used to add @@ -190,7 +119,7 @@ tracing prefixes, consider setting a callback with \&\fIcategory\fR by giving it the tracer callback \fIcb\fR with the associated data \fIdata\fR, which will simply be passed through to \fIcb\fR whenever it's called. The callback function is internally wrapped by a -dedicated \s-1BIO\s0 object, the so called \fIcallback trace channel\fR. +dedicated BIO object, the so-called \fIcallback trace channel\fR. This should be used when it's desirable to do form the trace output to something suitable for application needs where a prefix and suffix line aren't enough. @@ -199,8 +128,8 @@ line aren't enough. exclusive, calling one of them will clear whatever was set by the previous call. .PP -Calling \fBOSSL_trace_set_channel()\fR with \s-1NULL\s0 for \fIchannel\fR or -\&\fBOSSL_trace_set_callback()\fR with \s-1NULL\s0 for \fIcb\fR disables tracing for +Calling \fBOSSL_trace_set_channel()\fR with NULL for \fIchannel\fR or +\&\fBOSSL_trace_set_callback()\fR with NULL for \fIcb\fR disables tracing for the given \fIcategory\fR. .SS "Trace callback" .IX Subsection "Trace callback" @@ -211,105 +140,108 @@ the \fIcategory\fR, a control number \fIcmd\fR, and the \fIdata\fR that was passed to \fBOSSL_trace_set_callback()\fR. .PP The possible control numbers are: -.IP "\fB\s-1OSSL_TRACE_CTRL_BEGIN\s0\fR" 4 +.IP \fBOSSL_TRACE_CTRL_BEGIN\fR 4 .IX Item "OSSL_TRACE_CTRL_BEGIN" The callback is called from \fBOSSL_trace_begin()\fR, which gives the callback the possibility to output a dynamic starting line, or set a prefix that should be output at the beginning of each line, or something other. -.IP "\fB\s-1OSSL_TRACE_CTRL_WRITE\s0\fR" 4 +.IP \fBOSSL_TRACE_CTRL_WRITE\fR 4 .IX Item "OSSL_TRACE_CTRL_WRITE" -This callback is called whenever data is written to the \s-1BIO\s0 by some -regular \s-1BIO\s0 output routine. -An arbitrary number of \fB\s-1OSSL_TRACE_CTRL_WRITE\s0\fR callbacks can occur -inside a group marked by a pair of \fB\s-1OSSL_TRACE_CTRL_BEGIN\s0\fR and -\&\fB\s-1OSSL_TRACE_CTRL_END\s0\fR calls, but never outside such a group. -.IP "\fB\s-1OSSL_TRACE_CTRL_END\s0\fR" 4 +This callback is called whenever data is written to the BIO by some +regular BIO output routine. +An arbitrary number of \fBOSSL_TRACE_CTRL_WRITE\fR callbacks can occur +inside a group marked by a pair of \fBOSSL_TRACE_CTRL_BEGIN\fR and +\&\fBOSSL_TRACE_CTRL_END\fR calls, but never outside such a group. +.IP \fBOSSL_TRACE_CTRL_END\fR 4 .IX Item "OSSL_TRACE_CTRL_END" The callback is called from \fBOSSL_trace_end()\fR, which gives the callback the possibility to output a dynamic ending line, or reset the line -prefix that was set with \fB\s-1OSSL_TRACE_CTRL_BEGIN\s0\fR, or something other. +prefix that was set with \fBOSSL_TRACE_CTRL_BEGIN\fR, or something other. .SS "Trace categories" .IX Subsection "Trace categories" The trace categories are simple numbers available through macros. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_TRACE\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_TRACE\fR 4 .IX Item "OSSL_TRACE_CATEGORY_TRACE" -Traces the OpenSSL trace \s-1API\s0 itself. +Traces the OpenSSL trace API itself. .Sp More precisely, this will generate trace output any time a new trace hook is set. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_INIT\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_INIT\fR 4 .IX Item "OSSL_TRACE_CATEGORY_INIT" Traces OpenSSL library initialization and cleanup. .Sp This needs special care, as OpenSSL will do automatic cleanup after -exit from \f(CW\*(C`main()\*(C'\fR, and any tracing output done during this cleanup +exit from \f(CWmain()\fR, and any tracing output done during this cleanup will be lost if the tracing channel or callback were cleaned away prematurely. A suggestion is to make such cleanup part of a function that's registered very early with \fBatexit\fR\|(3). -.IP "\fB\s-1OSSL_TRACE_CATEGORY_TLS\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_TLS\fR 4 .IX Item "OSSL_TRACE_CATEGORY_TLS" -Traces the \s-1TLS/SSL\s0 protocol. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_TLS_CIPHER\s0\fR" 4 +Traces the TLS/SSL protocol. +.IP \fBOSSL_TRACE_CATEGORY_TLS_CIPHER\fR 4 .IX Item "OSSL_TRACE_CATEGORY_TLS_CIPHER" -Traces the ciphers used by the \s-1TLS/SSL\s0 protocol. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_CONF\s0\fR" 4 +Traces the ciphers used by the TLS/SSL protocol. +.IP \fBOSSL_TRACE_CATEGORY_CONF\fR 4 .IX Item "OSSL_TRACE_CATEGORY_CONF" Traces details about the provider and engine configuration. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_ENGINE_TABLE\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_ENGINE_TABLE\fR 4 .IX Item "OSSL_TRACE_CATEGORY_ENGINE_TABLE" -Traces the \s-1ENGINE\s0 algorithm table selection. +Traces the ENGINE algorithm table selection. .Sp More precisely, functions like \fBENGINE_get_pkey_asn1_meth_engine()\fR, \&\fBENGINE_get_pkey_meth_engine()\fR, \fBENGINE_get_cipher_engine()\fR, \&\fBENGINE_get_digest_engine()\fR, will generate trace summaries of the handling of internal tables. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_ENGINE_REF_COUNT\fR 4 .IX Item "OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT" -Traces the \s-1ENGINE\s0 reference counting. +Traces the ENGINE reference counting. .Sp -More precisely, both reference counts in the \s-1ENGINE\s0 structure will be +More precisely, both reference counts in the ENGINE structure will be monitored with a line of trace output generated for each change. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_PKCS5V2\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_PKCS5V2\fR 4 .IX Item "OSSL_TRACE_CATEGORY_PKCS5V2" Traces PKCS#5 v2 key generation. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_PKCS12_KEYGEN\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_PKCS12_KEYGEN\fR 4 .IX Item "OSSL_TRACE_CATEGORY_PKCS12_KEYGEN" Traces PKCS#12 key generation. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_PKCS12_DECRYPT\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_PKCS12_DECRYPT\fR 4 .IX Item "OSSL_TRACE_CATEGORY_PKCS12_DECRYPT" Traces PKCS#12 decryption. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_X509V3_POLICY\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_X509V3_POLICY\fR 4 .IX Item "OSSL_TRACE_CATEGORY_X509V3_POLICY" Traces X509v3 policy processing. .Sp More precisely, this generates the complete policy tree at various point during evaluation. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_BN_CTX\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_BN_CTX\fR 4 .IX Item "OSSL_TRACE_CATEGORY_BN_CTX" -Traces \s-1BIGNUM\s0 context operations. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_CMP\s0\fR" 4 +Traces BIGNUM context operations. +.IP \fBOSSL_TRACE_CATEGORY_CMP\fR 4 .IX Item "OSSL_TRACE_CATEGORY_CMP" -Traces \s-1CMP\s0 client and server activity. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_STORE\s0\fR" 4 +Traces CMP client and server activity. +.IP \fBOSSL_TRACE_CATEGORY_STORE\fR 4 .IX Item "OSSL_TRACE_CATEGORY_STORE" -Traces \s-1STORE\s0 operations. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_DECODER\s0\fR" 4 +Traces STORE operations. +.IP \fBOSSL_TRACE_CATEGORY_DECODER\fR 4 .IX Item "OSSL_TRACE_CATEGORY_DECODER" Traces decoder operations. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_ENCODER\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_ENCODER\fR 4 .IX Item "OSSL_TRACE_CATEGORY_ENCODER" Traces encoder operations. -.IP "\fB\s-1OSSL_TRACE_CATEGORY_REF_COUNT\s0\fR" 4 +.IP \fBOSSL_TRACE_CATEGORY_REF_COUNT\fR 4 .IX Item "OSSL_TRACE_CATEGORY_REF_COUNT" -Traces decrementing certain \s-1ASN.1\s0 structure references. +Traces decrementing certain ASN.1 structure references. +.IP \fBOSSL_TRACE_CATEGORY_HTTP\fR 4 +.IX Item "OSSL_TRACE_CATEGORY_HTTP" +Traces the HTTP client, such as message headers being sent and received. .PP -There is also \fB\s-1OSSL_TRACE_CATEGORY_ALL\s0\fR, which works as a fallback +There is also \fBOSSL_TRACE_CATEGORY_ALL\fR, which works as a fallback and can be used to get \fIall\fR trace output. .PP Note, however, that in this case all trace output will effectively be -associated with the '\s-1ALL\s0' category, which is undesirable if the +associated with the 'ALL' category, which is undesirable if the application intends to include the category name in the trace output. In this case it is better to register separate channels for each trace category instead. @@ -318,7 +250,7 @@ trace category instead. \&\fBOSSL_trace_set_channel()\fR, \fBOSSL_trace_set_prefix()\fR, \&\fBOSSL_trace_set_suffix()\fR, and \fBOSSL_trace_set_callback()\fR return 1 on success, or 0 on failure. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" In all examples below, the trace producing code is assumed to be the following: @@ -409,7 +341,7 @@ The output is almost the same as for the simple example above. \& 0000 \- 00 01 02 03 04 05 06 07\-08 09 0a 0b 0c 0d 0e 0f ................ \& END TRACE[TLS]:7f9eb0193b80 .Ve -.SH "NOTES" +.SH NOTES .IX Header "NOTES" .SS "Configure Tracing" .IX Subsection "Configure Tracing" @@ -418,18 +350,22 @@ use the tracing functionality documented here, it is therefore necessary to configure and build OpenSSL with the 'enable\-trace' option. .PP When the library is built with tracing disabled, the macro -\&\fB\s-1OPENSSL_NO_TRACE\s0\fR is defined in \fI<openssl/opensslconf.h>\fR and all +\&\fBOPENSSL_NO_TRACE\fR is defined in \fI<openssl/opensslconf.h>\fR and all functions described here are inoperational, i.e. will do nothing. -.SH "HISTORY" +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBOSSL_TRACE_ENABLED\fR\|(3), \fBOSSL_TRACE_BEGIN\fR\|(3), \fBOSSL_TRACE1\fR\|(3), +\&\fBatexit\fR\|(3) +.SH HISTORY .IX Header "HISTORY" \&\fBOSSL_trace_set_channel()\fR, \fBOSSL_trace_set_prefix()\fR, \&\fBOSSL_trace_set_suffix()\fR, and \fBOSSL_trace_set_callback()\fR were all added in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |