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