Lines Matching +full:4 +full:- +full:data
1 .\" -*- mode: troff; coding: utf-8 -*-
58 .TH OSSL_PARAM 3ossl 2025-09-30 3.5.4 OpenSSL
64 OSSL_PARAM \- a structure to pass or request object parameters
73 \& unsigned int data_type; /* declare what kind of content is in data */
74 \& void *data; /* value being passed in or out */
75 \& size_t data_size; /* data size */
81 \&\fBOSSL_PARAM\fR is a type that allows passing arbitrary data for some
90 .IP \(bu 4
95 take the data from the \fBOSSL_PARAM\fR array and assign them in a
97 .IP \(bu 4
102 about the object, which can take the internal data of the object and
104 \&\fIrequester\fR and pointed at with the \fBOSSL_PARAM\fR \fIdata\fR.
105 .IP \(bu 4
109 available parameters and some of their properties; name, data type and
110 expected data size.
137 .IP \fIkey\fR 4
143 .IP \fIdata_type\fR 4
146 the data.
148 .IP \fIdata\fR 4
149 .IX Item "data"
151 .IP \fIdata_size\fR 4
154 \&\fIdata\fR is a pointer to the memory where the parameter data is (when
157 The organization of the data depends on the parameter type and flag.
166 When \fIrequesting parameters\fR, it's acceptable for \fIdata\fR to be NULL.
168 how much buffer space is needed to store the parameter data.
171 When the \fBOSSL_PARAM\fR is used as a parameter descriptor, \fIdata\fR
173 If \fIdata_size\fR is zero, it means that an arbitrary data size is
175 .IP \fIreturn_size\fR 4
177 When an array of \fBOSSL_PARAM\fR is used to request data, the
179 data, including padding as the case may be.
180 In case the \fIdata_size\fR is an unsuitable size for the data, the
181 \&\fIresponder\fR must still set this field to indicate the minimum data
194 except for the pointer form of strings (see data type descriptions
203 .IP \fBOSSL_PARAM_INTEGER\fR 4
206 .IP \fBOSSL_PARAM_UNSIGNED_INTEGER\fR 4
209 The parameter data is an integer (signed or unsigned) of arbitrary
211 Big-Endian systems, and least significant byte first on Little-Endian
213 .IP \fBOSSL_PARAM_REAL\fR 4
215 The parameter data is a floating point value in native form.
216 .IP \fBOSSL_PARAM_UTF8_STRING\fR 4
218 The parameter data is a printable string.
219 .IP \fBOSSL_PARAM_OCTET_STRING\fR 4
221 The parameter data is an arbitrary string of bytes.
222 .IP \fBOSSL_PARAM_UTF8_PTR\fR 4
224 The parameter data is a pointer to a printable string.
226 The difference between this and \fBOSSL_PARAM_UTF8_STRING\fR is that \fIdata\fR
227 doesn't point directly at the data, but to a pointer that points to the data.
232 This is used to indicate that constant data is or will be passed,
233 and there is therefore no need to copy the data that is passed, just
236 \&\fIdata_size\fR must be set to the size of the data, not the size of the
237 pointer to the data.
240 \&\fIreturn_size\fR to the size of the data.
243 used for data that remains constant and in a constant location for a
244 long enough duration (such as the life-time of the entity that
246 .IP \fBOSSL_PARAM_OCTET_PTR\fR 4
248 The parameter data is a pointer to an arbitrary string of bytes.
251 \&\fIdata\fR doesn't point directly at the data, but to a pointer that
252 points to the data.
257 This is used to indicate that constant data is or will be passed, and
258 there is therefore no need to copy the data that is passed, just the
261 \&\fIdata_size\fR must be set to the size of the data, not the size of the
262 pointer to the data.
265 \&\fIreturn_size\fR to the size of the data.
268 used for data that remains constant and in a constant location for a
269 long enough duration (such as the life-time of the entity that
276 .IP \(bu 4
280 .IP \(bu 4
282 enough set of data, that call should succeed.
283 .IP \(bu 4
288 .IP \(bu 4
289 If the data type for a key that it's associated with is incorrect,
292 The called function may also try to convert the data to a suitable
297 .IP \(bu 4
298 If \fIdata\fR for a \fBOSSL_PARAM_OCTET_STRING\fR or a
302 with \fIdata\fR pointing at the place for the value to be put.
303 .IP \(bu 4
304 If a \fIresponder\fR finds that some data sizes are too small for the
305 requested data, it must set \fIreturn_size\fR for each such
308 .IP \(bu 4
334 \& { "bar", OSSL_PARAM_UTF8_STRING, (void *)&bar, sizeof(bar) \- 1, 0 },
366 \& *(char **)params[i].data = "foo value";
369 \& memcpy(params[i].data, "bar value", 10);
377 \&\fBopenssl\-core.h\fR\|(7), \fBOSSL_PARAM_get_int\fR\|(3), \fBOSSL_PARAM_dup\fR\|(3), \fBOSSL_PAR…
383 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.