Add KDF error codes
[openssl.git] / include / openssl / kdf.h
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  */
53
54 #ifndef HEADER_KDF_H
55 # define HEADER_KDF_H
56
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 # define EVP_PKEY_CTRL_TLS_MD       (EVP_PKEY_ALG_CTRL)
62 # define EVP_PKEY_CTRL_TLS_SECRET   (EVP_PKEY_ALG_CTRL + 1)
63 # define EVP_PKEY_CTRL_TLS_SEED     (EVP_PKEY_ALG_CTRL + 2)
64
65 # define EVP_PKEY_CTX_set_tls1_prf_md(pctx, md) \
66             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
67                               EVP_PKEY_CTRL_TLS_MD, 0, (void *)md)
68
69 # define EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, sec, seclen) \
70             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
71                               EVP_PKEY_CTRL_TLS_SECRET, seclen, (void *)sec)
72
73 # define EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, seed, seedlen) \
74             EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DERIVE, \
75                               EVP_PKEY_CTRL_TLS_SEED, seedlen, (void *)seed)
76
77 /* BEGIN ERROR CODES */
78 /*
79  * The following lines are auto generated by the script mkerr.pl. Any changes
80  * made after this point may be overwritten when the script is next run.
81  */
82 void ERR_load_KDF_strings(void);
83
84 /* Error codes for the KDF functions. */
85
86 /* Function codes. */
87 # define KDF_F_PKEY_TLS1_PRF_CTRL_STR                     100
88 # define KDF_F_PKEY_TLS1_PRF_DERIVE                       101
89
90 /* Reason codes. */
91 # define KDF_R_INVALID_DIGEST                             100
92 # define KDF_R_MISSING_PARAMETER                          101
93 # define KDF_R_VALUE_MISSING                              102
94
95 #ifdef  __cplusplus
96 }
97 #endif
98 #endif