2 * Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
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
15 # include <openssl/ossl_typ.h>
16 # include <openssl/core.h>
22 int EVP_KDF_up_ref(EVP_KDF *kdf);
23 void EVP_KDF_free(EVP_KDF *kdf);
24 EVP_KDF *EVP_KDF_fetch(OPENSSL_CTX *libctx, const char *algorithm,
25 const char *properties);
27 EVP_KDF_CTX *EVP_KDF_CTX_new(EVP_KDF *kdf);
28 void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx);
29 EVP_KDF_CTX *EVP_KDF_CTX_dup(const EVP_KDF_CTX *src);
30 const char *EVP_KDF_name(const EVP_KDF *kdf);
31 const OSSL_PROVIDER *EVP_KDF_provider(const EVP_KDF *kdf);
32 const EVP_KDF *EVP_KDF_CTX_kdf(EVP_KDF_CTX *ctx);
34 void EVP_KDF_reset(EVP_KDF_CTX *ctx);
35 size_t EVP_KDF_size(EVP_KDF_CTX *ctx);
36 int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen);
37 int EVP_KDF_get_params(EVP_KDF *kdf, OSSL_PARAM params[]);
38 int EVP_KDF_CTX_get_params(EVP_KDF_CTX *ctx, OSSL_PARAM params[]);
39 int EVP_KDF_CTX_set_params(EVP_KDF_CTX *ctx, const OSSL_PARAM params[]);
40 const OSSL_PARAM *EVP_KDF_gettable_params(const EVP_KDF *kdf);
41 const OSSL_PARAM *EVP_KDF_CTX_gettable_params(const EVP_KDF *kdf);
42 const OSSL_PARAM *EVP_KDF_CTX_settable_params(const EVP_KDF *kdf);
44 void EVP_KDF_do_all_ex(OPENSSL_CTX *libctx,
45 void (*fn)(EVP_KDF *kdf, void *arg),
48 # define EVP_KDF_CTRL_SET_PASS 0x01 /* unsigned char *, size_t */
49 # define EVP_KDF_CTRL_SET_SALT 0x02 /* unsigned char *, size_t */
50 # define EVP_KDF_CTRL_SET_ITER 0x03 /* int */
51 # define EVP_KDF_CTRL_SET_MD 0x04 /* EVP_MD * */
52 # define EVP_KDF_CTRL_SET_KEY 0x05 /* unsigned char *, size_t */
53 # define EVP_KDF_CTRL_SET_MAXMEM_BYTES 0x06 /* uint64_t */
54 # define EVP_KDF_CTRL_SET_TLS_SECRET 0x07 /* unsigned char *, size_t */
55 # define EVP_KDF_CTRL_ADD_TLS_SEED 0x08 /* unsigned char *, size_t */
56 # define EVP_KDF_CTRL_RESET_HKDF_INFO 0x09
57 # define EVP_KDF_CTRL_ADD_HKDF_INFO 0x0a /* unsigned char *, size_t */
58 # define EVP_KDF_CTRL_SET_HKDF_MODE 0x0b /* int */
59 # define EVP_KDF_CTRL_SET_SCRYPT_N 0x0c /* uint64_t */
60 # define EVP_KDF_CTRL_SET_SCRYPT_R 0x0d /* uint32_t */
61 # define EVP_KDF_CTRL_SET_SCRYPT_P 0x0e /* uint32_t */
62 # define EVP_KDF_CTRL_SET_SSHKDF_XCGHASH 0x0f /* unsigned char *, size_t */
63 # define EVP_KDF_CTRL_SET_SSHKDF_SESSION_ID 0x10 /* unsigned char *, size_t */
64 # define EVP_KDF_CTRL_SET_SSHKDF_TYPE 0x11 /* int */
65 # define EVP_KDF_CTRL_SET_MAC 0x12 /* EVP_MAC * */
66 # define EVP_KDF_CTRL_SET_MAC_SIZE 0x13 /* size_t */
67 # define EVP_KDF_CTRL_SET_SSKDF_INFO 0x14 /* unsigned char *, size_t */
68 # define EVP_KDF_CTRL_SET_PBKDF2_PKCS5_MODE 0x15 /* int */
69 # define EVP_KDF_CTRL_SET_UKM 0x16 /* unsigned char *, size_t */
70 # define EVP_KDF_CTRL_SET_CEK_ALG 0x17 /* char * */
71 # define EVP_KDF_CTRL_SET_SHARED_INFO EVP_KDF_CTRL_SET_SSKDF_INFO
73 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND 0
74 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY 1
75 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY 2
77 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV 65
78 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI 66
79 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
80 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
81 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV 69
82 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI 70
84 /**** The legacy PKEY-based KDF API follows. ****/
86 # define EVP_PKEY_CTRL_TLS_MD (EVP_PKEY_ALG_CTRL)
87 # define EVP_PKEY_CTRL_TLS_SECRET (EVP_PKEY_ALG_CTRL + 1)
88 # define EVP_PKEY_CTRL_TLS_SEED (EVP_PKEY_ALG_CTRL + 2)
89 # define EVP_PKEY_CTRL_HKDF_MD (EVP_PKEY_ALG_CTRL + 3)
90 # define EVP_PKEY_CTRL_HKDF_SALT (EVP_PKEY_ALG_CTRL + 4)
91 # define EVP_PKEY_CTRL_HKDF_KEY (EVP_PKEY_ALG_CTRL + 5)
92 # define EVP_PKEY_CTRL_HKDF_INFO (EVP_PKEY_ALG_CTRL + 6)
93 # define EVP_PKEY_CTRL_HKDF_MODE (EVP_PKEY_ALG_CTRL + 7)
94 # define EVP_PKEY_CTRL_PASS (EVP_PKEY_ALG_CTRL + 8)
95 # define EVP_PKEY_CTRL_SCRYPT_SALT (EVP_PKEY_ALG_CTRL + 9)
96 # define EVP_PKEY_CTRL_SCRYPT_N (EVP_PKEY_ALG_CTRL + 10)
97 # define EVP_PKEY_CTRL_SCRYPT_R (EVP_PKEY_ALG_CTRL + 11)
98 # define EVP_PKEY_CTRL_SCRYPT_P (EVP_PKEY_ALG_CTRL + 12)
99 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES (EVP_PKEY_ALG_CTRL + 13)
101 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
102 EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
103 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY \
104 EVP_KDF_HKDF_MODE_EXTRACT_ONLY
105 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY \
106 EVP_KDF_HKDF_MODE_EXPAND_ONLY
108 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
109 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
110 EVP_PKEY_CTRL_TLS_MD, 0, (void *)(md))
112 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
113 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
114 EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)(sec))
116 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
117 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
118 EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)(seed))
120 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
121 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
122 EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
124 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
125 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
126 EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
128 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
129 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
130 EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
132 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
133 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
134 EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
136 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
137 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
138 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
140 # define EVP_PKEY_CTX_set1_pbe_pass(pctx, pass, passlen) \
141 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
142 EVP_PKEY_CTRL_PASS, passlen, (void *)(pass))
144 # define EVP_PKEY_CTX_set1_scrypt_salt(pctx, salt, saltlen) \
145 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
146 EVP_PKEY_CTRL_SCRYPT_SALT, saltlen, (void *)(salt))
148 # define EVP_PKEY_CTX_set_scrypt_N(pctx, n) \
149 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
150 EVP_PKEY_CTRL_SCRYPT_N, n)
152 # define EVP_PKEY_CTX_set_scrypt_r(pctx, r) \
153 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
154 EVP_PKEY_CTRL_SCRYPT_R, r)
156 # define EVP_PKEY_CTX_set_scrypt_p(pctx, p) \
157 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
158 EVP_PKEY_CTRL_SCRYPT_P, p)
160 # define EVP_PKEY_CTX_set_scrypt_maxmem_bytes(pctx, maxmem_bytes) \
161 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
162 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, maxmem_bytes)