libwebsockets/lib/secure-streams/protocols/README.md
Andy Green 28ce32af64 client: secure streams
Secure Streams is an optional layer on top of lws that separates policy
like endpoint selection and tls cert validation into a device JSON
policy document.

Code that wants to open a client connection just specifies a streamtype name,
and no longer deals with details like the endpoint, the protocol (!) or anything
else other than payloads and optionally generic metadata; the JSON policy
contains all the details for each streamtype.  h1, h2, ws and mqtt client
connections are supported.

Logical secure streams outlive any particular connection and supports "nailed-up"
connectivity regardless of underlying connection stability.
2020-03-04 12:17:49 +00:00

1.3 KiB

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.