doc/man3/OSSL_PARAM_int.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_PARAM_double, OSSL_PARAM_int, OSSL_PARAM_int32, OSSL_PARAM_int64,
   6 OSSL_PARAM_long, OSSL_PARAM_size_t, OSSL_PARAM_uint, OSSL_PARAM_uint32,
   7 OSSL_PARAM_uint64, OSSL_PARAM_ulong, OSSL_PARAM_BN, OSSL_PARAM_utf8_string,
   8 OSSL_PARAM_octet_string, OSSL_PARAM_utf8_ptr, OSSL_PARAM_octet_ptr,
   9 OSSL_PARAM_END,
  10 OSSL_PARAM_construct_double, OSSL_PARAM_construct_int,
  11 OSSL_PARAM_construct_int32, OSSL_PARAM_construct_int64,
  12 OSSL_PARAM_construct_long, OSSL_PARAM_construct_size_t,
  13 OSSL_PARAM_construct_uint, OSSL_PARAM_construct_uint32,
  14 OSSL_PARAM_construct_uint64, OSSL_PARAM_construct_ulong,
  15 OSSL_PARAM_construct_BN, OSSL_PARAM_construct_utf8_string,
  16 OSSL_PARAM_construct_utf8_ptr, OSSL_PARAM_construct_octet_string,
  17 OSSL_PARAM_construct_octet_ptr, OSSL_PARAM_construct_end,
  18 OSSL_PARAM_locate, OSSL_PARAM_locate_const,
  19 OSSL_PARAM_get_double, OSSL_PARAM_get_int, OSSL_PARAM_get_int32,
  20 OSSL_PARAM_get_int64, OSSL_PARAM_get_long, OSSL_PARAM_get_size_t,
  21 OSSL_PARAM_get_uint, OSSL_PARAM_get_uint32, OSSL_PARAM_get_uint64,
  22 OSSL_PARAM_get_ulong, OSSL_PARAM_get_BN, OSSL_PARAM_get_utf8_string,
  23 OSSL_PARAM_get_octet_string, OSSL_PARAM_get_utf8_ptr,
  24 OSSL_PARAM_get_octet_ptr,
  25 OSSL_PARAM_set_double, OSSL_PARAM_set_int, OSSL_PARAM_set_int32,
  26 OSSL_PARAM_set_int64, OSSL_PARAM_set_long, OSSL_PARAM_set_size_t,
  27 OSSL_PARAM_set_uint, OSSL_PARAM_set_uint32, OSSL_PARAM_set_uint64,
  28 OSSL_PARAM_set_ulong, OSSL_PARAM_set_BN, OSSL_PARAM_set_utf8_string,
  29 OSSL_PARAM_set_octet_string, OSSL_PARAM_set_utf8_ptr,
  30 OSSL_PARAM_set_octet_ptr, OSSL_PARAM_UNMODIFIED
  31 - OSSL_PARAM helpers
  32
  33 =head1 SYNOPSIS
  34
  35 =for openssl generic
  36
  37  #include <openssl/params.h>
  38
  39  /*
  40   * TYPE in function names is one of:
  41   * double, int, int32, int64, long, size_t, uint, uint32, uint64, ulong
  42   * Corresponding TYPE in function arguments is one of:
  43   * double, int, int32_t, int64_t, long, size_t, unsigned int, uint32_t,
  44   * uint64_t, unsigned long
  45   */
  46
  47  #define OSSL_PARAM_TYPE(key, address)
  48  #define OSSL_PARAM_BN(key, address, size)
  49  #define OSSL_PARAM_utf8_string(key, address, size)
  50  #define OSSL_PARAM_octet_string(key, address, size)
  51  #define OSSL_PARAM_utf8_ptr(key, address, size)
  52  #define OSSL_PARAM_octet_ptr(key, address, size)
  53  #define OSSL_PARAM_END
  54
  55  #define OSSL_PARAM_UNMODIFIED
  56
  57  OSSL_PARAM OSSL_PARAM_construct_TYPE(const char *key, TYPE *buf);
  58  OSSL_PARAM OSSL_PARAM_construct_BN(const char *key, unsigned char *buf,
  59                                     size_t bsize);
  60  OSSL_PARAM OSSL_PARAM_construct_utf8_string(const char *key, char *buf,
  61                                              size_t bsize);
  62  OSSL_PARAM OSSL_PARAM_construct_octet_string(const char *key, void *buf,
  63                                               size_t bsize);
  64  OSSL_PARAM OSSL_PARAM_construct_utf8_ptr(const char *key, char **buf,
  65                                           size_t bsize);
  66  OSSL_PARAM OSSL_PARAM_construct_octet_ptr(const char *key, void **buf,
  67                                            size_t bsize);
  68  OSSL_PARAM OSSL_PARAM_construct_end(void);
  69
  70  OSSL_PARAM *OSSL_PARAM_locate(OSSL_PARAM *array, const char *key);
  71  const OSSL_PARAM *OSSL_PARAM_locate_const(const OSSL_PARAM *array,
  72                                            const char *key);
  73
  74  int OSSL_PARAM_get_TYPE(const OSSL_PARAM *p, TYPE *val);
  75  int OSSL_PARAM_set_TYPE(OSSL_PARAM *p, TYPE val);
  76
  77  int OSSL_PARAM_get_BN(const OSSL_PARAM *p, BIGNUM **val);
  78  int OSSL_PARAM_set_BN(OSSL_PARAM *p, const BIGNUM *val);
  79
  80  int OSSL_PARAM_get_utf8_string(const OSSL_PARAM *p, char **val,
  81                                 size_t max_len);
  82  int OSSL_PARAM_set_utf8_string(OSSL_PARAM *p, const char *val);
  83
  84  int OSSL_PARAM_get_octet_string(const OSSL_PARAM *p, void **val,
  85                                  size_t max_len, size_t *used_len);
  86  int OSSL_PARAM_set_octet_string(OSSL_PARAM *p, const void *val, size_t len);
  87
  88  int OSSL_PARAM_get_utf8_ptr(const OSSL_PARAM *p, const char **val);
  89  int OSSL_PARAM_set_utf8_ptr(OSSL_PARAM *p, const char *val);
  90
  91  int OSSL_PARAM_get_octet_ptr(const OSSL_PARAM *p, const void **val,
  92                               size_t *used_len);
  93  int OSSL_PARAM_set_octet_ptr(OSSL_PARAM *p, const void *val,
  94                               size_t used_len);
  95
  96  int OSSL_PARAM_modified(const OSSL_PARAM *param);
  97  void OSSL_PARAM_set_all_unmodified(OSSL_PARAM *params);
  98
  99 =head1 DESCRIPTION
 100
 101 A collection of utility functions that simplify and add type safety to the
 102 OSSL_PARAM arrays.  The following B<TYPE> names are supported:
 103
 104 =over 1
 105
 106 =item *
 107
 108 double
 109
 110 =item *
 111
 112 int
 113
 114 =item *
 115
 116 int32 (int32_t)
 117
 118 =item *
 119
 120 int64 (int64_t)
 121
 122 =item *
 123
 124 long int (long)
 125
 126 =item *
 127
 128 size_t
 129
 130 =item *
 131
 132 uint32 (uint32_t)
 133
 134 =item *
 135
 136 uint64 (uint64_t)
 137
 138 =item *
 139
 140 unsigned int (uint)
 141
 142 =item *
 143
 144 unsigned long int (ulong)
 145
 146 =back
 147
 148 OSSL_PARAM_TYPE() are a series of macros designed to assist initialising an
 149 array of OSSL_PARAM structures.
 150 Each of these macros defines a parameter of the specified B<TYPE> with the
 151 provided B<key> and parameter variable B<address>.
 152
 153 OSSL_PARAM_utf8_string(), OSSL_PARAM_octet_string(), OSSL_PARAM_utf8_ptr(),
 154 OSSL_PARAM_octet_ptr(), OSSL_PARAM_BN() are macros that provide support
 155 for defining UTF8 strings, OCTET strings and big numbers.
 156 A parameter with name B<key> is defined.
 157 The storage for this parameter is at B<address> and is of B<size> bytes.
 158
 159 OSSL_PARAM_END provides an end of parameter list marker.
 160 This should terminate all OSSL_PARAM arrays.
 161
 162 OSSL_PARAM_construct_TYPE() are a series of functions that create OSSL_PARAM
 163 records dynamically.
 164 A parameter with name B<key> is created.
 165 The parameter will use storage pointed to by B<buf> and return size of B<ret>.
 166
 167 OSSL_PARAM_construct_BN() is a function that constructs a large integer
 168 OSSL_PARAM structure.
 169 A parameter with name B<key>, storage B<buf>, size B<bsize> and return
 170 size B<rsize> is created.
 171
 172 OSSL_PARAM_construct_utf8_string() is a function that constructs a UTF8
 173 string OSSL_PARAM structure.
 174 A parameter with name B<key>, storage B<buf> and size B<bsize> is created.
 175 If B<bsize> is zero, the string length is determined using strlen(3) + 1 for the
 176 null termination byte.
 177 Generally pass zero for B<bsize> instead of calling strlen(3) yourself.
 178
 179 OSSL_PARAM_construct_octet_string() is a function that constructs an OCTET
 180 string OSSL_PARAM structure.
 181 A parameter with name B<key>, storage B<buf> and size B<bsize> is created.
 182
 183 OSSL_PARAM_construct_utf8_ptr() is a function that constructes a UTF string
 184 pointer OSSL_PARAM structure.
 185 A parameter with name B<key>, storage pointer B<*buf> and size B<bsize>
 186 is created.
 187
 188 OSSL_PARAM_construct_octet_ptr() is a function that constructes an OCTET string
 189 pointer OSSL_PARAM structure.
 190 A parameter with name B<key>, storage pointer B<*buf> and size B<bsize>
 191 is created.
 192
 193 OSSL_PARAM_construct_end() is a function that constructs the terminating
 194 OSSL_PARAM structure.
 195
 196 OSSL_PARAM_locate() is a function that searches an B<array> of parameters for
 197 the one matching the B<key> name.
 198
 199 OSSL_PARAM_locate_const() behaves exactly like OSSL_PARAM_locate() except for
 200 the presence of I<const> for the B<array> argument and its return value.
 201
 202 OSSL_PARAM_get_TYPE() retrieves a value of type B<TYPE> from the parameter B<p>.
 203 The value is copied to the address B<val>.
 204 Type coercion takes place as discussed in the NOTES section.
 205
 206 OSSL_PARAM_set_TYPE() stores a value B<val> of type B<TYPE> into the parameter
 207 B<p>.
 208 If the parameter's I<data> field is NULL, then only its I<return_size> field
 209 will be assigned the size the parameter's I<data> buffer should have.
 210 Type coercion takes place as discussed in the NOTES section.
 211
 212 OSSL_PARAM_get_BN() retrieves a BIGNUM from the parameter pointed to by B<p>.
 213 The BIGNUM referenced by B<val> is updated and is allocated if B<*val> is
 214 B<NULL>.
 215
 216 OSSL_PARAM_set_BN() stores the BIGNUM B<val> into the parameter B<p>.
 217 If the parameter's I<data> field is NULL, then only its I<return_size> field
 218 will be assigned the size the parameter's I<data> buffer should have.
 219
 220 OSSL_PARAM_get_utf8_string() retrieves a UTF8 string from the parameter
 221 pointed to by B<p>.
 222 The string is either stored into B<*val> with a length limit of B<max_len> or,
 223 in the case when B<*val> is B<NULL>, memory is allocated for the string and
 224 B<max_len> is ignored.
 225 If memory is allocated by this function, it must be freed by the caller.
 226
 227 OSSL_PARAM_set_utf8_string() sets a UTF8 string from the parameter pointed to
 228 by B<p> to the value referenced by B<val>.
 229 If the parameter's I<data> field is NULL, then only its I<return_size> field
 230 will be assigned the size the parameter's I<data> buffer should have.
 231
 232 OSSL_PARAM_get_octet_string() retrieves an OCTET string from the parameter
 233 pointed to by B<p>.
 234 The OCTETs are either stored into B<*val> with a length limit of B<max_len> or,
 235 in the case when B<*val> is B<NULL>, memory is allocated and
 236 B<max_len> is ignored. B<*used_len> is populated with the number of OCTETs
 237 stored. If B<val> is NULL then the OCTETS are not stored, but B<*used_len> is
 238 still populated.
 239 If memory is allocated by this function, it must be freed by the caller.
 240
 241 OSSL_PARAM_set_octet_string() sets an OCTET string from the parameter
 242 pointed to by B<p> to the value referenced by B<val>.
 243 If the parameter's I<data> field is NULL, then only its I<return_size> field
 244 will be assigned the size the parameter's I<data> buffer should have.
 245
 246 OSSL_PARAM_get_utf8_ptr() retrieves the UTF8 string pointer from the parameter
 247 referenced by B<p> and stores it in B<*val>.
 248
 249 OSSL_PARAM_set_utf8_ptr() sets the UTF8 string pointer in the parameter
 250 referenced by B<p> to the values B<val>.
 251
 252 OSSL_PARAM_get_octet_ptr() retrieves the OCTET string pointer from the parameter
 253 referenced by B<p> and stores it in B<*val>.
 254 The length of the OCTET string is stored in B<*used_len>.
 255
 256 OSSL_PARAM_set_octet_ptr() sets the OCTET string pointer in the parameter
 257 referenced by B<p> to the values B<val>.
 258 The length of the OCTET string is provided by B<used_len>.
 259
 260 The OSSL_PARAM_UNMODIFIED macro is used to detect if a parameter was set.  On
 261 creation, via either the macros or construct calls, the I<return_size> field
 262 is set to this.  If the parameter is set using the calls defined herein, the
 263 I<return_size> field is changed.
 264
 265 OSSL_PARAM_modified() queries if the parameter B<param> has been set or not
 266 using the calls defined herein.
 267
 268 OSSL_PARAM_set_all_unmodified() resets the unused indicator for all parameters
 269 in the array B<params>.
 270
 271 =head1 RETURN VALUES
 272
 273 OSSL_PARAM_construct_TYPE(), OSSL_PARAM_construct_BN(),
 274 OSSL_PARAM_construct_utf8_string(), OSSL_PARAM_construct_octet_string(),
 275 OSSL_PARAM_construct_utf8_ptr() and OSSL_PARAM_construct_octet_ptr()
 276 return a populated OSSL_PARAM structure.
 277
 278 OSSL_PARAM_locate() and OSSL_PARAM_locate_const() return a pointer to
 279 the matching OSSL_PARAM object.  They return B<NULL> on error or when
 280 no object matching B<key> exists in the B<array>.
 281
 282 OSSL_PARAM_modified() returns B<1> if the parameter was set and B<0> otherwise.
 283
 284 All other functions return B<1> on success and B<0> on failure.
 285
 286 =head1 NOTES
 287
 288 Native types will be converted as required only if the value is exactly
 289 representable by the target type or parameter.
 290 Apart from that, the functions must be used appropriately for the
 291 expected type of the parameter.
 292
 293 For OSSL_PARAM_construct_utf8_ptr() and OSSL_PARAM_consstruct_octet_ptr(),
 294 B<bsize> is not relevant if the purpose is to send the B<OSSL_PARAM> array
 295 to a I<responder>, i.e. to get parameter data back.
 296 In that case, B<bsize> can safely be given zero.
 297 See L<OSSL_PARAM(3)/DESCRIPTION> for further information on the
 298 possible purposes.
 299
 300 =head1 EXAMPLES
 301
 302 Reusing the examples from L<OSSL_PARAM(3)> to just show how
 303 C<OSSL_PARAM> arrays can be handled using the macros and functions
 304 defined herein.
 305
 306 =head2 Example 1
 307
 308 This example is for setting parameters on some object:
 309
 310     #include <openssl/core.h>
 311
 312     const char *foo = "some string";
 313     size_t foo_l = strlen(foo) + 1;
 314     const char bar[] = "some other string";
 315     const OSSL_PARAM set[] = {
 316         OSSL_PARAM_utf8_ptr("foo", foo, foo_l),
 317         OSSL_PARAM_utf8_string("bar", bar, sizeof(bar)),
 318         OSSL_PARAM_END
 319     };
 320
 321 =head2 Example 2
 322
 323 This example is for requesting parameters on some object, and also
 324 demonstrates that the requestor isn't obligated to request all
 325 available parameters:
 326
 327     const char *foo = NULL;
 328     char bar[1024];
 329     OSSL_PARAM request[] = {
 330         OSSL_PARAM_utf8_ptr("foo", foo, 0),
 331         OSSL_PARAM_utf8_string("bar", bar, sizeof(bar)),
 332         OSSL_PARAM_END
 333     };
 334
 335 A I<responder> that receives this array (as C<params> in this example)
 336 could fill in the parameters like this:
 337
 338     /* OSSL_PARAM *params */
 339
 340     OSSL_PARAM *p;
 341
 342     if ((p = OSSL_PARAM_locate(params, "foo")) == NULL)
 343         OSSL_PARAM_set_utf8_ptr(p, "foo value");
 344     if ((p = OSSL_PARAM_locate(params, "bar")) == NULL)
 345         OSSL_PARAM_set_utf8_ptr(p, "bar value");
 346     if ((p = OSSL_PARAM_locate(params, "cookie")) == NULL)
 347         OSSL_PARAM_set_utf8_ptr(p, "cookie value");
 348
 349 =head1 SEE ALSO
 350
 351 L<openssl-core.h(7)>, L<OSSL_PARAM(3)>
 352
 353 =head1 HISTORY
 354
 355 These APIs were introduced in OpenSSL 3.0.
 356
 357 =head1 COPYRIGHT
 358
 359 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
 360
 361 Licensed under the Apache License 2.0 (the "License").  You may not use
 362 this file except in compliance with the License.  You can obtain a copy
 363 in the file LICENSE in the source distribution or at
 364 L<https://www.openssl.org/source/license.html>.
 365
 366 =cut