Debian Codegraph @

upstream/debian-unstable/man3/OSSL_ITEM.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_ITEM 3SSL"
58 .TH OSSL_ITEM 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_ITEM \- OpenSSL Core type for generic itemized data
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/core.h>
69 \&
70 \& typedef struct ossl_item_st OSSL_ITEM;
71 \& struct ossl_item_st {
72 \& unsigned int id;
73 \& void *ptr;
74 \& };
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This type is a tuple of integer and pointer.
79 It's a generic type used as a generic descriptor, its exact meaning
80 being defined by how it's used.
81 Arrays of this type are passed between the OpenSSL libraries and the
82 providers, and must be terminated with a tuple where the integer is
83 zero and the pointer NULL.
84 .PP
85 This is currently mainly used for the return value of the provider's error
86 reason strings array, see "Provider Functions" in \fBprovider\-base\fR\|(7).
87 .SH "SEE ALSO"
88 .IX Header "SEE ALSO"
89 \&\fBcrypto\fR\|(7), \fBprovider\-base\fR\|(7), \fBopenssl\-core.h\fR\|(7)
90 .SH HISTORY
91 .IX Header "HISTORY"
92 \&\fBOSSL_ITEM\fR was added in OpenSSL 3.0
93 .SH COPYRIGHT
94 .IX Header "COPYRIGHT"
95 Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
96 .PP
97 Licensed under the Apache License 2.0 (the "License"). You may not use
98 this file except in compliance with the License. You can obtain a copy
99 in the file LICENSE in the source distribution or at
100 <https://www.openssl.org/source/license.html>.