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