1OSSL_CALLBACK(3ossl)                OpenSSL               OSSL_CALLBACK(3ossl)
2
3
4

NAME

6       OSSL_CALLBACK, OSSL_PASSPHRASE_CALLBACK - OpenSSL Core type to define
7       callbacks
8

SYNOPSIS

10        #include <openssl/core.h>
11        typedef int (OSSL_CALLBACK)(const OSSL_PARAM params[], void *arg);
12        typedef int (OSSL_PASSPHRASE_CALLBACK)(char *pass, size_t pass_size,
13                                               size_t *pass_len,
14                                               const OSSL_PARAM params[],
15                                               void *arg);
16

DESCRIPTION

18       For certain events or activities, provider functionality may need help
19       from the application or the calling OpenSSL libraries themselves.  For
20       example, user input or direct (possibly optional) user output could be
21       implemented this way.
22
23       Callback functions themselves are always provided by or through the
24       calling OpenSSL libraries, along with a generic pointer to data arg.
25       As far as the function receiving the pointer to the function pointer
26       and arg is concerned, the data that arg points at is opaque, and the
27       pointer should simply be passed back to the callback function when it's
28       called.
29
30       OSSL_CALLBACK
31           This is a generic callback function.  When calling this callback
32           function, the caller is expected to build an OSSL_PARAM(3) array of
33           data it wants or is expected to pass back, and pass that as params,
34           as well as the opaque data pointer it received, as arg.
35
36       OSSL_PASSPHRASE_CALLBACK
37           This is a specialised callback function, used specifically to
38           prompt the user for a passphrase.  When calling this callback
39           function, a buffer to store the pass phrase needs to be given with
40           pass, and its size with pass_size.  The length of the prompted pass
41           phrase will be given back in *pass_len.
42
43           Additional parameters can be passed with the OSSL_PARAM(3) array
44           params,
45

SEE ALSO

47       openssl-core.h(7)
48

HISTORY

50       The types described here were added in OpenSSL 3.0.
51

53       Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
54
55       Licensed under the Apache License 2.0 (the "License").  You may not use
56       this file except in compliance with the License.  You can obtain a copy
57       in the file LICENSE in the source distribution or at
58       <https://www.openssl.org/source/license.html>.
59
60
61
623.0.9                             2023-07-27              OSSL_CALLBACK(3ossl)
Impressum