Debian Codegraph @

upstream/debian-unstable/man3/OSSL_SELF_TEST_set_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 "OSSL_SELF_TEST_SET_CALLBACK 3SSL"
58 .TH OSSL_SELF_TEST_SET_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 OSSL_SELF_TEST_set_callback,
65 OSSL_SELF_TEST_get_callback \- specify a callback for processing self tests
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/self_test.h>
70 \&
71 \& void OSSL_SELF_TEST_set_callback(OSSL_LIB_CTX *ctx, OSSL_CALLBACK *cb, void *cbarg);
72 \& void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX *ctx, OSSL_CALLBACK **cb, void **cbarg);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 Set or gets the optional application callback (and the callback argument) that
77 is called during self testing.
78 The application callback \fBOSSL_CALLBACK\fR\|(3) is associated with a \fBOSSL_LIB_CTX\fR.
79 The application callback function receives information about a running self test,
80 and may return a result to the calling self test.
81 See \fBopenssl\-core.h\fR\|(7) for further information on the callback.
82 .SH "RETURN VALUES"
83 .IX Header "RETURN VALUES"
84 \&\fBOSSL_SELF_TEST_get_callback()\fR returns the callback and callback argument that
85 has been set via \fBOSSL_SELF_TEST_set_callback()\fR for the given library context
86 \&\fIctx\fR.
87 These returned parameters will be NULL if \fBOSSL_SELF_TEST_set_callback()\fR has
88 not been called.
89 .SH "SEE ALSO"
90 .IX Header "SEE ALSO"
91 \&\fBopenssl\-core.h\fR\|(7),
92 \&\fBOSSL_PROVIDER\-FIPS\fR\|(7)
93 \&\fBOSSL_SELF_TEST_new\fR\|(3)
94 \&\fBOSSL_LIB_CTX\fR\|(3)
95 .SH HISTORY
96 .IX Header "HISTORY"
97 The functions described here were added in OpenSSL 3.0.
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.