include/openssl/kdf.h

   1 /*
   2  * Copyright 2016-2021 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(OSSL_LIB_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_CTX_reset(EVP_KDF_CTX *ctx);
  43 size_t EVP_KDF_CTX_get_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(OSSL_LIB_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_HKDF_MODE_EXTRACT_AND_EXPAND  0
  60 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY        1
  61 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY         2
  62
  63 /* SSHKDF key exchange stages.*/
  64 /* See https://tools.ietf.org/html/rfc4253#section-7.2 */
  65 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV     {65, 0}
  66 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI     {66, 0}
  67 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV {67, 0}
  68 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI {68, 0}
  69 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV  {69, 0}
  70 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI  {70, 0}
  71
  72 /**** The legacy PKEY-based KDF API follows. ****/
  73
  74 # define EVP_PKEY_CTRL_TLS_MD                   (EVP_PKEY_ALG_CTRL)
  75 # define EVP_PKEY_CTRL_TLS_SECRET               (EVP_PKEY_ALG_CTRL + 1)
  76 # define EVP_PKEY_CTRL_TLS_SEED                 (EVP_PKEY_ALG_CTRL + 2)
  77 # define EVP_PKEY_CTRL_HKDF_MD                  (EVP_PKEY_ALG_CTRL + 3)
  78 # define EVP_PKEY_CTRL_HKDF_SALT                (EVP_PKEY_ALG_CTRL + 4)
  79 # define EVP_PKEY_CTRL_HKDF_KEY                 (EVP_PKEY_ALG_CTRL + 5)
  80 # define EVP_PKEY_CTRL_HKDF_INFO                (EVP_PKEY_ALG_CTRL + 6)
  81 # define EVP_PKEY_CTRL_HKDF_MODE                (EVP_PKEY_ALG_CTRL + 7)
  82 # define EVP_PKEY_CTRL_PASS                     (EVP_PKEY_ALG_CTRL + 8)
  83 # define EVP_PKEY_CTRL_SCRYPT_SALT              (EVP_PKEY_ALG_CTRL + 9)
  84 # define EVP_PKEY_CTRL_SCRYPT_N                 (EVP_PKEY_ALG_CTRL + 10)
  85 # define EVP_PKEY_CTRL_SCRYPT_R                 (EVP_PKEY_ALG_CTRL + 11)
  86 # define EVP_PKEY_CTRL_SCRYPT_P                 (EVP_PKEY_ALG_CTRL + 12)
  87 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES      (EVP_PKEY_ALG_CTRL + 13)
  88
  89 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
  90             EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
  91 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY       \
  92             EVP_KDF_HKDF_MODE_EXTRACT_ONLY
  93 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY        \
  94             EVP_KDF_HKDF_MODE_EXPAND_ONLY
  95
  96 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
  97
  98 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *pctx,
  99                                       const unsigned char *sec, int seclen);
 100
 101 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *pctx,
 102                                     const unsigned char *seed, int seedlen);
 103
 104 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 105
 106 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX *ctx,
 107                                 const unsigned char *salt, int saltlen);
 108
 109 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX *ctx,
 110                                const unsigned char *key, int keylen);
 111
 112 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX *ctx,
 113                                 const unsigned char *info, int infolen);
 114
 115 int EVP_PKEY_CTX_hkdf_mode(EVP_PKEY_CTX *ctx, int mode);
 116
 117 int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX *ctx, const char *pass,
 118                                int passlen);
 119
 120 int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX *ctx,
 121                                   const unsigned char *salt, int saltlen);
 122
 123 int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX *ctx, uint64_t n);
 124
 125 int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX *ctx, uint64_t r);
 126
 127 int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX *ctx, uint64_t p);
 128
 129 int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX *ctx,
 130                                          uint64_t maxmem_bytes);
 131
 132
 133 # ifdef __cplusplus
 134 }
 135 # endif
 136 #endif