]>
git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/kdf.h
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
11 # define OPENSSL_KDF_H
14 # include <openssl/macros.h>
21 # include <openssl/types.h>
22 # include <openssl/core.h>
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
);
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_is_a(const EVP_KDF
*kdf
, const char *name
);
37 const OSSL_PROVIDER
*EVP_KDF_provider(const EVP_KDF
*kdf
);
38 const EVP_KDF
*EVP_KDF_CTX_kdf(EVP_KDF_CTX
*ctx
);
40 void EVP_KDF_reset(EVP_KDF_CTX
*ctx
);
41 size_t EVP_KDF_size(EVP_KDF_CTX
*ctx
);
42 int EVP_KDF_derive(EVP_KDF_CTX
*ctx
, unsigned char *key
, size_t keylen
);
43 int EVP_KDF_get_params(EVP_KDF
*kdf
, OSSL_PARAM params
[]);
44 int EVP_KDF_CTX_get_params(EVP_KDF_CTX
*ctx
, OSSL_PARAM params
[]);
45 int EVP_KDF_CTX_set_params(EVP_KDF_CTX
*ctx
, const OSSL_PARAM params
[]);
46 const OSSL_PARAM
*EVP_KDF_gettable_params(const EVP_KDF
*kdf
);
47 const OSSL_PARAM
*EVP_KDF_gettable_ctx_params(const EVP_KDF
*kdf
);
48 const OSSL_PARAM
*EVP_KDF_settable_ctx_params(const EVP_KDF
*kdf
);
50 void EVP_KDF_do_all_provided(OPENSSL_CTX
*libctx
,
51 void (*fn
)(EVP_KDF
*kdf
, void *arg
),
53 void EVP_KDF_names_do_all(const EVP_KDF
*kdf
,
54 void (*fn
)(const char *name
, void *data
),
57 # define EVP_KDF_CTRL_SET_PASS 0x01 /* unsigned char *, size_t */
58 # define EVP_KDF_CTRL_SET_SALT 0x02 /* unsigned char *, size_t */
59 # define EVP_KDF_CTRL_SET_ITER 0x03 /* int */
60 # define EVP_KDF_CTRL_SET_MD 0x04 /* EVP_MD * */
61 # define EVP_KDF_CTRL_SET_KEY 0x05 /* unsigned char *, size_t */
62 # define EVP_KDF_CTRL_SET_MAXMEM_BYTES 0x06 /* uint64_t */
63 # define EVP_KDF_CTRL_SET_TLS_SECRET 0x07 /* unsigned char *, size_t */
64 # define EVP_KDF_CTRL_ADD_TLS_SEED 0x08 /* unsigned char *, size_t */
65 # define EVP_KDF_CTRL_RESET_HKDF_INFO 0x09
66 # define EVP_KDF_CTRL_ADD_HKDF_INFO 0x0a /* unsigned char *, size_t */
67 # define EVP_KDF_CTRL_SET_HKDF_MODE 0x0b /* int */
68 # define EVP_KDF_CTRL_SET_SCRYPT_N 0x0c /* uint64_t */
69 # define EVP_KDF_CTRL_SET_SCRYPT_R 0x0d /* uint32_t */
70 # define EVP_KDF_CTRL_SET_SCRYPT_P 0x0e /* uint32_t */
71 # define EVP_KDF_CTRL_SET_SSHKDF_XCGHASH 0x0f /* unsigned char *, size_t */
72 # define EVP_KDF_CTRL_SET_SSHKDF_SESSION_ID 0x10 /* unsigned char *, size_t */
73 # define EVP_KDF_CTRL_SET_SSHKDF_TYPE 0x11 /* int */
74 # define EVP_KDF_CTRL_SET_MAC 0x12 /* EVP_MAC * */
75 # define EVP_KDF_CTRL_SET_MAC_SIZE 0x13 /* size_t */
76 # define EVP_KDF_CTRL_SET_SSKDF_INFO 0x14 /* unsigned char *, size_t */
77 # define EVP_KDF_CTRL_SET_PBKDF2_PKCS5_MODE 0x15 /* int */
78 # define EVP_KDF_CTRL_SET_UKM 0x16 /* unsigned char *, size_t */
79 # define EVP_KDF_CTRL_SET_CEK_ALG 0x17 /* char * */
80 # define EVP_KDF_CTRL_SET_SHARED_INFO EVP_KDF_CTRL_SET_SSKDF_INFO
82 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND 0
83 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY 1
84 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY 2
86 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV 65
87 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI 66
88 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
89 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
90 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV 69
91 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI 70
93 /**** The legacy PKEY-based KDF API follows. ****/
95 # define EVP_PKEY_CTRL_TLS_MD (EVP_PKEY_ALG_CTRL)
96 # define EVP_PKEY_CTRL_TLS_SECRET (EVP_PKEY_ALG_CTRL + 1)
97 # define EVP_PKEY_CTRL_TLS_SEED (EVP_PKEY_ALG_CTRL + 2)
98 # define EVP_PKEY_CTRL_HKDF_MD (EVP_PKEY_ALG_CTRL + 3)
99 # define EVP_PKEY_CTRL_HKDF_SALT (EVP_PKEY_ALG_CTRL + 4)
100 # define EVP_PKEY_CTRL_HKDF_KEY (EVP_PKEY_ALG_CTRL + 5)
101 # define EVP_PKEY_CTRL_HKDF_INFO (EVP_PKEY_ALG_CTRL + 6)
102 # define EVP_PKEY_CTRL_HKDF_MODE (EVP_PKEY_ALG_CTRL + 7)
103 # define EVP_PKEY_CTRL_PASS (EVP_PKEY_ALG_CTRL + 8)
104 # define EVP_PKEY_CTRL_SCRYPT_SALT (EVP_PKEY_ALG_CTRL + 9)
105 # define EVP_PKEY_CTRL_SCRYPT_N (EVP_PKEY_ALG_CTRL + 10)
106 # define EVP_PKEY_CTRL_SCRYPT_R (EVP_PKEY_ALG_CTRL + 11)
107 # define EVP_PKEY_CTRL_SCRYPT_P (EVP_PKEY_ALG_CTRL + 12)
108 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES (EVP_PKEY_ALG_CTRL + 13)
110 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
111 EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
112 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY \
113 EVP_KDF_HKDF_MODE_EXTRACT_ONLY
114 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY \
115 EVP_KDF_HKDF_MODE_EXPAND_ONLY
117 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
118 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
119 EVP_PKEY_CTRL_TLS_MD, 0, (void *)(md))
121 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
122 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
123 EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)(sec))
125 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
126 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
127 EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)(seed))
129 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
130 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
131 EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
133 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
134 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
135 EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
137 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
138 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
139 EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
141 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
142 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
143 EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
145 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
146 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
147 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
149 # define EVP_PKEY_CTX_set1_pbe_pass(pctx, pass, passlen) \
150 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
151 EVP_PKEY_CTRL_PASS, passlen, (void *)(pass))
153 # define EVP_PKEY_CTX_set1_scrypt_salt(pctx, salt, saltlen) \
154 EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
155 EVP_PKEY_CTRL_SCRYPT_SALT, saltlen, (void *)(salt))
157 # define EVP_PKEY_CTX_set_scrypt_N(pctx, n) \
158 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
159 EVP_PKEY_CTRL_SCRYPT_N, n)
161 # define EVP_PKEY_CTX_set_scrypt_r(pctx, r) \
162 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
163 EVP_PKEY_CTRL_SCRYPT_R, r)
165 # define EVP_PKEY_CTX_set_scrypt_p(pctx, p) \
166 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
167 EVP_PKEY_CTRL_SCRYPT_P, p)
169 # define EVP_PKEY_CTX_set_scrypt_maxmem_bytes(pctx, maxmem_bytes) \
170 EVP_PKEY_CTX_ctrl_uint64(pctx, -1, EVP_PKEY_OP_DERIVE, \
171 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, maxmem_bytes)