2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
24 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
25 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
36 #if defined(LWS_HAS_INTPTR_T)
38 #define lws_intptr_t intptr_t
40 typedef unsigned long long lws_intptr_t;
43 #if defined(LWS_WITH_ESP8266)
50 #include "lws_config.h"
52 #if defined(WIN32) || defined(_WIN32)
53 #ifndef WIN32_LEAN_AND_MEAN
54 #define WIN32_LEAN_AND_MEAN
64 #define _O_RDONLY 0x0000
65 #define O_RDONLY _O_RDONLY
68 // Visual studio older than 2015 and WIN_CE has only _stricmp
69 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
70 #define strcasecmp _stricmp
71 #elif !defined(__MINGW32__)
72 #define strcasecmp stricmp
74 #define getdtablesize() 30000
76 #define LWS_INLINE __inline
78 #define LWS_WARN_UNUSED_RESULT
79 #define LWS_WARN_DEPRECATED
80 #define LWS_FORMAT(string_index)
84 #define LWS_EXTERN extern __declspec(dllexport)
86 #define LWS_EXTERN extern __declspec(dllimport)
92 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
93 #define LWS_O_RDONLY _O_RDONLY
94 #define LWS_O_WRONLY _O_WRONLY
95 #define LWS_O_CREAT _O_CREAT
96 #define LWS_O_TRUNC _O_TRUNC
98 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
99 #define lws_snprintf _snprintf
103 #define __func__ __FUNCTION__
106 #if !defined(__MINGW32__) &&(!defined(_MSC_VER) || _MSC_VER < 1900) && !defined(snprintf)
107 #define snprintf(buf,len, format,...) _snprintf_s(buf, len,len, format, __VA_ARGS__)
110 #else /* NOT WIN32 */
112 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
113 #include <sys/capability.h>
116 #if defined(__NetBSD__) || defined(__FreeBSD__)
117 #include <netinet/in.h>
120 #define LWS_INLINE inline
121 #define LWS_O_RDONLY O_RDONLY
122 #define LWS_O_WRONLY O_WRONLY
123 #define LWS_O_CREAT O_CREAT
124 #define LWS_O_TRUNC O_TRUNC
126 #if !defined(LWS_WITH_ESP8266) && !defined(OPTEE_TA) && !defined(LWS_WITH_ESP32)
129 #define LWS_INVALID_FILE -1
131 #define getdtablesize() (30)
132 #if defined(LWS_WITH_ESP32)
133 #define LWS_INVALID_FILE NULL
135 #define LWS_INVALID_FILE NULL
139 #if defined(__GNUC__)
141 /* warn_unused_result attribute only supported by GCC 3.4 or later */
142 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
143 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
145 #define LWS_WARN_UNUSED_RESULT
148 #define LWS_VISIBLE __attribute__((visibility("default")))
149 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
150 #define LWS_FORMAT(string_index) __attribute__ ((format(printf, string_index, string_index+1)))
153 #define LWS_WARN_UNUSED_RESULT
154 #define LWS_WARN_DEPRECATED
155 #define LWS_FORMAT(string_index)
158 #if defined(__ANDROID__)
160 #define getdtablesize() sysconf(_SC_OPEN_MAX)
167 #endif /* LWS_USE_LIBEV */
170 #ifdef LWS_HAVE_UV_VERSION_H
171 #include <uv-version.h>
173 #endif /* LWS_USE_LIBUV */
174 #ifdef LWS_USE_LIBEVENT
175 #include <event2/event.h>
176 #endif /* LWS_USE_LIBEVENT */
179 #define LWS_EXTERN extern
185 #if !defined(OPTEE_TA)
186 #include <sys/time.h>
191 #ifdef LWS_OPENSSL_SUPPORT
194 #ifdef USE_OLD_CYASSL
195 #include <cyassl/openssl/ssl.h>
196 #include <cyassl/error-ssl.h>
198 #include <wolfssl/openssl/ssl.h>
199 #include <wolfssl/error-ssl.h>
200 #endif /* not USE_OLD_CYASSL */
202 #include <openssl/ssl.h>
203 #if !defined(LWS_WITH_ESP32)
204 #include <openssl/err.h>
206 #endif /* not USE_WOLFSSL */
210 #define CONTEXT_PORT_NO_LISTEN -1
211 #define CONTEXT_PORT_NO_LISTEN_SERVER -2
213 /** \defgroup log Logging
217 * Lws provides flexible and filterable logging facilities, which can be
218 * used inside lws and in user code.
220 * Log categories may be individually filtered bitwise, and directed to built-in
221 * sinks for syslog-compatible logging, or a user-defined function.
225 enum lws_log_levels {
235 LLL_LATENCY = 1 << 9,
238 LLL_COUNT = 11 /* set to count of valid flags */
241 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...) LWS_FORMAT(2);
242 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
244 * lwsl_timestamp: generate logging timestamp string
246 * \param level: logging level
247 * \param p: char * buffer to take timestamp
248 * \param len: length of p
250 * returns length written in p
252 LWS_VISIBLE LWS_EXTERN int
253 lwsl_timestamp(int level, char *p, int len);
255 /* these guys are unconditionally included */
257 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
258 #define lwsl_user(...) _lws_log(LLL_USER, __VA_ARGS__)
260 #if !defined(LWS_WITH_NO_LOGS)
261 /* notice and warn are usually included by being compiled in */
262 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
263 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
266 * weaker logging can be deselected by telling CMake to build in RELEASE mode
267 * that gets rid of the overhead of checking while keeping _warn and _err
271 #if defined(LWS_WITH_ESP8266)
276 #if defined(LWS_WITH_NO_LOGS)
277 /* notice, warn and log are always compiled in */
278 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
279 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
281 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
282 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
283 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
284 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
285 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
286 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
287 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
289 * lwsl_hexdump() - helper to hexdump a buffer (DEBUG builds only)
291 * \param buf: buffer start to dump
292 * \param len: length of buffer to dump
294 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
297 #if defined(LWS_WITH_NO_LOGS)
298 #define lwsl_warn(...) do {} while(0)
299 #define lwsl_notice(...) do {} while(0)
301 #define lwsl_info(...) do {} while(0)
302 #define lwsl_debug(...) do {} while(0)
303 #define lwsl_parser(...) do {} while(0)
304 #define lwsl_header(...) do {} while(0)
305 #define lwsl_ext(...) do {} while(0)
306 #define lwsl_client(...) do {} while(0)
307 #define lwsl_latency(...) do {} while(0)
308 #define lwsl_hexdump(a, b)
312 static LWS_INLINE int lws_is_be(void) {
313 const int probe = ~0xff;
315 return *(const char *)&probe;
319 * lws_set_log_level() - Set the logging bitfield
320 * \param level: OR together the LLL_ debug contexts you want output from
321 * \param log_emit_function: NULL to leave it as it is, or a user-supplied
322 * function to perform log string emission instead of
323 * the default stderr one.
325 * log level defaults to "err", "warn" and "notice" contexts enabled and
326 * emission on stderr.
328 LWS_VISIBLE LWS_EXTERN void
329 lws_set_log_level(int level,
330 void (*log_emit_function)(int level, const char *line));
333 * lwsl_emit_syslog() - helper log emit function writes to system log
335 * \param level: one of LLL_ log level indexes
336 * \param line: log string
338 * You use this by passing the function pointer to lws_set_log_level(), to set
339 * it as the log emit function, it is not called directly.
341 LWS_VISIBLE LWS_EXTERN void
342 lwsl_emit_syslog(int level, const char *line);
345 * lwsl_visible() - returns true if the log level should be printed
347 * \param level: one of LLL_ log level indexes
349 * This is useful if you have to do work to generate the log content, you
350 * can skip the work if the log level used to print it is not actually
351 * enabled at runtime.
353 LWS_VISIBLE LWS_EXTERN int
354 lwsl_visible(int level);
361 #ifndef lws_container_of
362 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
368 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
371 /* api change list for user code to test against */
373 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
375 /* the struct lws_protocols has the id field present */
376 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
378 /* you can call lws_get_peer_write_allowance */
379 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
381 /* extra parameter introduced in 917f43ab821 */
382 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
384 /* File operations stuff exists */
385 #define LWS_FEATURE_FOPS
389 typedef SOCKET lws_sockfd_type;
390 typedef HANDLE lws_filefd_type;
391 #define lws_sockfd_valid(sfd) (!!sfd)
393 lws_sockfd_type fd; /**< file descriptor */
394 SHORT events; /**< which events to respond to */
395 SHORT revents; /**< which events happened */
397 #define LWS_POLLHUP (FD_CLOSE)
398 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
399 #define LWS_POLLOUT (FD_WRITE)
403 #if defined(LWS_WITH_ESP8266)
405 #include <user_interface.h>
408 typedef struct espconn * lws_sockfd_type;
409 typedef void * lws_filefd_type;
410 #define lws_sockfd_valid(sfd) (!!sfd)
412 lws_sockfd_type fd; /**< fd related to */
413 short events; /**< which POLL... events to respond to */
414 short revents; /**< which POLL... events occurred */
416 #define POLLIN 0x0001
417 #define POLLPRI 0x0002
418 #define POLLOUT 0x0004
419 #define POLLERR 0x0008
420 #define POLLHUP 0x0010
421 #define POLLNVAL 0x0020
425 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
426 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
432 int ets_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
433 #define snprintf ets_snprintf
435 typedef os_timer_t uv_timer_t;
436 typedef void uv_cb_t(uv_timer_t *);
438 void os_timer_disarm(void *);
439 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
441 void ets_timer_arm_new(os_timer_t *, int, int, int);
443 //void os_timer_arm(os_timer_t *, int, int);
445 #define UV_VERSION_MAJOR 1
447 #define lws_uv_getloop(a, b) (NULL)
449 static inline void uv_timer_init(void *l, uv_timer_t *t)
452 memset(t, 0, sizeof(*t));
456 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
458 os_timer_setfn(t, (os_timer_func_t *)cb, t);
460 os_timer_arm(t, first, !!rep);
463 static inline void uv_timer_stop(uv_timer_t *t)
469 #if defined(LWS_WITH_ESP32)
471 typedef int lws_sockfd_type;
472 typedef int lws_filefd_type;
473 #define lws_sockfd_valid(sfd) (sfd >= 0)
475 lws_sockfd_type fd; /**< fd related to */
476 short events; /**< which POLL... events to respond to */
477 short revents; /**< which POLL... events occurred */
479 #define POLLIN 0x0001
480 #define POLLPRI 0x0002
481 #define POLLOUT 0x0004
482 #define POLLERR 0x0008
483 #define POLLHUP 0x0010
484 #define POLLNVAL 0x0020
486 #include <freertos/FreeRTOS.h>
487 #include <freertos/event_groups.h>
489 #include "esp_wifi.h"
490 #include "esp_system.h"
491 #include "esp_event.h"
492 #include "esp_event_loop.h"
494 #include "driver/gpio.h"
495 #include "esp_spi_flash.h"
496 #include "freertos/timers.h"
498 #if !defined(CONFIG_FREERTOS_HZ)
499 #define CONFIG_FREERTOS_HZ 100
502 typedef TimerHandle_t uv_timer_t;
503 typedef void uv_cb_t(uv_timer_t *);
504 typedef void * uv_handle_t;
506 struct timer_mapping {
511 #define UV_VERSION_MAJOR 1
513 #define lws_uv_getloop(a, b) (NULL)
515 static inline void uv_timer_init(void *l, uv_timer_t *t)
521 extern void esp32_uvtimer_cb(TimerHandle_t t);
523 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
525 struct timer_mapping *tm = (struct timer_mapping *)malloc(sizeof(*tm));
533 *t = xTimerCreate("x", pdMS_TO_TICKS(first), !!rep, tm,
534 (TimerCallbackFunction_t)esp32_uvtimer_cb);
538 static inline void uv_timer_stop(uv_timer_t *t)
543 static inline void uv_close(uv_handle_t *h, void *v)
545 free(pvTimerGetTimerID((uv_timer_t)h));
546 xTimerDelete(*(uv_timer_t *)h, 0);
549 /* ESP32 helper declarations */
552 #include <esp_partition.h>
554 #define LWS_PLUGIN_STATIC
555 #define LWS_MAGIC_REBOOT_TYPE_ADS 0x50001ffc
556 #define LWS_MAGIC_REBOOT_TYPE_REQ_FACTORY 0xb00bcafe
557 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY 0xfaceb00b
558 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY_BUTTON 0xf0cedfac
561 /* user code provides these */
564 lws_esp32_identify_physical_device(void);
566 /* lws-plat-esp32 provides these */
568 typedef void (*lws_cb_scan_done)(uint16_t count, wifi_ap_record_t *recs, void *arg);
571 LWSESP32_GENLED__INIT,
572 LWSESP32_GENLED__LOST_NETWORK,
573 LWSESP32_GENLED__NO_NETWORK,
574 LWSESP32_GENLED__CONN_AP,
575 LWSESP32_GENLED__GOT_IP,
579 struct lws_group_member {
580 struct lws_group_member *next;
587 struct ip4_addr addr;
588 struct ip6_addr addrv6;
592 #define LWS_SYSTEM_GROUP_MEMBER_ADD 1
593 #define LWS_SYSTEM_GROUP_MEMBER_CHANGE 2
594 #define LWS_SYSTEM_GROUP_MEMBER_REMOVE 3
596 #define LWS_GROUP_FLAG_SELF 1
608 char password[4][32];
609 char active_ssid[32];
618 enum genled_state genled;
621 lws_cb_scan_done scan_consumer;
622 void *scan_consumer_arg;
623 struct lws_group_member *first;
624 int extant_group_members;
627 struct lws_esp32_image {
634 extern struct lws_esp32 lws_esp32;
637 lws_esp32_event_passthru(void *ctx, system_event_t *event);
639 lws_esp32_wlan_config(void);
641 lws_esp32_wlan_start_ap(void);
643 lws_esp32_wlan_start_station(void);
644 struct lws_context_creation_info;
646 lws_esp32_set_creation_defaults(struct lws_context_creation_info *info);
647 extern struct lws_context *
648 lws_esp32_init(struct lws_context_creation_info *);
650 lws_esp32_wlan_nvs_get(int retry);
652 lws_nvs_set_str(nvs_handle handle, const char* key, const char* value);
654 lws_esp32_restart_guided(uint32_t type);
655 extern const esp_partition_t *
656 lws_esp_ota_get_boot_partition(void);
658 lws_esp32_get_image_info(const esp_partition_t *part, struct lws_esp32_image *i, char *json, int json_len);
660 lws_esp32_leds_network_indication(void);
662 extern uint32_t lws_esp32_get_reboot_type(void);
663 extern uint16_t lws_esp32_sine_interp(int n);
665 /* required in external code by esp32 plat (may just return if no leds) */
666 extern void lws_esp32_leds_timer_cb(TimerHandle_t th);
668 typedef int lws_sockfd_type;
669 typedef int lws_filefd_type;
670 #define lws_sockfd_valid(sfd) (sfd >= 0)
674 #define lws_pollfd pollfd
675 #define LWS_POLLHUP (POLLHUP|POLLERR)
676 #define LWS_POLLIN (POLLIN)
677 #define LWS_POLLOUT (POLLOUT)
681 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
683 #define ssize_t SSIZE_T
686 #if defined(WIN32) && defined(LWS_HAVE__STAT32I64)
687 #include <sys/types.h>
688 #include <sys/stat.h>
691 #if defined(LWS_HAVE_STDINT_H)
694 #if defined(WIN32) || defined(_WIN32)
696 typedef unsigned __int32 uint32_t;
697 typedef unsigned __int16 uint16_t;
698 typedef unsigned __int8 uint8_t;
700 typedef unsigned int uint32_t;
701 typedef unsigned short uint16_t;
702 typedef unsigned char uint8_t;
706 typedef unsigned long long lws_filepos_t;
707 typedef long long lws_fileofs_t;
708 typedef uint32_t lws_fop_flags_t;
710 /** struct lws_pollargs - argument structure for all external poll related calls
711 * passed in via 'in' */
712 struct lws_pollargs {
713 lws_sockfd_type fd; /**< applicable socket descriptor */
714 int events; /**< the new event mask */
715 int prev_events; /**< the previous event mask */
719 struct lws_token_limits;
721 /*! \defgroup wsclose Websocket Close
723 * ##Websocket close frame control
725 * When we close a ws connection, we can send a reason code and a short
726 * UTF-8 description back with the close packet.
731 * NOTE: These public enums are part of the abi. If you want to add one,
732 * add it at where specified so existing users are unaffected.
734 /** enum lws_close_status - RFC6455 close status codes */
735 enum lws_close_status {
736 LWS_CLOSE_STATUS_NOSTATUS = 0,
737 LWS_CLOSE_STATUS_NORMAL = 1000,
738 /**< 1000 indicates a normal closure, meaning that the purpose for
739 which the connection was established has been fulfilled. */
740 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
741 /**< 1001 indicates that an endpoint is "going away", such as a server
742 going down or a browser having navigated away from a page. */
743 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
744 /**< 1002 indicates that an endpoint is terminating the connection due
745 to a protocol error. */
746 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
747 /**< 1003 indicates that an endpoint is terminating the connection
748 because it has received a type of data it cannot accept (e.g., an
749 endpoint that understands only text data MAY send this if it
750 receives a binary message). */
751 LWS_CLOSE_STATUS_RESERVED = 1004,
752 /**< Reserved. The specific meaning might be defined in the future. */
753 LWS_CLOSE_STATUS_NO_STATUS = 1005,
754 /**< 1005 is a reserved value and MUST NOT be set as a status code in a
755 Close control frame by an endpoint. It is designated for use in
756 applications expecting a status code to indicate that no status
757 code was actually present. */
758 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
759 /**< 1006 is a reserved value and MUST NOT be set as a status code in a
760 Close control frame by an endpoint. It is designated for use in
761 applications expecting a status code to indicate that the
762 connection was closed abnormally, e.g., without sending or
763 receiving a Close control frame. */
764 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
765 /**< 1007 indicates that an endpoint is terminating the connection
766 because it has received data within a message that was not
767 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
768 data within a text message). */
769 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
770 /**< 1008 indicates that an endpoint is terminating the connection
771 because it has received a message that violates its policy. This
772 is a generic status code that can be returned when there is no
773 other more suitable status code (e.g., 1003 or 1009) or if there
774 is a need to hide specific details about the policy. */
775 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
776 /**< 1009 indicates that an endpoint is terminating the connection
777 because it has received a message that is too big for it to
779 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
780 /**< 1010 indicates that an endpoint (client) is terminating the
781 connection because it has expected the server to negotiate one or
782 more extension, but the server didn't return them in the response
783 message of the WebSocket handshake. The list of extensions that
784 are needed SHOULD appear in the /reason/ part of the Close frame.
785 Note that this status code is not used by the server, because it
786 can fail the WebSocket handshake instead */
787 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
788 /**< 1011 indicates that a server is terminating the connection because
789 it encountered an unexpected condition that prevented it from
790 fulfilling the request. */
791 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
792 /**< 1015 is a reserved value and MUST NOT be set as a status code in a
793 Close control frame by an endpoint. It is designated for use in
794 applications expecting a status code to indicate that the
795 connection was closed due to a failure to perform a TLS handshake
796 (e.g., the server certificate can't be verified). */
798 /****** add new things just above ---^ ******/
800 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
804 * lws_close_reason - Set reason and aux data to send with Close packet
805 * If you are going to return nonzero from the callback
806 * requesting the connection to close, you can optionally
807 * call this to set the reason the peer will be told if
810 * \param wsi: The websocket connection to set the close reason on
811 * \param status: A valid close status from websocket standard
812 * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data
813 * \param len: Length of data in \param buf to send
815 LWS_VISIBLE LWS_EXTERN void
816 lws_close_reason(struct lws *wsi, enum lws_close_status status,
817 unsigned char *buf, size_t len);
823 /* needed even with extensions disabled for create context */
824 struct lws_extension;
826 /*! \defgroup usercb User Callback
828 * ##User protocol callback
830 * The protocol callback is the primary way lws interacts with
831 * user code. For one of a list of a few dozen reasons the callback gets
832 * called at some event to be handled.
834 * All of the events can be ignored, returning 0 is taken as "OK" and returning
835 * nonzero in most cases indicates that the connection should be closed.
839 struct lws_ssl_info {
845 * NOTE: These public enums are part of the abi. If you want to add one,
846 * add it at where specified so existing users are unaffected.
848 /** enum lws_callback_reasons - reason you're getting a protocol callback */
849 enum lws_callback_reasons {
850 LWS_CALLBACK_ESTABLISHED = 0,
851 /**< (VH) after the server completes a handshake with an incoming
852 * client. If you built the library with ssl support, in is a
853 * pointer to the ssl struct associated with the connection or NULL.*/
854 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
855 /**< the request client connection has been unable to complete a
856 * handshake with the remote server. If in is non-NULL, you can
857 * find an error string of length len where it points to
859 * Diagnostic strings that may be returned include
861 * "getaddrinfo (ipv6) failed"
862 * "unknown address family"
863 * "getaddrinfo (ipv4) failed"
864 * "set socket opts failed"
865 * "insert wsi failed"
866 * "lws_ssl_client_connect1 failed"
867 * "lws_ssl_client_connect2 failed"
871 * "HS: Redirect code but no Location"
872 * "HS: URI did not parse"
873 * "HS: Redirect failed"
874 * "HS: Server did not return 200"
876 * "HS: disallowed by client filter"
877 * "HS: disallowed at ESTABLISHED"
878 * "HS: ACCEPT missing"
879 * "HS: ws upgrade response not 101"
880 * "HS: UPGRADE missing"
881 * "HS: Upgrade to something other than websocket"
882 * "HS: CONNECTION missing"
883 * "HS: UPGRADE malformed"
884 * "HS: PROTOCOL malformed"
885 * "HS: Cannot match protocol"
886 * "HS: EXT: list too big"
887 * "HS: EXT: failed setting defaults"
888 * "HS: EXT: failed parsing defaults"
889 * "HS: EXT: failed parsing options"
890 * "HS: EXT: Rejects server options"
891 * "HS: EXT: unknown ext"
892 * "HS: Accept hash wrong"
893 * "HS: Rejected by filter cb"
895 * "HS: SO_SNDBUF failed"
896 * "HS: Rejected at CLIENT_ESTABLISHED"
898 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
899 /**< this is the last chance for the client user code to examine the
900 * http headers and decide to reject the connection. If the
901 * content in the headers is interesting to the
902 * client (url, etc) it needs to copy it out at
903 * this point since it will be destroyed before
904 * the CLIENT_ESTABLISHED call */
905 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
906 /**< after your client connection completed
907 * a handshake with the remote server */
908 LWS_CALLBACK_CLOSED = 4,
909 /**< when the websocket session ends */
910 LWS_CALLBACK_CLOSED_HTTP = 5,
911 /**< when a HTTP (non-websocket) session ends */
912 LWS_CALLBACK_RECEIVE = 6,
913 /**< data has appeared for this server endpoint from a
914 * remote client, it can be found at *in and is
916 LWS_CALLBACK_RECEIVE_PONG = 7,
917 /**< servers receive PONG packets with this callback reason */
918 LWS_CALLBACK_CLIENT_RECEIVE = 8,
919 /**< data has appeared from the server for the client connection, it
920 * can be found at *in and is len bytes long */
921 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
922 /**< clients receive PONG packets with this callback reason */
923 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
924 /**< If you call lws_callback_on_writable() on a connection, you will
925 * get one of these callbacks coming when the connection socket
926 * is able to accept another write packet without blocking.
927 * If it already was able to take another packet without blocking,
928 * you'll get this callback at the next call to the service loop
929 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
930 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
931 LWS_CALLBACK_SERVER_WRITEABLE = 11,
932 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
933 LWS_CALLBACK_HTTP = 12,
934 /**< an http request has come from a client that is not
935 * asking to upgrade the connection to a websocket
936 * one. This is a chance to serve http content,
937 * for example, to send a script to the client
938 * which will then open the websockets connection.
939 * in points to the URI path requested and
940 * lws_serve_http_file() makes it very
941 * simple to send back a file to the client.
942 * Normally after sending the file you are done
943 * with the http connection, since the rest of the
944 * activity will come by websockets from the script
945 * that was delivered by http, so you will want to
946 * return 1; to close and free up the connection. */
947 LWS_CALLBACK_HTTP_BODY = 13,
948 /**< the next len bytes data from the http
949 * request body HTTP connection is now available in in. */
950 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
951 /**< the expected amount of http request body has been delivered */
952 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
953 /**< a file requested to be sent down http link has completed. */
954 LWS_CALLBACK_HTTP_WRITEABLE = 16,
955 /**< you can write more down the http protocol link now. */
956 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
957 /**< called when a client connects to
958 * the server at network level; the connection is accepted but then
959 * passed to this callback to decide whether to hang up immediately
960 * or not, based on the client IP. in contains the connection
961 * socket's descriptor. Since the client connection information is
962 * not available yet, wsi still pointing to the main server socket.
963 * Return non-zero to terminate the connection before sending or
964 * receiving anything. Because this happens immediately after the
965 * network connection from the client, there's no websocket protocol
966 * selected yet so this callback is issued only to protocol 0. */
967 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
968 /**< called when the request has
969 * been received and parsed from the client, but the response is
970 * not sent yet. Return non-zero to disallow the connection.
971 * user is a pointer to the connection user space allocation,
972 * in is the URI, eg, "/"
973 * In your handler you can use the public APIs
974 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
975 * headers using the header enums lws_token_indexes from
976 * libwebsockets.h to check for and read the supported header
977 * presence and content before deciding to allow the http
978 * connection to proceed or to kill the connection. */
979 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
980 /**< A new client just had
981 * been connected, accepted, and instantiated into the pool. This
982 * callback allows setting any relevant property to it. Because this
983 * happens immediately after the instantiation of a new client,
984 * there's no websocket protocol selected yet so this callback is
985 * issued only to protocol 0. Only wsi is defined, pointing to the
986 * new client, and the return value is ignored. */
987 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
988 /**< called when the handshake has
989 * been received and parsed from the client, but the response is
990 * not sent yet. Return non-zero to disallow the connection.
991 * user is a pointer to the connection user space allocation,
992 * in is the requested protocol name
993 * In your handler you can use the public APIs
994 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
995 * headers using the header enums lws_token_indexes from
996 * libwebsockets.h to check for and read the supported header
997 * presence and content before deciding to allow the handshake
998 * to proceed or to kill the connection. */
999 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
1000 /**< if configured for
1001 * including OpenSSL support, this callback allows your user code
1002 * to perform extra SSL_CTX_load_verify_locations() or similar
1003 * calls to direct OpenSSL where to find certificates the client
1004 * can use to confirm the remote server identity. user is the
1005 * OpenSSL SSL_CTX* */
1006 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
1007 /**< if configured for
1008 * including OpenSSL support, this callback allows your user code
1009 * to load extra certifcates into the server which allow it to
1010 * verify the validity of certificates returned by clients. user
1011 * is the server's OpenSSL SSL_CTX* */
1012 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
1013 /**< if the libwebsockets vhost was created with the option
1014 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
1015 * callback is generated during OpenSSL verification of the cert
1016 * sent from the client. It is sent to protocol[0] callback as
1017 * no protocol has been negotiated on the connection yet.
1018 * Notice that the libwebsockets context and wsi are both NULL
1019 * during this callback. See
1020 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1021 * to understand more detail about the OpenSSL callback that
1022 * generates this libwebsockets callback and the meanings of the
1023 * arguments passed. In this callback, user is the x509_ctx,
1024 * in is the ssl pointer and len is preverify_ok
1025 * Notice that this callback maintains libwebsocket return
1026 * conventions, return 0 to mean the cert is OK or 1 to fail it.
1027 * This also means that if you don't handle this callback then
1028 * the default callback action of returning 0 allows the client
1030 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
1031 /**< this callback happens
1032 * when a client handshake is being compiled. user is NULL,
1033 * in is a char **, it's pointing to a char * which holds the
1034 * next location in the header buffer where you can add
1035 * headers, and len is the remaining space in the header buffer,
1036 * which is typically some hundreds of bytes. So, to add a canned
1037 * cookie, your handler code might look similar to:
1039 * char **p = (char **)in;
1044 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1048 * Notice if you add anything, you just have to take care about
1049 * the CRLF on the line you added. Obviously this callback is
1050 * optional, if you don't handle it everything is fine.
1052 * Notice the callback is coming to protocols[0] all the time,
1053 * because there is no specific protocol negotiated yet. */
1054 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
1055 /**< When the server handshake code
1056 * sees that it does support a requested extension, before
1057 * accepting the extension by additing to the list sent back to
1058 * the client it gives this callback just to check that it's okay
1059 * to use that extension. It calls back to the requested protocol
1060 * and with in being the extension name, len is 0 and user is
1061 * valid. Note though at this time the ESTABLISHED callback hasn't
1062 * happened yet so if you initialize user content there, user
1063 * content during this callback might not be useful for anything. */
1064 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
1066 * connection is being prepared to start a handshake to a server,
1067 * each supported extension is checked with protocols[0] callback
1068 * with this reason, giving the user code a chance to suppress the
1069 * claim to support that extension by returning non-zero. If
1070 * unhandled, by default 0 will be returned and the extension
1071 * support included in the header to the server. Notice this
1072 * callback comes to protocols[0]. */
1073 LWS_CALLBACK_PROTOCOL_INIT = 27,
1074 /**< One-time call per protocol, per-vhost using it, so it can
1075 * do initial setup / allocations etc */
1076 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
1077 /**< One-time call per protocol, per-vhost using it, indicating
1078 * this protocol won't get used at all after this callback, the
1079 * vhost is getting destroyed. Take the opportunity to
1080 * deallocate everything that was allocated by the protocol. */
1081 LWS_CALLBACK_WSI_CREATE = 29,
1082 /**< outermost (earliest) wsi create notification to protocols[0] */
1083 LWS_CALLBACK_WSI_DESTROY = 30,
1084 /**< outermost (latest) wsi destroy notification to protocols[0] */
1085 LWS_CALLBACK_GET_THREAD_ID = 31,
1086 /**< lws can accept callback when writable requests from other
1087 * threads, if you implement this callback and return an opaque
1088 * current thread ID integer. */
1090 /* external poll() management support */
1091 LWS_CALLBACK_ADD_POLL_FD = 32,
1092 /**< lws normally deals with its poll() or other event loop
1093 * internally, but in the case you are integrating with another
1094 * server you will need to have lws sockets share a
1095 * polling array with the other server. This and the other
1096 * POLL_FD related callbacks let you put your specialized
1097 * poll array interface code in the callback for protocol 0, the
1098 * first protocol you support, usually the HTTP protocol in the
1100 * This callback happens when a socket needs to be
1101 * added to the polling loop: in points to a struct
1102 * lws_pollargs; the fd member of the struct is the file
1103 * descriptor, and events contains the active events
1105 * If you are using the internal lws polling / event loop
1106 * you can just ignore these callbacks. */
1107 LWS_CALLBACK_DEL_POLL_FD = 33,
1108 /**< This callback happens when a socket descriptor
1109 * needs to be removed from an external polling array. in is
1110 * again the struct lws_pollargs containing the fd member
1111 * to be removed. If you are using the internal polling
1112 * loop, you can just ignore it. */
1113 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1114 /**< This callback happens when lws wants to modify the events for
1116 * in is the struct lws_pollargs with the fd to change.
1117 * The new event mask is in events member and the old mask is in
1118 * the prev_events member.
1119 * If you are using the internal polling loop, you can just ignore
1121 LWS_CALLBACK_LOCK_POLL = 35,
1122 /**< These allow the external poll changes driven
1123 * by lws to participate in an external thread locking
1124 * scheme around the changes, so the whole thing is threadsafe.
1125 * These are called around three activities in the library,
1126 * - inserting a new wsi in the wsi / fd table (len=1)
1127 * - deleting a wsi from the wsi / fd table (len=1)
1128 * - changing a wsi's POLLIN/OUT state (len=0)
1129 * Locking and unlocking external synchronization objects when
1130 * len == 1 allows external threads to be synchronized against
1131 * wsi lifecycle changes if it acquires the same lock for the
1132 * duration of wsi dereference from the other thread context. */
1133 LWS_CALLBACK_UNLOCK_POLL = 36,
1134 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1136 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1137 /**< if configured for including OpenSSL support but no private key
1138 * file has been specified (ssl_private_key_filepath is NULL), this is
1139 * called to allow the user to set the private key directly via
1140 * libopenssl and perform further operations if required; this might be
1141 * useful in situations where the private key is not directly accessible
1142 * by the OS, for example if it is stored on a smartcard.
1143 * user is the server's OpenSSL SSL_CTX* */
1144 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1145 /**< The peer has sent an unsolicited Close WS packet. in and
1146 * len are the optional close code (first 2 bytes, network
1147 * order) and the optional additional information which is not
1148 * defined in the standard, and may be a string or non-human- readable data.
1149 * If you return 0 lws will echo the close and then close the
1150 * connection. If you return nonzero lws will just close the
1153 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1156 LWS_CALLBACK_CGI = 40,
1158 LWS_CALLBACK_CGI_TERMINATED = 41,
1160 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1162 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1164 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1166 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1168 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1170 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1172 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1174 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1176 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1178 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1180 LWS_CALLBACK_PROCESS_HTML = 52,
1182 LWS_CALLBACK_ADD_HEADERS = 53,
1184 LWS_CALLBACK_SESSION_INFO = 54,
1187 LWS_CALLBACK_GS_EVENT = 55,
1189 LWS_CALLBACK_HTTP_PMO = 56,
1190 /**< per-mount options for this connection, called before
1191 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1194 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1195 /**< when doing an HTTP type client connection, you can call
1196 * lws_client_http_body_pending(wsi, 1) from
1197 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1198 * sending the HTTP headers.
1200 * From this callback, when you have sent everything, you should let
1201 * lws know by calling lws_client_http_body_pending(wsi, 0)
1203 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1204 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1205 * this callback is called during OpenSSL verification of the cert
1206 * sent from the server to the client. It is sent to protocol[0]
1207 * callback as no protocol has been negotiated on the connection yet.
1208 * Notice that the wsi is set because lws_client_connect_via_info was
1211 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1212 * to understand more detail about the OpenSSL callback that
1213 * generates this libwebsockets callback and the meanings of the
1214 * arguments passed. In this callback, user is the x509_ctx,
1215 * in is the ssl pointer and len is preverify_ok.
1217 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1218 * overruled and cert shall be accepted as ok,
1219 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1220 * called and return value must be 0 to mean the cert is OK;
1221 * returning 1 will fail the cert in any case.
1223 * This also means that if you don't handle this callback then
1224 * the default callback action of returning 0 will not accept the
1225 * certificate in case of a validation error decided by the SSL lib.
1227 * This is expected and secure behaviour when validating certificates.
1229 * Note: LCCSCF_ALLOW_SELFSIGNED and
1230 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1231 * callback being implemented.
1233 LWS_CALLBACK_RAW_RX = 59,
1234 /**< RAW mode connection RX */
1235 LWS_CALLBACK_RAW_CLOSE = 60,
1236 /**< RAW mode connection is closing */
1237 LWS_CALLBACK_RAW_WRITEABLE = 61,
1238 /**< RAW mode connection may be written */
1239 LWS_CALLBACK_RAW_ADOPT = 62,
1240 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1241 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1242 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1243 LWS_CALLBACK_RAW_RX_FILE = 64,
1244 /**< RAW mode file has something to read */
1245 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1246 /**< RAW mode file is writeable */
1247 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1248 /**< RAW mode wsi that adopted a file is closing */
1249 LWS_CALLBACK_SSL_INFO = 67,
1250 /**< SSL connections only. An event you registered an
1251 * interest in at the vhost has occurred on a connection
1252 * using the vhost. @in is a pointer to a
1253 * struct lws_ssl_info containing information about the
1256 /****** add new things just above ---^ ******/
1258 LWS_CALLBACK_USER = 1000,
1259 /**< user code can use any including above without fear of clashes */
1265 * typedef lws_callback_function() - User server actions
1266 * \param wsi: Opaque websocket instance pointer
1267 * \param reason: The reason for the call
1268 * \param user: Pointer to per-session user data allocated by library
1269 * \param in: Pointer used for some callback reasons
1270 * \param len: Length set for some callback reasons
1272 * This callback is the way the user controls what is served. All the
1273 * protocol detail is hidden and handled by the library.
1275 * For each connection / session there is user data allocated that is
1276 * pointed to by "user". You set the size of this user data area when
1277 * the library is initialized with lws_create_server.
1280 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1281 void *user, void *in, size_t len);
1284 /*! \defgroup extensions
1286 * ##Extension releated functions
1288 * Ws defines optional extensions, lws provides the ability to implement these
1289 * in user code if so desired.
1291 * We provide one extensions permessage-deflate.
1296 * NOTE: These public enums are part of the abi. If you want to add one,
1297 * add it at where specified so existing users are unaffected.
1299 enum lws_extension_callback_reasons {
1300 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1301 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1302 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1303 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1304 LWS_EXT_CB_CONSTRUCT = 4,
1305 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1306 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1307 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1308 LWS_EXT_CB_DESTROY = 8,
1309 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1310 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1311 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1312 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1313 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1314 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1315 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1316 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1317 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1318 LWS_EXT_CB_1HZ = 18,
1319 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1320 LWS_EXT_CB_IS_WRITEABLE = 20,
1321 LWS_EXT_CB_PAYLOAD_TX = 21,
1322 LWS_EXT_CB_PAYLOAD_RX = 22,
1323 LWS_EXT_CB_OPTION_DEFAULT = 23,
1324 LWS_EXT_CB_OPTION_SET = 24,
1325 LWS_EXT_CB_OPTION_CONFIRM = 25,
1326 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1328 /****** add new things just above ---^ ******/
1331 /** enum lws_ext_options_types */
1332 enum lws_ext_options_types {
1333 EXTARG_NONE, /**< does not take an argument */
1334 EXTARG_DEC, /**< requires a decimal argument */
1335 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1337 /* Add new things just above here ---^
1338 * This is part of the ABI, don't needlessly break compatibility */
1341 /** struct lws_ext_options - Option arguments to the extension. These are
1342 * used in the negotiation at ws upgrade time.
1343 * The helper function lws_ext_parse_options()
1344 * uses these to generate callbacks */
1345 struct lws_ext_options {
1346 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1347 enum lws_ext_options_types type; /**< What kind of args the option can take */
1349 /* Add new things just above here ---^
1350 * This is part of the ABI, don't needlessly break compatibility */
1353 /** struct lws_ext_option_arg */
1354 struct lws_ext_option_arg {
1355 const char *option_name; /**< may be NULL, option_index used then */
1356 int option_index; /**< argument ordinal to use if option_name missing */
1357 const char *start; /**< value */
1358 int len; /**< length of value */
1362 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1363 * \param context: Websockets context
1364 * \param ext: This extension
1365 * \param wsi: Opaque websocket instance pointer
1366 * \param reason: The reason for the call
1367 * \param user: Pointer to ptr to per-session user data allocated by library
1368 * \param in: Pointer used for some callback reasons
1369 * \param len: Length set for some callback reasons
1371 * Each extension that is active on a particular connection receives
1372 * callbacks during the connection lifetime to allow the extension to
1373 * operate on websocket data and manage itself.
1375 * Libwebsockets takes care of allocating and freeing "user" memory for
1376 * each active extension on each connection. That is what is pointed to
1377 * by the user parameter.
1379 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1380 * select this extension from the list provided by the client,
1381 * just before the server will send back the handshake accepting
1382 * the connection with this extension active. This gives the
1383 * extension a chance to initialize its connection context found
1386 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1387 * but called when client is instantiating this extension. Some
1388 * extensions will work the same on client and server side and then
1389 * you can just merge handlers for both CONSTRUCTS.
1391 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1392 * being used on is about to be closed and deallocated. It's the
1393 * last chance for the extension to deallocate anything it has
1394 * allocated in the user data (pointed to by user) before the
1395 * user data is deleted. This same callback is used whether you
1396 * are in client or server instantiation context.
1398 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1399 * a connection, and a packet of data arrived at the connection,
1400 * it is passed to this callback to give the extension a chance to
1401 * change the data, eg, decompress it. user is pointing to the
1402 * extension's private connection context data, in is pointing
1403 * to an lws_tokens struct, it consists of a char * pointer called
1404 * token, and an int called token_len. At entry, these are
1405 * set to point to the received buffer and set to the content
1406 * length. If the extension will grow the content, it should use
1407 * a new buffer allocated in its private user context data and
1408 * set the pointed-to lws_tokens members to point to its buffer.
1410 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1411 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1412 * extension a chance to change websocket data just before it will
1413 * be sent out. Using the same lws_token pointer scheme in in,
1414 * the extension can change the buffer and the length to be
1415 * transmitted how it likes. Again if it wants to grow the
1416 * buffer safely, it should copy the data into its own buffer and
1417 * set the lws_tokens token pointer to it.
1419 * LWS_EXT_CB_ARGS_VALIDATE:
1422 lws_extension_callback_function(struct lws_context *context,
1423 const struct lws_extension *ext, struct lws *wsi,
1424 enum lws_extension_callback_reasons reason,
1425 void *user, void *in, size_t len);
1427 /** struct lws_extension - An extension we support */
1428 struct lws_extension {
1429 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1430 lws_extension_callback_function *callback; /**< Service callback */
1431 const char *client_offer; /**< String containing exts and options client offers */
1433 /* Add new things just above here ---^
1434 * This is part of the ABI, don't needlessly break compatibility */
1438 * lws_set_extension_option(): set extension option if possible
1440 * \param wsi: websocket connection
1441 * \param ext_name: name of ext, like "permessage-deflate"
1442 * \param opt_name: name of option, like "rx_buf_size"
1443 * \param opt_val: value to set option to
1445 LWS_VISIBLE LWS_EXTERN int
1446 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1447 const char *opt_name, const char *opt_val);
1449 #ifndef LWS_NO_EXTENSIONS
1450 /* lws_get_internal_extensions() - DEPRECATED
1452 * \Deprecated There is no longer a set internal extensions table. The table is provided
1453 * by user code along with application-specific settings. See the test
1454 * client and server for how to do.
1456 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1457 lws_get_internal_extensions(void) { return NULL; }
1460 * lws_ext_parse_options() - deal with parsing negotiated extension options
1462 * \param ext: related extension struct
1463 * \param wsi: websocket connection
1464 * \param ext_user: per-connection extension private data
1465 * \param opts: list of supported options
1466 * \param o: option string to parse
1467 * \param len: length
1469 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1470 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1471 void *ext_user, const struct lws_ext_options *opts,
1472 const char *o, int len);
1475 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1477 * \param context: lws context
1478 * \param ext: related lws_extension struct
1479 * \param wsi: websocket connection
1480 * \param reason: incoming callback reason
1481 * \param user: per-connection extension private data
1482 * \param in: pointer parameter
1483 * \param len: length parameter
1485 * Built-in callback implementing RFC7692 permessage-deflate
1488 int lws_extension_callback_pm_deflate(
1489 struct lws_context *context, const struct lws_extension *ext,
1490 struct lws *wsi, enum lws_extension_callback_reasons reason,
1491 void *user, void *in, size_t len);
1494 * The internal exts are part of the public abi
1495 * If we add more extensions, publish the callback here ------v
1499 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1502 * ##Protocol and protocol plugin -related apis
1504 * Protocols bind ws protocol names to a custom callback specific to that
1505 * protocol implementaion.
1507 * A list of protocols can be passed in at context creation time, but it is
1508 * also legal to leave that NULL and add the protocols and their callback code
1511 * Plugins are much preferable compared to cut and pasting code into an
1512 * application each time, since they can be used standalone.
1515 /** struct lws_protocols - List of protocols and handlers client or server
1518 struct lws_protocols {
1520 /**< Protocol name that must match the one given in the client
1521 * Javascript new WebSocket(url, 'protocol') name. */
1522 lws_callback_function *callback;
1523 /**< The service callback used for this protocol. It allows the
1524 * service action for an entire protocol to be encapsulated in
1525 * the protocol-specific callback */
1526 size_t per_session_data_size;
1527 /**< Each new connection using this protocol gets
1528 * this much memory allocated on connection establishment and
1529 * freed on connection takedown. A pointer to this per-connection
1530 * allocation is passed into the callback in the 'user' parameter */
1531 size_t rx_buffer_size;
1532 /**< lws allocates this much space for rx data and informs callback
1533 * when something came. Due to rx flow control, the callback may not
1534 * be able to consume it all without having to return to the event
1535 * loop. That is supported in lws.
1537 * If .tx_packet_size is 0, this also controls how much may be sent at once
1538 * for backwards compatibility.
1541 /**< ignored by lws, but useful to contain user information bound
1542 * to the selected protocol. For example if this protocol was
1543 * called "myprotocol-v2", you might set id to 2, and the user
1544 * code that acts differently according to the version can do so by
1545 * switch (wsi->protocol->id), user code might use some bits as
1546 * capability flags based on selected protocol version, etc. */
1547 void *user; /**< ignored by lws, but user code can pass a pointer
1548 here it can later access from the protocol callback */
1549 size_t tx_packet_size;
1550 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1552 * If greater than zero, a single send() is restricted to this amount
1553 * and any remainder is buffered by lws and sent afterwards also in
1554 * these size chunks. Since that is expensive, it's preferable
1555 * to restrict one fragment you are trying to send to match this
1559 /* Add new things just above here ---^
1560 * This is part of the ABI, don't needlessly break compatibility */
1566 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1568 * \param vh: vhost to search
1569 * \param name: protocol name
1571 * Returns NULL or a pointer to the vhost's protocol of the requested name
1573 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1574 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1577 * lws_get_protocol() - Returns a protocol pointer from a websocket
1579 * \param wsi: pointer to struct websocket you want to know the protocol of
1582 * Some apis can act on all live connections of a given protocol,
1583 * this is how you can get a pointer to the active protocol if needed.
1585 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1586 lws_get_protocol(struct lws *wsi);
1588 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1589 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1590 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1593 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1595 * \param vhost: vhost the instance is related to
1596 * \param prot: protocol the instance is related to
1597 * \param size: bytes to allocate
1599 * Protocols often find it useful to allocate a per-vhost struct, this is a
1600 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1602 LWS_VISIBLE LWS_EXTERN void *
1603 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1607 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1609 * \param vhost: vhost the instance is related to
1610 * \param prot: protocol the instance is related to
1612 * Recover a pointer to the allocated per-vhost storage for the protocol created
1613 * by lws_protocol_vh_priv_zalloc() earlier
1615 LWS_VISIBLE LWS_EXTERN void *
1616 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1619 * lws_finalize_startup() - drop initial process privileges
1621 * \param context: lws context
1623 * This is called after the end of the vhost protocol initializations, but
1624 * you may choose to call it earlier
1626 LWS_VISIBLE LWS_EXTERN int
1627 lws_finalize_startup(struct lws_context *context);
1629 LWS_VISIBLE LWS_EXTERN int
1630 lws_protocol_init(struct lws_context *context);
1632 #ifdef LWS_WITH_PLUGINS
1634 /* PLUGINS implies LIBUV */
1636 #define LWS_PLUGIN_API_MAGIC 180
1638 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1639 struct lws_plugin_capability {
1640 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1641 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1642 int count_protocols; /**< how many protocols */
1643 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1644 int count_extensions; /**< how many extensions */
1647 typedef int (*lws_plugin_init_func)(struct lws_context *,
1648 struct lws_plugin_capability *);
1649 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1651 /** struct lws_plugin */
1653 struct lws_plugin *list; /**< linked list */
1654 #if (UV_VERSION_MAJOR > 0)
1655 uv_lib_t lib; /**< shared library pointer */
1657 void *l; /**< so we can compile on ancient libuv */
1659 char name[64]; /**< name of the plugin */
1660 struct lws_plugin_capability caps; /**< plugin capabilities */
1668 /*! \defgroup generic-sessions plugin: generic-sessions
1669 * \ingroup Protocols-and-Plugins
1671 * ##Plugin Generic-sessions related
1673 * generic-sessions plugin provides a reusable, generic session and login /
1674 * register / forgot password framework including email verification.
1678 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1679 /**< Maximum size of email we might send */
1681 /* SHA-1 binary and hexified versions */
1682 /** typedef struct lwsgw_hash_bin */
1683 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1684 /** typedef struct lwsgw_hash */
1685 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1687 /** enum lwsgs_auth_bits */
1688 enum lwsgs_auth_bits {
1689 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1690 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1691 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1692 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1695 /** struct lws_session_info - information about user session status */
1696 struct lws_session_info {
1697 char username[32]; /**< username logged in as, or empty string */
1698 char email[100]; /**< email address associated with login, or empty string */
1699 char ip[72]; /**< ip address session was started from */
1700 unsigned int mask; /**< access rights mask associated with session
1701 * see enum lwsgs_auth_bits */
1702 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1705 /** enum lws_gs_event */
1707 LWSGSE_CREATED, /**< a new user was created */
1708 LWSGSE_DELETED /**< an existing user was deleted */
1711 /** struct lws_gs_event_args */
1712 struct lws_gs_event_args {
1713 enum lws_gs_event event; /**< which event happened */
1714 const char *username; /**< which username the event happened to */
1715 const char *email; /**< the email address of that user */
1721 /*! \defgroup context-and-vhost
1724 * ##Context and Vhost releated functions
1726 * LWS requires that there is one context, in which you may define multiple
1727 * vhosts. Each vhost is a virtual host, with either its own listen port
1728 * or sharing an existing one. Each vhost has its own SSL context that can
1729 * be set up individually or left disabled.
1731 * If you don't care about multiple "site" support, you can ignore it and
1732 * lws will create a single default vhost at context creation time.
1737 * NOTE: These public enums are part of the abi. If you want to add one,
1738 * add it at where specified so existing users are unaffected.
1741 /** enum lws_context_options - context and vhost options */
1742 enum lws_context_options {
1743 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1745 /**< (VH) Don't allow the connection unless the client has a
1746 * client cert that we recognize; provides
1747 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1748 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1749 /**< (CTX) Don't try to get the server's hostname */
1750 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1752 /**< (VH) Allow non-SSL (plaintext) connections on the same
1753 * port as SSL is listening... undermines the security of SSL;
1754 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1755 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1756 /**< (CTX) Use libev event loop */
1757 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1758 /**< (VH) Disable IPV6 support */
1759 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1760 /**< (VH) Don't load OS CA certs, you will need to load your
1762 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1763 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1764 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1765 /**< (VH) Check UT-8 correctness */
1766 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1768 /**< (VH) initialize ECDH ciphers */
1769 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1770 /**< (CTX) Use libuv event loop */
1771 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1773 /**< (VH) Use http redirect to force http to https
1774 * (deprecated: use mount redirection) */
1775 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1776 /**< (CTX) Initialize the SSL library at all */
1777 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1778 /**< (CTX) Only create the context when calling context
1779 * create api, implies user code will create its own vhosts */
1780 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1781 /**< (VH) Use Unix socket */
1782 LWS_SERVER_OPTION_STS = (1 << 15),
1783 /**< (VH) Send Strict Transport Security header, making
1784 * clients subsequently go to https even if user asked for http */
1785 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1786 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1787 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1788 /**< (VH) if set, only ipv6 allowed on the vhost */
1789 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1790 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1791 * normally makes the lib spin so you can attach a debugger to it
1792 * even if it happened without a debugger in place. You can disable
1793 * that by giving this option.
1795 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1796 /**< For backwards-compatibility reasons, by default
1797 * lws prepends "http://" to the origin you give in the client
1798 * connection info struct. If you give this flag when you create
1799 * the context, only the string you give in the client connect
1800 * info for .origin (if any) will be used directly.
1802 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1803 /**< (VH) if invalid http is coming in the first line, */
1804 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1805 /**< (CTX) Use libevent event loop */
1806 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1807 /**< (VH) All connections to this vhost / port are RAW as soon as
1808 * the connection is accepted, no HTTP is going to be coming.
1810 LWS_SERVER_OPTION_ALLOW_LISTEN_SHARE = (1 << 23),
1811 /**< (VH) Set to allow multiple listen sockets on one interface +
1812 * address + port. The default is to strictly allow only one
1813 * listen socket at a time. This is automatically selected if you
1814 * have multiple service threads.
1817 /****** add new things just above ---^ ******/
1820 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1822 struct lws_plat_file_ops;
1824 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1826 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1827 * is not given, then for backwards compatibility one vhost is created at
1828 * context-creation time using the info from this struct.
1830 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1831 * at the same time as the context, they are expected to be created afterwards.
1833 struct lws_context_creation_info {
1835 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1836 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1837 * writing a server but you are using \ref sock-adopt instead of the
1838 * built-in listener */
1840 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1841 * interface name, eg, "eth2"
1842 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1843 * the pathname of a UNIX domain socket. you can use the UNIX domain
1844 * sockets in abstract namespace, by prepending an at symbol to the
1846 const struct lws_protocols *protocols;
1847 /**< VHOST: Array of structures listing supported protocols and a protocol-
1848 * specific callback for each one. The list is ended with an
1849 * entry that has a NULL callback pointer. */
1850 const struct lws_extension *extensions;
1851 /**< VHOST: NULL or array of lws_extension structs listing the
1852 * extensions this context supports. */
1853 const struct lws_token_limits *token_limits;
1854 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1855 * with a token length limit for each possible WSI_TOKEN_ */
1856 const char *ssl_private_key_password;
1857 /**< VHOST: NULL or the passphrase needed for the private key */
1858 const char *ssl_cert_filepath;
1859 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1860 * to listen using SSL, set to the filepath to fetch the
1861 * server cert from, otherwise NULL for unencrypted */
1862 const char *ssl_private_key_filepath;
1863 /**< VHOST: filepath to private key if wanting SSL mode;
1864 * if this is set to NULL but sll_cert_filepath is set, the
1865 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1866 * to allow setting of the private key directly via openSSL
1868 const char *ssl_ca_filepath;
1869 /**< VHOST: CA certificate filepath or NULL */
1870 const char *ssl_cipher_list;
1871 /**< VHOST: List of valid ciphers to use (eg,
1872 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1873 * or you can leave it as NULL to get "DEFAULT" */
1874 const char *http_proxy_address;
1875 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1876 * If proxy auth is required, use format "username:password\@server:port" */
1877 unsigned int http_proxy_port;
1878 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1880 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1882 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1883 unsigned int options;
1884 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1886 /**< CONTEXT: optional user pointer that can be recovered via the context
1887 * pointer using lws_context_user */
1889 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1890 * timeout to all libwebsocket sockets, client or server */
1892 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1893 * times to try to get a response from the peer before giving up
1894 * and killing the connection */
1896 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1898 #ifdef LWS_OPENSSL_SUPPORT
1899 SSL_CTX *provided_client_ssl_ctx;
1900 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1901 * implementation for the one provided by provided_ssl_ctx.
1902 * Libwebsockets no longer is responsible for freeing the context
1903 * if this option is selected. */
1904 #else /* maintain structure layout either way */
1905 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1908 short max_http_header_data;
1909 /**< CONTEXT: The max amount of header payload that can be handled
1910 * in an http request (unrecognized header payload is dropped) */
1911 short max_http_header_pool;
1912 /**< CONTEXT: The max number of connections with http headers that
1913 * can be processed simultaneously (the corresponding memory is
1914 * allocated for the lifetime of the context). If the pool is
1915 * busy new incoming connections must wait for accept until one
1918 unsigned int count_threads;
1919 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1920 unsigned int fd_limit_per_thread;
1921 /**< CONTEXT: nonzero means restrict each service thread to this
1922 * many fds, 0 means the default which is divide the process fd
1923 * limit by the number of threads. */
1924 unsigned int timeout_secs;
1925 /**< VHOST: various processes involving network roundtrips in the
1926 * library are protected from hanging forever by timeouts. If
1927 * nonzero, this member lets you set the timeout used in seconds.
1928 * Otherwise a default timeout is used. */
1929 const char *ecdh_curve;
1930 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1931 const char *vhost_name;
1932 /**< VHOST: name of vhost, must match external DNS name used to
1933 * access the site, like "warmcat.com" as it's used to match
1934 * Host: header and / or SNI name for SSL. */
1935 const char * const *plugin_dirs;
1936 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1937 * scan for lws protocol plugins at context creation time */
1938 const struct lws_protocol_vhost_options *pvo;
1939 /**< VHOST: pointer to optional linked list of per-vhost
1940 * options made accessible to protocols */
1941 int keepalive_timeout;
1942 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1943 * client to hold on to an idle HTTP/1.1 connection */
1944 const char *log_filepath;
1945 /**< VHOST: filepath to append logs to... this is opened before
1946 * any dropping of initial privileges */
1947 const struct lws_http_mount *mounts;
1948 /**< VHOST: optional linked list of mounts for this vhost */
1949 const char *server_string;
1950 /**< CONTEXT: string used in HTTP headers to identify server
1951 * software, if NULL, "libwebsockets". */
1952 unsigned int pt_serv_buf_size;
1953 /**< CONTEXT: 0 = default of 4096. This buffer is used by
1954 * various service related features including file serving, it
1955 * defines the max chunk of file that can be sent at once.
1956 * At the risk of lws having to buffer failed large sends, it
1957 * can be increased to, eg, 128KiB to improve throughput. */
1958 unsigned int max_http_header_data2;
1959 /**< CONTEXT: if max_http_header_data is 0 and this
1960 * is nonzero, this will be used in place of the default. It's
1961 * like this for compatibility with the original short version,
1962 * this is unsigned int length. */
1963 long ssl_options_set;
1964 /**< VHOST: Any bits set here will be set as SSL options */
1965 long ssl_options_clear;
1966 /**< VHOST: Any bits set here will be cleared as SSL options */
1967 unsigned short ws_ping_pong_interval;
1968 /**< CONTEXT: 0 for none, else interval in seconds between sending
1969 * PINGs on idle websocket connections. When the PING is sent,
1970 * the PONG must come within the normal timeout_secs timeout period
1971 * or the connection will be dropped.
1972 * Any RX or TX traffic on the connection restarts the interval timer,
1973 * so a connection which always sends or receives something at intervals
1974 * less than the interval given here will never send PINGs / expect
1975 * PONGs. Conversely as soon as the ws connection is established, an
1976 * idle connection will do the PING / PONG roundtrip as soon as
1977 * ws_ping_pong_interval seconds has passed without traffic
1979 const struct lws_protocol_vhost_options *headers;
1980 /**< VHOST: pointer to optional linked list of per-vhost
1981 * canned headers that are added to server responses */
1983 const struct lws_protocol_vhost_options *reject_service_keywords;
1984 /**< CONTEXT: Optional list of keywords and rejection codes + text.
1986 * The keywords are checked for existing in the user agent string.
1988 * Eg, "badrobot" "404 Not Found"
1990 void *external_baggage_free_on_destroy;
1991 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
1992 * should be freed when the context is destroyed. This allows you to
1993 * automatically sync the freeing action to the context destruction
1994 * action, so there is no need for an external free() if the context
1995 * succeeded to create.
1998 #ifdef LWS_OPENSSL_SUPPORT
1999 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
2000 * with a token length limit for each possible WSI_TOKEN_ */
2001 const char *client_ssl_private_key_password;
2002 /**< VHOST: NULL or the passphrase needed for the private key */
2003 const char *client_ssl_cert_filepath;
2004 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
2005 * to listen using SSL, set to the filepath to fetch the
2006 * server cert from, otherwise NULL for unencrypted */
2007 const char *client_ssl_private_key_filepath;
2008 /**< VHOST: filepath to private key if wanting SSL mode;
2009 * if this is set to NULL but sll_cert_filepath is set, the
2010 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
2011 * to allow setting of the private key directly via openSSL
2013 const char *client_ssl_ca_filepath;
2014 /**< VHOST: CA certificate filepath or NULL */
2015 const char *client_ssl_cipher_list;
2016 /**< VHOST: List of valid ciphers to use (eg,
2017 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
2018 * or you can leave it as NULL to get "DEFAULT" */
2021 const struct lws_plat_file_ops *fops;
2022 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
2023 * by a sentinel with NULL .open.
2025 * If NULL, lws provides just the platform file operations struct for
2026 * backwards compatibility.
2028 int simultaneous_ssl_restriction;
2029 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
2030 const char *socks_proxy_address;
2031 /**< VHOST: If non-NULL, attempts to proxy via the given address.
2032 * If proxy auth is required, use format "username:password\@server:port" */
2033 unsigned int socks_proxy_port;
2034 /**< VHOST: If socks_proxy_address was non-NULL, uses this port */
2035 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
2036 cap_value_t caps[4];
2037 /**< CONTEXT: array holding Linux capabilities you want to
2038 * continue to be available to the server after it transitions
2039 * to a noprivileged user. Usually none are needed but for, eg,
2040 * .bind_iface, CAP_NET_RAW is required. This gives you a way
2041 * to still have the capability but drop root.
2044 /**< CONTEXT: count of Linux capabilities in .caps[]. 0 means
2045 * no capabilities will be inherited from root (the default) */
2048 /**< VHOST: nonzero to strictly bind sockets to the interface name in
2049 * .iface (eg, "eth2"), using SO_BIND_TO_DEVICE.
2051 * Requires SO_BINDTODEVICE support from your OS and CAP_NET_RAW
2054 * Notice that common things like access network interface IP from
2055 * your local machine use your lo / loopback interface and will be
2056 * disallowed by this.
2059 /* Add new things just above here ---^
2060 * This is part of the ABI, don't needlessly break compatibility
2062 * The below is to ensure later library versions with new
2063 * members added above will see 0 (default) even if the app
2064 * was not built against the newer headers.
2066 int ssl_info_event_mask;
2067 /**< VHOST: mask of ssl events to be reported on LWS_CALLBACK_SSL_INFO
2068 * callback for connections on this vhost. The mask values are of
2069 * the form SSL_CB_ALERT, defined in openssl/ssl.h. The default of
2070 * 0 means no info events will be reported.
2073 void *_unused[8]; /**< dummy */
2077 * lws_create_context() - Create the websocket handler
2078 * \param info: pointer to struct with parameters
2080 * This function creates the listening socket (if serving) and takes care
2081 * of all initialization in one step.
2083 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
2084 * created; you're expected to create your own vhosts afterwards using
2085 * lws_create_vhost(). Otherwise a vhost named "default" is also created
2086 * using the information in the vhost-related members, for compatibility.
2088 * After initialization, it returns a struct lws_context * that
2089 * represents this server. After calling, user code needs to take care
2090 * of calling lws_service() with the context pointer to get the
2091 * server's sockets serviced. This must be done in the same process
2092 * context as the initialization call.
2094 * The protocol callback functions are called for a handful of events
2095 * including http requests coming in, websocket connections becoming
2096 * established, and data arriving; it's also called periodically to allow
2097 * async transmission.
2099 * HTTP requests are sent always to the FIRST protocol in protocol, since
2100 * at that time websocket protocol has not been negotiated. Other
2101 * protocols after the first one never see any HTTP callback activity.
2103 * The server created is a simple http server by default; part of the
2104 * websocket standard is upgrading this http connection to a websocket one.
2106 * This allows the same server to provide files like scripts and favicon /
2107 * images or whatever over http and dynamic data over websockets all in
2108 * one place; they're all handled in the user callback.
2110 LWS_VISIBLE LWS_EXTERN struct lws_context *
2111 lws_create_context(struct lws_context_creation_info *info);
2114 * lws_context_destroy() - Destroy the websocket context
2115 * \param context: Websocket context
2117 * This function closes any active connections and then frees the
2118 * context. After calling this, any further use of the context is
2121 LWS_VISIBLE LWS_EXTERN void
2122 lws_context_destroy(struct lws_context *context);
2124 LWS_VISIBLE LWS_EXTERN void
2125 lws_context_destroy2(struct lws_context *context);
2127 typedef int (*lws_reload_func)(void);
2130 * lws_context_deprecate() - Deprecate the websocket context
2131 * \param context: Websocket context
2133 * This function is used on an existing context before superceding it
2134 * with a new context.
2136 * It closes any listen sockets in the context, so new connections are
2139 * And it marks the context to be deleted when the number of active
2140 * connections into it falls to zero.
2142 * Otherwise if you attach the deprecated context to the replacement
2143 * context when it has been created using lws_context_attach_deprecated()
2144 * both any deprecated and the new context will service their connections.
2146 * This is aimed at allowing seamless configuration reloads.
2148 * The callback cb will be called after the listen sockets are actually
2149 * closed and may be reopened. In the callback the new context should be
2150 * configured and created. (With libuv, socket close happens async after
2151 * more loop events).
2153 LWS_VISIBLE LWS_EXTERN void
2154 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2156 LWS_VISIBLE LWS_EXTERN int
2157 lws_context_is_deprecated(struct lws_context *context);
2160 * lws_set_proxy() - Setups proxy to lws_context.
2161 * \param vhost: pointer to struct lws_vhost you want set proxy for
2162 * \param proxy: pointer to c string containing proxy in format address:port
2164 * Returns 0 if proxy string was parsed and proxy was setup.
2165 * Returns -1 if proxy is NULL or has incorrect format.
2167 * This is only required if your OS does not provide the http_proxy
2168 * environment variable (eg, OSX)
2170 * IMPORTANT! You should call this function right after creation of the
2171 * lws_context and before call to connect. If you call this
2172 * function after connect behavior is undefined.
2173 * This function will override proxy settings made on lws_context
2174 * creation with genenv() call.
2176 LWS_VISIBLE LWS_EXTERN int
2177 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2180 * lws_set_socks() - Setup socks to lws_context.
2181 * \param vhost: pointer to struct lws_vhost you want set socks for
2182 * \param socks: pointer to c string containing socks in format address:port
2184 * Returns 0 if socks string was parsed and socks was setup.
2185 * Returns -1 if socks is NULL or has incorrect format.
2187 * This is only required if your OS does not provide the socks_proxy
2188 * environment variable (eg, OSX)
2190 * IMPORTANT! You should call this function right after creation of the
2191 * lws_context and before call to connect. If you call this
2192 * function after connect behavior is undefined.
2193 * This function will override proxy settings made on lws_context
2194 * creation with genenv() call.
2196 LWS_VISIBLE LWS_EXTERN int
2197 lws_set_socks(struct lws_vhost *vhost, const char *socks);
2202 * lws_create_vhost() - Create a vhost (virtual server context)
2203 * \param context: pointer to result of lws_create_context()
2204 * \param info: pointer to struct with parameters
2206 * This function creates a virtual server (vhost) using the vhost-related
2207 * members of the info struct. You can create many vhosts inside one context
2208 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2210 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
2211 lws_create_vhost(struct lws_context *context,
2212 struct lws_context_creation_info *info);
2215 * lwsws_get_config_globals() - Parse a JSON server config file
2216 * \param info: pointer to struct with parameters
2217 * \param d: filepath of the config file
2218 * \param config_strings: storage for the config strings extracted from JSON,
2219 * the pointer is incremented as strings are stored
2220 * \param len: pointer to the remaining length left in config_strings
2221 * the value is decremented as strings are stored
2223 * This function prepares a n lws_context_creation_info struct with global
2224 * settings from a file d.
2226 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2228 LWS_VISIBLE LWS_EXTERN int
2229 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2230 char **config_strings, int *len);
2233 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2234 * \param context: pointer to result of lws_create_context()
2235 * \param info: pointer to struct with parameters
2236 * \param d: filepath of the config file
2237 * \param config_strings: storage for the config strings extracted from JSON,
2238 * the pointer is incremented as strings are stored
2239 * \param len: pointer to the remaining length left in config_strings
2240 * the value is decremented as strings are stored
2242 * This function creates vhosts into a context according to the settings in
2243 *JSON files found in directory d.
2245 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2247 LWS_VISIBLE LWS_EXTERN int
2248 lwsws_get_config_vhosts(struct lws_context *context,
2249 struct lws_context_creation_info *info, const char *d,
2250 char **config_strings, int *len);
2252 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2253 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2254 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2257 * lws_get_vhost() - return the vhost a wsi belongs to
2259 * \param wsi: which connection
2261 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2262 lws_get_vhost(struct lws *wsi);
2265 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2267 * \param vh: the vhost
2268 * \param buf: buffer to fill with JSON
2269 * \param len: max length of buf
2271 LWS_VISIBLE LWS_EXTERN int
2272 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2275 * lws_json_dump_context() - describe context state and stats in JSON
2277 * \param context: the context
2278 * \param buf: buffer to fill with JSON
2279 * \param len: max length of buf
2281 LWS_VISIBLE LWS_EXTERN int
2282 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2286 * lws_context_user() - get the user data associated with the context
2287 * \param context: Websocket context
2289 * This returns the optional user allocation that can be attached to
2290 * the context the sockets live in at context_create time. It's a way
2291 * to let all sockets serviced in the same context share data without
2292 * using globals statics in the user code.
2294 LWS_VISIBLE LWS_EXTERN void *
2295 lws_context_user(struct lws_context *context);
2297 /*! \defgroup vhost-mounts Vhost mounts and options
2298 * \ingroup context-and-vhost-creation
2300 * ##Vhost mounts and options
2303 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2304 * name=value options
2306 * This provides a general way to attach a linked-list of name=value pairs,
2307 * which can also have an optional child link-list using the options member.
2309 struct lws_protocol_vhost_options {
2310 const struct lws_protocol_vhost_options *next; /**< linked list */
2311 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2312 const char *name; /**< name of name=value pair */
2313 const char *value; /**< value of name=value pair */
2316 /** enum lws_mount_protocols
2317 * This specifies the mount protocol for a mountpoint, whether it is to be
2318 * served from a filesystem, or it is a cgi etc.
2320 enum lws_mount_protocols {
2321 LWSMPRO_HTTP = 0, /**< http reverse proxy */
2322 LWSMPRO_HTTPS = 1, /**< https reverse proxy */
2323 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2324 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2325 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2326 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2327 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2330 /** struct lws_http_mount
2332 * arguments for mounting something in a vhost's url namespace
2334 struct lws_http_mount {
2335 const struct lws_http_mount *mount_next;
2336 /**< pointer to next struct lws_http_mount */
2337 const char *mountpoint;
2338 /**< mountpoint in http pathspace, eg, "/" */
2340 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2342 /**< default target, eg, "index.html" */
2343 const char *protocol;
2344 /**<"protocol-name" to handle mount */
2346 const struct lws_protocol_vhost_options *cgienv;
2347 /**< optional linked-list of cgi options. These are created
2348 * as environment variables for the cgi process
2350 const struct lws_protocol_vhost_options *extra_mimetypes;
2351 /**< optional linked-list of mimetype mappings */
2352 const struct lws_protocol_vhost_options *interpret;
2353 /**< optional linked-list of files to be interpreted */
2356 /**< seconds cgi is allowed to live, if cgi://mount type */
2358 /**< max-age for reuse of client cache of files, seconds */
2359 unsigned int auth_mask;
2360 /**< bits set here must be set for authorized client session */
2362 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2363 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2364 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2366 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2367 unsigned char mountpoint_len; /**< length of mountpoint string */
2369 const char *basic_auth_login_file;
2370 /**<NULL, or filepath to use to check basic auth logins against */
2372 /* Add new things just above here ---^
2373 * This is part of the ABI, don't needlessly break compatibility
2375 * The below is to ensure later library versions with new
2376 * members added above will see 0 (default) even if the app
2377 * was not built against the newer headers.
2380 void *_unused[2]; /**< dummy */
2385 /*! \defgroup client
2388 * ##Client releated functions
2392 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2393 * with struct lws_client_connect_info ssl_connection member to control if
2394 * and how SSL checks apply to the client connection being created
2397 enum lws_client_connect_ssl_connection_flags {
2398 LCCSCF_USE_SSL = (1 << 0),
2399 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2400 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2401 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2404 /** struct lws_client_connect_info - parameters to connect with when using
2405 * lws_client_connect_via_info() */
2407 struct lws_client_connect_info {
2408 struct lws_context *context;
2409 /**< lws context to create connection in */
2410 const char *address;
2411 /**< remote address to connect to */
2413 /**< remote port to connect to */
2415 /**< nonzero for ssl */
2419 /**< content of host header */
2421 /**< content of origin header */
2422 const char *protocol;
2423 /**< list of ws protocols we could accept */
2424 int ietf_version_or_minus_one;
2425 /**< deprecated: currently leave at 0 or -1 */
2427 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2428 const void *client_exts;
2429 /**< UNUSED... provide in info.extensions at context creation time */
2431 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2432 * use "GET" to be a simple http client connection */
2433 struct lws *parent_wsi;
2434 /**< if another wsi is responsible for this connection, give it here.
2435 * this is used to make sure if the parent closes so do any
2436 * child connections first. */
2437 const char *uri_replace_from;
2438 /**< if non-NULL, when this string is found in URIs in
2439 * text/html content-encoding, it's replaced with uri_replace_to */
2440 const char *uri_replace_to;
2441 /**< see uri_replace_from */
2442 struct lws_vhost *vhost;
2443 /**< vhost to bind to (used to determine related SSL_CTX) */
2445 /**< if not NULL, store the new wsi here early in the connection
2446 * process. Although we return the new wsi, the call to create the
2447 * client connection does progress the connection somewhat and may
2448 * meet an error that will result in the connection being scrubbed and
2449 * NULL returned. While the wsi exists though, he may process a
2450 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2451 * user callback a way to identify which wsi it is that faced the error
2452 * even before the new wsi is returned and even if ultimately no wsi
2456 /**< NULL to allow routing on any interface, or interface name or IP
2457 * to bind the socket to */
2459 /* Add new things just above here ---^
2460 * This is part of the ABI, don't needlessly break compatibility
2462 * The below is to ensure later library versions with new
2463 * members added above will see 0 (default) even if the app
2464 * was not built against the newer headers.
2467 void *_unused[4]; /**< dummy */
2471 * lws_client_connect_via_info() - Connect to another websocket server
2472 * \param ccinfo: pointer to lws_client_connect_info struct
2474 * This function creates a connection to a remote server using the
2475 * information provided in ccinfo.
2477 LWS_VISIBLE LWS_EXTERN struct lws *
2478 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2481 * lws_client_connect() - Connect to another websocket server
2482 * \deprecated DEPRECATED use lws_client_connect_via_info
2483 * \param clients: Websocket context
2484 * \param address: Remote server address, eg, "myserver.com"
2485 * \param port: Port to connect to on the remote server, eg, 80
2486 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2488 * \param path: Websocket path on server
2489 * \param host: Hostname on server
2490 * \param origin: Socket origin name
2491 * \param protocol: Comma-separated list of protocols being asked for from
2492 * the server, or just one. The server will pick the one it
2493 * likes best. If you don't want to specify a protocol, which is
2494 * legal, use NULL here.
2495 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2496 * protocol supported, or the specific protocol ordinal
2498 * This function creates a connection to a remote server
2500 /* deprecated, use lws_client_connect_via_info() */
2501 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2502 lws_client_connect(struct lws_context *clients, const char *address,
2503 int port, int ssl_connection, const char *path,
2504 const char *host, const char *origin, const char *protocol,
2505 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2506 /* deprecated, use lws_client_connect_via_info() */
2508 * lws_client_connect_extended() - Connect to another websocket server
2509 * \deprecated DEPRECATED use lws_client_connect_via_info
2510 * \param clients: Websocket context
2511 * \param address: Remote server address, eg, "myserver.com"
2512 * \param port: Port to connect to on the remote server, eg, 80
2513 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2515 * \param path: Websocket path on server
2516 * \param host: Hostname on server
2517 * \param origin: Socket origin name
2518 * \param protocol: Comma-separated list of protocols being asked for from
2519 * the server, or just one. The server will pick the one it
2521 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2522 * protocol supported, or the specific protocol ordinal
2523 * \param userdata: Pre-allocated user data
2525 * This function creates a connection to a remote server
2527 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2528 lws_client_connect_extended(struct lws_context *clients, const char *address,
2529 int port, int ssl_connection, const char *path,
2530 const char *host, const char *origin,
2531 const char *protocol, int ietf_version_or_minus_one,
2532 void *userdata) LWS_WARN_DEPRECATED;
2535 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2537 * \param info: client ssl related info
2538 * \param vhost: which vhost to initialize client ssl operations on
2540 * You only need to call this if you plan on using SSL client connections on
2541 * the vhost. For non-SSL client connections, it's not necessary to call this.
2543 * The following members of info are used during the call
2545 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2546 * otherwise the call does nothing
2547 * - provided_client_ssl_ctx must be NULL to get a generated client
2548 * ssl context, otherwise you can pass a prepared one in by setting it
2549 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2550 * - ssl_ca_filepath may be NULL or client cert filepath
2551 * - ssl_cert_filepath may be NULL or client cert filepath
2552 * - ssl_private_key_filepath may be NULL or client cert private key
2554 * You must create your vhost explicitly if you want to use this, so you have
2555 * a pointer to the vhost. Create the context first with the option flag
2556 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2557 * the same info struct.
2559 LWS_VISIBLE LWS_EXTERN int
2560 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2561 struct lws_vhost *vhost);
2563 * lws_http_client_read() - consume waiting received http client data
2565 * \param wsi: client connection
2566 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2567 * \param len: pointer to chunk length - fill with max length of buffer
2569 * This is called when the user code is notified client http data has arrived.
2570 * The user code may choose to delay calling it to consume the data, for example
2571 * waiting until an onward connection is writeable.
2573 * For non-chunked connections, up to len bytes of buf are filled with the
2574 * received content. len is set to the actual amount filled before return.
2576 * For chunked connections, the linear buffer content contains the chunking
2577 * headers and it cannot be passed in one lump. Instead, this function will
2578 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2579 * chunk start and len set to the chunk length. There will be as many calls
2580 * as there are chunks or partial chunks in the buffer.
2582 LWS_VISIBLE LWS_EXTERN int
2583 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2586 * lws_http_client_http_response() - get last HTTP response code
2588 * \param wsi: client connection
2590 * Returns the last server response code, eg, 200 for client http connections.
2592 LWS_VISIBLE LWS_EXTERN unsigned int
2593 lws_http_client_http_response(struct lws *wsi);
2595 LWS_VISIBLE LWS_EXTERN void
2596 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2599 * lws_client_http_body_pending() - control if client connection neeeds to send body
2601 * \param wsi: client connection
2602 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2603 * if nothing more to send
2605 * If you will send payload data with your HTTP client connection, eg, for POST,
2606 * when you set the related http headers in
2607 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2608 * this API with something_left_to_send nonzero, and call
2609 * lws_callback_on_writable(wsi);
2611 * After sending the headers, lws will call your callback with
2612 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2613 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2614 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2615 * let lws know the last part is sent and the connection can move on.
2620 /** \defgroup service Built-in service loop entry
2622 * ##Built-in service loop entry
2624 * If you're not using libev / libuv, these apis are needed to enter the poll()
2625 * wait in lws and service any connections with pending events.
2630 * lws_service() - Service any pending websocket activity
2631 * \param context: Websocket context
2632 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2633 * service otherwise block and service immediately, returning
2634 * after the timeout if nothing needed service.
2636 * This function deals with any pending websocket traffic, for three
2637 * kinds of event. It handles these events on both server and client
2638 * types of connection the same.
2640 * 1) Accept new connections to our context's server
2642 * 2) Call the receive callback for incoming frame data received by
2643 * server or client connections.
2645 * You need to call this service function periodically to all the above
2646 * functions to happen; if your application is single-threaded you can
2647 * just call it in your main event loop.
2649 * Alternatively you can fork a new process that asynchronously handles
2650 * calling this service in a loop. In that case you are happy if this
2651 * call blocks your thread until it needs to take care of something and
2652 * would call it with a large nonzero timeout. Your loop then takes no
2653 * CPU while there is nothing happening.
2655 * If you are calling it in a single-threaded app, you don't want it to
2656 * wait around blocking other things in your loop from happening, so you
2657 * would call it with a timeout_ms of 0, so it returns immediately if
2658 * nothing is pending, or as soon as it services whatever was pending.
2660 LWS_VISIBLE LWS_EXTERN int
2661 lws_service(struct lws_context *context, int timeout_ms);
2664 * lws_service() - Service any pending websocket activity
2666 * \param context: Websocket context
2667 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2668 * service otherwise block and service immediately, returning
2669 * after the timeout if nothing needed service.
2671 * Same as lws_service(), but for a specific thread service index. Only needed
2672 * if you are spawning multiple service threads.
2674 LWS_VISIBLE LWS_EXTERN int
2675 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2678 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2680 * \param wsi: Cancel service on the thread this wsi is serviced by
2682 * This function lets a call to lws_service() waiting for a timeout
2683 * immediately return.
2685 * It works by creating a phony event and then swallowing it silently.
2687 * The reason it may be needed is when waiting in poll(), changes to
2688 * the event masks are ignored by the OS until poll() is reentered. This
2689 * lets you halt the poll() wait and make the reentry happen immediately
2690 * instead of having the wait out the rest of the poll timeout.
2692 LWS_VISIBLE LWS_EXTERN void
2693 lws_cancel_service_pt(struct lws *wsi);
2696 * lws_cancel_service() - Cancel wait for new pending socket activity
2697 * \param context: Websocket context
2699 * This function let a call to lws_service() waiting for a timeout
2700 * immediately return.
2702 * What it basically does is provide a fake event that will be swallowed,
2703 * so the wait in poll() is ended. That's useful because poll() doesn't
2704 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2706 LWS_VISIBLE LWS_EXTERN void
2707 lws_cancel_service(struct lws_context *context);
2710 * lws_service_fd() - Service polled socket with something waiting
2711 * \param context: Websocket context
2712 * \param pollfd: The pollfd entry describing the socket fd and which events
2713 * happened, or NULL to tell lws to do only timeout servicing.
2715 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2716 * services it according to the state of the associated
2719 * The one call deals with all "service" that might happen on a socket
2720 * including listen accepts, http files as well as websocket protocol.
2722 * If a pollfd says it has something, you can just pass it to
2723 * lws_service_fd() whether it is a socket handled by lws or not.
2724 * If it sees it is a lws socket, the traffic will be handled and
2725 * pollfd->revents will be zeroed now.
2727 * If the socket is foreign to lws, it leaves revents alone. So you can
2728 * see if you should service yourself by checking the pollfd revents
2729 * after letting lws try to service it.
2731 * You should also call this with pollfd = NULL to just allow the
2732 * once-per-second global timeout checks; if less than a second since the last
2733 * check it returns immediately then.
2735 LWS_VISIBLE LWS_EXTERN int
2736 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2739 * lws_service_fd_tsi() - Service polled socket in specific service thread
2740 * \param context: Websocket context
2741 * \param pollfd: The pollfd entry describing the socket fd and which events
2743 * \param tsi: thread service index
2745 * Same as lws_service_fd() but used with multiple service threads
2747 LWS_VISIBLE LWS_EXTERN int
2748 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2752 * lws_service_adjust_timeout() - Check for any connection needing forced service
2753 * \param context: Websocket context
2754 * \param timeout_ms: The original poll timeout value. You can just set this
2755 * to 1 if you don't really have a poll timeout.
2756 * \param tsi: thread service index
2758 * Under some conditions connections may need service even though there is no
2759 * pending network action on them, this is "forced service". For default
2760 * poll() and libuv / libev, the library takes care of calling this and
2761 * dealing with it for you. But for external poll() integration, you need
2762 * access to the apis.
2764 * If anybody needs "forced service", returned timeout is zero. In that case,
2765 * you can call lws_service_tsi() with a timeout of -1 to only service
2766 * guys who need forced service.
2768 LWS_VISIBLE LWS_EXTERN int
2769 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2771 /* Backwards compatibility */
2772 #define lws_plat_service_tsi lws_service_tsi
2776 /*! \defgroup http HTTP
2778 Modules related to handling HTTP
2782 /*! \defgroup httpft HTTP File transfer
2785 APIs for sending local files in response to HTTP requests
2790 * lws_get_mimetype() - Determine mimetype to use from filename
2792 * \param file: filename
2793 * \param m: NULL, or mount context
2795 * This uses a canned list of known filetypes first, if no match and m is
2796 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2798 * Returns either NULL or a pointer to the mimetype matching the file.
2800 LWS_VISIBLE LWS_EXTERN const char *
2801 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2804 * lws_serve_http_file() - Send a file back to the client using http
2805 * \param wsi: Websocket instance (available from user callback)
2806 * \param file: The file to issue over http
2807 * \param content_type: The http content type, eg, text/html
2808 * \param other_headers: NULL or pointer to header string
2809 * \param other_headers_len: length of the other headers if non-NULL
2811 * This function is intended to be called from the callback in response
2812 * to http requests from the client. It allows the callback to issue
2813 * local files down the http link in a single step.
2815 * Returning <0 indicates error and the wsi should be closed. Returning
2816 * >0 indicates the file was completely sent and
2817 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2818 * ==0 indicates the file transfer is started and needs more service later,
2819 * the wsi should be left alone.
2821 LWS_VISIBLE LWS_EXTERN int
2822 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2823 const char *other_headers, int other_headers_len);
2825 LWS_VISIBLE LWS_EXTERN int
2826 lws_serve_http_file_fragment(struct lws *wsi);
2829 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2832 * ##HTML chunked Substitution
2834 * APIs for receiving chunks of text, replacing a set of variable names via
2835 * a callback, and then prepending and appending HTML chunked encoding
2841 HTTP_STATUS_OK = 200,
2842 HTTP_STATUS_NO_CONTENT = 204,
2843 HTTP_STATUS_PARTIAL_CONTENT = 206,
2845 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2846 HTTP_STATUS_FOUND = 302,
2847 HTTP_STATUS_SEE_OTHER = 303,
2848 HTTP_STATUS_NOT_MODIFIED = 304,
2850 HTTP_STATUS_BAD_REQUEST = 400,
2851 HTTP_STATUS_UNAUTHORIZED,
2852 HTTP_STATUS_PAYMENT_REQUIRED,
2853 HTTP_STATUS_FORBIDDEN,
2854 HTTP_STATUS_NOT_FOUND,
2855 HTTP_STATUS_METHOD_NOT_ALLOWED,
2856 HTTP_STATUS_NOT_ACCEPTABLE,
2857 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2858 HTTP_STATUS_REQUEST_TIMEOUT,
2859 HTTP_STATUS_CONFLICT,
2861 HTTP_STATUS_LENGTH_REQUIRED,
2862 HTTP_STATUS_PRECONDITION_FAILED,
2863 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2864 HTTP_STATUS_REQ_URI_TOO_LONG,
2865 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2866 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2867 HTTP_STATUS_EXPECTATION_FAILED,
2869 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2870 HTTP_STATUS_NOT_IMPLEMENTED,
2871 HTTP_STATUS_BAD_GATEWAY,
2872 HTTP_STATUS_SERVICE_UNAVAILABLE,
2873 HTTP_STATUS_GATEWAY_TIMEOUT,
2874 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2877 struct lws_process_html_args {
2878 char *p; /**< pointer to the buffer containing the data */
2879 int len; /**< length of the original data at p */
2880 int max_len; /**< maximum length we can grow the data to */
2881 int final; /**< set if this is the last chunk of the file */
2884 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2886 struct lws_process_html_state {
2887 char *start; /**< pointer to start of match */
2888 char swallow[16]; /**< matched character buffer */
2889 int pos; /**< position in match */
2890 void *data; /**< opaque pointer */
2891 const char * const *vars; /**< list of variable names */
2892 int count_vars; /**< count of variable names */
2894 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2897 /*! lws_chunked_html_process() - generic chunked substitution
2898 * \param args: buffer to process using chunked encoding
2899 * \param s: current processing state
2901 LWS_VISIBLE LWS_EXTERN int
2902 lws_chunked_html_process(struct lws_process_html_args *args,
2903 struct lws_process_html_state *s);
2906 /** \defgroup HTTP-headers-read HTTP headers: read
2909 * ##HTTP header releated functions
2911 * In lws the client http headers are temporarily stored in a pool, only for the
2912 * duration of the http part of the handshake. It's because in most cases,
2913 * the header content is ignored for the whole rest of the connection lifetime
2914 * and would then just be taking up space needlessly.
2916 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2917 * the http headers are still allocated, you can use these apis then to
2918 * look at and copy out interesting header content (cookies, etc)
2920 * Notice that the header total length reported does not include a terminating
2921 * '\0', however you must allocate for it when using the _copy apis. So the
2922 * length reported for a header containing "123" is 3, but you must provide
2923 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2924 * will fail with a nonzero return code.
2926 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2927 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2928 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2929 * length to confirm the method.
2931 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2932 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2933 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2935 * As a convenience, lws has an api that will find the fragment with a
2936 * given name= part, lws_get_urlarg_by_name().
2940 /** struct lws_tokens
2941 * you need these to look at headers that have been parsed if using the
2942 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
2943 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
2944 * points to .token_len chars containing that header content.
2947 char *token; /**< pointer to start of the token */
2948 int token_len; /**< length of the token's value */
2951 /* enum lws_token_indexes
2952 * these have to be kept in sync with lextable.h / minilex.c
2954 * NOTE: These public enums are part of the abi. If you want to add one,
2955 * add it at where specified so existing users are unaffected.
2957 enum lws_token_indexes {
2958 WSI_TOKEN_GET_URI = 0,
2959 WSI_TOKEN_POST_URI = 1,
2960 WSI_TOKEN_OPTIONS_URI = 2,
2962 WSI_TOKEN_CONNECTION = 4,
2963 WSI_TOKEN_UPGRADE = 5,
2964 WSI_TOKEN_ORIGIN = 6,
2965 WSI_TOKEN_DRAFT = 7,
2966 WSI_TOKEN_CHALLENGE = 8,
2967 WSI_TOKEN_EXTENSIONS = 9,
2968 WSI_TOKEN_KEY1 = 10,
2969 WSI_TOKEN_KEY2 = 11,
2970 WSI_TOKEN_PROTOCOL = 12,
2971 WSI_TOKEN_ACCEPT = 13,
2972 WSI_TOKEN_NONCE = 14,
2973 WSI_TOKEN_HTTP = 15,
2974 WSI_TOKEN_HTTP2_SETTINGS = 16,
2975 WSI_TOKEN_HTTP_ACCEPT = 17,
2976 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2977 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2978 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2979 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2980 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2981 WSI_TOKEN_HTTP_PRAGMA = 23,
2982 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2983 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2984 WSI_TOKEN_HTTP_COOKIE = 26,
2985 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2986 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2987 WSI_TOKEN_HTTP_DATE = 29,
2988 WSI_TOKEN_HTTP_RANGE = 30,
2989 WSI_TOKEN_HTTP_REFERER = 31,
2991 WSI_TOKEN_VERSION = 33,
2992 WSI_TOKEN_SWORIGIN = 34,
2994 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2995 WSI_TOKEN_HTTP_COLON_METHOD = 36,
2996 WSI_TOKEN_HTTP_COLON_PATH = 37,
2997 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2998 WSI_TOKEN_HTTP_COLON_STATUS = 39,
3000 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
3001 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
3002 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
3003 WSI_TOKEN_HTTP_AGE = 43,
3004 WSI_TOKEN_HTTP_ALLOW = 44,
3005 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
3006 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
3007 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
3008 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
3009 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
3010 WSI_TOKEN_HTTP_ETAG = 50,
3011 WSI_TOKEN_HTTP_EXPECT = 51,
3012 WSI_TOKEN_HTTP_EXPIRES = 52,
3013 WSI_TOKEN_HTTP_FROM = 53,
3014 WSI_TOKEN_HTTP_IF_MATCH = 54,
3015 WSI_TOKEN_HTTP_IF_RANGE = 55,
3016 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
3017 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
3018 WSI_TOKEN_HTTP_LINK = 58,
3019 WSI_TOKEN_HTTP_LOCATION = 59,
3020 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
3021 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
3022 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
3023 WSI_TOKEN_HTTP_REFRESH = 63,
3024 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
3025 WSI_TOKEN_HTTP_SERVER = 65,
3026 WSI_TOKEN_HTTP_SET_COOKIE = 66,
3027 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
3028 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
3029 WSI_TOKEN_HTTP_USER_AGENT = 69,
3030 WSI_TOKEN_HTTP_VARY = 70,
3031 WSI_TOKEN_HTTP_VIA = 71,
3032 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
3034 WSI_TOKEN_PATCH_URI = 73,
3035 WSI_TOKEN_PUT_URI = 74,
3036 WSI_TOKEN_DELETE_URI = 75,
3038 WSI_TOKEN_HTTP_URI_ARGS = 76,
3039 WSI_TOKEN_PROXY = 77,
3040 WSI_TOKEN_HTTP_X_REAL_IP = 78,
3041 WSI_TOKEN_HTTP1_0 = 79,
3042 WSI_TOKEN_X_FORWARDED_FOR = 80,
3043 WSI_TOKEN_CONNECT = 81,
3044 /****** add new things just above ---^ ******/
3046 /* use token storage to stash these internally, not for
3049 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
3050 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
3051 _WSI_TOKEN_CLIENT_URI,
3052 _WSI_TOKEN_CLIENT_HOST,
3053 _WSI_TOKEN_CLIENT_ORIGIN,
3054 _WSI_TOKEN_CLIENT_METHOD,
3055 _WSI_TOKEN_CLIENT_IFACE,
3057 /* always last real token index*/
3060 /* parser state additions, no storage associated */
3061 WSI_TOKEN_NAME_PART,
3063 WSI_TOKEN_SKIPPING_SAW_CR,
3064 WSI_PARSING_COMPLETE,
3065 WSI_INIT_TOKEN_MUXURL,
3068 struct lws_token_limits {
3069 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
3073 * lws_token_to_string() - returns a textual representation of a hdr token index
3075 * \param: token index
3077 LWS_VISIBLE LWS_EXTERN const unsigned char *
3078 lws_token_to_string(enum lws_token_indexes token);
3082 * lws_hdr_total_length: report length of all fragments of a header totalled up
3083 * The returned length does not include the space for a
3086 * \param wsi: websocket connection
3087 * \param h: which header index we are interested in
3089 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3090 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
3093 * lws_hdr_fragment_length: report length of a single fragment of a header
3094 * The returned length does not include the space for a
3097 * \param wsi: websocket connection
3098 * \param h: which header index we are interested in
3099 * \param frag_idx: which fragment of h we want to get the length of
3101 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3102 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
3105 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
3106 * The buffer length len must include space for an additional
3107 * terminating '\0', or it will fail returning -1.
3109 * \param wsi: websocket connection
3110 * \param dest: destination buffer
3111 * \param len: length of destination buffer
3112 * \param h: which header index we are interested in
3114 * copies the whole, aggregated header, even if it was delivered in
3115 * several actual headers piece by piece
3117 LWS_VISIBLE LWS_EXTERN int
3118 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
3121 * lws_hdr_copy_fragment() - copy a single fragment of the given header to a buffer
3122 * The buffer length len must include space for an additional
3123 * terminating '\0', or it will fail returning -1.
3124 * If the requested fragment index is not present, it fails
3127 * \param wsi: websocket connection
3128 * \param dest: destination buffer
3129 * \param len: length of destination buffer
3130 * \param h: which header index we are interested in
3131 * \param frag_idx: which fragment of h we want to copy
3133 * Normally this is only useful
3134 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
3135 * fragment 0 will contain "x=1" and fragment 1 "y=2"
3137 LWS_VISIBLE LWS_EXTERN int
3138 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
3139 enum lws_token_indexes h, int frag_idx);
3142 * lws_get_urlarg_by_name() - return pointer to arg value if present
3143 * \param wsi: the connection to check
3144 * \param name: the arg name, like "token="
3145 * \param buf: the buffer to receive the urlarg (including the name= part)
3146 * \param len: the length of the buffer to receive the urlarg
3148 * Returns NULL if not found or a pointer inside buf to just after the
3151 LWS_VISIBLE LWS_EXTERN const char *
3152 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
3155 /*! \defgroup HTTP-headers-create HTTP headers: create
3157 * ## HTTP headers: Create
3159 * These apis allow you to create HTTP response headers in a way compatible with
3160 * both HTTP/1.x and HTTP/2.
3162 * They each append to a buffer taking care about the buffer end, which is
3163 * passed in as a pointer. When data is written to the buffer, the current
3164 * position p is updated accordingly.
3166 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3167 * and fail with nonzero return.
3171 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3172 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3175 * lws_add_http_header_status() - add the HTTP response status code
3177 * \param wsi: the connection to check
3178 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3179 * \param p: pointer to current position in buffer pointer
3180 * \param end: pointer to end of buffer
3182 * Adds the initial response code, so should be called first.
3184 * Code may additionally take OR'd flags:
3186 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3188 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3189 lws_add_http_header_status(struct lws *wsi,
3190 unsigned int code, unsigned char **p,
3191 unsigned char *end);
3193 * lws_add_http_header_by_name() - append named header and value
3195 * \param wsi: the connection to check
3196 * \param name: the hdr name, like "my-header"
3197 * \param value: the value after the = for this header
3198 * \param length: the length of the value
3199 * \param p: pointer to current position in buffer pointer
3200 * \param end: pointer to end of buffer
3202 * Appends name: value to the headers
3204 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3205 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3206 const unsigned char *value, int length,
3207 unsigned char **p, unsigned char *end);
3209 * lws_add_http_header_by_token() - append given header and value
3211 * \param wsi: the connection to check
3212 * \param token: the token index for the hdr
3213 * \param value: the value after the = for this header
3214 * \param length: the length of the value
3215 * \param p: pointer to current position in buffer pointer
3216 * \param end: pointer to end of buffer
3218 * Appends name=value to the headers, but is able to take advantage of better
3219 * HTTP/2 coding mechanisms where possible.
3221 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3222 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3223 const unsigned char *value, int length,
3224 unsigned char **p, unsigned char *end);
3226 * lws_add_http_header_content_length() - append content-length helper
3228 * \param wsi: the connection to check
3229 * \param content_length: the content length to use
3230 * \param p: pointer to current position in buffer pointer
3231 * \param end: pointer to end of buffer
3233 * Appends content-length: content_length to the headers
3235 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3236 lws_add_http_header_content_length(struct lws *wsi,
3237 lws_filepos_t content_length,
3238 unsigned char **p, unsigned char *end);
3240 * lws_finalize_http_header() - terminate header block
3242 * \param wsi: the connection to check
3243 * \param p: pointer to current position in buffer pointer
3244 * \param end: pointer to end of buffer
3246 * Indicates no more headers will be added
3248 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3249 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3250 unsigned char *end);
3253 /** \defgroup form-parsing Form Parsing
3255 * ##POSTed form parsing functions
3257 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3258 * POSTed form arguments, both using simple urlencoded and multipart transfer
3261 * It's capable of handling file uploads as well a named input parsing,
3262 * and the apis are the same for both form upload styles.
3264 * You feed it a list of parameter names and it creates pointers to the
3265 * urldecoded arguments: file upload parameters pass the file data in chunks to
3266 * a user-supplied callback as they come.
3268 * Since it's stateful, it handles the incoming data needing more than one
3269 * POST_BODY callback and has no limit on uploaded file size.
3273 /** enum lws_spa_fileupload_states */
3274 enum lws_spa_fileupload_states {
3276 /**< a chunk of file content has arrived */
3277 LWS_UFS_FINAL_CONTENT,
3278 /**< the last chunk (possibly zero length) of file content has arrived */
3280 /**< a new file is starting to arrive */
3284 * lws_spa_fileupload_cb() - callback to receive file upload data
3286 * \param data: opt_data pointer set in lws_spa_create
3287 * \param name: name of the form field being uploaded
3288 * \param filename: original filename from client
3289 * \param buf: start of data to receive
3290 * \param len: length of data to receive
3291 * \param state: information about how this call relates to file
3293 * Notice name and filename shouldn't be trusted, as they are passed from
3294 * HTTP provided by the client.
3296 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3297 const char *filename, char *buf, int len,
3298 enum lws_spa_fileupload_states state);
3300 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3301 * and file uploads */
3305 * lws_spa_create() - create urldecode parser
3307 * \param wsi: lws connection (used to find Content Type)
3308 * \param param_names: array of form parameter names, like "username"
3309 * \param count_params: count of param_names
3310 * \param max_storage: total amount of form parameter values we can store
3311 * \param opt_cb: NULL, or callback to receive file upload data.
3312 * \param opt_data: NULL, or user pointer provided to opt_cb.
3314 * Creates a urldecode parser and initializes it.
3316 * opt_cb can be NULL if you just want normal name=value parsing, however
3317 * if one or more entries in your form are bulk data (file transfer), you
3318 * can provide this callback and filter on the name callback parameter to
3319 * treat that urldecoded data separately. The callback should return -1
3320 * in case of fatal error, and 0 if OK.
3322 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3323 lws_spa_create(struct lws *wsi, const char * const *param_names,
3324 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3328 * lws_spa_process() - parses a chunk of input data
3330 * \param spa: the parser object previously created
3331 * \param in: incoming, urlencoded data
3332 * \param len: count of bytes valid at \param in
3334 LWS_VISIBLE LWS_EXTERN int
3335 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3338 * lws_spa_finalize() - indicate incoming data completed
3340 * \param spa: the parser object previously created
3342 LWS_VISIBLE LWS_EXTERN int
3343 lws_spa_finalize(struct lws_spa *spa);
3346 * lws_spa_get_length() - return length of parameter value
3348 * \param spa: the parser object previously created
3349 * \param n: parameter ordinal to return length of value for
3351 LWS_VISIBLE LWS_EXTERN int
3352 lws_spa_get_length(struct lws_spa *spa, int n);
3355 * lws_spa_get_string() - return pointer to parameter value
3356 * \param spa: the parser object previously created
3357 * \param n: parameter ordinal to return pointer to value for
3359 LWS_VISIBLE LWS_EXTERN const char *
3360 lws_spa_get_string(struct lws_spa *spa, int n);
3363 * lws_spa_destroy() - destroy parser object
3365 * \param spa: the parser object previously created
3367 LWS_VISIBLE LWS_EXTERN int
3368 lws_spa_destroy(struct lws_spa *spa);
3371 /*! \defgroup urlendec Urlencode and Urldecode
3374 * ##HTML chunked Substitution
3376 * APIs for receiving chunks of text, replacing a set of variable names via
3377 * a callback, and then prepending and appending HTML chunked encoding
3383 * lws_urlencode() - like strncpy but with urlencoding
3385 * \param escaped: output buffer
3386 * \param string: input buffer ('/0' terminated)
3387 * \param len: output buffer max length
3389 * Because urlencoding expands the output string, it's not
3390 * possible to do it in-place, ie, with escaped == string
3392 LWS_VISIBLE LWS_EXTERN const char *
3393 lws_urlencode(char *escaped, const char *string, int len);
3398 * This simple urldecode only operates until the first '\0' and requires the
3399 * data to exist all at once
3402 * lws_urldecode() - like strncpy but with urldecoding
3404 * \param string: output buffer
3405 * \param escaped: input buffer ('\0' terminated)
3406 * \param len: output buffer max length
3408 * This is only useful for '\0' terminated strings
3410 * Since urldecoding only shrinks the output string, it is possible to
3411 * do it in-place, ie, string == escaped
3413 LWS_VISIBLE LWS_EXTERN int
3414 lws_urldecode(char *string, const char *escaped, int len);
3417 * lws_return_http_status() - Return simple http status
3418 * \param wsi: Websocket instance (available from user callback)
3419 * \param code: Status index, eg, 404
3420 * \param html_body: User-readable HTML description < 1KB, or NULL
3422 * Helper to report HTTP errors back to the client cleanly and
3425 LWS_VISIBLE LWS_EXTERN int
3426 lws_return_http_status(struct lws *wsi, unsigned int code,
3427 const char *html_body);
3430 * lws_http_redirect() - write http redirect into buffer
3432 * \param wsi: websocket connection
3433 * \param code: HTTP response code (eg, 301)
3434 * \param loc: where to redirect to
3435 * \param len: length of loc
3436 * \param p: pointer current position in buffer (updated as we write)
3437 * \param end: pointer to end of buffer
3439 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3440 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3441 unsigned char **p, unsigned char *end);
3444 * lws_http_transaction_completed() - wait for new http transaction or close
3445 * \param wsi: websocket connection
3447 * Returns 1 if the HTTP connection must close now
3448 * Returns 0 and resets connection to wait for new HTTP header /
3449 * transaction if possible
3451 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3452 lws_http_transaction_completed(struct lws *wsi);
3455 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3457 * ##Sanitize / purify SQL and JSON helpers
3459 * APIs for escaping untrusted JSON and SQL safely before use
3464 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3466 * \param escaped: output buffer
3467 * \param string: input buffer ('/0' terminated)
3468 * \param len: output buffer max length
3470 * Because escaping expands the output string, it's not
3471 * possible to do it in-place, ie, with escaped == string
3473 LWS_VISIBLE LWS_EXTERN const char *
3474 lws_sql_purify(char *escaped, const char *string, int len);
3477 * lws_json_purify() - like strncpy but with escaping for json chars
3479 * \param escaped: output buffer
3480 * \param string: input buffer ('/0' terminated)
3481 * \param len: output buffer max length
3483 * Because escaping expands the output string, it's not
3484 * possible to do it in-place, ie, with escaped == string
3486 LWS_VISIBLE LWS_EXTERN const char *
3487 lws_json_purify(char *escaped, const char *string, int len);
3490 /*! \defgroup ev libev helpers
3494 * APIs specific to libev event loop itegration
3498 #ifdef LWS_USE_LIBEV
3499 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3501 LWS_VISIBLE LWS_EXTERN int
3502 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3503 lws_ev_signal_cb_t *cb);
3505 LWS_VISIBLE LWS_EXTERN int
3506 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3508 LWS_VISIBLE LWS_EXTERN void
3509 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3510 #endif /* LWS_USE_LIBEV */
3514 /*! \defgroup uv libuv helpers
3518 * APIs specific to libuv event loop itegration
3521 #ifdef LWS_USE_LIBUV
3522 LWS_VISIBLE LWS_EXTERN int
3523 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3526 LWS_VISIBLE LWS_EXTERN void
3527 lws_libuv_run(const struct lws_context *context, int tsi);
3529 LWS_VISIBLE LWS_EXTERN void
3530 lws_libuv_stop(struct lws_context *context);
3532 LWS_VISIBLE LWS_EXTERN void
3533 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3535 LWS_VISIBLE LWS_EXTERN int
3536 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3538 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3539 lws_uv_getloop(struct lws_context *context, int tsi);
3541 LWS_VISIBLE LWS_EXTERN void
3542 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3544 LWS_VISIBLE LWS_EXTERN void
3545 lws_close_all_handles_in_loop(uv_loop_t *loop);
3546 #endif /* LWS_USE_LIBUV */
3549 /*! \defgroup event libevent helpers
3551 * ##libevent helpers
3553 * APIs specific to libevent event loop itegration
3557 #ifdef LWS_USE_LIBEVENT
3558 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3561 LWS_VISIBLE LWS_EXTERN int
3562 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3563 lws_event_signal_cb_t cb);
3565 LWS_VISIBLE LWS_EXTERN int
3566 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3569 LWS_VISIBLE LWS_EXTERN void
3570 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3572 #endif /* LWS_USE_LIBEVENT */
3576 /*! \defgroup timeout Connection timeouts
3578 APIs related to setting connection timeouts
3583 * NOTE: These public enums are part of the abi. If you want to add one,
3584 * add it at where specified so existing users are unaffected.
3586 enum pending_timeout {
3587 NO_PENDING_TIMEOUT = 0,
3588 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3589 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3590 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3591 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3592 PENDING_TIMEOUT_AWAITING_PING = 5,
3593 PENDING_TIMEOUT_CLOSE_ACK = 6,
3594 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3595 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3596 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3597 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3598 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3599 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3600 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3601 PENDING_TIMEOUT_CGI = 14,
3602 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3603 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3604 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3605 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3606 PENDING_TIMEOUT_AWAITING_SOCKS_GREETING_REPLY = 19,
3607 PENDING_TIMEOUT_AWAITING_SOCKS_CONNECT_REPLY = 20,
3608 PENDING_TIMEOUT_AWAITING_SOCKS_AUTH_REPLY = 21,
3609 PENDING_TIMEOUT_KILLED_BY_SSL_INFO = 22,
3611 /****** add new things just above ---^ ******/
3615 * lws_set_timeout() - marks the wsi as subject to a timeout
3617 * You will not need this unless you are doing something special
3619 * \param wsi: Websocket connection instance
3620 * \param reason: timeout reason
3621 * \param secs: how many seconds
3623 LWS_VISIBLE LWS_EXTERN void
3624 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3627 /*! \defgroup sending-data Sending data
3629 APIs related to writing data on a connection
3632 #if !defined(LWS_SIZEOFPTR)
3633 #define LWS_SIZEOFPTR (sizeof (void *))
3635 #if !defined(u_int64_t)
3636 #define u_int64_t unsigned long long
3639 #if defined(__x86_64__)
3640 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3642 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3644 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3645 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3646 #define LWS_PRE _LWS_PAD(4 + 10)
3647 /* used prior to 1.7 and retained for backward compatibility */
3648 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3649 #define LWS_SEND_BUFFER_POST_PADDING 0
3652 * NOTE: These public enums are part of the abi. If you want to add one,
3653 * add it at where specified so existing users are unaffected.
3655 enum lws_write_protocol {
3657 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3658 * memory behind it. The receiver expects only valid utf-8 in the
3660 LWS_WRITE_BINARY = 1,
3661 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3662 * memory behind it. Any sequence of bytes is valid */
3663 LWS_WRITE_CONTINUATION = 2,
3664 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3665 * memory behind it */
3667 /**< Send HTTP content */
3669 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3673 /* Same as write_http but we know this write ends the transaction */
3674 LWS_WRITE_HTTP_FINAL = 7,
3678 LWS_WRITE_HTTP_HEADERS = 8,
3679 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3680 * payload differently, http 1.x links also handle this correctly. so
3681 * to be compatible with both in the future,header response part should
3682 * be sent using this regardless of http version expected)
3685 /****** add new things just above ---^ ******/
3689 LWS_WRITE_NO_FIN = 0x40,
3690 /**< This part of the message is not the end of the message */
3692 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3693 /**< client packet payload goes out on wire unmunged
3694 * only useful for security tests since normal servers cannot
3695 * decode the content if used */
3700 * lws_write() - Apply protocol then write data to client
3701 * \param wsi: Websocket instance (available from user callback)
3702 * \param buf: The data to send. For data being sent on a websocket
3703 * connection (ie, not default http), this buffer MUST have
3704 * LWS_PRE bytes valid BEFORE the pointer.
3705 * This is so the protocol header data can be added in-situ.
3706 * \param len: Count of the data bytes in the payload starting from buf
3707 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3708 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3709 * data on a websockets connection. Remember to allow the extra
3710 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3713 * This function provides the way to issue data back to the client
3714 * for both http and websocket protocols.
3718 * When sending with websocket protocol
3722 * LWS_WRITE_CONTINUATION,
3726 * the send buffer has to have LWS_PRE bytes valid BEFORE
3727 * the buffer pointer you pass to lws_write().
3729 * This allows us to add protocol info before and after the data, and send as
3730 * one packet on the network without payload copying, for maximum efficiency.
3732 * So for example you need this kind of code to use lws_write with a
3735 * char buf[LWS_PRE + 128];
3737 * // fill your part of the buffer... for example here it's all zeros
3738 * memset(&buf[LWS_PRE], 0, 128);
3740 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3742 * When sending HTTP, with
3745 * LWS_WRITE_HTTP_HEADERS
3746 * LWS_WRITE_HTTP_FINAL
3748 * there is no protocol data prepended, and don't need to take care about the
3749 * LWS_PRE bytes valid before the buffer pointer.
3751 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3752 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3753 * The example apps no longer use it.
3755 * Pad LWS_PRE to the CPU word size, so that word references
3756 * to the address immediately after the padding won't cause an unaligned access
3757 * error. Sometimes for performance reasons the recommended padding is even
3758 * larger than sizeof(void *).
3760 * In the case of sending using websocket protocol, be sure to allocate
3761 * valid storage before and after buf as explained above. This scheme
3762 * allows maximum efficiency of sending data and protocol in a single
3763 * packet while not burdening the user code with any protocol knowledge.
3765 * Return may be -1 for a fatal error needing connection close, or the
3766 * number of bytes sent.
3771 * The OS may not accept everything you asked to write on the connection.
3773 * Posix defines POLLOUT indication from poll() to show that the connection
3774 * will accept more write data, but it doesn't specifiy how much. It may just
3775 * accept one byte of whatever you wanted to send.
3777 * LWS will buffer the remainder automatically, and send it out autonomously.
3779 * During that time, WRITABLE callbacks will be suppressed.
3781 * This is to handle corner cases where unexpectedly the OS refuses what we
3782 * usually expect it to accept. You should try to send in chunks that are
3783 * almost always accepted in order to avoid the inefficiency of the buffering.
3785 LWS_VISIBLE LWS_EXTERN int
3786 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3787 enum lws_write_protocol protocol);
3789 /* helper for case where buffer may be const */
3790 #define lws_write_http(wsi, buf, len) \
3791 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3794 /** \defgroup callback-when-writeable Callback when writeable
3796 * ##Callback When Writeable
3798 * lws can only write data on a connection when it is able to accept more
3799 * data without blocking.
3801 * So a basic requirement is we should only use the lws_write() apis when the
3802 * connection we want to write on says that he can accept more data.
3804 * When lws cannot complete your send at the time, it will buffer the data
3805 * and send it in the background, suppressing any further WRITEABLE callbacks
3806 * on that connection until it completes. So it is important to write new
3807 * things in a new writeable callback.
3809 * These apis reflect the various ways we can indicate we would like to be
3810 * called back when one or more connections is writeable.
3815 * lws_callback_on_writable() - Request a callback when this socket
3816 * becomes able to be written to without
3819 * \param wsi: Websocket connection instance to get callback for
3821 * - Which: only this wsi
3822 * - When: when the individual connection becomes writeable
3823 * - What: LWS_CALLBACK_*_WRITEABLE
3825 LWS_VISIBLE LWS_EXTERN int
3826 lws_callback_on_writable(struct lws *wsi);
3829 * lws_callback_on_writable_all_protocol() - Request a callback for all
3830 * connections on same vhost using the given protocol when it
3831 * becomes possible to write to each socket without
3834 * \param context: lws_context
3835 * \param protocol: Protocol whose connections will get callbacks
3837 * - Which: connections using this protocol on ANY VHOST
3838 * - When: when the individual connection becomes writeable
3839 * - What: LWS_CALLBACK_*_WRITEABLE
3841 LWS_VISIBLE LWS_EXTERN int
3842 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3843 const struct lws_protocols *protocol);
3846 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3847 * all connections using the given protocol when it
3848 * becomes possible to write to each socket without
3851 * \param vhost: Only consider connections on this lws_vhost
3852 * \param protocol: Protocol whose connections will get callbacks
3854 * - Which: connections using this protocol on GIVEN VHOST ONLY
3855 * - When: when the individual connection becomes writeable
3856 * - What: LWS_CALLBACK_*_WRITEABLE
3858 LWS_VISIBLE LWS_EXTERN int
3859 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3860 const struct lws_protocols *protocol);
3863 * lws_callback_all_protocol() - Callback all connections using
3864 * the given protocol with the given reason
3866 * \param context: lws_context
3867 * \param protocol: Protocol whose connections will get callbacks
3868 * \param reason: Callback reason index
3870 * - Which: connections using this protocol on ALL VHOSTS
3871 * - When: before returning
3874 * This isn't normally what you want... normally any update of connection-
3875 * specific information can wait until a network-related callback like rx,
3876 * writable, or close.
3878 LWS_VISIBLE LWS_EXTERN int
3879 lws_callback_all_protocol(struct lws_context *context,
3880 const struct lws_protocols *protocol, int reason);
3883 * lws_callback_all_protocol_vhost() - Callback all connections using
3884 * the given protocol with the given reason
3886 * \param vh: Vhost whose connections will get callbacks
3887 * \param protocol: Which protocol to match
3888 * \param reason: Callback reason index
3890 * - Which: connections using this protocol on GIVEN VHOST ONLY
3894 LWS_VISIBLE LWS_EXTERN int
3895 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3896 const struct lws_protocols *protocol, int reason);
3899 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3900 * with the given reason
3902 * \param wsi: wsi whose vhost will get callbacks
3903 * \param reason: Callback reason index
3904 * \param in: in argument to callback
3905 * \param len: len argument to callback
3907 * - Which: connections using this protocol on same VHOST as wsi ONLY
3911 LWS_VISIBLE LWS_EXTERN int
3912 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3914 LWS_VISIBLE LWS_EXTERN int
3915 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3916 void *user, void *in, size_t len);
3919 * lws_get_socket_fd() - returns the socket file descriptor
3921 * You will not need this unless you are doing something special
3923 * \param wsi: Websocket connection instance
3925 LWS_VISIBLE LWS_EXTERN int
3926 lws_get_socket_fd(struct lws *wsi);
3929 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
3932 * \param wsi: Websocket connection instance
3934 * if the protocol does not have any guidance, returns -1. Currently only
3935 * http2 connections get send window information from this API. But your code
3936 * should use it so it can work properly with any protocol.
3938 * If nonzero return is the amount of payload data the peer or intermediary has
3939 * reported it has buffer space for. That has NO relationship with the amount
3940 * of buffer space your OS can accept on this connection for a write action.
3942 * This number represents the maximum you could send to the peer or intermediary
3943 * on this connection right now without the protocol complaining.
3945 * lws manages accounting for send window updates and payload writes
3946 * automatically, so this number reflects the situation at the peer or
3947 * intermediary dynamically.
3949 LWS_VISIBLE LWS_EXTERN size_t
3950 lws_get_peer_write_allowance(struct lws *wsi);
3954 * lws_rx_flow_control() - Enable and disable socket servicing for
3957 * If the output side of a server process becomes choked, this allows flow
3958 * control for the input side.
3960 * \param wsi: Websocket connection instance to get callback for
3961 * \param enable: 0 = disable read servicing for this connection, 1 = enable
3963 LWS_VISIBLE LWS_EXTERN int
3964 lws_rx_flow_control(struct lws *wsi, int enable);
3967 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
3969 * When the user server code realizes it can accept more input, it can
3970 * call this to have the RX flow restriction removed from all connections using
3971 * the given protocol.
3972 * \param context: lws_context
3973 * \param protocol: all connections using this protocol will be allowed to receive
3975 LWS_VISIBLE LWS_EXTERN void
3976 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3977 const struct lws_protocols *protocol);
3980 * lws_remaining_packet_payload() - Bytes to come before "overall"
3981 * rx packet is complete
3982 * \param wsi: Websocket instance (available from user callback)
3984 * This function is intended to be called from the callback if the
3985 * user code is interested in "complete packets" from the client.
3986 * libwebsockets just passes through payload as it comes and issues a buffer
3987 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
3988 * callback handler can use this API to find out if the buffer it has just
3989 * been given is the last piece of a "complete packet" from the client --
3990 * when that is the case lws_remaining_packet_payload() will return
3993 * Many protocols won't care becuse their packets are always small.
3995 LWS_VISIBLE LWS_EXTERN size_t
3996 lws_remaining_packet_payload(struct lws *wsi);
3999 /** \defgroup sock-adopt Socket adoption helpers
4000 * ##Socket adoption helpers
4002 * When integrating with an external app with its own event loop, these can
4003 * be used to accept connections from someone else's listening socket.
4005 * When using lws own event loop, these are not needed.
4010 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
4011 * for the default vhost of context.
4012 * \param context: lws context
4013 * \param accept_fd: fd of already-accepted socket to adopt
4015 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4016 * returns NULL, having cleaned up any new wsi pieces.
4018 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4019 * to ws or just serve http.
4021 LWS_VISIBLE LWS_EXTERN struct lws *
4022 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
4024 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
4026 * \param vhost: lws vhost
4027 * \param accept_fd: fd of already-accepted socket to adopt
4029 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4030 * returns NULL, having cleaned up any new wsi pieces.
4032 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4033 * to ws or just serve http.
4035 LWS_VISIBLE LWS_EXTERN struct lws *
4036 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
4039 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
4040 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
4041 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
4042 LWS_ADOPT_ALLOW_SSL = 4 /* flag: if set requires LWS_ADOPT_SOCKET */
4043 } lws_adoption_type;
4046 lws_sockfd_type sockfd;
4047 lws_filefd_type filefd;
4048 } lws_sock_file_fd_type;
4051 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
4052 * if socket descriptor, should already have been accepted from listen socket
4054 * \param vhost: lws vhost
4055 * \param type: OR-ed combinations of lws_adoption_type flags
4056 * \param fd: union with either .sockfd or .filefd set
4057 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
4058 * \param parent: NULL or struct lws to attach new_wsi to as a child
4060 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4061 * returns NULL, having cleaned up any new wsi pieces.
4063 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
4064 * ready to accept an upgrade to ws or just serve http.
4066 * parent may be NULL, if given it should be an existing wsi that will become the
4067 * parent of the new wsi created by this call.
4069 LWS_VISIBLE struct lws *
4070 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
4071 lws_sock_file_fd_type fd, const char *vh_prot_name,
4072 struct lws *parent);
4075 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
4076 * for the default vhost of context.
4077 * \param context: lws context
4078 * \param accept_fd: fd of already-accepted socket to adopt
4079 * \param readbuf: NULL or pointer to data that must be drained before reading from
4081 * \param len: The length of the data held at \param readbuf
4083 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4084 * returns NULL, having cleaned up any new wsi pieces.
4086 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4087 * to ws or just serve http.
4089 * If your external code did not already read from the socket, you can use
4090 * lws_adopt_socket() instead.
4092 * This api is guaranteed to use the data at \param readbuf first, before reading from
4095 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4097 LWS_VISIBLE LWS_EXTERN struct lws *
4098 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
4099 const char *readbuf, size_t len);
4101 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
4102 * accepted it for vhost.
4103 * \param vhost: lws vhost
4104 * \param accept_fd: fd of already-accepted socket to adopt
4105 * \param readbuf: NULL or pointer to data that must be drained before reading from
4107 * \param len: The length of the data held at \param readbuf
4109 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4110 * returns NULL, having cleaned up any new wsi pieces.
4112 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4113 * to ws or just serve http.
4115 * If your external code did not already read from the socket, you can use
4116 * lws_adopt_socket() instead.
4118 * This api is guaranteed to use the data at \param readbuf first, before reading from
4121 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4123 LWS_VISIBLE LWS_EXTERN struct lws *
4124 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
4125 const char *readbuf, size_t len);
4128 /** \defgroup net Network related helper APIs
4129 * ##Network related helper APIs
4131 * These wrap miscellaneous useful network-related functions
4136 * lws_canonical_hostname() - returns this host's hostname
4138 * This is typically used by client code to fill in the host parameter
4139 * when making a client connection. You can only call it after the context
4142 * \param context: Websocket context
4144 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4145 lws_canonical_hostname(struct lws_context *context);
4148 * lws_get_peer_addresses() - Get client address information
4149 * \param wsi: Local struct lws associated with
4150 * \param fd: Connection socket descriptor
4151 * \param name: Buffer to take client address name
4152 * \param name_len: Length of client address name buffer
4153 * \param rip: Buffer to take client address IP dotted quad
4154 * \param rip_len: Length of client address IP buffer
4156 * This function fills in name and rip with the name and IP of
4157 * the client connected with socket descriptor fd. Names may be
4158 * truncated if there is not enough room. If either cannot be
4159 * determined, they will be returned as valid zero-length strings.
4161 LWS_VISIBLE LWS_EXTERN void
4162 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
4163 int name_len, char *rip, int rip_len);
4166 * lws_get_peer_simple() - Get client address information without RDNS
4168 * \param wsi: Local struct lws associated with
4169 * \param name: Buffer to take client address name
4170 * \param namelen: Length of client address name buffer
4172 * This provides a 123.123.123.123 type IP address in name from the
4173 * peer that has connected to wsi
4175 LWS_VISIBLE LWS_EXTERN const char *
4176 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4177 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4179 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4181 * \param ipv6: Allow IPV6 addresses
4182 * \param ifname: Interface name or IP
4183 * \param addr: struct sockaddr_in * to be written
4184 * \param addrlen: Length of addr
4186 * This converts a textual network interface name to a sockaddr usable by
4187 * other network functions
4189 LWS_VISIBLE LWS_EXTERN int
4190 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4195 /** \defgroup misc Miscellaneous APIs
4196 * ##Miscellaneous APIs
4198 * Various APIs outside of other categories
4203 * lws_start_foreach_ll(): linkedlist iterator helper start
4205 * \param type: type of iteration, eg, struct xyz *
4206 * \param it: iterator var name to create
4207 * \param start: start of list
4209 * This helper creates an iterator and starts a while (it) {
4210 * loop. The iterator runs through the linked list starting at start and
4211 * ends when it gets a NULL.
4212 * The while loop should be terminated using lws_start_foreach_ll().
4214 #define lws_start_foreach_ll(type, it, start)\
4220 * lws_end_foreach_ll(): linkedlist iterator helper end
4222 * \param it: same iterator var name given when starting
4223 * \param nxt: member name in the iterator pointing to next list element
4225 * This helper is the partner for lws_start_foreach_ll() that ends the
4229 #define lws_end_foreach_ll(it, nxt) \
4235 * lws_start_foreach_llp(): linkedlist pointer iterator helper start
4237 * \param type: type of iteration, eg, struct xyz **
4238 * \param it: iterator var name to create
4239 * \param start: start of list
4241 * This helper creates an iterator and starts a while (it) {
4242 * loop. The iterator runs through the linked list starting at the
4243 * address of start and ends when it gets a NULL.
4244 * The while loop should be terminated using lws_start_foreach_llp().
4246 * This helper variant iterates using a pointer to the previous linked-list
4247 * element. That allows you to easily delete list members by rewriting the
4248 * previous pointer to the element's next pointer.
4250 #define lws_start_foreach_llp(type, it, start)\
4252 type it = &(start); \
4256 * lws_end_foreach_llp(): linkedlist pointer iterator helper end
4258 * \param it: same iterator var name given when starting
4259 * \param nxt: member name in the iterator pointing to next list element
4261 * This helper is the partner for lws_start_foreach_llp() that ends the
4265 #define lws_end_foreach_llp(it, nxt) \
4266 it = &(*(it))->nxt; \
4271 * lws_snprintf(): snprintf that truncates the returned length too
4273 * \param str: destination buffer
4274 * \param size: bytes left in destination buffer
4275 * \param format: format string
4276 * \param ...: args for format
4278 * This lets you correctly truncate buffers by concatenating lengths, if you
4279 * reach the limit the reported length doesn't exceed the limit.
4281 LWS_VISIBLE LWS_EXTERN int
4282 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4285 * lws_get_random(): fill a buffer with platform random data
4287 * \param context: the lws context
4288 * \param buf: buffer to fill
4289 * \param len: how much to fill
4291 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4292 * it's interested to see if the frame it's dealing with was sent in binary
4295 LWS_VISIBLE LWS_EXTERN int
4296 lws_get_random(struct lws_context *context, void *buf, int len);
4298 * lws_daemonize(): make current process run in the background
4300 * \param _lock_path: the filepath to write the lock file
4302 * Spawn lws as a background process, taking care of various things
4304 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4305 lws_daemonize(const char *_lock_path);
4307 * lws_get_library_version(): return string describing the version of lws
4309 * On unix, also includes the git describe
4311 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4312 lws_get_library_version(void);
4315 * lws_wsi_user() - get the user data associated with the connection
4316 * \param wsi: lws connection
4318 * Not normally needed since it's passed into the callback
4320 LWS_VISIBLE LWS_EXTERN void *
4321 lws_wsi_user(struct lws *wsi);
4324 * lws_wsi_set_user() - set the user data associated with the client connection
4325 * \param wsi: lws connection
4326 * \param user: user data
4328 * By default lws allocates this and it's not legal to externally set it
4329 * yourself. However client connections may have it set externally when the
4330 * connection is created... if so, this api can be used to modify it at
4331 * runtime additionally.
4333 LWS_VISIBLE LWS_EXTERN void
4334 lws_set_wsi_user(struct lws *wsi, void *user);
4337 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4338 * Notice it does so by dropping '\0' into input string
4339 * and the leading / on the path is consequently lost
4341 * \param p: incoming uri string.. will get written to
4342 * \param prot: result pointer for protocol part (https://)
4343 * \param ads: result pointer for address part
4344 * \param port: result pointer for port part
4345 * \param path: result pointer for path part
4347 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4348 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4352 * lws_now_secs(): return seconds since 1970-1-1
4354 LWS_VISIBLE LWS_EXTERN unsigned long
4358 * lws_get_context - Allow geting lws_context from a Websocket connection
4361 * With this function, users can access context in the callback function.
4362 * Otherwise users may have to declare context as a global variable.
4364 * \param wsi: Websocket connection instance
4366 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4367 lws_get_context(const struct lws *wsi);
4370 * lws_get_count_threads(): how many service threads the context uses
4372 * \param context: the lws context
4374 * By default this is always 1, if you asked for more than lws can handle it
4375 * will clip the number of threads. So you can use this to find out how many
4376 * threads are actually in use.
4378 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4379 lws_get_count_threads(struct lws_context *context);
4382 * lws_get_parent() - get parent wsi or NULL
4383 * \param wsi: lws connection
4385 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4386 * this allows you to get their parent.
4388 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4389 lws_get_parent(const struct lws *wsi);
4392 * lws_get_child() - get child wsi or NULL
4393 * \param wsi: lws connection
4395 * Allows you to find a related wsi from the parent wsi.
4397 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4398 lws_get_child(const struct lws *wsi);
4402 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4403 * It's provided in case it is
4404 * useful when integrating with other app poll loop service code.
4406 LWS_VISIBLE LWS_EXTERN int
4407 lws_read(struct lws *wsi, unsigned char *buf, lws_filepos_t len);
4410 * lws_set_allocator() - custom allocator support
4414 * Allows you to replace the allocator (and deallocator) used by lws
4416 LWS_VISIBLE LWS_EXTERN void
4417 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4420 /** \defgroup wsstatus Websocket status APIs
4421 * ##Websocket connection status APIs
4423 * These provide information about ws connection or message status
4427 * lws_send_pipe_choked() - tests if socket is writable or not
4428 * \param wsi: lws connection
4430 * Allows you to check if you can write more on the socket
4432 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4433 lws_send_pipe_choked(struct lws *wsi);
4436 * lws_is_final_fragment() - tests if last part of ws message
4437 * \param wsi: lws connection
4439 LWS_VISIBLE LWS_EXTERN int
4440 lws_is_final_fragment(struct lws *wsi);
4443 * lws_get_reserved_bits() - access reserved bits of ws frame
4444 * \param wsi: lws connection
4446 LWS_VISIBLE LWS_EXTERN unsigned char
4447 lws_get_reserved_bits(struct lws *wsi);
4450 * lws_partial_buffered() - find out if lws buffered the last write
4451 * \param wsi: websocket connection to check
4453 * Returns 1 if you cannot use lws_write because the last
4454 * write on this connection is still buffered, and can't be cleared without
4455 * returning to the service loop and waiting for the connection to be
4458 * If you will try to do >1 lws_write call inside a single
4459 * WRITEABLE callback, you must check this after every write and bail if
4460 * set, ask for a new writeable callback and continue writing from there.
4462 * This is never set at the start of a writeable callback, but any write
4465 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4466 lws_partial_buffered(struct lws *wsi);
4469 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4471 * \param wsi: the connection we are inquiring about
4473 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4474 * it's interested to see if the frame it's dealing with was sent in binary
4477 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4478 lws_frame_is_binary(struct lws *wsi);
4481 * lws_is_ssl() - Find out if connection is using SSL
4482 * \param wsi: websocket connection to check
4484 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4485 * using verified cert, and 2 if using SSL but the cert was not
4486 * checked (appears for client wsi told to skip check on connection)
4488 LWS_VISIBLE LWS_EXTERN int
4489 lws_is_ssl(struct lws *wsi);
4491 * lws_is_cgi() - find out if this wsi is running a cgi process
4492 * \param wsi: lws connection
4494 LWS_VISIBLE LWS_EXTERN int
4495 lws_is_cgi(struct lws *wsi);
4497 #ifdef LWS_OPENSSL_SUPPORT
4499 * lws_get_ssl() - Return wsi's SSL context structure
4500 * \param wsi: websocket connection
4502 * Returns pointer to the SSL library's context structure
4504 LWS_VISIBLE LWS_EXTERN SSL*
4505 lws_get_ssl(struct lws *wsi);
4510 /** \defgroup sha SHA and B64 helpers
4511 * ##SHA and B64 helpers
4513 * These provide SHA-1 and B64 helper apis
4516 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4517 #define lws_SHA1 SHA1
4520 * lws_SHA1(): make a SHA-1 digest of a buffer
4522 * \param d: incoming buffer
4523 * \param n: length of incoming buffer
4524 * \param md: buffer for message digest (must be >= 20 bytes)
4526 * Reduces any size buffer into a 20-byte SHA-1 hash.
4528 LWS_VISIBLE LWS_EXTERN unsigned char *
4529 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4532 * lws_b64_encode_string(): encode a string into base 64
4534 * \param in: incoming buffer
4535 * \param in_len: length of incoming buffer
4536 * \param out: result buffer
4537 * \param out_size: length of result buffer
4539 * Encodes a string using b64
4541 LWS_VISIBLE LWS_EXTERN int
4542 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4544 * lws_b64_decode_string(): decode a string from base 64
4546 * \param in: incoming buffer
4547 * \param out: result buffer
4548 * \param out_size: length of result buffer
4550 * Decodes a string using b64
4552 LWS_VISIBLE LWS_EXTERN int
4553 lws_b64_decode_string(const char *in, char *out, int out_size);
4557 /*! \defgroup cgi cgi handling
4561 * These functions allow low-level control over stdin/out/err of the cgi.
4563 * However for most cases, binding the cgi to http in and out, the default
4564 * lws implementation already does the right thing.
4567 enum lws_enum_stdinouterr {
4573 enum lws_cgi_hdr_state {
4585 struct lws_cgi_args {
4586 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4587 enum lws_enum_stdinouterr ch; /**< channel index */
4588 unsigned char *data; /**< for messages with payload */
4589 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4590 int len; /**< length */
4595 * lws_cgi: spawn network-connected cgi process
4597 * \param wsi: connection to own the process
4598 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4599 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4600 * \param timeout_secs: seconds script should be allowed to run
4601 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4603 LWS_VISIBLE LWS_EXTERN int
4604 lws_cgi(struct lws *wsi, const char * const *exec_array,
4605 int script_uri_path_len, int timeout_secs,
4606 const struct lws_protocol_vhost_options *mp_cgienv);
4609 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4611 * \param wsi: connection to own the process
4613 LWS_VISIBLE LWS_EXTERN int
4614 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4617 * lws_cgi_kill: terminate cgi process associated with wsi
4619 * \param wsi: connection to own the process
4621 LWS_VISIBLE LWS_EXTERN int
4622 lws_cgi_kill(struct lws *wsi);
4627 /*! \defgroup fops file operation wrapping
4629 * ##File operation wrapping
4631 * Use these helper functions if you want to access a file from the perspective
4632 * of a specific wsi, which is usually the case. If you just want contextless
4633 * file access, use the fops callbacks directly with NULL wsi instead of these
4636 * If so, then it calls the platform handler or user overrides where present
4637 * (as defined in info->fops)
4639 * The advantage from all this is user code can be portable for file operations
4640 * without having to deal with differences between platforms.
4644 /** struct lws_plat_file_ops - Platform-specific file operations
4646 * These provide platform-agnostic ways to deal with filesystem access in the
4647 * library and in the user code.
4650 #if defined(LWS_WITH_ESP32)
4651 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4652 #define LWS_FOP_OPEN _open
4653 #define LWS_FOP_CLOSE _close
4654 #define LWS_FOP_SEEK_CUR _seek_cur
4655 #define LWS_FOP_READ _read
4656 #define LWS_FOP_WRITE _write
4658 #define LWS_FOP_OPEN open
4659 #define LWS_FOP_CLOSE close
4660 #define LWS_FOP_SEEK_CUR seek_cur
4661 #define LWS_FOP_READ read
4662 #define LWS_FOP_WRITE write
4665 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4666 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4667 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4668 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4669 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4671 struct lws_plat_file_ops;
4675 /**< real file descriptor related to the file... */
4676 const struct lws_plat_file_ops *fops;
4677 /**< fops that apply to this fop_fd */
4678 void *filesystem_priv;
4679 /**< ignored by lws; owned by the fops handlers */
4681 /**< generic "position in file" */
4683 /**< generic "length of file" */
4684 lws_fop_flags_t flags;
4685 /**< copy of the returned flags */
4687 /**< optional "modification time of file", only valid if .open()
4688 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4690 typedef struct lws_fop_fd *lws_fop_fd_t;
4692 struct lws_fops_index {
4693 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4694 uint8_t len; /* length of above string */
4697 struct lws_plat_file_ops {
4698 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4699 const char *filename, const char *vpath,
4700 lws_fop_flags_t *flags);
4701 /**< Open file (always binary access if plat supports it)
4702 * vpath may be NULL, or if the fops understands it, the point at which
4703 * the filename's virtual part starts.
4704 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4705 * If the file may be gzip-compressed,
4706 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4707 * gzip-compressed, then the open handler should OR
4708 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4710 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4711 /**< close file AND set the pointer to NULL */
4712 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4713 lws_fileofs_t offset_from_cur_pos);
4714 /**< seek from current position */
4715 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4716 uint8_t *buf, lws_filepos_t len);
4717 /**< Read from file, on exit *amount is set to amount actually read */
4718 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4719 uint8_t *buf, lws_filepos_t len);
4720 /**< Write to file, on exit *amount is set to amount actually written */
4722 struct lws_fops_index fi[3];
4723 /**< vfs path signatures implying use of this fops */
4725 const struct lws_plat_file_ops *next;
4726 /**< NULL or next fops in list */
4728 /* Add new things just above here ---^
4729 * This is part of the ABI, don't needlessly break compatibility */
4733 * lws_get_fops() - get current file ops
4735 * \param context: context
4737 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4738 lws_get_fops(struct lws_context *context);
4739 LWS_VISIBLE LWS_EXTERN void
4740 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4742 * lws_vfs_tell() - get current file position
4744 * \param fop_fd: fop_fd we are asking about
4746 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4747 lws_vfs_tell(lws_fop_fd_t fop_fd);
4749 * lws_vfs_get_length() - get current file total length in bytes
4751 * \param fop_fd: fop_fd we are asking about
4753 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4754 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4756 * lws_vfs_get_mod_time() - get time file last modified
4758 * \param fop_fd: fop_fd we are asking about
4760 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4761 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4763 * lws_vfs_file_seek_set() - seek relative to start of file
4765 * \param fop_fd: fop_fd we are seeking in
4766 * \param offset: offset from start of file
4768 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4769 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4771 * lws_vfs_file_seek_end() - seek relative to end of file
4773 * \param fop_fd: fop_fd we are seeking in
4774 * \param offset: offset from start of file
4776 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4777 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4779 extern struct lws_plat_file_ops fops_zip;
4782 * lws_plat_file_open() - open vfs filepath
4784 * \param fops: file ops struct that applies to this descriptor
4785 * \param vfs_path: filename to open
4786 * \param flags: pointer to open flags
4788 * The vfs_path is scanned for known fops signatures, and the open directed
4789 * to any matching fops open.
4791 * User code should use this api to perform vfs opens.
4793 * returns semi-opaque handle
4795 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4796 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4797 lws_fop_flags_t *flags);
4800 * lws_plat_file_close() - close file
4802 * \param fop_fd: file handle to close
4804 static LWS_INLINE int
4805 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4807 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4811 * lws_plat_file_seek_cur() - close file
4814 * \param fop_fd: file handle
4815 * \param offset: position to seek to
4817 static LWS_INLINE lws_fileofs_t
4818 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4820 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4823 * lws_plat_file_read() - read from file
4825 * \param fop_fd: file handle
4826 * \param amount: how much to read (rewritten by call)
4827 * \param buf: buffer to write to
4828 * \param len: max length
4830 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4831 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4832 uint8_t *buf, lws_filepos_t len)
4834 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4837 * lws_plat_file_write() - write from file
4839 * \param fop_fd: file handle
4840 * \param amount: how much to write (rewritten by call)
4841 * \param buf: buffer to read from
4842 * \param len: max length
4844 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4845 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4846 uint8_t *buf, lws_filepos_t len)
4848 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4851 /* these are the platform file operations implementations... they can
4852 * be called directly and used in fops arrays
4855 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4856 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4857 const char *vpath, lws_fop_flags_t *flags);
4858 LWS_VISIBLE LWS_EXTERN int
4859 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4860 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4861 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4862 LWS_VISIBLE LWS_EXTERN int
4863 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4864 uint8_t *buf, lws_filepos_t len);
4865 LWS_VISIBLE LWS_EXTERN int
4866 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4867 uint8_t *buf, lws_filepos_t len);
4869 LWS_VISIBLE LWS_EXTERN int
4870 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4871 lws_filepos_t *amount);
4876 * ##SMTP related functions
4878 * These apis let you communicate with a local SMTP server to send email from
4879 * lws. It handles all the SMTP sequencing and protocol actions.
4881 * Your system should have postfix, sendmail or another MTA listening on port
4882 * 25 and able to send email using the "mail" commandline app. Usually distro
4883 * MTAs are configured for this by default.
4885 * It runs via its own libuv events if initialized (which requires giving it
4886 * a libuv loop to attach to).
4888 * It operates using three callbacks, on_next() queries if there is a new email
4889 * to send, on_get_body() asks for the body of the email, and on_sent() is
4890 * called after the email is successfully sent.
4894 * - create an lws_email struct
4896 * - initialize data, loop, the email_* strings, max_content_size and
4899 * - call lws_email_init()
4901 * When you have at least one email to send, call lws_email_check() to
4902 * schedule starting to send it.
4905 #ifdef LWS_WITH_SMTP
4907 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
4908 enum lwsgs_smtp_states {
4909 LGSSMTP_IDLE, /**< awaiting new email */
4910 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
4911 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
4912 LGSSMTP_SENT_HELO, /**< sent the HELO */
4913 LGSSMTP_SENT_FROM, /**< sent FROM */
4914 LGSSMTP_SENT_TO, /**< sent TO */
4915 LGSSMTP_SENT_DATA, /**< sent DATA request */
4916 LGSSMTP_SENT_BODY, /**< sent the email body */
4917 LGSSMTP_SENT_QUIT, /**< sent the session quit */
4920 /** struct lws_email - abstract context for performing SMTP operations */
4923 /**< opaque pointer set by user code and available to the callbacks */
4925 /**< the libuv loop we will work on */
4927 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
4928 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
4929 char email_from[100]; /**< Fill before init or on_next */
4930 char email_to[100]; /**< Fill before init or on_next */
4932 unsigned int max_content_size;
4933 /**< largest possible email body size */
4935 /* Fill all the callbacks before init */
4937 int (*on_next)(struct lws_email *email);
4938 /**< (Fill in before calling lws_email_init)
4939 * called when idle, 0 = another email to send, nonzero is idle.
4940 * If you return 0, all of the email_* char arrays must be set
4941 * to something useful. */
4942 int (*on_sent)(struct lws_email *email);
4943 /**< (Fill in before calling lws_email_init)
4944 * called when transfer of the email to the SMTP server was
4945 * successful, your callback would remove the current email
4947 int (*on_get_body)(struct lws_email *email, char *buf, int len);
4948 /**< (Fill in before calling lws_email_init)
4949 * called when the body part of the queued email is about to be
4950 * sent to the SMTP server. */
4953 /* private things */
4954 uv_timer_t timeout_email; /**< private */
4955 enum lwsgs_smtp_states estate; /**< private */
4956 uv_connect_t email_connect_req; /**< private */
4957 uv_tcp_t email_client; /**< private */
4958 time_t email_connect_started; /**< private */
4959 char email_buf[256]; /**< private */
4960 char *content; /**< private */
4964 * lws_email_init() - Initialize a struct lws_email
4966 * \param email: struct lws_email to init
4967 * \param loop: libuv loop to use
4968 * \param max_content: max email content size
4970 * Prepares a struct lws_email for use ending SMTP
4972 LWS_VISIBLE LWS_EXTERN int
4973 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4976 * lws_email_check() - Request check for new email
4978 * \param email: struct lws_email context to check
4980 * Schedules a check for new emails in 1s... call this when you have queued an
4983 LWS_VISIBLE LWS_EXTERN void
4984 lws_email_check(struct lws_email *email);
4986 * lws_email_destroy() - stop using the struct lws_email
4988 * \param email: the struct lws_email context
4990 * Stop sending email using email and free allocations
4992 LWS_VISIBLE LWS_EXTERN void
4993 lws_email_destroy(struct lws_email *email);
4999 * Stats are all uint64_t numbers that start at 0.
5000 * Index names here have the convention
5004 * _MS_ millisecond count
5008 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
5009 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
5010 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
5011 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
5012 LWSSTATS_C_API_WRITE, /**< count calls to write API */
5013 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
5014 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
5015 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
5016 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
5017 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
5018 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
5019 LWSSTATS_C_SSL_CONNS_HAD_RX, /**< count of accepted SSL conns that have had some RX */
5020 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
5021 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
5022 LWSSTATS_B_READ, /**< aggregate bytes read */
5023 LWSSTATS_B_WRITE, /**< aggregate bytes written */
5024 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
5025 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
5026 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
5027 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
5028 LWSSTATS_MS_SSL_RX_DELAY, /**< aggregate delay between ssl accept complete and first RX */
5030 /* Add new things just above here ---^
5031 * This is part of the ABI, don't needlessly break compatibility */
5035 #if defined(LWS_WITH_STATS)
5037 LWS_VISIBLE LWS_EXTERN uint64_t
5038 lws_stats_get(struct lws_context *context, int index);
5039 LWS_VISIBLE LWS_EXTERN void
5040 lws_stats_log_dump(struct lws_context *context);
5042 static LWS_INLINE uint64_t
5043 lws_stats_get(struct lws_context *context, int index) { return 0; }
5044 static LWS_INLINE void
5045 lws_stats_log_dump(struct lws_context *context) { }