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

NAME

6       OSSL_DISPATCH - OpenSSL Core type to define a dispatchable function
7       table
8

SYNOPSIS

10        #include <openssl/core.h>
11
12        typedef struct ossl_dispatch_st OSSL_DISPATCH;
13        struct ossl_dispatch_st {
14            int function_id;
15            void (*function)(void);
16        };
17

DESCRIPTION

19       This type is a tuple of function identity and function pointer.  Arrays
20       of this type are passed between the OpenSSL libraries and the providers
21       to describe what functionality one side provides to the other.
22
23       Arrays of this type must be terminated with a tuple having function
24       identity zero and function pointer NULL.
25
26   OSSL_DISPATCH fields
27       function_id
28           OpenSSL defined function identity of the implemented function.
29
30       function
31           Pointer to the implemented function itself.  Despite the generic
32           definition of this field, the implemented function it points to
33           must have a function signature that corresponds to the function_id
34
35       Available function identities and corresponding function signatures are
36       defined in openssl-core_dispatch.h(7).  Furthermore, the chosen
37       function identities and associated function signature must be chosen
38       specifically for the operation that it's intended for, as determined by
39       the intended OSSL_ALGORITHM(3) array.
40
41       Any function identity not recognised by the recipient of this type will
42       be ignored.  This ensures that providers built with one OpenSSL version
43       in mind will work together with any other OpenSSL version that supports
44       this mechanism.
45

SEE ALSO

47       crypto(7), openssl-core_dispatch.h(7), OSSL_ALGORITHM(3)
48

HISTORY

50       OSSL_DISPATCH was 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_DISPATCH(3ossl)
Impressum