xref: /freebsd/crypto/openssl/doc/man3/OSSL_SELF_TEST_set_callback.pod (revision 2008043f386721d58158e37e0d7e50df8095942d)
1=pod
2
3=head1 NAME
4
5OSSL_SELF_TEST_set_callback,
6OSSL_SELF_TEST_get_callback - specify a callback for processing self tests
7
8=head1 SYNOPSIS
9
10 #include <openssl/self_test.h>
11
12 void OSSL_SELF_TEST_set_callback(OSSL_LIB_CTX *ctx, OSSL_CALLBACK *cb, void *cbarg);
13 void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX *ctx, OSSL_CALLBACK **cb, void **cbarg);
14
15=head1 DESCRIPTION
16
17Set or gets the optional application callback (and the callback argument) that
18is called during self testing.
19The application callback L<OSSL_CALLBACK(3)> is associated with a B<OSSL_LIB_CTX>.
20The application callback function receives information about a running self test,
21and may return a result to the calling self test.
22See L<openssl-core.h(7)> for further information on the callback.
23
24=head1 RETURN VALUES
25
26OSSL_SELF_TEST_get_callback() returns the callback and callback argument that
27has been set via OSSL_SELF_TEST_set_callback() for the given library context
28I<ctx>.
29These returned parameters will be NULL if OSSL_SELF_TEST_set_callback() has
30not been called.
31
32=head1 SEE ALSO
33
34L<openssl-core.h(7)>,
35L<OSSL_PROVIDER-FIPS(7)>
36L<OSSL_SELF_TEST_new(3)>
37L<OSSL_LIB_CTX(3)>
38
39=head1 HISTORY
40
41The functions described here were added in OpenSSL 3.0.
42
43=head1 COPYRIGHT
44
45Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
46
47Licensed under the Apache License 2.0 (the "License").  You may not use
48this file except in compliance with the License.  You can obtain a copy
49in the file LICENSE in the source distribution or at
50L<https://www.openssl.org/source/license.html>.
51
52=cut
53