libwebsockets
Lightweight C library for HTML5 websockets
|
Modules | |
Vhost mounts and options | |
Data Structures | |
struct | lws_context_creation_info |
struct | lws_protocol_vhost_options |
Macros | |
#define | lws_check_opt(c, f) (((c) & (f)) == (f)) |
Typedefs | |
typedef int(* | lws_reload_func) (void) |
Functions | |
LWS_VISIBLE LWS_EXTERN struct lws_context * | lws_create_context (const struct lws_context_creation_info *info) |
LWS_VISIBLE LWS_EXTERN void | lws_context_destroy (struct lws_context *context) |
LWS_VISIBLE LWS_EXTERN void | lws_context_deprecate (struct lws_context *context, lws_reload_func cb) |
LWS_VISIBLE LWS_EXTERN int | lws_context_is_deprecated (struct lws_context *context) |
LWS_VISIBLE LWS_EXTERN int | lws_set_proxy (struct lws_vhost *vhost, const char *proxy) |
LWS_VISIBLE LWS_EXTERN int | lws_set_socks (struct lws_vhost *vhost, const char *socks) |
LWS_VISIBLE LWS_EXTERN struct lws_vhost * | lws_create_vhost (struct lws_context *context, const struct lws_context_creation_info *info) |
LWS_VISIBLE LWS_EXTERN void | lws_vhost_destroy (struct lws_vhost *vh) |
LWS_VISIBLE LWS_EXTERN int | lwsws_get_config_globals (struct lws_context_creation_info *info, const char *d, char **config_strings, int *len) |
LWS_VISIBLE LWS_EXTERN int | lwsws_get_config_vhosts (struct lws_context *context, struct lws_context_creation_info *info, const char *d, char **config_strings, int *len) |
LWS_VISIBLE LWS_EXTERN struct lws_vhost * | lws_vhost_get (struct lws *wsi) LWS_WARN_DEPRECATED |
LWS_VISIBLE LWS_EXTERN struct lws_vhost * | lws_get_vhost (struct lws *wsi) |
LWS_VISIBLE const LWS_EXTERN char * | lws_get_vhost_name (struct lws_vhost *vhost) |
LWS_VISIBLE LWS_EXTERN int | lws_get_vhost_port (struct lws_vhost *vhost) |
LWS_VISIBLE LWS_EXTERN void * | lws_get_vhost_user (struct lws_vhost *vhost) |
LWS_VISIBLE const LWS_EXTERN char * | lws_get_vhost_iface (struct lws_vhost *vhost) |
LWS_VISIBLE LWS_EXTERN int | lws_json_dump_vhost (const struct lws_vhost *vh, char *buf, int len) |
LWS_VISIBLE LWS_EXTERN int | lws_json_dump_context (const struct lws_context *context, char *buf, int len, int hide_vhosts) |
LWS_VISIBLE LWS_EXTERN void * | lws_vhost_user (struct lws_vhost *vhost) |
LWS_VISIBLE LWS_EXTERN void * | lws_context_user (struct lws_context *context) |
LWS requires that there is one context, in which you may define multiple vhosts. Each vhost is a virtual host, with either its own listen port or sharing an existing one. Each vhost has its own SSL context that can be set up individually or left disabled.
If you don't care about multiple "site" support, you can ignore it and lws will create a single default vhost at context creation time.
enum lws_context_options |
#include <include/libwebsockets/lws-context-vhost.h>
enum lws_context_options - context and vhost options
Enumerator | |
---|---|
LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT | (VH) Don't allow the connection unless the client has a client cert that we recognize; provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT |
LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME | (CTX) Don't try to get the server's hostname |
LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT | (VH) Allow non-SSL (plaintext) connections on the same port as SSL is listening... undermines the security of SSL; provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT |
LWS_SERVER_OPTION_LIBEV | (CTX) Use libev event loop |
LWS_SERVER_OPTION_DISABLE_IPV6 | (VH) Disable IPV6 support |
LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS | (VH) Don't load OS CA certs, you will need to load your own CA cert(s) |
LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED | (VH) Accept connections with no valid Cert (eg, selfsigned) |
LWS_SERVER_OPTION_VALIDATE_UTF8 | (VH) Check UT-8 correctness |
LWS_SERVER_OPTION_SSL_ECDH | (VH) initialize ECDH ciphers |
LWS_SERVER_OPTION_LIBUV | (CTX) Use libuv event loop |
LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS | (VH) Use http redirect to force http to https (deprecated: use mount redirection) |
LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT | (CTX) Initialize the SSL library at all |
LWS_SERVER_OPTION_EXPLICIT_VHOSTS | (CTX) Only create the context when calling context create api, implies user code will create its own vhosts |
LWS_SERVER_OPTION_UNIX_SOCK | (VH) Use Unix socket |
LWS_SERVER_OPTION_STS | (VH) Send Strict Transport Security header, making clients subsequently go to https even if user asked for http |
LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY | (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect |
LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE | (VH) if set, only ipv6 allowed on the vhost |
LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN | (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault normally makes the lib spin so you can attach a debugger to it even if it happened without a debugger in place. You can disable that by giving this option. |
LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN | For backwards-compatibility reasons, by default lws prepends "http://" to the origin you give in the client connection info struct. If you give this flag when you create the context, only the string you give in the client connect info for .origin (if any) will be used directly. |
LWS_SERVER_OPTION_FALLBACK_TO_RAW | (VH) if invalid http is coming in the first line, |
LWS_SERVER_OPTION_LIBEVENT | (CTX) Use libevent event loop |
LWS_SERVER_OPTION_ONLY_RAW | (VH) All connections to this vhost / port are RAW as soon as the connection is accepted, no HTTP is going to be coming. |
LWS_SERVER_OPTION_ALLOW_LISTEN_SHARE | (VH) Set to allow multiple listen sockets on one interface + address + port. The default is to strictly allow only one listen socket at a time. This is automatically selected if you have multiple service threads. |
LWS_SERVER_OPTION_CREATE_VHOST_SSL_CTX | (VH) Force setting up the vhost SSL_CTX, even though the user code doesn't explicitly provide a cert in the info struct. It implies the user code is going to provide a cert at the LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS callback, which provides the vhost SSL_CTX * in the user parameter. |
LWS_SERVER_OPTION_SKIP_PROTOCOL_INIT | (VH) You probably don't want this. It forces this vhost to not call LWS_CALLBACK_PROTOCOL_INIT on its protocols. It's used in the special case of a temporary vhost bound to a single protocol. |
LWS_SERVER_OPTION_IGNORE_MISSING_CERT | (VH) Don't fail if the vhost TLS cert or key are missing, just continue. The vhost won't be able to serve anything, but if for example the ACME plugin was configured to fetch a cert, this lets you bootstrap your vhost from having no cert to start with. |
LWS_SERVER_OPTION_VHOST_UPG_STRICT_HOST_CHECK | (VH) On this vhost, if the connection is being upgraded, insist that there's a Host: header and that the contents match the vhost name + port (443 / 80 are assumed if no :port given based on if the connection is using TLS). By default, without this flag, on upgrade lws just checks that the Host: header was given without checking the contents... this is to allow lax hostname mappings like localhost / 127.0.0.1, and CNAME mappings like www.mysite.com / mysite.com |
LWS_SERVER_OPTION_HTTP_HEADERS_SECURITY_BEST_PRACTICES_ENFORCE | (VH) Send lws default HTTP headers recommended by Mozilla Observatory for security. This is a helper option that sends canned headers on each http response enabling a VERY strict Content Security Policy. The policy is so strict, for example it won't let the page run its own inline JS nor show images or take CSS from a different server. In many cases your JS only comes from your server as do the image sources and CSS, so that is what you want... attackers hoping to inject JS into your DOM are completely out of luck since even if they succeed, it will be rejected for execution by the browser according to the strict CSP. In other cases you have to deviate from the complete strictness, in which case don't use this flag: use the .headers member in the vhost init described in struct lws_context_creation_info instead to send the adapted headers yourself. |
LWS_VISIBLE LWS_EXTERN void lws_context_deprecate | ( | struct lws_context * | context, |
lws_reload_func | cb | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_context_deprecate() - Deprecate the websocket context
context | Websocket context |
cb | Callback notified when old context listen sockets are closed This function is used on an existing context before superceding it with a new context. It closes any listen sockets in the context, so new connections are not possible. And it marks the context to be deleted when the number of active connections into it falls to zero. This is aimed at allowing seamless configuration reloads. The callback cb will be called after the listen sockets are actually closed and may be reopened. In the callback the new context should be configured and created. (With libuv, socket close happens async after more loop events). |
LWS_VISIBLE LWS_EXTERN void lws_context_destroy | ( | struct lws_context * | context | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_context_destroy() - Destroy the websocket context
context | Websocket context This function closes any active connections and then frees the context. After calling this, any further use of the context is undefined. |
LWS_VISIBLE LWS_EXTERN void* lws_context_user | ( | struct lws_context * | context | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_context_user() - get the user data associated with the context
context | Websocket context |
This returns the optional user allocation that can be attached to the context the sockets live in at context_create time. It's a way to let all sockets serviced in the same context share data without using globals statics in the user code.
LWS_VISIBLE LWS_EXTERN struct lws_context* lws_create_context | ( | const struct lws_context_creation_info * | info | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_create_context() - Create the websocket handler
info | pointer to struct with parameters This function creates the listening socket (if serving) and takes care of all initialization in one step. If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is created; you're expected to create your own vhosts afterwards using lws_create_vhost(). Otherwise a vhost named "default" is also created using the information in the vhost-related members, for compatibility. After initialization, it returns a struct lws_context * that represents this server. After calling, user code needs to take care of calling lws_service() with the context pointer to get the server's sockets serviced. This must be done in the same process context as the initialization call. The protocol callback functions are called for a handful of events including http requests coming in, websocket connections becoming established, and data arriving; it's also called periodically to allow async transmission. HTTP requests are sent always to the FIRST protocol in protocol, since at that time websocket protocol has not been negotiated. Other protocols after the first one never see any HTTP callback activity. The server created is a simple http server by default; part of the websocket standard is upgrading this http connection to a websocket one. This allows the same server to provide files like scripts and favicon / images or whatever over http and dynamic data over websockets all in one place; they're all handled in the user callback. |
LWS_VISIBLE LWS_EXTERN struct lws_vhost* lws_create_vhost | ( | struct lws_context * | context, |
const struct lws_context_creation_info * | info | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_create_vhost() - Create a vhost (virtual server context)
context | pointer to result of lws_create_context() |
info | pointer to struct with parameters |
This function creates a virtual server (vhost) using the vhost-related members of the info struct. You can create many vhosts inside one context if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
LWS_VISIBLE LWS_EXTERN struct lws_vhost* lws_get_vhost | ( | struct lws * | wsi | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_get_vhost() - return the vhost a wsi belongs to
wsi | which connection |
LWS_VISIBLE const LWS_EXTERN char* lws_get_vhost_iface | ( | struct lws_vhost * | vhost | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_get_vhost_iface() - returns the binding for the vhost listen socket
vhost | which vhost |
LWS_VISIBLE const LWS_EXTERN char* lws_get_vhost_name | ( | struct lws_vhost * | vhost | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_get_vhost_name() - returns the name of a vhost
vhost | which vhost |
LWS_VISIBLE LWS_EXTERN int lws_get_vhost_port | ( | struct lws_vhost * | vhost | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_get_vhost_port() - returns the port a vhost listens on, or -1
vhost | which vhost |
LWS_VISIBLE LWS_EXTERN void* lws_get_vhost_user | ( | struct lws_vhost * | vhost | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_get_vhost_user() - returns the user pointer for the vhost
vhost | which vhost |
LWS_VISIBLE LWS_EXTERN int lws_json_dump_context | ( | const struct lws_context * | context, |
char * | buf, | ||
int | len, | ||
int | hide_vhosts | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_json_dump_context() - describe context state and stats in JSON
context | the context |
buf | buffer to fill with JSON |
len | max length of buf |
hide_vhosts | nonzero to not provide per-vhost mount etc information |
Generates a JSON description of vhost state into buf
LWS_VISIBLE LWS_EXTERN int lws_json_dump_vhost | ( | const struct lws_vhost * | vh, |
char * | buf, | ||
int | len | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_json_dump_vhost() - describe vhost state and stats in JSON
vh | the vhost |
buf | buffer to fill with JSON |
len | max length of buf |
LWS_VISIBLE LWS_EXTERN int lws_set_proxy | ( | struct lws_vhost * | vhost, |
const char * | proxy | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_set_proxy() - Setups proxy to lws_context.
vhost | pointer to struct lws_vhost you want set proxy for |
proxy | pointer to c string containing proxy in format address:port |
Returns 0 if proxy string was parsed and proxy was setup. Returns -1 if proxy is NULL or has incorrect format.
This is only required if your OS does not provide the http_proxy environment variable (eg, OSX)
IMPORTANT! You should call this function right after creation of the lws_context and before call to connect. If you call this function after connect behavior is undefined. This function will override proxy settings made on lws_context creation with genenv() call.
LWS_VISIBLE LWS_EXTERN int lws_set_socks | ( | struct lws_vhost * | vhost, |
const char * | socks | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_set_socks() - Setup socks to lws_context.
vhost | pointer to struct lws_vhost you want set socks for |
socks | pointer to c string containing socks in format address:port |
Returns 0 if socks string was parsed and socks was setup. Returns -1 if socks is NULL or has incorrect format.
This is only required if your OS does not provide the socks_proxy environment variable (eg, OSX)
IMPORTANT! You should call this function right after creation of the lws_context and before call to connect. If you call this function after connect behavior is undefined. This function will override proxy settings made on lws_context creation with genenv() call.
LWS_VISIBLE LWS_EXTERN void lws_vhost_destroy | ( | struct lws_vhost * | vh | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_vhost_destroy() - Destroy a vhost (virtual server context)
vh | pointer to result of lws_create_vhost() |
This function destroys a vhost. Normally, if you just want to exit, then lws_destroy_context() will take care of everything. If you want to destroy an individual vhost and all connections and allocations, you can do it with this.
If the vhost has a listen sockets shared by other vhosts, it will be given to one of the vhosts sharing it rather than closed.
The vhost close is staged according to the needs of the event loop, and if there are multiple service threads. At the point the vhost itself if about to be freed, if you provided a finalize callback and optional arg at vhost creation time, it will be called just before the vhost is freed.
LWS_VISIBLE LWS_EXTERN struct lws_vhost* lws_vhost_get | ( | struct lws * | wsi | ) |
#include <include/libwebsockets/lws-context-vhost.h>
LWS_VISIBLE LWS_EXTERN void* lws_vhost_user | ( | struct lws_vhost * | vhost | ) |
#include <include/libwebsockets/lws-context-vhost.h>
lws_vhost_user() - get the user data associated with the vhost
vhost | Websocket vhost |
This returns the optional user pointer that can be attached to a vhost when it was created. Lws never dereferences this pointer, it only sets it when the vhost is created, and returns it using this api.
LWS_VISIBLE LWS_EXTERN int lwsws_get_config_globals | ( | struct lws_context_creation_info * | info, |
const char * | d, | ||
char ** | config_strings, | ||
int * | len | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lwsws_get_config_globals() - Parse a JSON server config file
info | pointer to struct with parameters |
d | filepath of the config file |
config_strings | storage for the config strings extracted from JSON, the pointer is incremented as strings are stored |
len | pointer to the remaining length left in config_strings the value is decremented as strings are stored |
This function prepares a n lws_context_creation_info struct with global settings from a file d.
Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
LWS_VISIBLE LWS_EXTERN int lwsws_get_config_vhosts | ( | struct lws_context * | context, |
struct lws_context_creation_info * | info, | ||
const char * | d, | ||
char ** | config_strings, | ||
int * | len | ||
) |
#include <include/libwebsockets/lws-context-vhost.h>
lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
context | pointer to result of lws_create_context() |
info | pointer to struct with parameters |
d | filepath of the config file |
config_strings | storage for the config strings extracted from JSON, the pointer is incremented as strings are stored |
len | pointer to the remaining length left in config_strings the value is decremented as strings are stored |
This function creates vhosts into a context according to the settings in JSON files found in directory d.
Requires CMake option LWS_WITH_LEJP_CONF to have been enabled