1 /*	$OpenBSD: kdf.h,v 1.8 2022/07/12 14:42:49 kn Exp $ */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
4  * project.
5  */
6 /* ====================================================================
7  * Copyright (c) 2016-2018 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  */
54 
55 #ifndef HEADER_KDF_H
56 # define HEADER_KDF_H
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 # define EVP_PKEY_CTRL_HKDF_MD                  (EVP_PKEY_ALG_CTRL + 3)
63 # define EVP_PKEY_CTRL_HKDF_SALT                (EVP_PKEY_ALG_CTRL + 4)
64 # define EVP_PKEY_CTRL_HKDF_KEY                 (EVP_PKEY_ALG_CTRL + 5)
65 # define EVP_PKEY_CTRL_HKDF_INFO                (EVP_PKEY_ALG_CTRL + 6)
66 # define EVP_PKEY_CTRL_HKDF_MODE                (EVP_PKEY_ALG_CTRL + 7)
67 
68 # define EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND 0
69 # define EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY       1
70 # define EVP_PKEY_HKDEF_MODE_EXPAND_ONLY        2
71 
72 # define EVP_PKEY_CTX_set_hkdf_md(pctx, md) \
73             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
74                               EVP_PKEY_CTRL_HKDF_MD, 0, (void *)(md))
75 
76 # define EVP_PKEY_CTX_set1_hkdf_salt(pctx, salt, saltlen) \
77             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
78                               EVP_PKEY_CTRL_HKDF_SALT, saltlen, (void *)(salt))
79 
80 # define EVP_PKEY_CTX_set1_hkdf_key(pctx, key, keylen) \
81             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
82                               EVP_PKEY_CTRL_HKDF_KEY, keylen, (void *)(key))
83 
84 # define EVP_PKEY_CTX_add1_hkdf_info(pctx, info, infolen) \
85             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
86                               EVP_PKEY_CTRL_HKDF_INFO, infolen, (void *)(info))
87 
88 # define EVP_PKEY_CTX_hkdf_mode(pctx, mode) \
89             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
90                               EVP_PKEY_CTRL_HKDF_MODE, mode, NULL)
91 
92 int ERR_load_KDF_strings(void);
93 
94 /*
95  * KDF function codes.
96  */
97 # define KDF_F_PKEY_HKDF_CTRL_STR                         103
98 # define KDF_F_PKEY_HKDF_DERIVE                           102
99 # define KDF_F_PKEY_HKDF_INIT                             108
100 
101 /*
102  * KDF reason codes.
103  */
104 # define KDF_R_MISSING_KEY                                104
105 # define KDF_R_MISSING_MESSAGE_DIGEST                     105
106 # define KDF_R_UNKNOWN_PARAMETER_TYPE                     103
107 
108 # ifdef  __cplusplus
109 }
110 # endif
111 #endif
112