1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-16 00:00:07 +01:00
libwebsockets/lib/secure-streams/protocols
Andy Green 33da902ed4 ss: policy: response code mapping
This adds a per-streamtype JSON mapping table in the policy.

In addition to the previous flow, it lets you generate custom
SS state notifications for specific http response codes, eg:

   "http_resp_map": [ { "530": 1530 }, { "531": 1531 } ],

It's not recommended to overload the transport-layer response
code with application layer responses.  It's better to return
a 200 and then in the application protocol inside http, explain
what happened from the application perspective, usually with
JSON.  But this is designed to let you handle existing systems
that do overload the transport layer response code.

SS states for user use start at LWSSSCS_USER_BASE, which is
1000.

You can do a basic test with minimal-secure-streams and --respmap
flag, this will go to httpbin.org and get a 404, and the warmcat.com
policy has the mapping for 404 -> LWSSSCS_USER_BASE (1000).

Since the mapping emits states, these are serialized and handled
like any other state in the proxy case.

The policy2c example / tool is also updated to handle the additional
mapping tables.
2020-09-16 13:10:26 +01:00
..
README.md client: secure streams 2020-03-04 12:17:49 +00:00
ss-h1.c ss: policy: response code mapping 2020-09-16 13:10:26 +01:00
ss-h2.c ss: improve callback return consistency 2020-08-31 16:51:37 +01:00
ss-mqtt.c ss: improve callback return consistency 2020-08-31 16:51:37 +01:00
ss-raw.c ss: improve callback return consistency 2020-08-31 16:51:37 +01:00
ss-ws.c ss: improve callback return consistency 2020-08-31 16:51:37 +01:00

Lws Protocol bindings for Secure Streams

This directory contains the code wiring up normal lws protocols to Secure Streams.

The lws_protocols callback

This is the normal lws struct lws_protocols callback that handles events and traffic on the lws protocol being supported.

The various events and traffic are converted into calls using the Secure Streams api, and Secure Streams events.

The connect_munge helper

Different protocols have different semantics in the arguments to the client connect function, this protocol-specific helper is called to munge the connect_info struct to match the details of the protocol selected.

The ss->policy->aux string is used to hold protocol-specific information passed in the from the policy, eg, the URL path or websockets subprotocol name.

The (library-private) ss_pcols export

Each protocol binding exports two things to other parts of lws (they are not exported to user code)

  • a struct lws_protocols, including a pointer to the callback

  • a struct ss_pcols describing how secure_streams should use, including a pointer to the related connect_munge helper.

In ./lib/core-net/vhost.c, enabled protocols are added to vhost protcols lists so they may be used. And in ./lib/secure-streams/secure-streams.c, enabled struct ss_pcols are listed and checked for matches when the user creates a new Secure Stream.