Subject: windows: support to bind to a specific IPv6 address
[platform/upstream/libwebsockets.git] / lib / private-libwebsockets.h
index e55c7f8..dcee160 100644 (file)
@@ -208,6 +208,9 @@ int kill(int pid, int sig);
 #ifdef LWS_USE_LIBUV
 #include <uv.h>
 #endif
+#ifdef LWS_USE_LIBEVENT
+#include <event2/event.h>
+#endif
 
 #ifndef LWS_NO_FORK
 #ifdef LWS_HAVE_SYS_PRCTL_H
@@ -262,6 +265,7 @@ lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
 #endif /* not USE_OLD_CYASSL */
 #else
 #include <openssl/ssl.h>
+#if !defined(LWS_WITH_ESP32)
 #include <openssl/evp.h>
 #include <openssl/err.h>
 #include <openssl/md5.h>
@@ -270,7 +274,7 @@ lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
 #include <openssl/ecdh.h>
 #endif
 #include <openssl/x509v3.h>
-
+#endif
 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
 /* later openssl defines this to negate the presence of tlsext... but it was only
  * introduced at 0.9.8j.  Earlier versions don't know it exists so don't
@@ -366,11 +370,23 @@ extern "C" {
 #endif
 
 #if defined(__sun) && defined(__GNUC__)
+
+#include <arpa/nameser_compat.h>
+
+#if !defined (BYTE_ORDER)
 # define BYTE_ORDER __BYTE_ORDER__
+#endif
+
+#if !defined(LITTLE_ENDIAN)
 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
+#endif
+
+#if !defined(BIG_ENDIAN)
 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
 #endif
 
+#endif /* sun + GNUC */
+
 #if !defined(BYTE_ORDER)
 # define BYTE_ORDER __BYTE_ORDER
 #endif
@@ -558,12 +574,75 @@ enum connection_mode {
        LWSCM_WSCL_WAITING_SERVER_REPLY,
        LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
        LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
+       LWSCM_WSCL_WAITING_SOCKS_GREETING_REPLY,
+       LWSCM_WSCL_WAITING_SOCKS_CONNECT_REPLY,
+       LWSCM_WSCL_WAITING_SOCKS_AUTH_REPLY,
 
        /****** add new things just above ---^ ******/
 
 
 };
 
+/* enums of socks version */
+enum socks_version {
+       SOCKS_VERSION_4 = 4,
+       SOCKS_VERSION_5 = 5
+};
+
+/* enums of subnegotiation version */
+enum socks_subnegotiation_version {
+       SOCKS_SUBNEGOTIATION_VERSION_1 = 1,
+};
+
+/* enums of socks commands */
+enum socks_command {
+       SOCKS_COMMAND_CONNECT = 1,
+       SOCKS_COMMAND_BIND = 2,
+       SOCKS_COMMAND_UDP_ASSOCIATE = 3
+};
+
+/* enums of socks address type */
+enum socks_atyp {
+       SOCKS_ATYP_IPV4 = 1,
+       SOCKS_ATYP_DOMAINNAME = 3,
+       SOCKS_ATYP_IPV6 = 4
+};
+
+/* enums of socks authentication methods */
+enum socks_auth_method {
+       SOCKS_AUTH_NO_AUTH = 0,
+       SOCKS_AUTH_GSSAPI = 1,
+       SOCKS_AUTH_USERNAME_PASSWORD = 2
+};
+
+/* enums of subnegotiation status */
+enum socks_subnegotiation_status {
+       SOCKS_SUBNEGOTIATION_STATUS_SUCCESS = 0,
+};
+
+/* enums of socks request reply */
+enum socks_request_reply {
+       SOCKS_REQUEST_REPLY_SUCCESS = 0,
+       SOCKS_REQUEST_REPLY_FAILURE_GENERAL = 1,
+       SOCKS_REQUEST_REPLY_CONNECTION_NOT_ALLOWED = 2,
+       SOCKS_REQUEST_REPLY_NETWORK_UNREACHABLE = 3,
+       SOCKS_REQUEST_REPLY_HOST_UNREACHABLE = 4,
+       SOCKS_REQUEST_REPLY_CONNECTION_REFUSED = 5,
+       SOCKS_REQUEST_REPLY_TTL_EXPIRED = 6,
+       SOCKS_REQUEST_REPLY_COMMAND_NOT_SUPPORTED = 7,
+       SOCKS_REQUEST_REPLY_ATYP_NOT_SUPPORTED = 8
+};
+
+/* enums used to generate socks messages */
+enum socks_msg_type {
+       /* greeting */
+       SOCKS_MSG_GREETING,
+       /* credential, user name and password */
+       SOCKS_MSG_USERNAME_PASSWORD,
+       /* connect command */
+       SOCKS_MSG_CONNECT
+};
+
 enum {
        LWS_RXFLOW_ALLOW = (1 << 0),
        LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
@@ -575,7 +654,7 @@ enum {
 struct lws_protocols;
 struct lws;
 
-#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
+#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 
 struct lws_io_watcher {
 #ifdef LWS_USE_LIBEV
@@ -584,6 +663,9 @@ struct lws_io_watcher {
 #ifdef LWS_USE_LIBUV
        uv_poll_t uv_watcher;
 #endif
+#ifdef LWS_USE_LIBEVENT
+       struct event *event_watcher;
+#endif
        struct lws_context *context;
 };
 
@@ -594,6 +676,9 @@ struct lws_signal_watcher {
 #ifdef LWS_USE_LIBUV
        uv_signal_t uv_watcher;
 #endif
+#ifdef LWS_USE_LIBEVENT
+       struct event *event_watcher;
+#endif
        struct lws_context *context;
 };
 #endif
@@ -670,7 +755,7 @@ struct lws_context_per_thread {
        struct lws *rx_draining_ext_list;
        struct lws *tx_draining_ext_list;
        struct lws *timeout_list;
-#ifdef LWS_USE_LIBUV
+#if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
        struct lws_context *context;
 #endif
 #ifdef LWS_WITH_CGI
@@ -692,10 +777,13 @@ struct lws_context_per_thread {
        uv_timer_t uv_timeout_watcher;
        uv_idle_t uv_idle;
 #endif
+#if defined(LWS_USE_LIBEVENT)
+       struct event_base *io_loop_event_base;
+#endif
 #if defined(LWS_USE_LIBEV)
        struct lws_io_watcher w_accept;
 #endif
-#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
+#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
        struct lws_signal_watcher w_sigint;
        unsigned char ev_loop_foreign:1;
 #endif
@@ -749,6 +837,11 @@ struct lws_vhost {
 #if !defined(LWS_WITH_ESP8266)
        char http_proxy_address[128];
        char proxy_basic_auth_token[128];
+#if defined(LWS_WITH_SOCKS5)
+       char socks_proxy_address[128];
+       char socks_user[96];
+       char socks_password[96];
+#endif
 #endif
 #if defined(LWS_WITH_ESP8266)
        /* listen sockets need a place to hang their hat */
@@ -776,6 +869,9 @@ struct lws_vhost {
 
        int listen_port;
        unsigned int http_proxy_port;
+#if defined(LWS_WITH_SOCKS5)
+       unsigned int socks_proxy_port;
+#endif
        unsigned int options;
        int count_protocols;
        int ka_time;
@@ -795,6 +891,7 @@ struct lws_vhost {
        unsigned int created_vhost_protocols:1;
 
        unsigned char default_protocol_index;
+       unsigned char raw_protocol_index;
 };
 
 /*
@@ -809,7 +906,10 @@ struct lws_context {
        time_t last_ws_ping_pong_check_s;
        time_t time_up;
        const struct lws_plat_file_ops *fops;
-       struct lws_plat_file_ops fops_default[2];
+       struct lws_plat_file_ops fops_platform;
+#if defined(LWS_WITH_ZIP_FOPS)
+       struct lws_plat_file_ops fops_zip;
+#endif
        struct lws_context_per_thread pt[LWS_MAX_SMP];
        struct lws_conn_stats conn_stats;
 #ifdef _WIN32
@@ -841,14 +941,23 @@ struct lws_context {
 #if defined(LWS_USE_LIBUV)
        uv_signal_cb lws_uv_sigint_cb;
 #endif
+#if defined(LWS_USE_LIBEVENT)
+       lws_event_signal_cb_t * lws_event_sigint_cb;
+#endif
        char canonical_hostname[128];
 #ifdef LWS_LATENCY
        unsigned long worst_latency;
        char worst_latency_info[256];
 #endif
 
+#if defined(LWS_WITH_STATS)
+       uint64_t lws_stats[LWSSTATS_SIZE];
+       uint64_t last_dump;
+       int updated;
+#endif
+
        int max_fds;
-#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
+#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
        int use_ev_sigint;
 #endif
        int started_with_parent;
@@ -873,13 +982,15 @@ struct lws_context {
        unsigned int timeout_secs;
        unsigned int pt_serv_buf_size;
        int max_http_header_data;
+       int simultaneous_ssl_restriction;
+       int simultaneous_ssl;
 
        unsigned int deprecated:1;
        unsigned int being_destroyed:1;
        unsigned int being_destroyed1:1;
        unsigned int requested_kill:1;
        unsigned int protocol_init_done:1;
-
+       unsigned int ssl_gate_accepts:1;
        /*
         * set to the Thread ID that's doing the service loop just before entry
         * to poll indicates service thread likely idling in poll()
@@ -896,6 +1007,7 @@ struct lws_context {
        short server_string_len;
        unsigned short ws_ping_pong_interval;
        unsigned short deprecation_pending_listen_close_count;
+       uint8_t max_fi;
 };
 
 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
@@ -931,6 +1043,7 @@ enum {
 #if defined(LWS_USE_LIBEV)
 LWS_EXTERN void
 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
+LWS_EXTERN void
 lws_libev_io(struct lws *wsi, int flags);
 LWS_EXTERN int
 lws_libev_init_fd_table(struct lws_context *context);
@@ -985,6 +1098,34 @@ LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info)
 #endif
 #endif
 
+#if defined(LWS_USE_LIBEVENT)
+LWS_EXTERN void
+lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
+LWS_EXTERN void
+lws_libevent_io(struct lws *wsi, int flags);
+LWS_EXTERN int
+lws_libevent_init_fd_table(struct lws_context *context);
+LWS_EXTERN void
+lws_libevent_destroyloop(struct lws_context *context, int tsi);
+LWS_EXTERN void
+lws_libevent_run(const struct lws_context *context, int tsi);
+#define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
+LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
+#else
+#define lws_libevent_accept(_a, _b) ((void) 0)
+#define lws_libevent_io(_a, _b) ((void) 0)
+#define lws_libevent_init_fd_table(_a) (0)
+#define lws_libevent_run(_a, _b) ((void) 0)
+#define lws_libevent_destroyloop(_a, _b) ((void) 0)
+#define LWS_LIBEVENT_ENABLED(context) (0)
+#if LWS_POSIX && !defined(LWS_WITH_ESP32)
+#define lws_feature_status_libevent(_a) \
+                       lwsl_notice("libevent support not compiled in\n")
+#else
+#define lws_feature_status_libevent(_a)
+#endif
+#endif
+
 
 #ifdef LWS_USE_IPV6
 #define LWS_IPV6_ENABLED(vh) \
@@ -1301,18 +1442,36 @@ struct _lws_websocket_related {
 
 #ifdef LWS_WITH_CGI
 
+enum {
+       SIGNIFICANT_HDR_CONTENT_LENGTH,
+       SIGNIFICANT_HDR_LOCATION,
+       SIGNIFICANT_HDR_STATUS,
+       SIGNIFICANT_HDR_TRANSFER_ENCODING,
+
+       SIGNIFICANT_HDR_COUNT
+};
+
 /* wsi who is master of the cgi points to an lws_cgi */
 
 struct lws_cgi {
        struct lws_cgi *cgi_list;
        struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
        struct lws *wsi; /* owner */
+       unsigned char *headers_buf;
+       unsigned char *headers_pos;
+       unsigned char *headers_dumped;
+       unsigned char *headers_end;
        unsigned long content_length;
        unsigned long content_length_seen;
        int pipe_fds[3][2];
+       int match[SIGNIFICANT_HDR_COUNT];
        int pid;
+       int response_code;
+       int lp;
+       char l[12];
 
        unsigned int being_closed:1;
+       unsigned int explicitly_chunked:1;
 
        unsigned char chunked_grace;
 };
@@ -1357,10 +1516,10 @@ struct lws {
 
        /* lifetime members */
 
-#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
+#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
        struct lws_io_watcher w_read;
 #endif
-#if defined(LWS_USE_LIBEV)
+#if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
        struct lws_io_watcher w_write;
 #endif
        time_t pending_timeout_limit;
@@ -1401,6 +1560,10 @@ struct lws {
        SSL *ssl;
        BIO *client_bio;
        struct lws *pending_read_list_prev, *pending_read_list_next;
+#if defined(LWS_WITH_STATS)
+       uint64_t accept_start_us;
+       char seen_rx;
+#endif
 #endif
 #ifdef LWS_WITH_HTTP_PROXY
        struct lws_rewrite *rw;
@@ -1410,7 +1573,9 @@ struct lws {
        unsigned long latency_start;
 #endif
        lws_sock_file_fd_type desc; /* .filefd / .sockfd */
-
+#if defined(LWS_WITH_STATS)
+       uint64_t active_writable_req_us;
+#endif
        /* ints */
        int position_in_fds_table;
        int rxflow_len;
@@ -1438,7 +1603,7 @@ struct lws {
        unsigned int sending_chunked:1;
        unsigned int already_did_cce:1;
        unsigned int told_user_closed:1;
-       unsigned int :1;
+
 #if defined(LWS_WITH_ESP8266)
        unsigned int pending_send_completion:3;
        unsigned int close_is_pending_send_completion:1;
@@ -1468,6 +1633,10 @@ struct lws {
        unsigned int redirect_to_https:1;
 #endif
 
+       /* volatile to make sure code is aware other thread can change */
+       volatile unsigned int handling_pollout:1;
+       volatile unsigned int leave_pollout_active:1;
+
 #ifndef LWS_NO_CLIENT
        unsigned short c_port;
 #endif
@@ -1505,6 +1674,11 @@ LWS_EXTERN int
 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
                const char *iface);
 
+#if defined(LWS_USE_IPV6)
+LWS_EXTERN unsigned long
+lws_get_addr_scope(const char *ipaddr);
+#endif
+
 LWS_EXTERN void
 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
 
@@ -1798,7 +1972,6 @@ lws_context_init_server_ssl(struct lws_context_creation_info *info,
 #endif
 LWS_EXTERN void
 lws_ssl_destroy(struct lws_vhost *vhost);
-
 /* HTTP2-related */
 
 #ifdef LWS_USE_HTTP2
@@ -1953,6 +2126,10 @@ void lws_free(void *p);
 #define lws_free_set_NULL(P)   do { lws_realloc(P, 0); (P) = NULL; } while(0)
 #endif
 
+const struct lws_plat_file_ops *
+lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
+                   const char **vpath);
+
 /* lws_plat_ */
 LWS_EXTERN void
 lws_plat_delete_socket_from_fds(struct lws_context *context,
@@ -1966,6 +2143,10 @@ lws_plat_service_periodic(struct lws_context *context);
 LWS_EXTERN int
 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
                       struct lws_pollfd *pfd);
+LWS_EXTERN void
+lws_add_wsi_to_draining_ext_list(struct lws *wsi);
+LWS_EXTERN void
+lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
 LWS_EXTERN int
 lws_plat_context_early_init(void);
 LWS_EXTERN void
@@ -1987,9 +2168,40 @@ LWS_EXTERN unsigned long long
 time_in_microseconds(void);
 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
+LWS_EXTERN int LWS_WARN_UNUSED_RESULT
+lws_plat_inet_pton(int af, const char *src, void *dst);
 
 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
+LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
+                               lws_filepos_t *amount);
+LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
+              lws_filepos_t *amount);
+
+LWS_EXTERN void
+lws_same_vh_protocol_remove(struct lws *wsi);
+LWS_EXTERN void
+lws_same_vh_protocol_insert(struct lws *wsi, int n);
+
+#if defined(LWS_WITH_STATS)
+void
+lws_stats_atomic_bump(struct lws_context * context,
+               struct lws_context_per_thread *pt, int index, uint64_t bump);
+void
+lws_stats_atomic_max(struct lws_context * context,
+               struct lws_context_per_thread *pt, int index, uint64_t val);
+#else
+static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
+               struct lws_context_per_thread *pt, int index, uint64_t bump) {
+       (void)context; (void)pt; (void)index; (void)bump; return 0; }
+static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
+               struct lws_context_per_thread *pt, int index, uint64_t val) {
+       (void)context; (void)pt; (void)index; (void)val; return 0; }
+#endif
+
+/* socks */
+void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,
+                       size_t *msg_len);
 
 #ifdef __cplusplus
 };