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
26 EVP_KDF_CTX *EVP_KDF_CTX_new_id(int id);
27 void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx);
29 void EVP_KDF_reset(EVP_KDF_CTX *ctx);
30 int EVP_KDF_ctrl(EVP_KDF_CTX *ctx, int cmd, ...);
31 int EVP_KDF_vctrl(EVP_KDF_CTX *ctx, int cmd, va_list args);
32 int EVP_KDF_ctrl_str(EVP_KDF_CTX *ctx, const char *type, const char *value);
33 size_t EVP_KDF_size(EVP_KDF_CTX *ctx);
34 int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen);
37 # define EVP_KDF_CTRL_SET_PASS 0x01 /* unsigned char *, size_t */
38 # define EVP_KDF_CTRL_SET_SALT 0x02 /* unsigned char *, size_t */
39 # define EVP_KDF_CTRL_SET_ITER 0x03 /* int */
40 # define EVP_KDF_CTRL_SET_MD 0x04 /* EVP_MD * */
41 # define EVP_KDF_CTRL_SET_KEY 0x05 /* unsigned char *, size_t */
42 # define EVP_KDF_CTRL_SET_MAXMEM_BYTES 0x06 /* uint64_t */
43 # define EVP_KDF_CTRL_SET_TLS_SECRET 0x07 /* unsigned char *, size_t */
44 # define EVP_KDF_CTRL_RESET_TLS_SEED 0x08
45 # define EVP_KDF_CTRL_ADD_TLS_SEED 0x09 /* unsigned char *, size_t */
46 # define EVP_KDF_CTRL_RESET_HKDF_INFO 0x0a
47 # define EVP_KDF_CTRL_ADD_HKDF_INFO 0x0b /* unsigned char *, size_t */
48 # define EVP_KDF_CTRL_SET_HKDF_MODE 0x0c /* int */
49 # define EVP_KDF_CTRL_SET_SCRYPT_N 0x0d /* uint64_t */
50 # define EVP_KDF_CTRL_SET_SCRYPT_R 0x0e /* uint32_t */
51 # define EVP_KDF_CTRL_SET_SCRYPT_P 0x0f /* uint32_t */
53 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND 0
54 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY 1
55 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY 2
58 /**** The legacy PKEY-based KDF API follows. ****/
60 # define EVP_PKEY_CTRL_TLS_MD (EVP_PKEY_ALG_CTRL)
61 # define EVP_PKEY_CTRL_TLS_SECRET (EVP_PKEY_ALG_CTRL + 1)
62 # define EVP_PKEY_CTRL_TLS_SEED (EVP_PKEY_ALG_CTRL + 2)
63 # define EVP_PKEY_CTRL_HKDF_MD (EVP_PKEY_ALG_CTRL + 3)
64 # define EVP_PKEY_CTRL_HKDF_SALT (EVP_PKEY_ALG_CTRL + 4)
65 # define EVP_PKEY_CTRL_HKDF_KEY (EVP_PKEY_ALG_CTRL + 5)
66 # define EVP_PKEY_CTRL_HKDF_INFO (EVP_PKEY_ALG_CTRL + 6)
67 # define EVP_PKEY_CTRL_HKDF_MODE (EVP_PKEY_ALG_CTRL + 7)
68 # define EVP_PKEY_CTRL_PASS (EVP_PKEY_ALG_CTRL + 8)
69 # define EVP_PKEY_CTRL_SCRYPT_SALT (EVP_PKEY_ALG_CTRL + 9)
70 # define EVP_PKEY_CTRL_SCRYPT_N (EVP_PKEY_ALG_CTRL + 10)
71 # define EVP_PKEY_CTRL_SCRYPT_R (EVP_PKEY_ALG_CTRL + 11)
72 # define EVP_PKEY_CTRL_SCRYPT_P (EVP_PKEY_ALG_CTRL + 12)
73 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES (EVP_PKEY_ALG_CTRL + 13)
75 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
76 EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
77 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY \
78 EVP_KDF_HKDF_MODE_EXTRACT_ONLY
79 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY \
80 EVP_KDF_HKDF_MODE_EXPAND_ONLY
82 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
83 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
84 EVP_PKEY_CTRL_TLS_MD, 0, (void *)(md))
86 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
87 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
88 EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)(sec))
90 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
91 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
92 EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)(seed))
94 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
95 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
96 EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
98 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
99 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
100 EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
102 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
103 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
104 EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
106 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
107 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
108 EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
110 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
111 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
112 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
114 # define EVP_PKEY_CTX_set1_pbe_pass(pctx, pass, passlen) \
115 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
116 EVP_PKEY_CTRL_PASS, passlen, (void *)(pass))
118 # define EVP_PKEY_CTX_set1_scrypt_salt(pctx, salt, saltlen) \
119 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
120 EVP_PKEY_CTRL_SCRYPT_SALT, saltlen, (void *)(salt))
122 # define EVP_PKEY_CTX_set_scrypt_N(pctx, n) \
123 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
124 EVP_PKEY_CTRL_SCRYPT_N, n)
126 # define EVP_PKEY_CTX_set_scrypt_r(pctx, r) \
127 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
128 EVP_PKEY_CTRL_SCRYPT_R, r)
130 # define EVP_PKEY_CTX_set_scrypt_p(pctx, p) \
131 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
132 EVP_PKEY_CTRL_SCRYPT_P, p)
134 # define EVP_PKEY_CTX_set_scrypt_maxmem_bytes(pctx, maxmem_bytes) \
135 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
136 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, maxmem_bytes)