OSSL_CALLBACK.3ossl - Man Page

OpenSSL Core type to define callbacks


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


For certain events or activities, provider functionality may need help from the application or the calling OpenSSL libraries themselves.  For example, user input or direct (possibly optional) user output could be implemented this way.

Callback functions themselves are always provided by or through the calling OpenSSL libraries, along with a generic pointer to data arg.  As far as the function receiving the pointer to the function pointer and arg is concerned, the data that arg points at is opaque, and the pointer should simply be passed back to the callback function when it's called.


This is a generic callback function.  When calling this callback function, the caller is expected to build an OSSL_PARAM(3) array of data it wants or is expected to pass back, and pass that as params, as well as the opaque data pointer it received, as arg.


This is a specialised callback function, used specifically to prompt the user for a passphrase.  When calling this callback function, a buffer to store the pass phrase needs to be given with pass, and its size with pass_size.  The length of the prompted pass phrase will be given back in *pass_len.

Additional parameters can be passed with the OSSL_PARAM(3) array params,

See Also



The types described here were added in OpenSSL 3.0.

Referenced By

openssl-core.h.7ossl(7), OSSL_SELF_TEST_set_callback.3ossl(3).

The man page OSSL_PASSPHRASE_CALLBACK.3ossl(3) is an alias of OSSL_CALLBACK.3ossl(3).

2024-04-04 3.2.1 OpenSSL