libwebsockets
Lightweight C library for HTML5 websockets
lws-secure-streams-policy.h
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  * included from libwebsockets.h
25  */
26 
27 typedef int (*plugin_auth_status_cb)(struct lws_ss_handle *ss, int status);
28 
54 #if defined(LWS_WITH_SSPLUGINS)
55 typedef struct lws_ss_plugin {
56  struct lws_ss_plugin *next;
57  const char *name;
58  size_t alloc;
60  int (*create)(struct lws_ss_handle *ss, void *info,
61  plugin_auth_status_cb status);
67  int (*destroy)(struct lws_ss_handle *ss);
71  int (*munge)(struct lws_ss_handle *ss, char *path,
72  size_t path_len);
77 } lws_ss_plugin_t;
78 #endif
79 
80 /* the public, const metrics policy definition */
81 
82 typedef struct lws_metric_policy {
83  /* order of first two mandated by JSON policy parsing scope union */
84  const struct lws_metric_policy *next;
85  const char *name;
86 
87  const char *report;
88 
90  uint64_t us_schedule;
93  uint32_t us_decay_unit;
98 
99 typedef struct lws_ss_x509 {
100  struct lws_ss_x509 *next;
101  const char *vhost_name;
102  const uint8_t *ca_der;
103  size_t ca_der_len;
104  uint8_t keep:1;
105 } lws_ss_x509_t;
106 
107 enum {
108  LWSSSPOLF_OPPORTUNISTIC = (1 << 0),
110  LWSSSPOLF_NAILED_UP = (1 << 1),
112  LWSSSPOLF_URGENT_TX = (1 << 2),
114  LWSSSPOLF_URGENT_RX = (1 << 3),
116  LWSSSPOLF_TLS = (1 << 4),
118  LWSSSPOLF_LONG_POLL = (1 << 5),
120  LWSSSPOLF_AUTH_BEARER = (1 << 6),
122  LWSSSPOLF_HTTP_NO_CONTENT_LENGTH = (1 << 7),
124  LWSSSPOLF_QUIRK_NGHTTP2_END_STREAM = (1 << 8),
126  LWSSSPOLF_H2_QUIRK_OVERFLOWS_TXCR = (1 << 9),
128  LWSSSPOLF_H2_QUIRK_UNCLEAN_HPACK_STATE = (1 << 10),
130  LWSSSPOLF_HTTP_MULTIPART = (1 << 11),
136  LWSSSPOLF_HTTP_X_WWW_FORM_URLENCODED = (1 << 12),
138  LWSSSPOLF_LOCAL_SINK = (1 << 13),
140  LWSSSPOLF_WAKE_SUSPEND__VALIDITY = (1 << 14),
144  LWSSSPOLF_SERVER = (1 << 15),
146  LWSSSPOLF_ALLOW_REDIRECTS = (1 << 16),
148  LWSSSPOLF_HTTP_MULTIPART_IN = (1 << 17),
151  LWSSSPOLF_ATTR_LOW_LATENCY = (1 << 18),
153  LWSSSPOLF_ATTR_HIGH_THROUGHPUT = (1 << 19),
155  LWSSSPOLF_ATTR_HIGH_RELIABILITY = (1 << 20),
157  LWSSSPOLF_ATTR_LOW_COST = (1 << 21),
159  LWSSSPOLF_PERF = (1 << 22),
161  LWSSSPOLF_DIRECT_PROTO_STR = (1 << 23),
164 };
165 
166 typedef struct lws_ss_trust_store {
167  struct lws_ss_trust_store *next;
168  const char *name;
169 
170  const lws_ss_x509_t *ssx509[6];
171  int count;
173 
174 enum {
175  LWSSSP_H1,
176  LWSSSP_H2,
177  LWSSSP_WS,
178  LWSSSP_MQTT,
179  LWSSSP_RAW,
180 
181 
182  LWSSS_HBI_AUTH = 0,
183  LWSSS_HBI_DSN,
184  LWSSS_HBI_FWV,
185  LWSSS_HBI_TYPE,
186 
187  _LWSSS_HBI_COUNT /* always last */
188 };
189 
190 /*
191  * This does for both the static policy metadata entry, and the runtime metadata
192  * handling object.
193  */
194 
195 typedef struct lws_ss_metadata {
196  struct lws_ss_metadata *next;
197  const char *name;
198  void *value__may_own_heap;
199  size_t length;
200 
201  uint8_t value_length; /* only valid if set by policy */
202  uint8_t value_is_http_token; /* valid if set by policy */
203 #if defined(LWS_WITH_SS_DIRECT_PROTOCOL_STR)
204  uint8_t name_on_lws_heap:1; /* proxy metatadata does this */
205 #endif
206  uint8_t value_on_lws_heap:1; /* proxy + rx metadata does this */
207 #if defined(LWS_WITH_SECURE_STREAMS_PROXY_API)
208  uint8_t pending_onward:1;
209 #endif
211 
212 typedef struct lws_ss_http_respmap {
213  uint16_t resp; /* the http response code */
214  uint16_t state; /* low 16-bits of associated state */
216 
217 /*
218  * This is a mapping between an auth streamtype and a name and other information
219  * that can be independently instantiated. Other streamtypes can indicate they
220  * require this authentication on their connection.
221  */
222 
223 typedef struct lws_ss_auth {
224  struct lws_ss_auth *next;
225  const char *name;
226 
227  const char *type;
228  const char *streamtype;
229  uint8_t blob_index;
230 } lws_ss_auth_t;
231 
245 typedef struct lws_ss_policy {
246  struct lws_ss_policy *next;
247  const char *streamtype;
249  const char *endpoint;
250  const char *rideshare_streamtype;
253  const char *payload_fmt;
254  const char *socks5_proxy;
255  lws_ss_metadata_t *metadata; /* linked-list of metadata */
256  const lws_metric_policy_t *metrics; /* linked-list of metric policies */
257  const lws_ss_auth_t *auth; /* NULL or auth object we bind to */
258 
259  /* protocol-specific connection policy details */
260 
261  union {
262 
263 #if defined(LWS_ROLE_H1) || defined(LWS_ROLE_H2) || defined(LWS_ROLE_WS)
264 
265  /* details for http-related protocols... */
266 
267  struct {
268 
269  /* common to all http-related protocols */
270 
271  const char *method;
272  const char *url;
273 
274  const char *multipart_name;
275  const char *multipart_filename;
276  const char *multipart_content_type;
277 
278  const char *blob_header[_LWSSS_HBI_COUNT];
279  const char *auth_preamble;
280 
281  const lws_ss_http_respmap_t *respmap;
282 
283  union {
284 // struct { /* LWSSSP_H1 */
285 // } h1;
286 // struct { /* LWSSSP_H2 */
287 // } h2;
288  struct { /* LWSSSP_WS */
289  const char *subprotocol;
290  uint8_t binary;
291  /* false = TEXT, true = BINARY */
292  } ws;
293  } u;
294 
295  uint16_t resp_expect;
296  uint8_t count_respmap;
297  uint8_t fail_redirect:1;
298  } http;
299 
300 #endif
301 
302 #if defined(LWS_ROLE_MQTT)
303 
304  struct {
305  const char *topic; /* stream sends on this topic */
306  const char *subscribe; /* stream subscribes to this topic */
307 
308  const char *will_topic;
309  const char *will_message;
310 
311  uint16_t keep_alive;
312  uint8_t qos;
313  uint8_t clean_start;
314  uint8_t will_qos;
315  uint8_t will_retain;
316  uint8_t aws_iot;
317 
318  } mqtt;
319 
320 #endif
321 
322  /* details for non-http related protocols... */
323  } u;
324 
325 #if defined(LWS_WITH_SSPLUGINS)
326  const
327  struct lws_ss_plugin *plugins[2];
328  const void *plugins_info[2];
329 #endif
330 
331 #if defined(LWS_WITH_SECURE_STREAMS_AUTH_SIGV4)
332  /* directly point to the metadata name, no need to expand */
333  const char *aws_region;
334  const char *aws_service;
335 #endif
336  /*
337  * We're either a client connection policy that wants a trust store,
338  * or we're a server policy that wants a mem cert and key... Hold
339  * these mutually-exclusive things in a union.
340  */
341 
342  union {
346  struct {
351  } server;
352  } trust;
353 
356  uint32_t proxy_buflen;
357  uint32_t proxy_buflen_rxflow_on_above;
358  uint32_t proxy_buflen_rxflow_off_below;
359 
360  uint32_t client_buflen;
361  uint32_t client_buflen_rxflow_on_above;
362  uint32_t client_buflen_rxflow_off_below;
363 
364 
365  uint32_t timeout_ms;
367  uint32_t flags;
369  uint16_t port;
371  uint8_t metadata_count;
372  uint8_t protocol;
373  uint8_t client_cert;
375  uint8_t priority; /* 0 = normal, 6 = max normal,
376  * 7 = network management */
378 
379 #if !defined(LWS_WITH_SECURE_STREAMS_STATIC_POLICY_ONLY)
380 
381 /*
382  * These only exist / have meaning if there's a dynamic JSON policy enabled
383  */
384 
385 LWS_VISIBLE LWS_EXTERN int
386 lws_ss_policy_parse_begin(struct lws_context *context, int overlay);
387 
388 LWS_VISIBLE LWS_EXTERN int
389 lws_ss_policy_parse_abandon(struct lws_context *context);
390 
391 LWS_VISIBLE LWS_EXTERN int
392 lws_ss_policy_parse(struct lws_context *context, const uint8_t *buf, size_t len);
393 
394 LWS_VISIBLE LWS_EXTERN int
395 lws_ss_policy_overlay(struct lws_context *context, const char *overlay);
396 
397 /*
398  * You almost certainly don't want these, they return the first policy or auth
399  * object in a linked-list of objects created by lws_ss_policy_parse above,
400  * they are exported to generate static policy with
401  */
402 LWS_VISIBLE LWS_EXTERN const lws_ss_policy_t *
403 lws_ss_policy_get(struct lws_context *context);
404 
405 LWS_VISIBLE LWS_EXTERN const lws_ss_auth_t *
406 lws_ss_auth_get(struct lws_context *context);
407 
408 #endif
Definition: lws-secure-streams-policy.h:82
uint32_t us_decay_unit
Definition: lws-secure-streams-policy.h:93
uint8_t min_contributors
Definition: lws-secure-streams-policy.h:95
uint64_t us_schedule
Definition: lws-secure-streams-policy.h:90
const char * report
Definition: lws-secure-streams-policy.h:87
Definition: lws-retry.h:25
Definition: lws-secure-streams-policy.h:223
Definition: lws-secure-streams-policy.h:212
Definition: lws-secure-streams-policy.h:195
Definition: lws-secure-streams-policy.h:245
uint32_t flags
Definition: lws-secure-streams-policy.h:367
uint8_t metadata_count
Definition: lws-secure-streams-policy.h:371
uint32_t timeout_ms
Definition: lws-secure-streams-policy.h:365
const lws_ss_x509_t * cert
Definition: lws-secure-streams-policy.h:347
const char * streamtype
Definition: lws-secure-streams-policy.h:247
const char * rideshare_streamtype
Definition: lws-secure-streams-policy.h:250
uint8_t client_cert
Definition: lws-secure-streams-policy.h:373
const char * endpoint
Definition: lws-secure-streams-policy.h:249
const lws_ss_trust_store_t * store
Definition: lws-secure-streams-policy.h:343
const lws_retry_bo_t * retry_bo
Definition: lws-secure-streams-policy.h:354
uint16_t port
Definition: lws-secure-streams-policy.h:369
uint8_t protocol
Definition: lws-secure-streams-policy.h:372
uint32_t client_buflen
Definition: lws-secure-streams-policy.h:360
const lws_ss_x509_t * key
Definition: lws-secure-streams-policy.h:349
uint32_t proxy_buflen
Definition: lws-secure-streams-policy.h:356
Definition: lws-secure-streams-policy.h:166
Definition: lws-secure-streams-policy.h:99
uint8_t keep
Definition: lws-secure-streams-policy.h:104
size_t ca_der_len
Definition: lws-secure-streams-policy.h:103
const uint8_t * ca_der
Definition: lws-secure-streams-policy.h:102
const char * vhost_name
Definition: lws-secure-streams-policy.h:101