]>
git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/kdf.h
2 * Copyright 2016-2021 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>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
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(OSSL_LIB_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_number(const EVP_KDF
*kdf
);
37 const char *EVP_KDF_description(const EVP_KDF
*kdf
);
38 int EVP_KDF_is_a(const EVP_KDF
*kdf
, const char *name
);
39 const char *EVP_KDF_name(const EVP_KDF
*kdf
);
40 const OSSL_PROVIDER
*EVP_KDF_provider(const EVP_KDF
*kdf
);
41 const EVP_KDF
*EVP_KDF_CTX_kdf(EVP_KDF_CTX
*ctx
);
43 void EVP_KDF_CTX_reset(EVP_KDF_CTX
*ctx
);
44 size_t EVP_KDF_CTX_get_kdf_size(EVP_KDF_CTX
*ctx
);
45 int EVP_KDF_derive(EVP_KDF_CTX
*ctx
, unsigned char *key
, size_t keylen
,
46 const OSSL_PARAM params
[]);
47 int EVP_KDF_get_params(EVP_KDF
*kdf
, OSSL_PARAM params
[]);
48 int EVP_KDF_CTX_get_params(EVP_KDF_CTX
*ctx
, OSSL_PARAM params
[]);
49 int EVP_KDF_CTX_set_params(EVP_KDF_CTX
*ctx
, const OSSL_PARAM params
[]);
50 const OSSL_PARAM
*EVP_KDF_gettable_params(const EVP_KDF
*kdf
);
51 const OSSL_PARAM
*EVP_KDF_gettable_ctx_params(const EVP_KDF
*kdf
);
52 const OSSL_PARAM
*EVP_KDF_settable_ctx_params(const EVP_KDF
*kdf
);
53 const OSSL_PARAM
*EVP_KDF_CTX_gettable_params(EVP_KDF_CTX
*ctx
);
54 const OSSL_PARAM
*EVP_KDF_CTX_settable_params(EVP_KDF_CTX
*ctx
);
56 void EVP_KDF_do_all_provided(OSSL_LIB_CTX
*libctx
,
57 void (*fn
)(EVP_KDF
*kdf
, void *arg
),
59 int EVP_KDF_names_do_all(const EVP_KDF
*kdf
,
60 void (*fn
)(const char *name
, void *data
),
63 # define EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND 0
64 # define EVP_KDF_HKDF_MODE_EXTRACT_ONLY 1
65 # define EVP_KDF_HKDF_MODE_EXPAND_ONLY 2
67 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_CLI_TO_SRV 65
68 #define EVP_KDF_SSHKDF_TYPE_INITIAL_IV_SRV_TO_CLI 66
69 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_CLI_TO_SRV 67
70 #define EVP_KDF_SSHKDF_TYPE_ENCRYPTION_KEY_SRV_TO_CLI 68
71 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_CLI_TO_SRV 69
72 #define EVP_KDF_SSHKDF_TYPE_INTEGRITY_KEY_SRV_TO_CLI 70
74 /**** The legacy PKEY-based KDF API follows. ****/
76 # define EVP_PKEY_CTRL_TLS_MD (EVP_PKEY_ALG_CTRL)
77 # define EVP_PKEY_CTRL_TLS_SECRET (EVP_PKEY_ALG_CTRL + 1)
78 # define EVP_PKEY_CTRL_TLS_SEED (EVP_PKEY_ALG_CTRL + 2)
79 # define EVP_PKEY_CTRL_HKDF_MD (EVP_PKEY_ALG_CTRL + 3)
80 # define EVP_PKEY_CTRL_HKDF_SALT (EVP_PKEY_ALG_CTRL + 4)
81 # define EVP_PKEY_CTRL_HKDF_KEY (EVP_PKEY_ALG_CTRL + 5)
82 # define EVP_PKEY_CTRL_HKDF_INFO (EVP_PKEY_ALG_CTRL + 6)
83 # define EVP_PKEY_CTRL_HKDF_MODE (EVP_PKEY_ALG_CTRL + 7)
84 # define EVP_PKEY_CTRL_PASS (EVP_PKEY_ALG_CTRL + 8)
85 # define EVP_PKEY_CTRL_SCRYPT_SALT (EVP_PKEY_ALG_CTRL + 9)
86 # define EVP_PKEY_CTRL_SCRYPT_N (EVP_PKEY_ALG_CTRL + 10)
87 # define EVP_PKEY_CTRL_SCRYPT_R (EVP_PKEY_ALG_CTRL + 11)
88 # define EVP_PKEY_CTRL_SCRYPT_P (EVP_PKEY_ALG_CTRL + 12)
89 # define EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES (EVP_PKEY_ALG_CTRL + 13)
91 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND \
92 EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
93 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY \
94 EVP_KDF_HKDF_MODE_EXTRACT_ONLY
95 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY \
96 EVP_KDF_HKDF_MODE_EXPAND_ONLY
98 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
);
100 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX
*pctx
,
101 const unsigned char *sec
, int seclen
);
103 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX
*pctx
,
104 const unsigned char *seed
, int seedlen
);
106 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
);
108 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX
*ctx
,
109 const unsigned char *salt
, int saltlen
);
111 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX
*ctx
,
112 const unsigned char *key
, int keylen
);
114 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX
*ctx
,
115 const unsigned char *info
, int infolen
);
117 int EVP_PKEY_CTX_hkdf_mode(EVP_PKEY_CTX
*ctx
, int mode
);
119 int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX
*ctx
, const char *pass
,
122 int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX
*ctx
,
123 const unsigned char *salt
, int saltlen
);
125 int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX
*ctx
, uint64_t n
);
127 int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX
*ctx
, uint64_t r
);
129 int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX
*ctx
, uint64_t p
);
131 int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX
*ctx
,
132 uint64_t maxmem_bytes
);