libwebsockets
Lightweight C library for HTML5 websockets
libwebsockets.h
Go to the documentation of this file.
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22  * IN THE SOFTWARE.
23  */
24 
27 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
28 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
29 
30 #ifdef __cplusplus
31 #include <cstddef>
32 #include <cstdarg>
33 
34 extern "C" {
35 #else
36 #include <stdarg.h>
37 #endif
38 
39 #include <string.h>
40 #include <stdlib.h>
41 
42 #include "lws_config.h"
43 
44 /* place for one-shot opaque forward references */
45 
46 struct lws_sequencer;
47 struct lws_dsh;
48 
49 /*
50  * CARE: everything using cmake defines needs to be below here
51  */
52 
53 #define LWS_US_PER_SEC ((lws_usec_t)1000000)
54 #define LWS_MS_PER_SEC ((lws_usec_t)1000)
55 #define LWS_US_PER_MS ((lws_usec_t)1000)
56 #define LWS_NS_PER_US ((lws_usec_t)1000)
57 
58 #define LWS_KI (1024)
59 #define LWS_MI (LWS_KI * 1024)
60 #define LWS_GI (LWS_MI * 1024)
61 #define LWS_TI ((uint64_t)LWS_GI * 1024)
62 #define LWS_PI ((uint64_t)LWS_TI * 1024)
63 
64 #define LWS_US_TO_MS(x) ((x + (LWS_US_PER_MS / 2)) / LWS_US_PER_MS)
65 
66 #if defined(LWS_HAS_INTPTR_T)
67 #include <stdint.h>
68 #define lws_intptr_t intptr_t
69 #else
70 typedef unsigned long long lws_intptr_t;
71 #endif
72 
73 #if defined(WIN32) || defined(_WIN32)
74 #ifndef WIN32_LEAN_AND_MEAN
75 #define WIN32_LEAN_AND_MEAN
76 #endif
77 
78 #include <winsock2.h>
79 #include <ws2tcpip.h>
80 #include <stddef.h>
81 #include <basetsd.h>
82 #include <io.h>
83 #ifndef _WIN32_WCE
84 #include <fcntl.h>
85 #else
86 #define _O_RDONLY 0x0000
87 #define O_RDONLY _O_RDONLY
88 #endif
89 
90 #define LWS_INLINE __inline
91 #define LWS_VISIBLE
92 #define LWS_WARN_UNUSED_RESULT
93 #define LWS_WARN_DEPRECATED
94 #define LWS_FORMAT(string_index)
95 
96 #if !defined(LWS_EXTERN)
97 #ifdef LWS_DLL
98 #ifdef LWS_INTERNAL
99 #define LWS_EXTERN extern __declspec(dllexport)
100 #else
101 #define LWS_EXTERN extern __declspec(dllimport)
102 #endif
103 #endif
104 #endif
105 
106 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
107 #define LWS_SOCK_INVALID (INVALID_SOCKET)
108 #define LWS_O_RDONLY _O_RDONLY
109 #define LWS_O_WRONLY _O_WRONLY
110 #define LWS_O_CREAT _O_CREAT
111 #define LWS_O_TRUNC _O_TRUNC
112 
113 #ifndef __func__
114 #define __func__ __FUNCTION__
115 #endif
116 
117 #else /* NOT WIN32 */
118 #include <unistd.h>
119 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
120 #include <sys/capability.h>
121 #endif
122 
123 #if defined(__NetBSD__) || defined(__FreeBSD__) || defined(__QNX__) || defined(__OpenBSD__)
124 #include <sys/socket.h>
125 #include <netinet/in.h>
126 #endif
127 
128 #define LWS_INLINE inline
129 #define LWS_O_RDONLY O_RDONLY
130 #define LWS_O_WRONLY O_WRONLY
131 #define LWS_O_CREAT O_CREAT
132 #define LWS_O_TRUNC O_TRUNC
133 
134 #if !defined(LWS_PLAT_OPTEE) && !defined(OPTEE_TA) && !defined(LWS_PLAT_FREERTOS)
135 #include <poll.h>
136 #include <netdb.h>
137 #define LWS_INVALID_FILE -1
138 #define LWS_SOCK_INVALID (-1)
139 #else
140 #define getdtablesize() (30)
141 #if defined(LWS_PLAT_FREERTOS)
142 #define LWS_INVALID_FILE NULL
143 #define LWS_SOCK_INVALID (-1)
144 #else
145 #define LWS_INVALID_FILE NULL
146 #define LWS_SOCK_INVALID (-1)
147 #endif
148 #endif
149 
150 #if defined(__GNUC__)
151 
152 /* warn_unused_result attribute only supported by GCC 3.4 or later */
153 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
154 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
155 #else
156 #define LWS_WARN_UNUSED_RESULT
157 #endif
158 
159 #define LWS_VISIBLE __attribute__((visibility("default")))
160 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
161 #define LWS_FORMAT(string_index) __attribute__ ((format(printf, string_index, string_index+1)))
162 #else
163 #define LWS_VISIBLE
164 #define LWS_WARN_UNUSED_RESULT
165 #define LWS_WARN_DEPRECATED
166 #define LWS_FORMAT(string_index)
167 #endif
168 
169 #if defined(__ANDROID__)
170 #include <netinet/in.h>
171 #include <unistd.h>
172 #endif
173 
174 #endif
175 
176 #if defined(LWS_WITH_LIBEV)
177 #include <ev.h>
178 #endif /* LWS_WITH_LIBEV */
179 #ifdef LWS_WITH_LIBUV
180 #include <uv.h>
181 #ifdef LWS_HAVE_UV_VERSION_H
182 #include <uv-version.h>
183 #endif
184 #ifdef LWS_HAVE_NEW_UV_VERSION_H
185 #include <uv/version.h>
186 #endif
187 #endif /* LWS_WITH_LIBUV */
188 #if defined(LWS_WITH_LIBEVENT)
189 #include <event2/event.h>
190 #endif /* LWS_WITH_LIBEVENT */
191 
192 #ifndef LWS_EXTERN
193 #define LWS_EXTERN extern
194 #endif
195 
196 #ifdef _WIN32
197 #define random rand
198 #else
199 #if !defined(LWS_PLAT_OPTEE)
200 #include <sys/time.h>
201 #include <unistd.h>
202 #endif
203 #endif
204 
205 #if defined(LWS_WITH_TLS)
206 
207 #ifdef USE_WOLFSSL
208 #ifdef USE_OLD_CYASSL
209 #ifdef _WIN32
210 /*
211  * Include user-controlled settings for windows from
212  * <wolfssl-root>/IDE/WIN/user_settings.h
213  */
214 #include <IDE/WIN/user_settings.h>
215 #include <cyassl/ctaocrypt/settings.h>
216 #else
217 #include <cyassl/options.h>
218 #endif
219 #include <cyassl/openssl/ssl.h>
220 #include <cyassl/error-ssl.h>
221 
222 #else
223 #ifdef _WIN32
224 /*
225  * Include user-controlled settings for windows from
226  * <wolfssl-root>/IDE/WIN/user_settings.h
227  */
228 #include <IDE/WIN/user_settings.h>
229 #include <wolfssl/wolfcrypt/settings.h>
230 #else
231 #include <wolfssl/options.h>
232 #endif
233 #include <wolfssl/openssl/ssl.h>
234 #include <wolfssl/error-ssl.h>
235 #endif /* not USE_OLD_CYASSL */
236 #else
237 #if defined(LWS_WITH_MBEDTLS)
238 #if defined(LWS_PLAT_FREERTOS)
239 /* this filepath is passed to us but without quotes or <> */
240 #if !defined(LWS_AMAZON_RTOS)
241 /* AMAZON RTOS has its own setting via MTK_MBEDTLS_CONFIG_FILE */
242 #undef MBEDTLS_CONFIG_FILE
243 #define MBEDTLS_CONFIG_FILE <mbedtls/esp_config.h>
244 #endif
245 #endif
246 #include <mbedtls/ssl.h>
247 #include <mbedtls/entropy.h>
248 #include <mbedtls/ctr_drbg.h>
249 #else
250 #include <openssl/ssl.h>
251 #if !defined(LWS_WITH_MBEDTLS)
252 #include <openssl/err.h>
253 #endif
254 #endif
255 #endif /* not USE_WOLFSSL */
256 #endif
257 
258 /*
259  * Helpers for pthread mutex in user code... if lws is built for
260  * multiple service threads, these resolve to pthread mutex
261  * operations. In the case LWS_MAX_SMP is 1 (the default), they
262  * are all NOPs and no pthread type or api is referenced.
263  */
264 
265 #if LWS_MAX_SMP > 1
266 
267 #include <pthread.h>
268 
269 #define lws_pthread_mutex(name) pthread_mutex_t name;
270 
271 static LWS_INLINE void
272 lws_pthread_mutex_init(pthread_mutex_t *lock)
273 {
274  pthread_mutex_init(lock, NULL);
275 }
276 
277 static LWS_INLINE void
278 lws_pthread_mutex_destroy(pthread_mutex_t *lock)
279 {
280  pthread_mutex_destroy(lock);
281 }
282 
283 static LWS_INLINE void
284 lws_pthread_mutex_lock(pthread_mutex_t *lock)
285 {
286  pthread_mutex_lock(lock);
287 }
288 
289 static LWS_INLINE void
290 lws_pthread_mutex_unlock(pthread_mutex_t *lock)
291 {
292  pthread_mutex_unlock(lock);
293 }
294 
295 #else
296 #define lws_pthread_mutex(name)
297 #define lws_pthread_mutex_init(_a)
298 #define lws_pthread_mutex_destroy(_a)
299 #define lws_pthread_mutex_lock(_a)
300 #define lws_pthread_mutex_unlock(_a)
301 #endif
302 
303 
304 #define CONTEXT_PORT_NO_LISTEN -1
305 #define CONTEXT_PORT_NO_LISTEN_SERVER -2
306 
307 #include <libwebsockets/lws-logs.h>
308 
309 
310 #include <stddef.h>
311 
312 #ifndef lws_container_of
313 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
314 #endif
315 #define LWS_ALIGN_TO(x, bou) x += ((bou) - ((x) % (bou))) % (bou)
316 
317 struct lws;
318 
319 /* api change list for user code to test against */
320 
321 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
322 
323 /* the struct lws_protocols has the id field present */
324 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
325 
326 /* you can call lws_get_peer_write_allowance */
327 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
328 
329 /* extra parameter introduced in 917f43ab821 */
330 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
331 
332 /* File operations stuff exists */
333 #define LWS_FEATURE_FOPS
334 
335 
336 #if defined(_WIN32)
337 #if !defined(LWS_WIN32_HANDLE_TYPES)
338 typedef SOCKET lws_sockfd_type;
339 typedef HANDLE lws_filefd_type;
340 #endif
341 
342 struct lws_pollfd {
343  lws_sockfd_type fd;
344  SHORT events;
345  SHORT revents;
346 };
347 #define LWS_POLLHUP (FD_CLOSE)
348 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
349 #define LWS_POLLOUT (FD_WRITE)
350 #else
351 
352 
353 #if defined(LWS_PLAT_FREERTOS)
354 #include <libwebsockets/lws-freertos.h>
355 #if defined(LWS_WITH_ESP32)
356 #include <libwebsockets/lws-esp32.h>
357 #endif
358 #else
359 typedef int lws_sockfd_type;
360 typedef int lws_filefd_type;
361 #endif
362 
363 #if defined(LWS_PLAT_OPTEE)
364 #include <time.h>
365 struct timeval {
366  time_t tv_sec;
367  unsigned int tv_usec;
368 };
369 #if defined(LWS_WITH_NETWORK)
370 // #include <poll.h>
371 #define lws_pollfd pollfd
372 
373 struct timezone;
374 
375 int gettimeofday(struct timeval *tv, struct timezone *tz);
376 
377  /* Internet address. */
378  struct in_addr {
379  uint32_t s_addr; /* address in network byte order */
380  };
381 
382 typedef unsigned short sa_family_t;
383 typedef unsigned short in_port_t;
384 typedef uint32_t socklen_t;
385 
386 #include <libwebsockets/lws-optee.h>
387 
388 #if !defined(TEE_SE_READER_NAME_MAX)
389  struct addrinfo {
390  int ai_flags;
391  int ai_family;
392  int ai_socktype;
393  int ai_protocol;
394  socklen_t ai_addrlen;
395  struct sockaddr *ai_addr;
396  char *ai_canonname;
397  struct addrinfo *ai_next;
398  };
399 #endif
400 
401 ssize_t recv(int sockfd, void *buf, size_t len, int flags);
402 ssize_t send(int sockfd, const void *buf, size_t len, int flags);
403 ssize_t read(int fd, void *buf, size_t count);
404 int getsockopt(int sockfd, int level, int optname,
405  void *optval, socklen_t *optlen);
406  int setsockopt(int sockfd, int level, int optname,
407  const void *optval, socklen_t optlen);
408 int connect(int sockfd, const struct sockaddr *addr,
409  socklen_t addrlen);
410 
411 extern int errno;
412 
413 uint16_t ntohs(uint16_t netshort);
414 uint16_t htons(uint16_t hostshort);
415 
416 int bind(int sockfd, const struct sockaddr *addr,
417  socklen_t addrlen);
418 
419 
420 #define MSG_NOSIGNAL 0x4000
421 #define EAGAIN 11
422 #define EINTR 4
423 #define EWOULDBLOCK EAGAIN
424 #define EADDRINUSE 98
425 #define INADDR_ANY 0
426 #define AF_INET 2
427 #define SHUT_WR 1
428 #define AF_UNSPEC 0
429 #define PF_UNSPEC 0
430 #define SOCK_STREAM 1
431 #define SOCK_DGRAM 2
432 # define AI_PASSIVE 0x0001
433 #define IPPROTO_UDP 17
434 #define SOL_SOCKET 1
435 #define SO_SNDBUF 7
436 #define EISCONN 106
437 #define EALREADY 114
438 #define EINPROGRESS 115
439 int shutdown(int sockfd, int how);
440 int close(int fd);
441 int atoi(const char *nptr);
442 long long atoll(const char *nptr);
443 
444 int socket(int domain, int type, int protocol);
445  int getaddrinfo(const char *node, const char *service,
446  const struct addrinfo *hints,
447  struct addrinfo **res);
448 
449  void freeaddrinfo(struct addrinfo *res);
450 
451 #if !defined(TEE_SE_READER_NAME_MAX)
452 struct lws_pollfd
453 {
454  int fd; /* File descriptor to poll. */
455  short int events; /* Types of events poller cares about. */
456  short int revents; /* Types of events that actually occurred. */
457 };
458 #endif
459 
460 int poll(struct pollfd *fds, int nfds, int timeout);
461 
462 #define LWS_POLLHUP (0x18)
463 #define LWS_POLLIN (1)
464 #define LWS_POLLOUT (4)
465 #else
466 struct lws_pollfd;
467 struct sockaddr_in;
468 #endif
469 #else
470 #define lws_pollfd pollfd
471 #define LWS_POLLHUP (POLLHUP | POLLERR)
472 #define LWS_POLLIN (POLLIN)
473 #define LWS_POLLOUT (POLLOUT)
474 #endif
475 #endif
476 
477 
478 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
479 /* ... */
480 #define ssize_t SSIZE_T
481 #endif
482 
483 #if defined(WIN32) && defined(LWS_HAVE__STAT32I64)
484 #include <sys/types.h>
485 #include <sys/stat.h>
486 #endif
487 
488 #if defined(LWS_HAVE_STDINT_H)
489 #include <stdint.h>
490 #else
491 #if defined(WIN32) || defined(_WIN32)
492 /* !!! >:-[ */
493 typedef __int64 int64_t;
494 typedef unsigned __int64 uint64_t;
495 typedef __int32 int32_t;
496 typedef unsigned __int32 uint32_t;
497 typedef __int16 int16_t;
498 typedef unsigned __int16 uint16_t;
499 typedef unsigned __int8 uint8_t;
500 #else
501 typedef unsigned int uint32_t;
502 typedef unsigned short uint16_t;
503 typedef unsigned char uint8_t;
504 #endif
505 #endif
506 
507 typedef int64_t lws_usec_t;
508 typedef unsigned long long lws_filepos_t;
509 typedef long long lws_fileofs_t;
510 typedef uint32_t lws_fop_flags_t;
511 
512 #define lws_concat_temp(_t, _l) (_t + sizeof(_t) - _l)
513 #define lws_concat_used(_t, _l) (sizeof(_t) - _l)
514 
517 struct lws_pollargs {
518  lws_sockfd_type fd;
519  int events;
521 };
522 
523 struct lws_extension; /* needed even with ws exts disabled for create context */
524 struct lws_token_limits;
525 struct lws_protocols;
526 struct lws_context;
527 struct lws_tokens;
528 struct lws_vhost;
529 struct lws;
530 
531 #include <libwebsockets/lws-dll2.h>
532 #include <libwebsockets/lws-timeout-timer.h>
533 #include <libwebsockets/lws-state.h>
534 #include <libwebsockets/lws-retry.h>
535 #include <libwebsockets/lws-adopt.h>
536 #include <libwebsockets/lws-network-helper.h>
537 #include <libwebsockets/lws-system.h>
538 #include <libwebsockets/lws-detailed-latency.h>
539 #include <libwebsockets/lws-ws-close.h>
540 #include <libwebsockets/lws-callbacks.h>
541 #include <libwebsockets/lws-ws-state.h>
542 #include <libwebsockets/lws-ws-ext.h>
543 #include <libwebsockets/lws-protocols-plugins.h>
544 #include <libwebsockets/lws-plugin-generic-sessions.h>
545 #include <libwebsockets/lws-context-vhost.h>
546 #include <libwebsockets/lws-client.h>
547 #include <libwebsockets/lws-http.h>
548 #include <libwebsockets/lws-spa.h>
549 #include <libwebsockets/lws-purify.h>
550 #include <libwebsockets/lws-misc.h>
551 #include <libwebsockets/lws-dsh.h>
552 #include <libwebsockets/lws-service.h>
553 #include <libwebsockets/lws-write.h>
554 #include <libwebsockets/lws-writeable.h>
555 #include <libwebsockets/lws-ring.h>
556 #include <libwebsockets/lws-sha1-base64.h>
557 #include <libwebsockets/lws-x509.h>
558 #include <libwebsockets/lws-cgi.h>
559 #if defined(LWS_WITH_FILE_OPS)
560 #include <libwebsockets/lws-vfs.h>
561 #endif
562 #include <libwebsockets/lws-lejp.h>
563 #include <libwebsockets/lws-stats.h>
564 #include <libwebsockets/lws-struct.h>
565 #include <libwebsockets/lws-threadpool.h>
566 #include <libwebsockets/lws-tokenize.h>
567 #include <libwebsockets/lws-lwsac.h>
568 #include <libwebsockets/lws-fts.h>
569 #include <libwebsockets/lws-diskcache.h>
570 #include <libwebsockets/lws-sequencer.h>
571 
572 #include <libwebsockets/abstract/abstract.h>
573 
574 #include <libwebsockets/lws-test-sequencer.h>
575 #include <libwebsockets/lws-async-dns.h>
576 
577 #if defined(LWS_WITH_TLS)
578 
579 #if defined(LWS_WITH_MBEDTLS)
580 #include <mbedtls/md5.h>
581 #include <mbedtls/sha1.h>
582 #include <mbedtls/sha256.h>
583 #include <mbedtls/sha512.h>
584 #endif
585 
586 #include <libwebsockets/lws-gencrypto.h>
587 #include <libwebsockets/lws-genhash.h>
588 #include <libwebsockets/lws-genrsa.h>
589 #include <libwebsockets/lws-genaes.h>
590 #include <libwebsockets/lws-genec.h>
591 
592 #include <libwebsockets/lws-jwk.h>
593 #include <libwebsockets/lws-jose.h>
594 #include <libwebsockets/lws-jws.h>
595 #include <libwebsockets/lws-jwe.h>
596 
597 #endif
598 
599 #ifdef __cplusplus
600 }
601 #endif
602 
603 #endif
lws_pollargs
Definition: libwebsockets.h:517
lws_pollargs::events
int events
Definition: libwebsockets.h:519
lws_pollargs::prev_events
int prev_events
Definition: libwebsockets.h:520
pollfd
Definition: lws-freertos.h:40
lws_pollargs::fd
lws_sockfd_type fd
Definition: libwebsockets.h:518
lws_extension
Definition: lws-ws-ext.h:139
lws_tokens
Definition: lws-http.h:204
lws_protocols
Definition: lws-protocols-plugins.h:44
lws_token_limits
Definition: lws-http.h:336