Update HKDF to support separte Extract and Expand steps
[openssl.git] / include / openssl / kdf.h
1 /*
2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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
8  */
9
10 #ifndef HEADER_KDF_H
11 # define HEADER_KDF_H
12
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16
17 # define EVP_PKEY_CTRL_TLS_MD                   (EVP_PKEY_ALG_CTRL)
18 # define EVP_PKEY_CTRL_TLS_SECRET               (EVP_PKEY_ALG_CTRL + 1)
19 # define EVP_PKEY_CTRL_TLS_SEED                 (EVP_PKEY_ALG_CTRL + 2)
20 # define EVP_PKEY_CTRL_HKDF_MD                  (EVP_PKEY_ALG_CTRL + 3)
21 # define EVP_PKEY_CTRL_HKDF_SALT                (EVP_PKEY_ALG_CTRL + 4)
22 # define EVP_PKEY_CTRL_HKDF_KEY                 (EVP_PKEY_ALG_CTRL + 5)
23 # define EVP_PKEY_CTRL_HKDF_INFO                (EVP_PKEY_ALG_CTRL + 6)
24 # define EVP_PKEY_CTRL_HKDF_MODE                (EVP_PKEY_ALG_CTRL + 7)
25
26 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND 0
27 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY       1
28 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY        2
29
30 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
31             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
32                               EVP_PKEY_CTRL_TLS_MD, 0, (void *)md)
33
34 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
35             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
36                               EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)sec)
37
38 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
39             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
40                               EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)seed)
41
42 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
43             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
44                               EVP_PKEY_CTRL_HKDF_MD, 0, (void *)md)
45
46 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
47             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
48                               EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)salt)
49
50 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
51             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
52                               EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)key)
53
54 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
55             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
56                               EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)info)
57
58 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
59             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
60                               EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
61
62 /* BEGIN ERROR CODES */
63 /*
64  * The following lines are auto generated by the script mkerr.pl. Any changes
65  * made after this point may be overwritten when the script is next run.
66  */
67
68 int ERR_load_KDF_strings(void);
69
70 /* Error codes for the KDF functions. */
71
72 /* Function codes. */
73 # define KDF_F_PKEY_TLS1_PRF_CTRL_STR                     100
74 # define KDF_F_PKEY_TLS1_PRF_DERIVE                       101
75
76 /* Reason codes. */
77 # define KDF_R_INVALID_DIGEST                             100
78 # define KDF_R_MISSING_PARAMETER                          101
79 # define KDF_R_VALUE_MISSING                              102
80
81 # ifdef  __cplusplus
82 }
83 # endif
84 #endif