doc/man3/OSSL_SELF_TEST_set_callback.pod

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