Debian Codegraph @

upstream/debian-unstable/man3/OSSL_INDICATOR_set_callback.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_INDICATOR_SET_CALLBACK 3SSL"
58 .TH OSSL_INDICATOR_SET_CALLBACK 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_INDICATOR_set_callback,
65 OSSL_INDICATOR_get_callback \- specify a callback for FIPS indicators
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/indicator.h>
70 .Ve
71 .PP
72 typedef int (OSSL_INDICATOR_CALLBACK)(const char *type, const char *desc,
73 const OSSL_PARAM params[]);
74 .PP
75 .Vb 4
76 \& void OSSL_INDICATOR_set_callback(OSSL_LIB_CTX *libctx,
77 \& OSSL_INDICATOR_CALLBACK *cb);
78 \& void OSSL_INDICATOR_get_callback(OSSL_LIB_CTX *libctx,
79 \& OSSL_INDICATOR_CALLBACK **cb);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 \&\fBOSSL_INDICATOR_set_callback()\fR sets a user callback \fIcb\fR associated with a
84 \&\fIlibctx\fR that will be called when a non approved FIPS operation is detected.
85 .PP
86 The user's callback may be triggered multiple times during an algorithm operation
87 to indicate different approved mode checks have failed.
88 .PP
89 Non approved operations may only occur if the user has deliberately chosen to do
90 so (either by setting a global FIPS configuration option or via an option in an
91 algorithm's operation context).
92 .PP
93 The user's callback \fBOSSL_INDICATOR_CALLBACK\fR \fItype\fR and \fIdesc\fR
94 contain the algorithm type and operation that is not approved.
95 \&\fIparams\fR is not currently used.
96 .PP
97 If the user callback returns 0, an error will occur in the caller. This can be
98 used for testing purposes.
99 .SH "RETURN VALUES"
100 .IX Header "RETURN VALUES"
101 \&\fBOSSL_INDICATOR_get_callback()\fR returns the callback that has been set via
102 \&\fBOSSL_INDICATOR_set_callback()\fR for the given library context \fIlibctx\fR, or NULL
103 if no callback is currently set.
104 .SH EXAMPLES
105 .IX Header "EXAMPLES"
106 A simple indicator callback to log non approved FIPS operations
107 .PP
108 .Vb 9
109 \& static int indicator_cb(const char *type, const char *desc,
110 \& const OSSL_PARAM params[])
111 \& {
112 \& if (type != NULL && desc != NULL)
113 \& fprintf(stdout, "%s %s is not approved\en", type, desc);
114 \&end:
115 \& /* For Testing purposes you could return 0 here to cause an error */
116 \& return 1;
117 \& }
118 \&
119 \& OSSL_INDICATOR_set_callback(libctx, indicator_cb);
120 .Ve
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 \&\fBopenssl\-core.h\fR\|(7),
124 \&\fBOSSL_PROVIDER\-FIPS\fR\|(7)
125 \&\fBOSSL_LIB_CTX\fR\|(3)
126 .SH HISTORY
127 .IX Header "HISTORY"
128 The functions described here were added in OpenSSL 3.4.
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
132 .PP
133 Licensed under the Apache License 2.0 (the "License"). You may not use
134 this file except in compliance with the License. You can obtain a copy
135 in the file LICENSE in the source distribution or at
136 <https://www.openssl.org/source/license.html>.