OSSL_PARAM.pod - OpenGrok cross reference for /openssl/doc/man3/OSSL

Lines Matching refs:I
37 (the I<setter>) that has intimate knowledge about the object that can
43 The caller (the I<requester>) sets up the B<OSSL_PARAM> array and
44 calls some function (the I<responder>) that has intimate knowledge
47 I<requester> and pointed at with the B<OSSL_PARAM> I<data>.
58 build up its own B<OSSL_PARAM> array to pass down to a I<setter> or
59 I<responder>.
64 However, if the I<responder> can handle multiple elements with the
67 An B<OSSL_PARAM> array must have a terminating element, where I<key>
84 =item I<key>
91 =item I<data_type>
93 The I<data_type> is a value that describes the type and organization of
97 =item I<data>
99 =item I<data_size>
101 I<data> is a pointer to the memory where the parameter data is (when
103 and I<data_size> is its size in bytes.
106 The I<data_size> needs special attention with the parameter type
113 When I<requesting parameters>, it's acceptable for I<data> to be NULL.
114 This can be used by the I<requester> to figure out dynamically exactly
116 In this case, I<data_size> is ignored.
118 When the B<OSSL_PARAM> is used as a parameter descriptor, I<data>
120 If I<data_size> is zero, it means that an arbitrary data size is
123 =item I<return_size>
126 I<responder> must set this field to indicate size of the parameter
128 In case the I<data_size> is an unsuitable size for the data, the
129 I<responder> must still set this field to indicate the minimum data
134 I<return_size> should be ignored.
153 The I<data_type> field can be one of the following types:
182 The difference between this and B<OSSL_PARAM_UTF8_STRING> is that I<data>
192 I<data_size> must be set to the size of the data, not the size of the
195 I<data_size> is not relevant.  However, the I<responder> will set
196 I<return_size> to the size of the data.
208 I<data> doesn't point directly at the data, but to a pointer that
218 I<data_size> must be set to the size of the data, not the size of the
221 I<data_size> is not relevant.  However, the I<responder> will set
222 I<return_size> to the size of the data.
241 Keys that a I<setter> or I<responder> doesn't recognise should simply
247 If the keys that a called I<setter> recognises form a consistent
252 Apart from the I<return_size>, a I<responder> must never change the fields
255 I<data> points at.
270 If I<data> for a B<OSSL_PARAM_OCTET_STRING> or a
271 B<OSSL_PARAM_UTF8_STRING> is NULL, the I<responder> should
272 set I<return_size> to the size of the item to be returned
274 with I<data> pointing at the place for the value to be put.
278 If a I<responder> finds that some data sizes are too small for the
279 requested data, it must set I<return_size> for each such
286 B<OSSL_PARAM_INTEGER>), a I<responder> may choose to return an error
287 if the I<data_size> isn't a suitable size (even if I<data_size> is
288 bigger than needed).  If the I<responder> finds the size suitable, it
289 must fill all I<data_size> bytes and ensure correct padding for the
290 native endianness, and set I<return_size> to the same value as
291 I<data_size>.
339 A I<responder> that receives this array (as I<params> in this example)