• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * This file is part of the openHiTLS project.
3  *
4  * openHiTLS is licensed under the Mulan PSL v2.
5  * You can use this software according to the terms and conditions of the Mulan PSL v2.
6  * You may obtain a copy of Mulan PSL v2 at:
7  *
8  *     http://license.coscl.org.cn/MulanPSL2
9  *
10  * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11  * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12  * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13  * See the Mulan PSL v2 for more details.
14  */
15 
16 #ifndef HS_COOKIE_H
17 #define HS_COOKIE_H
18 
19 #include <stdint.h>
20 #include <stdbool.h>
21 #include "tls.h"
22 #include "hs_msg.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /**
29  * @brief Calculate the cookie
30  * The mackey is updated each time the number of times that Cookie_SECRET_LIFETIME is calculated.
31  *
32  * @param ctx [IN] Handshake context
33  * @param clientHello [IN] Parsed clientHello structure
34  * @param cookie [OUT] Calculated cookie
35  * @param cookieLen [OUT] Calculated cookie length.
36  *
37  * @retval HITLS_SUCCESS succeeded.
38  * @retval For other error codes, see hitls_error.h.
39  */
40 int32_t HS_CalcCookie(TLS_Ctx *ctx, const ClientHelloMsg *clientHello, uint8_t *cookie, uint32_t *cookieLen);
41 
42 /**
43  * @brief Verify the cookie.
44  * If the first cookie verification fails, the previous mackey is used for verification again.
45  *
46  * @param ctx [IN] Handshake context
47  * @param clientHello [IN] Parsed clientHello structure
48  * @param isCookieValid [OUT] Indicates whether the verification is successful.
49  *
50  * @retval HITLS_SUCCESS succeeded.
51  * @retval For other error codes, see hitls_error.h.
52  */
53 int32_t HS_CheckCookie(TLS_Ctx *ctx, const ClientHelloMsg *clientHello, bool *isCookieValid);
54 
55 #ifdef __cplusplus
56 }
57 #endif /* end __cplusplus */
58 #endif /* end HS_COOKIE_H */
59