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