2 * Copyright 2016-2018 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/kdferr.h>
21 # define EVP_KDF_PBKDF2 NID_id_pbkdf2
22 # define EVP_KDF_SCRYPT NID_id_scrypt
23 # define EVP_KDF_TLS1_PRF NID_tls1_prf
24 # define EVP_KDF_HKDF NID_hkdf
25 # define EVP_KDF_SSHKDF NID_sshkdf
26 # define EVP_KDF_SS NID_sskdf
28 EVP_KDF_CTX *EVP_KDF_CTX_new_id(int id);
29 EVP_KDF_CTX *EVP_KDF_CTX_new(const EVP_KDF *kdf);
30 void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx);
31 const EVP_KDF *EVP_KDF_CTX_kdf(EVP_KDF_CTX *ctx);
33 void EVP_KDF_reset(EVP_KDF_CTX *ctx);
34 int EVP_KDF_ctrl(EVP_KDF_CTX *ctx, int cmd, ...);
35 int EVP_KDF_vctrl(EVP_KDF_CTX *ctx, int cmd, va_list args);
36 int EVP_KDF_ctrl_str(EVP_KDF_CTX *ctx, const char *type, const char *value);
37 size_t EVP_KDF_size(EVP_KDF_CTX *ctx);
38 int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen);
40 int EVP_KDF_nid(const EVP_KDF *kdf);
41 # define EVP_get_kdfbynid(a) EVP_get_kdfbyname(OBJ_nid2sn(a))
42 # define EVP_get_kdfbyobj(a) EVP_get_kdfbynid(OBJ_obj2nid(a))
43 # define EVP_KDF_name(o) OBJ_nid2sn(EVP_KDF_nid(o))
44 const EVP_KDF *EVP_get_kdfbyname(const char *name);
46 # define EVP_KDF_CTRL_SET_PASS 0x01 /* unsigned char *, size_t */
47 # define EVP_KDF_CTRL_SET_SALT 0x02 /* unsigned char *, size_t */
48 # define EVP_KDF_CTRL_SET_ITER 0x03 /* int */
49 # define EVP_KDF_CTRL_SET_MD 0x04 /* EVP_MD * */
50 # define EVP_KDF_CTRL_SET_KEY 0x05 /* unsigned char *, size_t */
51 # define EVP_KDF_CTRL_SET_MAXMEM_BYTES 0x06 /* uint64_t */
52 # define EVP_KDF_CTRL_SET_TLS_SECRET 0x07 /* unsigned char *, size_t */
53 # define EVP_KDF_CTRL_RESET_TLS_SEED 0x08
54 # define EVP_KDF_CTRL_ADD_TLS_SEED 0x09 /* unsigned char *, size_t */
55 # define EVP_KDF_CTRL_RESET_HKDF_INFO 0x0a
56 # define EVP_KDF_CTRL_ADD_HKDF_INFO 0x0b /* unsigned char *, size_t */
57 # define EVP_KDF_CTRL_SET_HKDF_MODE 0x0c /* int */
58 # define EVP_KDF_CTRL_SET_SCRYPT_N 0x0d /* uint64_t */
59 # define EVP_KDF_CTRL_SET_SCRYPT_R 0x0e /* uint32_t */
60 # define EVP_KDF_CTRL_SET_SCRYPT_P 0x0f /* uint32_t */
61 # define EVP_KDF_CTRL_SET_SSHKDF_XCGHASH 0x10 /* unsigned char *, size_t */
62 # define EVP_KDF_CTRL_SET_SSHKDF_SESSION_ID 0x11 /* unsigned char *, size_t */
63 # define EVP_KDF_CTRL_SET_SSHKDF_TYPE 0x12 /* int */
64 # define EVP_KDF_CTRL_SET_MAC 0x13 /* EVP_MAC * */
65 # define EVP_KDF_CTRL_SET_MAC_SIZE 0x14 /* size_t */
66 # define EVP_KDF_CTRL_SET_SSKDF_INFO 0x15 /* unsigned char *, size_t */
68 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND 0
69 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY 1
70 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY 2
72 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV 65
73 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI 66
74 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
75 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
76 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV 69
77 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI 70
79 /**** The legacy PKEY-based KDF API follows. ****/
81 # define EVP_PKEY_CTRL_TLS_MD (EVP_PKEY_ALG_CTRL)
82 # define EVP_PKEY_CTRL_TLS_SECRET (EVP_PKEY_ALG_CTRL + 1)
83 # define EVP_PKEY_CTRL_TLS_SEED (EVP_PKEY_ALG_CTRL + 2)
84 # define EVP_PKEY_CTRL_HKDF_MD (EVP_PKEY_ALG_CTRL + 3)
85 # define EVP_PKEY_CTRL_HKDF_SALT (EVP_PKEY_ALG_CTRL + 4)
86 # define EVP_PKEY_CTRL_HKDF_KEY (EVP_PKEY_ALG_CTRL + 5)
87 # define EVP_PKEY_CTRL_HKDF_INFO (EVP_PKEY_ALG_CTRL + 6)
88 # define EVP_PKEY_CTRL_HKDF_MODE (EVP_PKEY_ALG_CTRL + 7)
89 # define EVP_PKEY_CTRL_PASS (EVP_PKEY_ALG_CTRL + 8)
90 # define EVP_PKEY_CTRL_SCRYPT_SALT (EVP_PKEY_ALG_CTRL + 9)
91 # define EVP_PKEY_CTRL_SCRYPT_N (EVP_PKEY_ALG_CTRL + 10)
92 # define EVP_PKEY_CTRL_SCRYPT_R (EVP_PKEY_ALG_CTRL + 11)
93 # define EVP_PKEY_CTRL_SCRYPT_P (EVP_PKEY_ALG_CTRL + 12)
94 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES (EVP_PKEY_ALG_CTRL + 13)
96 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
97 EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
98 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY \
99 EVP_KDF_HKDF_MODE_EXTRACT_ONLY
100 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY \
101 EVP_KDF_HKDF_MODE_EXPAND_ONLY
103 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
104 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
105 EVP_PKEY_CTRL_TLS_MD, 0, (void *)(md))
107 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
108 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
109 EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)(sec))
111 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
112 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
113 EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)(seed))
115 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
116 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
117 EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
119 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
120 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
121 EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
123 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
124 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
125 EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
127 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
128 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
129 EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
131 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
132 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
133 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
135 # define EVP_PKEY_CTX_set1_pbe_pass(pctx, pass, passlen) \
136 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
137 EVP_PKEY_CTRL_PASS, passlen, (void *)(pass))
139 # define EVP_PKEY_CTX_set1_scrypt_salt(pctx, salt, saltlen) \
140 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
141 EVP_PKEY_CTRL_SCRYPT_SALT, saltlen, (void *)(salt))
143 # define EVP_PKEY_CTX_set_scrypt_N(pctx, n) \
144 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
145 EVP_PKEY_CTRL_SCRYPT_N, n)
147 # define EVP_PKEY_CTX_set_scrypt_r(pctx, r) \
148 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
149 EVP_PKEY_CTRL_SCRYPT_R, r)
151 # define EVP_PKEY_CTX_set_scrypt_p(pctx, p) \
152 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
153 EVP_PKEY_CTRL_SCRYPT_P, p)
155 # define EVP_PKEY_CTX_set_scrypt_maxmem_bytes(pctx, maxmem_bytes) \
156 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
157 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, maxmem_bytes)