doc/man7/provider-kdf.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 provider-kdf - The KDF library E<lt>-E<gt> provider functions
   6
   7 =head1 SYNOPSIS
   8
   9 =for openssl multiple includes
  10
  11  #include <openssl/core_dispatch.h>
  12  #include <openssl/core_names.h>
  13
  14  /*
  15   * None of these are actual functions, but are displayed like this for
  16   * the function signatures for functions that are offered as function
  17   * pointers in OSSL_DISPATCH arrays.
  18   */
  19
  20  /* Context management */
  21  void *OSSL_FUNC_kdf_newctx(void *provctx);
  22  void OSSL_FUNC_kdf_freectx(void *kctx);
  23  void *OSSL_FUNC_kdf_dupctx(void *src);
  24
  25  /* Encryption/decryption */
  26  int OSSL_FUNC_kdf_reset(void *kctx);
  27  int OSSL_FUNC_kdf_derive(void *kctx, unsigned char *key, size_t keylen);
  28
  29  /* KDF parameter descriptors */
  30  const OSSL_PARAM *OSSL_FUNC_kdf_gettable_params(void *provctx);
  31  const OSSL_PARAM *OSSL_FUNC_kdf_gettable_ctx_params(void *provctx);
  32  const OSSL_PARAM *OSSL_FUNC_kdf_settable_ctx_params(void *provctx);
  33
  34  /* KDF parameters */
  35  int OSSL_FUNC_kdf_get_params(OSSL_PARAM params[]);
  36  int OSSL_FUNC_kdf_get_ctx_params(void *kctx, OSSL_PARAM params[]);
  37  int OSSL_FUNC_kdf_set_ctx_params(void *kctx, const OSSL_PARAM params[]);
  38
  39 =head1 DESCRIPTION
  40
  41 This documentation is primarily aimed at provider authors. See L<provider(7)>
  42 for further information.
  43
  44 The KDF operation enables providers to implement KDF algorithms and make
  45 them available to applications via the API functions L<EVP_KDF_CTX_reset(3)>,
  46 and L<EVP_KDF_derive(3)>.
  47
  48 All "functions" mentioned here are passed as function pointers between
  49 F<libcrypto> and the provider in B<OSSL_DISPATCH> arrays via
  50 B<OSSL_ALGORITHM> arrays that are returned by the provider's
  51 provider_query_operation() function
  52 (see L<provider-base(7)/Provider Functions>).
  53
  54 All these "functions" have a corresponding function type definition
  55 named B<OSSL_{name}_fn>, and a helper function to retrieve the
  56 function pointer from an B<OSSL_DISPATCH> element named
  57 B<OSSL_FUNC_{name}>.
  58 For example, the "function" OSSL_FUNC_kdf_newctx() has these:
  59
  60  typedef void *(OSSL_OSSL_FUNC_kdf_newctx_fn)(void *provctx);
  61  static ossl_inline OSSL_OSSL_FUNC_kdf_newctx_fn
  62      OSSL_FUNC_kdf_newctx(const OSSL_DISPATCH *opf);
  63
  64 B<OSSL_DISPATCH> array entries are identified by numbers that are provided as
  65 macros in L<openssl-core_dispatch.h(7)>, as follows:
  66
  67  OSSL_FUNC_kdf_newctx               OSSL_FUNC_KDF_NEWCTX
  68  OSSL_FUNC_kdf_freectx              OSSL_FUNC_KDF_FREECTX
  69  OSSL_FUNC_kdf_dupctx               OSSL_FUNC_KDF_DUPCTX
  70
  71  OSSL_FUNC_kdf_reset                OSSL_FUNC_KDF_RESET
  72  OSSL_FUNC_kdf_derive               OSSL_FUNC_KDF_DERIVE
  73
  74  OSSL_FUNC_kdf_get_params           OSSL_FUNC_KDF_GET_PARAMS
  75  OSSL_FUNC_kdf_get_ctx_params       OSSL_FUNC_KDF_GET_CTX_PARAMS
  76  OSSL_FUNC_kdf_set_ctx_params       OSSL_FUNC_KDF_SET_CTX_PARAMS
  77
  78  OSSL_FUNC_kdf_gettable_params      OSSL_FUNC_KDF_GETTABLE_PARAMS
  79  OSSL_FUNC_kdf_gettable_ctx_params  OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS
  80  OSSL_FUNC_kdf_settable_ctx_params  OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS
  81
  82 A KDF algorithm implementation may not implement all of these functions.
  83 In order to be a consistent set of functions, at least the following functions
  84 must be implemented: OSSL_FUNC_kdf_newctx(), OSSL_FUNC_kdf_freectx(),
  85 OSSL_FUNC_kdf_set_ctx_params(), OSSL_FUNC_kdf_derive().
  86 All other functions are optional.
  87
  88 =head2 Context Management Functions
  89
  90 OSSL_FUNC_kdf_newctx() should create and return a pointer to a provider side
  91 structure for holding context information during a KDF operation.
  92 A pointer to this context will be passed back in a number of the other KDF
  93 operation function calls.
  94 The parameter I<provctx> is the provider context generated during provider
  95 initialisation (see L<provider(7)>).
  96
  97 OSSL_FUNC_kdf_freectx() is passed a pointer to the provider side KDF context in
  98 the I<kctx> parameter.
  99 If it receives NULL as I<kctx> value, it should not do anything other than
 100 return.
 101 This function should free any resources associated with that context.
 102
 103 OSSL_FUNC_kdf_dupctx() should duplicate the provider side KDF context in the
 104 I<kctx> parameter and return the duplicate copy.
 105
 106 =head2 Encryption/Decryption Functions
 107
 108 OSSL_FUNC_kdf_reset() initialises a KDF operation given a provider
 109 side KDF context in the I<kctx> parameter.
 110
 111 OSSL_FUNC_kdf_derive() performs the KDF operation.
 112 The I<kctx> parameter contains a pointer to the provider side context.
 113 The resulting key of the desired I<keylen> should be written to I<key>.
 114 If the algorithm does not support the requested I<keylen> the function must
 115 return error.
 116
 117 =head2 KDF Parameters
 118
 119 See L<OSSL_PARAM(3)> for further details on the parameters structure used by
 120 these functions.
 121
 122 OSSL_FUNC_kdf_get_params() gets details of parameter values associated with the
 123 provider algorithm and stores them in I<params>.
 124
 125 OSSL_FUNC_kdf_set_ctx_params() sets KDF parameters associated with the given
 126 provider side KDF context I<kctx> to I<params>.
 127 Any parameter settings are additional to any that were previously set.
 128
 129 OSSL_FUNC_kdf_get_ctx_params() retrieves gettable parameter values associated
 130 with the given provider side KDF context I<kctx> and stores them in I<params>.
 131
 132 OSSL_FUNC_kdf_gettable_params(), OSSL_FUNC_kdf_gettable_ctx_params(), and
 133 OSSL_FUNC_kdf_settable_ctx_params() all return constant B<OSSL_PARAM> arrays
 134 as descriptors of the parameters that OSSL_FUNC_kdf_get_params(),
 135 OSSL_FUNC_kdf_get_ctx_params(), and OSSL_FUNC_kdf_set_ctx_params() can handle,
 136 respectively.
 137
 138 Parameters currently recognised by built-in KDFs are as follows. Not all
 139 parameters are relevant to, or are understood by all KDFs:
 140
 141 =over 4
 142
 143 =item "size" (B<OSSL_KDF_PARAM_SIZE>) <unsigned integer>
 144
 145 Gets the output size from the associated KDF ctx.
 146 If the algorithm produces a variable amount of output, SIZE_MAX should be
 147 returned.
 148 If the input parameters required to calculate the fixed output size have not yet
 149 been supplied, 0 should be returned indicating an error.
 150
 151 =item "key" (B<OSSL_KDF_PARAM_KEY>) <octet string>
 152
 153 Sets the key in the associated KDF ctx.
 154
 155 =item "secret" (B<OSSL_KDF_PARAM_SECRET>) <octet string>
 156
 157 Sets the secret in the associated KDF ctx.
 158
 159 =item "pass" (B<OSSL_KDF_PARAM_PASSWORD>) <octet string>
 160
 161 Sets the password in the associated KDF ctx.
 162
 163 =item "cipher" (B<OSSL_KDF_PARAM_CIPHER>) <UTF8 string>
 164
 165 =item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
 166
 167 =item "mac" (B<OSSL_KDF_PARAM_MAC>) <UTF8 string>
 168
 169 Sets the name of the underlying cipher, digest or MAC to be used.
 170 It must name a suitable algorithm for the KDF that's being used.
 171
 172 =item "maclen" (B<OSSL_KDF_PARAM_MAC_SIZE>) <octet string>
 173
 174 Sets the length of the MAC in the associated KDF ctx.
 175
 176 =item "properties" (B<OSSL_KDF_PARAM_PROPERTIES>) <UTF8 string>
 177
 178 Sets the properties to be queried when trying to fetch the underlying algorithm.
 179 This must be given together with the algorithm naming parameter to be
 180 considered valid.
 181
 182 =item "iter" (B<OSSL_KDF_PARAM_ITER>) <unsigned integer>
 183
 184 Sets the number of iterations in the associated KDF ctx.
 185
 186 =item "mode" (B<OSSL_KDF_PARAM_MODE>) <UTF8 string>
 187
 188 Sets the mode in the associated KDF ctx.
 189
 190 =item "pkcs5" (B<OSSL_KDF_PARAM_PKCS5>) <integer>
 191
 192 Enables or diables the SP800-132 compliance checks.
 193 A mode of 0 enables the compliance checks.
 194
 195 The checks performed are:
 196
 197 =over 4
 198
 199 =item - the iteration count is at least 1000.
 200
 201 =item - the salt length is at least 128 bits.
 202
 203 =item - the derived key length is at least 112 bits.
 204
 205 =back
 206
 207 =item "ukm" (B<OSSL_KDF_PARAM_UKM>) <octet string>
 208
 209 Sets an optional random string that is provided by the sender called
 210 "partyAInfo".  In CMS this is the user keying material.
 211
 212
 213 =item "cekalg" (B<OSSL_KDF_PARAM_CEK_ALG>) <UTF8 string>
 214
 215 Sets the CEK wrapping algorithm name in the associated KDF ctx.
 216
 217 =item "n" (B<OSSL_KDF_PARAM_SCRYPT_N>) <unsigned integer>
 218
 219 Sets the scrypt work factor parameter N in the associated KDF ctx.
 220
 221 =item "r" (B<OSSL_KDF_PARAM_SCRYPT_R>) <unsigned integer>
 222
 223 Sets the scrypt work factor parameter r in the associated KDF ctx.
 224
 225 =item "p" (B<OSSL_KDF_PARAM_SCRYPT_P>) <unsigned integer>
 226
 227 Sets the scrypt work factor parameter p in the associated KDF ctx.
 228
 229 =item "maxmem_bytes" (B<OSSL_KDF_PARAM_SCRYPT_MAXMEM>) <unsigned integer>
 230
 231 Sets the scrypt work factor parameter maxmem in the associated KDF ctx.
 232
 233 =item "info" (B<OSSL_KDF_PARAM_INFO>) <octet string>
 234
 235 Sets the optional shared info in the associated KDF ctx.
 236
 237 =item "seed" (B<OSSL_KDF_PARAM_SEED>) <octet string>
 238
 239 Sets the IV in the associated KDF ctx.
 240
 241 =item "xcghash" (B<OSSL_KDF_PARAM_SSHKDF_XCGHASH>) <octet string>
 242
 243 Sets the xcghash in the associated KDF ctx.
 244
 245 =item "session_id" (B<OSSL_KDF_PARAM_SSHKDF_SESSION_ID>) <octet string>
 246
 247 Sets the session ID in the associated KDF ctx.
 248
 249 =item "type" (B<OSSL_KDF_PARAM_SSHKDF_TYPE>) <integer>
 250
 251 Sets the SSH KDF type parameter in the associated KDF ctx.
 252 There are six supported types:
 253
 254 =over 4
 255
 256 =item EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV
 257
 258 The Initial IV from client to server.
 259 A single char of value 65 (ASCII char 'A').
 260
 261 =item EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI
 262
 263 The Initial IV from server to client
 264 A single char of value 66 (ASCII char 'B').
 265
 266 =item EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV
 267
 268 The Encryption Key from client to server
 269 A single char of value 67 (ASCII char 'C').
 270
 271 =item EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI
 272
 273 The Encryption Key from server to client
 274 A single char of value 68 (ASCII char 'D').
 275
 276 =item EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV
 277
 278 The Integrity Key from client to server
 279 A single char of value 69 (ASCII char 'E').
 280
 281 =item EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI
 282
 283 The Integrity Key from client to server
 284 A single char of value 70 (ASCII char 'F').
 285
 286 =back
 287
 288 =item "constant" (B<OSSL_KDF_PARAM_CONSTANT>) <octet string>
 289
 290 Sets the constant value in the associated KDF ctx.
 291
 292 =item "id" (B<OSSL_KDF_PARAM_PKCS12_ID>) <integer>
 293
 294 Sets the intended usage of the output bits in the associated KDF ctx.
 295 It is defined as per RFC 7292 section B.3.
 296
 297 =back
 298
 299 =head1 RETURN VALUES
 300
 301 OSSL_FUNC_kdf_newctx() and OSSL_FUNC_kdf_dupctx() should return the newly created
 302 provider side KDF context, or NULL on failure.
 303
 304 OSSL_FUNC_kdf_derive(), OSSL_FUNC_kdf_get_params(),
 305 OSSL_FUNC_kdf_get_ctx_params() and OSSL_FUNC_kdf_set_ctx_params() should return 1 for
 306 success or 0 on error.
 307
 308 OSSL_FUNC_kdf_gettable_params(), OSSL_FUNC_kdf_gettable_ctx_params() and
 309 OSSL_FUNC_kdf_settable_ctx_params() should return a constant B<OSSL_PARAM>
 310 array, or NULL if none is offered.
 311
 312 =head1 SEE ALSO
 313
 314 L<provider(7)>
 315
 316 =head1 HISTORY
 317
 318 The provider KDF interface was introduced in OpenSSL 3.0.
 319
 320 =head1 COPYRIGHT
 321
 322 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
 323
 324 Licensed under the Apache License 2.0 (the "License").  You may not use
 325 this file except in compliance with the License.  You can obtain a copy
 326 in the file LICENSE in the source distribution or at
 327 L<https://www.openssl.org/source/license.html>.
 328
 329 =cut