include/openssl/kdf.h

   1 /*
   2  * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OPENSSL_KDF_H
  11 # define OPENSSL_KDF_H
  12 # pragma once
  13
  14 # include <openssl/macros.h>
  15 # ifndef OPENSSL_NO_DEPRECATED_3_0
  16 #  define HEADER_KDF_H
  17 # endif
  18
  19 # include <stdarg.h>
  20 # include <stddef.h>
  21 # include <openssl/types.h>
  22 # include <openssl/core.h>
  23
  24 # ifdef __cplusplus
  25 extern "C" {
  26 # endif
  27
  28 int EVP_KDF_up_ref(EVP_KDF *kdf);
  29 void EVP_KDF_free(EVP_KDF *kdf);
  30 EVP_KDF *EVP_KDF_fetch(OPENSSL_CTX *libctx, const char *algorithm,
  31                        const char *properties);
  32
  33 EVP_KDF_CTX *EVP_KDF_CTX_new(EVP_KDF *kdf);
  34 void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx);
  35 EVP_KDF_CTX *EVP_KDF_CTX_dup(const EVP_KDF_CTX *src);
  36 int EVP_KDF_number(const EVP_KDF *kdf);
  37 int EVP_KDF_is_a(const EVP_KDF *kdf, const char *name);
  38 const char *EVP_KDF_name(const EVP_KDF *kdf);
  39 const OSSL_PROVIDER *EVP_KDF_provider(const EVP_KDF *kdf);
  40 const EVP_KDF *EVP_KDF_CTX_kdf(EVP_KDF_CTX *ctx);
  41
  42 void EVP_KDF_reset(EVP_KDF_CTX *ctx);
  43 size_t EVP_KDF_size(EVP_KDF_CTX *ctx);
  44 int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen);
  45 int EVP_KDF_get_params(EVP_KDF *kdf, OSSL_PARAM params[]);
  46 int EVP_KDF_CTX_get_params(EVP_KDF_CTX *ctx, OSSL_PARAM params[]);
  47 int EVP_KDF_CTX_set_params(EVP_KDF_CTX *ctx, const OSSL_PARAM params[]);
  48 const OSSL_PARAM *EVP_KDF_gettable_params(const EVP_KDF *kdf);
  49 const OSSL_PARAM *EVP_KDF_gettable_ctx_params(const EVP_KDF *kdf);
  50 const OSSL_PARAM *EVP_KDF_settable_ctx_params(const EVP_KDF *kdf);
  51
  52 void EVP_KDF_do_all_provided(OPENSSL_CTX *libctx,
  53                              void (*fn)(EVP_KDF *kdf, void *arg),
  54                              void *arg);
  55 void EVP_KDF_names_do_all(const EVP_KDF *kdf,
  56                           void (*fn)(const char *name, void *data),
  57                           void *data);
  58
  59 # define EVP_KDF_CTRL_SET_PASS               0x01 /* unsigned char *, size_t */
  60 # define EVP_KDF_CTRL_SET_SALT               0x02 /* unsigned char *, size_t */
  61 # define EVP_KDF_CTRL_SET_ITER               0x03 /* int */
  62 # define EVP_KDF_CTRL_SET_MD                 0x04 /* EVP_MD * */
  63 # define EVP_KDF_CTRL_SET_KEY                0x05 /* unsigned char *, size_t */
  64 # define EVP_KDF_CTRL_SET_MAXMEM_BYTES       0x06 /* uint64_t */
  65 # define EVP_KDF_CTRL_SET_TLS_SECRET         0x07 /* unsigned char *, size_t */
  66 # define EVP_KDF_CTRL_ADD_TLS_SEED           0x08 /* unsigned char *, size_t */
  67 # define EVP_KDF_CTRL_RESET_HKDF_INFO        0x09
  68 # define EVP_KDF_CTRL_ADD_HKDF_INFO          0x0a /* unsigned char *, size_t */
  69 # define EVP_KDF_CTRL_SET_HKDF_MODE          0x0b /* int */
  70 # define EVP_KDF_CTRL_SET_SCRYPT_N           0x0c /* uint64_t */
  71 # define EVP_KDF_CTRL_SET_SCRYPT_R           0x0d /* uint32_t */
  72 # define EVP_KDF_CTRL_SET_SCRYPT_P           0x0e /* uint32_t */
  73 # define EVP_KDF_CTRL_SET_SSHKDF_XCGHASH     0x0f /* unsigned char *, size_t */
  74 # define EVP_KDF_CTRL_SET_SSHKDF_SESSION_ID  0x10 /* unsigned char *, size_t */
  75 # define EVP_KDF_CTRL_SET_SSHKDF_TYPE        0x11 /* int */
  76 # define EVP_KDF_CTRL_SET_MAC                0x12 /* EVP_MAC * */
  77 # define EVP_KDF_CTRL_SET_MAC_SIZE           0x13 /* size_t */
  78 # define EVP_KDF_CTRL_SET_SSKDF_INFO         0x14 /* unsigned char *, size_t */
  79 # define EVP_KDF_CTRL_SET_PBKDF2_PKCS5_MODE  0x15 /* int */
  80 # define EVP_KDF_CTRL_SET_UKM                0x16 /* unsigned char *, size_t */
  81 # define EVP_KDF_CTRL_SET_CEK_ALG            0x17 /* char * */
  82 # define EVP_KDF_CTRL_SET_SHARED_INFO        EVP_KDF_CTRL_SET_SSKDF_INFO
  83
  84 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND  0
  85 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY        1
  86 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY         2
  87
  88 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV     65
  89 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI     66
  90 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
  91 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
  92 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV  69
  93 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI  70
  94
  95 /**** The legacy PKEY-based KDF API follows. ****/
  96
  97 # define EVP_PKEY_CTRL_TLS_MD                   (EVP_PKEY_ALG_CTRL)
  98 # define EVP_PKEY_CTRL_TLS_SECRET               (EVP_PKEY_ALG_CTRL + 1)
  99 # define EVP_PKEY_CTRL_TLS_SEED                 (EVP_PKEY_ALG_CTRL + 2)
 100 # define EVP_PKEY_CTRL_HKDF_MD                  (EVP_PKEY_ALG_CTRL + 3)
 101 # define EVP_PKEY_CTRL_HKDF_SALT                (EVP_PKEY_ALG_CTRL + 4)
 102 # define EVP_PKEY_CTRL_HKDF_KEY                 (EVP_PKEY_ALG_CTRL + 5)
 103 # define EVP_PKEY_CTRL_HKDF_INFO                (EVP_PKEY_ALG_CTRL + 6)
 104 # define EVP_PKEY_CTRL_HKDF_MODE                (EVP_PKEY_ALG_CTRL + 7)
 105 # define EVP_PKEY_CTRL_PASS                     (EVP_PKEY_ALG_CTRL + 8)
 106 # define EVP_PKEY_CTRL_SCRYPT_SALT              (EVP_PKEY_ALG_CTRL + 9)
 107 # define EVP_PKEY_CTRL_SCRYPT_N                 (EVP_PKEY_ALG_CTRL + 10)
 108 # define EVP_PKEY_CTRL_SCRYPT_R                 (EVP_PKEY_ALG_CTRL + 11)
 109 # define EVP_PKEY_CTRL_SCRYPT_P                 (EVP_PKEY_ALG_CTRL + 12)
 110 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES      (EVP_PKEY_ALG_CTRL + 13)
 111
 112 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
 113             EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
 114 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY       \
 115             EVP_KDF_HKDF_MODE_EXTRACT_ONLY
 116 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY        \
 117             EVP_KDF_HKDF_MODE_EXPAND_ONLY
 118
 119 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 120
 121 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *pctx,
 122                                       const unsigned char *sec, int seclen);
 123
 124 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *pctx,
 125                                     const unsigned char *seed, int seedlen);
 126
 127 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 128
 129 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX *ctx,
 130                                 const unsigned char *salt, int saltlen);
 131
 132 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX *ctx,
 133                                const unsigned char *key, int keylen);
 134
 135 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX *ctx,
 136                                 const unsigned char *info, int infolen);
 137
 138 int EVP_PKEY_CTX_hkdf_mode(EVP_PKEY_CTX *ctx, int mode);
 139
 140 int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX *ctx, const char *pass,
 141                                int passlen);
 142
 143 int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX *ctx,
 144                                   const unsigned char *salt, int saltlen);
 145
 146 int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX *ctx, uint64_t n);
 147
 148 int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX *ctx, uint64_t r);
 149
 150 int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX *ctx, uint64_t p);
 151
 152 int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX *ctx,
 153                                          uint64_t maxmem_bytes);
 154
 155
 156 # ifdef __cplusplus
 157 }
 158 # endif
 159 #endif