libwebsockets
Lightweight C library for HTML5 websockets
lws-secure-streams-transport-proxy.h
Go to the documentation of this file.
1/*
2 * libwebsockets - small server side websockets and web server implementation
3 *
4 * Copyright (C) 2019 - 2021 Andy Green <andy@warmcat.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22 * IN THE SOFTWARE.
23 *
24 *
25 * These headers are related to providing user Secure Streams Serialization
26 * transport implementations in user code.
27 *
28 * The default implementation uses wsi for proxy serving and connecting clients,
29 * but it's also possible to provide user implementations of the operations
30 * needed to serve on a different transport for proxy, and to connect out on
31 * the different transport for client.
32 *
33 * You can provide your own lws_sss_ops_client_t and lws_sss_ops_proxy_t to
34 * control how serialized data is transmitted and received, to use SS
35 * serialization over, eg, UART instead.
36 *
37 * This allows situations where full SS proxy services can be offered to much
38 * weker devices, without any networking stack or tls library being needed.
39 */
40
41/*
42 * SSS Proxy Transport-related implementation apis
43 */
44
45struct lws_sss_proxy_conn;