Debian Codegraph @

upstream/debian-unstable/man3/OSSL_DISPATCH.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_DISPATCH 3SSL"
58 .TH OSSL_DISPATCH 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_DISPATCH, OSSL_DISPATCH_END \- OpenSSL Core type to define a dispatchable function table
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/core.h>
69 \&
70 \& typedef struct ossl_dispatch_st OSSL_DISPATCH;
71 \& struct ossl_dispatch_st {
72 \& int function_id;
73 \& void (*function)(void);
74 \& };
75 \&
76 \& #define OSSL_DISPATCH_END
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 This type is a tuple of function identity and function pointer.
81 Arrays of this type are passed between the OpenSSL libraries and the
82 providers to describe what functionality one side provides to the other.
83 .PP
84 Arrays of this type must be terminated with the OSSL_DISPATCH_END macro.
85 .SS "\fBOSSL_DISPATCH\fP fields"
86 .IX Subsection "OSSL_DISPATCH fields"
87 .IP \fIfunction_id\fR 4
88 .IX Item "function_id"
89 OpenSSL defined function identity of the implemented function.
90 .IP \fIfunction\fR 4
91 .IX Item "function"
92 Pointer to the implemented function itself. Despite the generic definition
93 of this field, the implemented function it points to must have a function
94 signature that corresponds to the \fIfunction_id\fR
95 .PP
96 Available function identities and corresponding function signatures are
97 defined in \fBopenssl\-core_dispatch.h\fR\|(7).
98 Furthermore, the chosen function identities and associated function
99 signature must be chosen specifically for the operation that it's intended
100 for, as determined by the intended \fBOSSL_ALGORITHM\fR\|(3) array.
101 .PP
102 Any function identity not recognised by the recipient of this type
103 will be ignored.
104 This ensures that providers built with one OpenSSL version in mind
105 will work together with any other OpenSSL version that supports this
106 mechanism.
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBcrypto\fR\|(7), \fBopenssl\-core_dispatch.h\fR\|(7), \fBOSSL_ALGORITHM\fR\|(3)
110 .SH HISTORY
111 .IX Header "HISTORY"
112 \&\fBOSSL_DISPATCH\fR was added in OpenSSL 3.0.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.