Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
altcp_tls.h
Go to the documentation of this file.
1 /**
2  * @file
3  * Application layered TCP/TLS connection API (to be used from TCPIP thread)
4  *
5  * @defgroup altcp_tls TLS layer
6  * @ingroup altcp
7  * This file contains function prototypes for a TLS layer.
8  * A port to ARM mbedtls is provided in the apps/ tree
9  * (LWIP_ALTCP_TLS_MBEDTLS option).
10  */
11 
12 /*
13  * Copyright (c) 2017 Simon Goldschmidt
14  * All rights reserved.
15  *
16  * Redistribution and use in source and binary forms, with or without modification,
17  * are permitted provided that the following conditions are met:
18  *
19  * 1. Redistributions of source code must retain the above copyright notice,
20  * this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright notice,
22  * this list of conditions and the following disclaimer in the documentation
23  * and/or other materials provided with the distribution.
24  * 3. The name of the author may not be used to endorse or promote products
25  * derived from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
28  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
29  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
30  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
32  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
35  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
36  * OF SUCH DAMAGE.
37  *
38  * This file is part of the lwIP TCP/IP stack.
39  *
40  * Author: Simon Goldschmidt <goldsimon@gmx.de>
41  *
42  */
43 #ifndef LWIP_HDR_ALTCP_TLS_H
44 #define LWIP_HDR_ALTCP_TLS_H
45 
46 #include "lwip/opt.h"
47 
48 #if LWIP_ALTCP /* don't build if not configured for use in lwipopts.h */
49 
50 #if LWIP_ALTCP_TLS
51 
52 #include "lwip/altcp.h"
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /** @ingroup altcp_tls
59  * ALTCP_TLS configuration handle, content depends on port (e.g. mbedtls)
60  */
61 struct altcp_tls_config;
62 
63 /** @ingroup altcp_tls
64  * Create an ALTCP_TLS server configuration handle
65  */
66 struct altcp_tls_config *altcp_tls_create_config_server_privkey_cert(const u8_t *privkey, size_t privkey_len,
67  const u8_t *privkey_pass, size_t privkey_pass_len,
68  const u8_t *cert, size_t cert_len);
69 
70 /** @ingroup altcp_tls
71  * Create an ALTCP_TLS client configuration handle
72  */
73 struct altcp_tls_config *altcp_tls_create_config_client(const u8_t *cert, size_t cert_len);
74 
75 /** @ingroup altcp_tls
76  * Create an ALTCP_TLS client configuration handle with two-way server/client authentication
77  */
78 struct altcp_tls_config *altcp_tls_create_config_client_2wayauth(const u8_t *ca, size_t ca_len, const u8_t *privkey, size_t privkey_len,
79  const u8_t *privkey_pass, size_t privkey_pass_len,
80  const u8_t *cert, size_t cert_len);
81 
82 /** @ingroup altcp_tls
83  * Free an ALTCP_TLS configuration handle
84  */
85 void altcp_tls_free_config(struct altcp_tls_config *conf);
86 
87 /** @ingroup altcp_tls
88  * Create new ALTCP_TLS layer wrapping an existing pcb as inner connection (e.g. TLS over TCP)
89  */
90 struct altcp_pcb *altcp_tls_wrap(struct altcp_tls_config *config, struct altcp_pcb *inner_pcb);
91 
92 /** @ingroup altcp_tls
93  * Create new ALTCP_TLS pcb and its inner tcp pcb
94  */
95 struct altcp_pcb *altcp_tls_new(struct altcp_tls_config *config, u8_t ip_type);
96 
97 /** @ingroup altcp_tls
98  * Create new ALTCP_TLS layer pcb and its inner tcp pcb.
99  * Same as @ref altcp_tls_new but this allocator function fits to
100  * @ref altcp_allocator_t / @ref altcp_new.\n
101  'arg' must contain a struct altcp_tls_config *.
102  */
103 struct altcp_pcb *altcp_tls_alloc(void *arg, u8_t ip_type);
104 
105 /** @ingroup altcp_tls
106  * Return pointer to internal TLS context so application can tweak it.
107  * Real type depends on port (e.g. mbedtls)
108  */
109 void *altcp_tls_context(struct altcp_pcb *conn);
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif /* LWIP_ALTCP_TLS */
116 #endif /* LWIP_ALTCP */
117 #endif /* LWIP_HDR_ALTCP_TLS_H */
opt.h
lwIP Options Configuration
altcp.h
Application layered TCP connection API (to be used from TCPIP thread) .
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.