#ifdef __AVR__ #include "avrsupport.h" #endif /* * Copyright (c) 2004-2013 Sergey Lyubka * Copyright (c) 2013-2015 Cesanta Software Limited * All rights reserved * * This software is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this software under a commercial * license, as set out in . */ #define MG_VERSION "6.0" /* * Copyright (c) 2015 Cesanta Software Limited * All rights reserved */ #ifndef OSDEP_HEADER_INCLUDED #define OSDEP_HEADER_INCLUDED #if !defined(MG_DISABLE_FILESYSTEM) && defined(AVR_NOFS) #define MG_DISABLE_FILESYSTEM #endif #undef UNICODE /* Use ANSI WinAPI functions */ #undef _UNICODE /* Use multibyte encoding on Windows */ #define _MBCS /* Use multibyte encoding on Windows */ #define _INTEGRAL_MAX_BITS 64 /* Enable _stati64() on Windows */ #ifndef _CRT_SECURE_NO_WARNINGS #define _CRT_SECURE_NO_WARNINGS /* Disable deprecation warning in VS2005+ */ #endif #undef WIN32_LEAN_AND_MEAN /* Let windows.h always include winsock2.h */ #undef _XOPEN_SOURCE #define _XOPEN_SOURCE 600 /* For flockfile() on Linux */ #define __STDC_FORMAT_MACROS /* wants this for C++ */ #define __STDC_LIMIT_MACROS /* C++ wants that for INT64_MAX */ #ifndef _LARGEFILE_SOURCE #define _LARGEFILE_SOURCE /* Enable fseeko() and ftello() functions */ #endif #define _FILE_OFFSET_BITS 64 /* Enable 64-bit file offsets */ #if !(defined(AVR_LIBC) || defined(PICOTCP)) #include #include #include #include #include #endif #ifndef BYTE_ORDER #define LITTLE_ENDIAN 0x41424344 #define BIG_ENDIAN 0x44434241 #define PDP_ENDIAN 0x42414443 /* TODO(lsm): fix for big-endian machines. 'ABCD' is not portable */ /*#define BYTE_ORDER 'ABCD'*/ #define BYTE_ORDER LITTLE_ENDIAN #endif /* * MSVC++ 14.0 _MSC_VER == 1900 (Visual Studio 2015) * MSVC++ 12.0 _MSC_VER == 1800 (Visual Studio 2013) * MSVC++ 11.0 _MSC_VER == 1700 (Visual Studio 2012) * MSVC++ 10.0 _MSC_VER == 1600 (Visual Studio 2010) * MSVC++ 9.0 _MSC_VER == 1500 (Visual Studio 2008) * MSVC++ 8.0 _MSC_VER == 1400 (Visual Studio 2005) * MSVC++ 7.1 _MSC_VER == 1310 (Visual Studio 2003) * MSVC++ 7.0 _MSC_VER == 1300 * MSVC++ 6.0 _MSC_VER == 1200 * MSVC++ 5.0 _MSC_VER == 1100 */ #ifdef _MSC_VER #pragma warning(disable : 4127) /* FD_SET() emits warning, disable it */ #pragma warning(disable : 4204) /* missing c99 support */ #endif #ifdef PICOTCP #define time(x) PICO_TIME() #ifndef SOMAXCONN #define SOMAXCONN (16) #endif #ifdef _POSIX_VERSION #define signal(...) #endif #endif #include #include #include #include #include #include #include #include #ifndef va_copy #ifdef __va_copy #define va_copy __va_copy #else #define va_copy(x, y) (x) = (y) #endif #endif #ifdef _WIN32 #define random() rand() #ifdef _MSC_VER #pragma comment(lib, "ws2_32.lib") /* Linking with winsock library */ #endif #include #include #ifndef EINPROGRESS #define EINPROGRESS WSAEINPROGRESS #endif #ifndef EWOULDBLOCK #define EWOULDBLOCK WSAEWOULDBLOCK #endif #ifndef __func__ #define STRX(x) #x #define STR(x) STRX(x) #define __func__ __FILE__ ":" STR(__LINE__) #endif #define snprintf _snprintf #define fileno _fileno #define vsnprintf _vsnprintf #define sleep(x) Sleep((x) *1000) #define to64(x) _atoi64(x) #define popen(x, y) _popen((x), (y)) #define pclose(x) _pclose(x) #if defined(_MSC_VER) && _MSC_VER >= 1400 #define fseeko(x, y, z) _fseeki64((x), (y), (z)) #else #define fseeko(x, y, z) fseek((x), (y), (z)) #endif #define random() rand() typedef int socklen_t; typedef signed char int8_t; typedef unsigned char uint8_t; typedef int int32_t; typedef unsigned int uint32_t; typedef short int16_t; typedef unsigned short uint16_t; typedef __int64 int64_t; typedef unsigned __int64 uint64_t; typedef SOCKET sock_t; typedef uint32_t in_addr_t; #ifndef UINT16_MAX #define UINT16_MAX 65535 #endif #ifndef UINT32_MAX #define UINT32_MAX 4294967295 #endif #ifndef pid_t #define pid_t HANDLE #endif #define INT64_FMT "I64d" #define SIZE_T_FMT "Iu" #ifdef __MINGW32__ typedef struct stat cs_stat_t; #else typedef struct _stati64 cs_stat_t; #endif #ifndef S_ISDIR #define S_ISDIR(x) ((x) &_S_IFDIR) #endif #define DIRSEP '\\' /* POSIX opendir/closedir/readdir API for Windows. */ struct dirent { char d_name[MAX_PATH]; }; typedef struct DIR { HANDLE handle; WIN32_FIND_DATAW info; struct dirent result; } DIR; DIR *opendir(const char *name); int closedir(DIR *dir); struct dirent *readdir(DIR *dir); #elif /* not _WIN32 */ defined(MG_CC3200) #include #include #include #include #elif /* not CC3200 */ defined(MG_LWIP) #include #include #include #if defined(MG_ESP8266) && defined(RTOS_SDK) #include #define random() os_random() #endif /* TODO(alashkin): check if zero is OK */ #define SOMAXCONN 0 #include #elif /* not ESP8266 RTOS */ !defined(NO_LIBC) && !defined(NO_BSD_SOCKETS) #include #include #include #include #include #include /* For inet_pton() when MG_ENABLE_IPV6 is defined */ #include #include #include #endif #ifndef _WIN32 #include #include #include #ifndef AVR_LIBC #ifndef MG_ESP8266 #define closesocket(x) close(x) #endif #ifndef __cdecl #define __cdecl #endif #define INVALID_SOCKET (-1) #define INT64_FMT PRId64 #if defined(ESP8266) || defined(MG_ESP8266) #define SIZE_T_FMT "u" #else #define SIZE_T_FMT "zu" #endif #define to64(x) strtoll(x, NULL, 10) typedef int sock_t; typedef struct stat cs_stat_t; #define DIRSEP '/' #endif /* !AVR_LIBC */ #ifdef __APPLE__ int64_t strtoll(const char *str, char **endptr, int base); #endif #endif /* !_WIN32 */ #define __DBG(x) \ do { \ printf("%-20s ", __func__); \ printf x; \ putchar('\n'); \ fflush(stdout); \ } while (0) #ifdef MG_ENABLE_DEBUG #define DBG __DBG #else #define DBG(x) #endif #ifndef ARRAY_SIZE #define ARRAY_SIZE(array) (sizeof(array) / sizeof(array[0])) #endif #endif /* OSDEP_HEADER_INCLUDED */ /* * Copyright (c) 2015 Cesanta Software Limited * All rights reserved */ /* * === Memory Buffers * * Mbufs are mutable/growing memory buffers, like C++ strings. * Mbuf can append data to the end of a buffer, or insert data into arbitrary * position in the middle of a buffer. The buffer grows automatically when * needed. */ #ifndef MBUF_H_INCLUDED #define MBUF_H_INCLUDED #if defined(__cplusplus) extern "C" { #endif #include #ifndef MBUF_SIZE_MULTIPLIER #define MBUF_SIZE_MULTIPLIER 1.5 #endif /* Memory buffer descriptor */ struct mbuf { char *buf; /* Buffer pointer */ size_t len; /* Data length. Data is located between offset 0 and len. */ size_t size; /* Buffer size allocated by realloc(1). Must be >= len */ }; /* * Initialize an Mbuf. * `initial_capacity` specifies the initial capacity of the mbuf. */ void mbuf_init(struct mbuf *, size_t initial_capacity); /* Free the space allocated for the mbuffer and resets the mbuf structure. */ void mbuf_free(struct mbuf *); /* * Appends data to the Mbuf. * * Return the number of bytes appended, or 0 if out of memory. */ size_t mbuf_append(struct mbuf *, const void *data, size_t data_size); /* * Insert data at a specified offset in the Mbuf. * * Existing data will be shifted forwards and the buffer will * be grown if necessary. * Return the number of bytes inserted. */ size_t mbuf_insert(struct mbuf *, size_t, const void *, size_t); /* Remove `data_size` bytes from the beginning of the buffer. */ void mbuf_remove(struct mbuf *, size_t data_size); /* * Resize an Mbuf. * * If `new_size` is smaller than buffer's `len`, the * resize is not performed. */ void mbuf_resize(struct mbuf *, size_t new_size); /* Shrink an Mbuf by resizing its `size` to `len`. */ void mbuf_trim(struct mbuf *); #if defined(__cplusplus) } #endif /* __cplusplus */ #endif /* MBUF_H_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ #if !defined(MG_SHA1_HEADER_INCLUDED) && !defined(DISABLE_SHA1) #define MG_SHA1_HEADER_INCLUDED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ typedef struct { uint32_t state[5]; uint32_t count[2]; unsigned char buffer[64]; } cs_sha1_ctx; void cs_sha1_init(cs_sha1_ctx *); void cs_sha1_update(cs_sha1_ctx *, const unsigned char *data, uint32_t len); void cs_sha1_final(unsigned char digest[20], cs_sha1_ctx *); void cs_hmac_sha1(const unsigned char *key, size_t key_len, const unsigned char *text, size_t text_len, unsigned char out[20]); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_SHA1_HEADER_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ #ifndef MD5_HEADER_DEFINED #define MD5_HEADER_DEFINED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ typedef struct MD5Context { uint32_t buf[4]; uint32_t bits[2]; unsigned char in[64]; } MD5_CTX; void MD5_Init(MD5_CTX *c); void MD5_Update(MD5_CTX *c, const unsigned char *data, size_t len); void MD5_Final(unsigned char *md, MD5_CTX *c); /* * Return stringified MD5 hash for NULL terminated list of strings. * Example: * * char buf[33]; * cs_md5(buf, "foo", "bar", NULL); */ char *cs_md5(char buf[33], ...); /* * Stringify binary data. Output buffer size must be 2 * size_of_input + 1 * because each byte of input takes 2 bytes in string representation * plus 1 byte for the terminating \0 character. */ void cs_to_hex(char *to, const unsigned char *p, size_t len); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ #if !defined(BASE64_H_INCLUDED) && !defined(DISABLE_BASE64) #define BASE64_H_INCLUDED #include #ifdef __cplusplus extern "C" { #endif typedef void (*cs_base64_putc_t)(char, void *); struct cs_base64_ctx { /* cannot call it putc because it's a macro on some environments */ cs_base64_putc_t b64_putc; unsigned char chunk[3]; int chunk_size; void *user_data; }; void cs_base64_init(struct cs_base64_ctx *ctx, cs_base64_putc_t putc, void *user_data); void cs_base64_update(struct cs_base64_ctx *ctx, const char *str, size_t len); void cs_base64_finish(struct cs_base64_ctx *ctx); void cs_base64_encode(const unsigned char *src, int src_len, char *dst); void cs_fprint_base64(FILE *f, const unsigned char *src, int src_len); int cs_base64_decode(const unsigned char *s, int len, char *dst); #ifdef __cplusplus } #endif #endif /* * Copyright (c) 2015 Cesanta Software Limited * All rights reserved */ #ifndef STR_UTIL_H #define STR_UTIL_H #include #include #ifdef __cplusplus extern "C" { #endif int c_snprintf(char *buf, size_t buf_size, const char *format, ...); int c_vsnprintf(char *buf, size_t buf_size, const char *format, va_list ap); #if !(_XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L) && \ !(__DARWIN_C_LEVEL >= 200809L) && !defined(RTOS_SDK) || \ defined(_WIN32) int strnlen(const char *s, size_t maxlen); #endif #ifdef __cplusplus } #endif #endif /* * Copyright (c) 2004-2013 Sergey Lyubka * Copyright (c) 2013 Cesanta Software Limited * All rights reserved * * This library is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this library under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this library under a commercial * license, as set out in . */ #ifndef FROZEN_HEADER_INCLUDED #define FROZEN_HEADER_INCLUDED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #include enum json_type { JSON_TYPE_EOF = 0, /* End of parsed tokens marker */ JSON_TYPE_STRING = 1, JSON_TYPE_NUMBER = 2, JSON_TYPE_OBJECT = 3, JSON_TYPE_TRUE = 4, JSON_TYPE_FALSE = 5, JSON_TYPE_NULL = 6, JSON_TYPE_ARRAY = 7 }; struct json_token { const char *ptr; /* Points to the beginning of the token */ int len; /* Token length */ int num_desc; /* For arrays and object, total number of descendants */ enum json_type type; /* Type of the token, possible values above */ }; /* Error codes */ #define JSON_STRING_INVALID -1 #define JSON_STRING_INCOMPLETE -2 #define JSON_TOKEN_ARRAY_TOO_SMALL -3 int parse_json(const char *json_string, int json_string_length, struct json_token *tokens_array, int size_of_tokens_array); struct json_token *parse_json2(const char *json_string, int string_length); struct json_token *find_json_token(struct json_token *toks, const char *path); int json_emit_long(char *buf, int buf_len, long value); int json_emit_double(char *buf, int buf_len, double value); int json_emit_quoted_str(char *buf, int buf_len, const char *str, int len); int json_emit_unquoted_str(char *buf, int buf_len, const char *str, int len); int json_emit(char *buf, int buf_len, const char *fmt, ...); int json_emit_va(char *buf, int buf_len, const char *fmt, va_list); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* FROZEN_HEADER_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved * This software is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this software under a commercial * license, as set out in . */ /* * === Core: TCP/UDP/SSL * * NOTE: Mongoose manager is single threaded. It does not protect * its data structures by mutexes, therefore all functions that are dealing * with particular event manager should be called from the same thread, * with exception of `mg_broadcast()` function. It is fine to have different * event managers handled by different threads. */ #ifndef MG_NET_HEADER_INCLUDED #define MG_NET_HEADER_INCLUDED #ifdef MG_ENABLE_JAVASCRIPT #define EXCLUDE_COMMON #include #endif #ifdef MG_ENABLE_SSL #ifdef __APPLE__ #pragma GCC diagnostic ignored "-Wdeprecated-declarations" #endif #include #else typedef void *SSL; typedef void *SSL_CTX; #endif #ifdef MG_USE_READ_WRITE #define MG_EV_RECV_FUNC(s, b, l, f) read(s, b, l) #define MG_EV_SEND_FUNC(s, b, l, f) write(s, b, l) #else #define MG_EV_RECV_FUNC(s, b, l, f) recv(s, b, l, f) #define MG_EV_SEND_FUNC(s, b, l, f) send(s, b, l, f) #endif #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ union socket_address { struct sockaddr sa; struct sockaddr_in sin; #ifdef MG_ENABLE_IPV6 struct sockaddr_in6 sin6; #else struct sockaddr sin6; #endif }; /* Describes chunk of memory */ struct mg_str { const char *p; /* Memory chunk pointer */ size_t len; /* Memory chunk length */ }; #define MG_STR(str_literal) \ { str_literal, sizeof(str_literal) - 1 } /* * Callback function (event handler) prototype, must be defined by user. * Mongoose calls event handler, passing events defined below. */ struct mg_connection; typedef void (*mg_event_handler_t)(struct mg_connection *, int ev, void *); /* Events. Meaning of event parameter (evp) is given in the comment. */ #define MG_EV_POLL 0 /* Sent to each connection on each mg_mgr_poll() call */ #define MG_EV_ACCEPT 1 /* New connection accepted. union socket_address * */ #define MG_EV_CONNECT 2 /* connect() succeeded or failed. int * */ #define MG_EV_RECV 3 /* Data has benn received. int *num_bytes */ #define MG_EV_SEND 4 /* Data has been written to a socket. int *num_bytes */ #define MG_EV_CLOSE 5 /* Connection is closed. NULL */ /* * Mongoose event manager. */ struct mg_mgr { struct mg_connection *active_connections; const char *hexdump_file; /* Debug hexdump file path */ sock_t ctl[2]; /* Socketpair for mg_wakeup() */ void *user_data; /* User data */ void *mgr_data; /* Implementation-specific event manager's data. */ #ifdef MG_ENABLE_JAVASCRIPT struct v7 *v7; #endif }; /* * Mongoose connection. */ struct mg_connection { struct mg_connection *next, *prev; /* mg_mgr::active_connections linkage */ struct mg_connection *listener; /* Set only for accept()-ed connections */ struct mg_mgr *mgr; /* Pointer to containing manager */ sock_t sock; /* Socket to the remote peer */ union socket_address sa; /* Remote peer address */ size_t recv_mbuf_limit; /* Max size of recv buffer */ struct mbuf recv_mbuf; /* Received data */ struct mbuf send_mbuf; /* Data scheduled for sending */ SSL *ssl; SSL_CTX *ssl_ctx; time_t last_io_time; /* Timestamp of the last socket IO */ mg_event_handler_t proto_handler; /* Protocol-specific event handler */ void *proto_data; /* Protocol-specific data */ mg_event_handler_t handler; /* Event handler function */ void *user_data; /* User-specific data */ void *priv_1; /* Used by mg_enable_multithreading() */ void *priv_2; /* Used by mg_enable_multithreading() */ void *mgr_data; /* Implementation-specific event manager's data. */ unsigned long flags; /* Flags set by Mongoose */ #define MG_F_LISTENING (1 << 0) /* This connection is listening */ #define MG_F_UDP (1 << 1) /* This connection is UDP */ #define MG_F_RESOLVING (1 << 2) /* Waiting for async resolver */ #define MG_F_CONNECTING (1 << 3) /* connect() call in progress */ #define MG_F_SSL_HANDSHAKE_DONE (1 << 4) /* SSL specific */ #define MG_F_WANT_READ (1 << 5) /* SSL specific */ #define MG_F_WANT_WRITE (1 << 6) /* SSL specific */ #define MG_F_IS_WEBSOCKET (1 << 7) /* Websocket specific */ /* Flags that are settable by user */ #define MG_F_SEND_AND_CLOSE (1 << 10) /* Push remaining data and close */ #define MG_F_DONT_SEND (1 << 11) /* Do not send data to peer */ #define MG_F_CLOSE_IMMEDIATELY (1 << 12) /* Disconnect */ #define MG_F_WEBSOCKET_NO_DEFRAG (1 << 13) /* Websocket specific */ #define MG_F_DELETE_CHUNK (1 << 14) /* HTTP specific */ #define MG_F_USER_1 (1 << 20) /* Flags left for application */ #define MG_F_USER_2 (1 << 21) #define MG_F_USER_3 (1 << 22) #define MG_F_USER_4 (1 << 23) #define MG_F_USER_5 (1 << 24) #define MG_F_USER_6 (1 << 25) }; /* * Initialize Mongoose manager. Side effect: ignores SIGPIPE signal. * `mgr->user_data` field will be initialized with `user_data` parameter. * That is an arbitrary pointer, where user code can associate some data * with the particular Mongoose manager. For example, a C++ wrapper class * could be written, in which case `user_data` can hold a pointer to the * class instance. */ void mg_mgr_init(struct mg_mgr *mgr, void *user_data); /* * De-initializes Mongoose manager. * * Close and deallocate all active connections. */ void mg_mgr_free(struct mg_mgr *); /* * This function performs the actual IO, and must be called in a loop * (an event loop). Returns the current timestamp. * `milli` is the maximum number of milliseconds to sleep. * `mg_mgr_poll()` checks all connection for IO readiness. If at least one * of the connections is IO-ready, `mg_mgr_poll()` triggers respective * event handlers and returns. */ time_t mg_mgr_poll(struct mg_mgr *, int milli); /* * Pass a message of a given length to all connections. * * Must be called from a thread that does NOT call `mg_mgr_poll()`. * Note that `mg_broadcast()` is the only function * that can be, and must be, called from a different (non-IO) thread. * * `func` callback function will be called by the IO thread for each * connection. When called, event would be `MG_EV_POLL`, and message will * be passed as `ev_data` pointer. Maximum message size is capped * by `MG_CTL_MSG_MESSAGE_SIZE` which is set to 8192 bytes. */ void mg_broadcast(struct mg_mgr *, mg_event_handler_t func, void *, size_t); /* * Iterate over all active connections. * * Returns next connection from the list * of active connections, or `NULL` if there is no more connections. Below * is the iteration idiom: * * [source,c] * ---- * for (c = mg_next(srv, NULL); c != NULL; c = mg_next(srv, c)) { * // Do something with connection `c` * } * ---- */ struct mg_connection *mg_next(struct mg_mgr *, struct mg_connection *); /* * Optional parameters to mg_add_sock_opt() * `flags` is an initial `struct mg_connection::flags` bitmask to set, * see `MG_F_*` flags definitions. */ struct mg_add_sock_opts { void *user_data; /* Initial value for connection's user_data */ unsigned int flags; /* Initial connection flags */ const char **error_string; /* Placeholder for the error string */ }; /* * Create a connection, associate it with the given socket and event handler, * and add it to the manager. * * For more options see the `mg_add_sock_opt` variant. */ struct mg_connection *mg_add_sock(struct mg_mgr *, sock_t, mg_event_handler_t); /* * Create a connection, associate it with the given socket and event handler, * and add to the manager. * * See the `mg_add_sock_opts` structure for a description of the options. */ struct mg_connection *mg_add_sock_opt(struct mg_mgr *, sock_t, mg_event_handler_t, struct mg_add_sock_opts); /* * Optional parameters to mg_bind_opt() * `flags` is an initial `struct mg_connection::flags` bitmask to set, * see `MG_F_*` flags definitions. */ struct mg_bind_opts { void *user_data; /* Initial value for connection's user_data */ unsigned int flags; /* Extra connection flags */ const char **error_string; /* Placeholder for the error string */ }; /* * Create listening connection. * * See `mg_bind_opt` for full documentation. */ struct mg_connection *mg_bind(struct mg_mgr *, const char *, mg_event_handler_t); /* * Create listening connection. * * `address` parameter tells which address to bind to. It's format is the same * as for the `mg_connect()` call, where `HOST` part is optional. `address` * can be just a port number, e.g. `:8000`. To bind to a specific interface, * an IP address can be specified, e.g. `1.2.3.4:8000`. By default, a TCP * connection is created. To create UDP connection, prepend `udp://` prefix, * e.g. `udp://:8000`. To summarize, `address` paramer has following format: * `[PROTO://][IP_ADDRESS]:PORT`, where `PROTO` could be `tcp` or `udp`. * * See the `mg_bind_opts` structure for a description of the optional * parameters. * * Return a new listening connection, or `NULL` on error. * NOTE: Connection remains owned by the manager, do not free(). */ struct mg_connection *mg_bind_opt(struct mg_mgr *, const char *, mg_event_handler_t, struct mg_bind_opts); /* Optional parameters to mg_connect_opt() */ struct mg_connect_opts { void *user_data; /* Initial value for connection's user_data */ unsigned int flags; /* Extra connection flags */ const char **error_string; /* Placeholder for the error string */ }; /* * Connect to a remote host. * * See `mg_connect_opt()` for full documentation. */ struct mg_connection *mg_connect(struct mg_mgr *, const char *, mg_event_handler_t); /* * Connect to a remote host. * * `address` format is `[PROTO://]HOST:PORT`. `PROTO` could be `tcp` or `udp`. * `HOST` could be an IP address, * IPv6 address (if Mongoose is compiled with `-DMG_ENABLE_IPV6`), or a host * name. If `HOST` is a name, Mongoose will resolve it asynchronously. Examples * of valid addresses: `google.com:80`, `udp://1.2.3.4:53`, `10.0.0.1:443`, * `[::1]:80` * * See the `mg_connect_opts` structure for a description of the optional * parameters. * * Returns a new outbound connection, or `NULL` on error. * * NOTE: Connection remains owned by the manager, do not free(). * * NOTE: To enable IPv6 addresses, `-DMG_ENABLE_IPV6` should be specified * in the compilation flags. * * NOTE: New connection will receive `MG_EV_CONNECT` as it's first event * which will report connect success status. * If asynchronous resolution fail, or `connect()` syscall fail for whatever * reason (e.g. with `ECONNREFUSED` or `ENETUNREACH`), then `MG_EV_CONNECT` * event report failure. Code example below: * * [source,c] * ---- * static void ev_handler(struct mg_connection *nc, int ev, void *ev_data) { * int connect_status; * * switch (ev) { * case MG_EV_CONNECT: * connect_status = * (int *) ev_data; * if (connect_status == 0) { * // Success * } else { * // Error * printf("connect() error: %s\n", strerror(connect_status)); * } * break; * ... * } * } * * ... * mg_connect(mgr, "my_site.com:80", ev_handler); * ---- */ struct mg_connection *mg_connect_opt(struct mg_mgr *, const char *, mg_event_handler_t, struct mg_connect_opts); /* * Enable SSL for a given connection. * `cert` is a server certificate file name for a listening connection, * or a client certificate file name for an outgoing connection. * Certificate files must be in PEM format. Server certificate file * must contain a certificate, concatenated with a private key, optionally * concatenated with parameters. * `ca_cert` is a CA certificate, or NULL if peer verification is not * required. * Return: NULL on success, or error message on error. */ const char *mg_set_ssl(struct mg_connection *nc, const char *cert, const char *ca_cert); /* * Send data to the connection. * * Return number of written bytes. Note that sending * functions do not actually push data to the socket. They just append data * to the output buffer. The exception is UDP connections. For UDP, data is * sent immediately, and returned value indicates an actual number of bytes * sent to the socket. */ int mg_send(struct mg_connection *, const void *buf, int len); /* Enables format string warnings for mg_printf */ #if defined(__GNUC__) __attribute__((format(printf, 2, 3))) #endif /* don't separate from mg_printf declaration */ /* * Send `printf`-style formatted data to the connection. * * See `mg_send` for more details on send semantics. */ int mg_printf(struct mg_connection *, const char *fmt, ...); /* Same as `mg_printf()`, but takes `va_list ap` as an argument. */ int mg_vprintf(struct mg_connection *, const char *fmt, va_list ap); /* * Create a socket pair. * `sock_type` can be either `SOCK_STREAM` or `SOCK_DGRAM`. * Return 0 on failure, 1 on success. */ int mg_socketpair(sock_t[2], int sock_type); /* * Convert domain name into IP address. * * This is a utility function. If compilation flags have * `-DMG_ENABLE_GETADDRINFO`, then `getaddrinfo()` call is used for name * resolution. Otherwise, `gethostbyname()` is used. * * CAUTION: this function can block. * Return 1 on success, 0 on failure. */ int mg_resolve(const char *domain_name, char *ip_addr_buf, size_t buf_len); /* * Verify given IP address against the ACL. * * `remote_ip` - an IPv4 address to check, in host byte order * `acl` - a comma separated list of IP subnets: `x.x.x.x/x` or `x.x.x.x`. * Each subnet is * prepended by either a - or a + sign. A plus sign means allow, where a * minus sign means deny. If a subnet mask is omitted, such as `-1.2.3.4`, * this means to deny only that single IP address. * Subnet masks may vary from 0 to 32, inclusive. The default setting * is to allow all accesses. On each request the full list is traversed, * and the last match wins. Example: * * `-0.0.0.0/0,+192.168/16` - deny all acccesses, only allow 192.168/16 subnet * * To learn more about subnet masks, see the * link:https://en.wikipedia.org/wiki/Subnetwork[Wikipedia page on Subnetwork] * * Return -1 if ACL is malformed, 0 if address is disallowed, 1 if allowed. */ int mg_check_ip_acl(const char *acl, uint32_t remote_ip); /* * Enable multi-threaded handling for the given listening connection `nc`. * For each accepted connection, Mongoose will create a separate thread * and run event handler in that thread. Thus, if an event hanler is doing * a blocking call or some long computation, that will not slow down * other connections. */ void mg_enable_multithreading(struct mg_connection *nc); #ifdef MG_ENABLE_JAVASCRIPT /* * Enable server-side JavaScript scripting. * Requires `-DMG_ENABLE_JAVASCRIPT` compilation flag, and V7 engine sources. * v7 instance must not be destroyed during manager's lifetime. * Return V7 error. */ enum v7_err mg_enable_javascript(struct mg_mgr *m, struct v7 *v7, const char *init_js_file_name); #endif #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_NET_HEADER_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === Utilities */ #ifndef MG_UTIL_HEADER_DEFINED #define MG_UTIL_HEADER_DEFINED #include #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #ifndef MAX_PATH_SIZE #define MAX_PATH_SIZE 500 #endif /* * Fetch substring from input string `s`, `end` into `v`. * Skips initial delimiter characters. Records first non-delimiter character * as the beginning of substring `v`. Then scans the rest of the string * until a delimiter character or end-of-string is found. * `delimiters` is a 0-terminated string containing delimiter characters. * Either one of `delimiters` or `end_string` terminates the search. * Return an `s` pointer, advanced forward where parsing stopped. */ const char *mg_skip(const char *s, const char *end_string, const char *delimiters, struct mg_str *v); /* * Cross-platform version of `strncasecmp()`. */ int mg_ncasecmp(const char *s1, const char *s2, size_t len); /* * Cross-platform version of `strcasecmp()`. */ int mg_casecmp(const char *s1, const char *s2); /* * Cross-platform version of `strcmp()` where where first string is * specified by `struct mg_str`. */ int mg_vcmp(const struct mg_str *str2, const char *str1); /* * Cross-platform version of `strncasecmp()` where first string is * specified by `struct mg_str`. */ int mg_vcasecmp(const struct mg_str *str2, const char *str1); /* * Decode base64-encoded string `s`, `len` into the destination `dst`. * Destination has to have enough space to hold decoded buffer. * Decoding stops either when all string has been decoded, or invalid * character appeared. * Destination is '\0'-terminated. * Return number of decoded characters. On success, that should be equal to * `len`. On error (invalid character) the return value is smaller then `len`. */ int mg_base64_decode(const unsigned char *s, int len, char *dst); /* * Base64-encode chunk of memory `src`, `src_len` into the destination `dst`. * Destination has to have enough space to hold encoded buffer. * Destination is '\0'-terminated. */ void mg_base64_encode(const unsigned char *src, int src_len, char *dst); #ifndef MG_DISABLE_FILESYSTEM /* * Perform a 64-bit `stat()` call against given file. * * `path` should be UTF8 encoded. * * Return value is the same as for `stat()` syscall. */ int mg_stat(const char *path, cs_stat_t *st); /* * Open the given file and return a file stream. * * `path` and `mode` should be UTF8 encoded. * * Return value is the same as for the `fopen()` call. */ FILE *mg_fopen(const char *path, const char *mode); /* * Open the given file and return a file stream. * * `path` should be UTF8 encoded. * * Return value is the same as for the `open()` syscall. */ int mg_open(const char *path, int flag, int mode); #endif /* MG_DISABLE_FILESYSTEM */ #ifdef MG_ENABLE_THREADS /* * Start a new detached thread. * Arguments and semantic is the same as pthead's `pthread_create()`. * `thread_func` is a thread function, `thread_func_param` is a parameter * that is passed to the thread function. */ void *mg_start_thread(void *(*thread_func)(void *), void *thread_func_param); #endif void mg_set_close_on_exec(sock_t); #define MG_SOCK_STRINGIFY_IP 1 #define MG_SOCK_STRINGIFY_PORT 2 #define MG_SOCK_STRINGIFY_REMOTE 4 /* * Convert socket's local or remote address into string. * * The `flags` parameter is a bit mask that controls the behavior, * see `MG_SOCK_STRINGIFY_*` definitions. * * - MG_SOCK_STRINGIFY_IP - print IP address * - MG_SOCK_STRINGIFY_PORT - print port number * - MG_SOCK_STRINGIFY_REMOTE - print remote peer's IP/port, not local address * * If both port number and IP address are printed, they are separated by `:`. * If compiled with `-DMG_ENABLE_IPV6`, IPv6 addresses are supported. */ void mg_sock_to_str(sock_t sock, char *buf, size_t len, int flags); /* * Convert socket's address into string. * * `flags` is MG_SOCK_STRINGIFY_IP and/or MG_SOCK_STRINGIFY_PORT. */ void mg_sock_addr_to_str(const union socket_address *sa, char *buf, size_t len, int flags); /* * Generates human-readable hexdump of memory chunk. * * Takes a memory buffer `buf` of length `len` and creates a hex dump of that * buffer in `dst`. Generated output is a-la hexdump(1). * Return length of generated string, excluding terminating `\0`. If returned * length is bigger than `dst_len`, overflow bytes are discarded. */ int mg_hexdump(const void *buf, int len, char *dst, int dst_len); /* * Generates human-readable hexdump of the data sent or received by connection. * `path` is a file name where hexdump should be written. `num_bytes` is * a number of bytes sent/received. `ev` is one of the `MG_*` events sent to * an event handler. This function is supposed to be called from the * event handler. */ void mg_hexdump_connection(struct mg_connection *nc, const char *path, int num_bytes, int ev); /* * Print message to buffer. If buffer is large enough to hold the message, * return buffer. If buffer is to small, allocate large enough buffer on heap, * and return allocated buffer. * This is a supposed use case: * * char buf[5], *p = buf; * p = mg_avprintf(&p, sizeof(buf), "%s", "hi there"); * use_p_somehow(p); * if (p != buf) { * free(p); * } * * The purpose of this is to avoid malloc-ing if generated strings are small. */ int mg_avprintf(char **buf, size_t size, const char *fmt, va_list ap); /* * Return true if target platform is big endian. */ int mg_is_big_endian(void); /* * A helper function for traversing a comma separated list of values. * It returns a list pointer shifted to the next value, or NULL if the end * of the list found. * Value is stored in val vector. If value has form "x=y", then eq_val * vector is initialized to point to the "y" part, and val vector length * is adjusted to point only to "x". * If list is just a comma separated list of entries, like "aa,bb,cc" then * `eq_val` will contain zero-length string. * * The purpose of this function is to parse comma separated string without * any copying/memory allocation. */ const char *mg_next_comma_list_entry(const char *list, struct mg_str *val, struct mg_str *eq_val); /* * Match 0-terminated string against a glob pattern. * Match is case-insensitive. Return number of bytes matched, or -1 if no match. */ int mg_match_prefix(const char *pattern, int pattern_len, const char *str); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_UTIL_HEADER_DEFINED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === HTTP + Websocket */ #ifndef MG_HTTP_HEADER_DEFINED #define MG_HTTP_HEADER_DEFINED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #ifndef MG_MAX_HTTP_HEADERS #define MG_MAX_HTTP_HEADERS 40 #endif #ifndef MG_MAX_HTTP_REQUEST_SIZE #define MG_MAX_HTTP_REQUEST_SIZE 8192 #endif #ifndef MG_MAX_PATH #define MG_MAX_PATH 1024 #endif #ifndef MG_MAX_HTTP_SEND_IOBUF #define MG_MAX_HTTP_SEND_IOBUF 4096 #endif #ifndef MG_WEBSOCKET_PING_INTERVAL_SECONDS #define MG_WEBSOCKET_PING_INTERVAL_SECONDS 5 #endif #ifndef MG_CGI_ENVIRONMENT_SIZE #define MG_CGI_ENVIRONMENT_SIZE 8192 #endif #ifndef MG_MAX_CGI_ENVIR_VARS #define MG_MAX_CGI_ENVIR_VARS 64 #endif #ifndef MG_ENV_EXPORT_TO_CGI #define MG_ENV_EXPORT_TO_CGI "MONGOOSE_CGI" #endif /* HTTP message */ struct http_message { struct mg_str message; /* Whole message: request line + headers + body */ /* HTTP Request line (or HTTP response line) */ struct mg_str method; /* "GET" */ struct mg_str uri; /* "/my_file.html" */ struct mg_str proto; /* "HTTP/1.1" -- for both request and response */ /* For responses, code and response status message are set */ int resp_code; struct mg_str resp_status_msg; /* * Query-string part of the URI. For example, for HTTP request * GET /foo/bar?param1=val1¶m2=val2 * | uri | query_string | * * Note that question mark character doesn't belong neither to the uri, * nor to the query_string */ struct mg_str query_string; /* Headers */ struct mg_str header_names[MG_MAX_HTTP_HEADERS]; struct mg_str header_values[MG_MAX_HTTP_HEADERS]; /* Message body */ struct mg_str body; /* Zero-length for requests with no body */ }; struct websocket_message { unsigned char *data; size_t size; unsigned char flags; }; /* HTTP and websocket events. void *ev_data is described in a comment. */ #define MG_EV_HTTP_REQUEST 100 /* struct http_message * */ #define MG_EV_HTTP_REPLY 101 /* struct http_message * */ #define MG_EV_HTTP_CHUNK 102 /* struct http_message * */ #define MG_EV_SSI_CALL 105 /* char * */ #define MG_EV_WEBSOCKET_HANDSHAKE_REQUEST 111 /* NULL */ #define MG_EV_WEBSOCKET_HANDSHAKE_DONE 112 /* NULL */ #define MG_EV_WEBSOCKET_FRAME 113 /* struct websocket_message * */ #define MG_EV_WEBSOCKET_CONTROL_FRAME 114 /* struct websocket_message * */ /* * Attach built-in HTTP event handler to the given connection. * User-defined event handler will receive following extra events: * * - MG_EV_HTTP_REQUEST: HTTP request has arrived. Parsed HTTP request is passed *as * `struct http_message` through the handler's `void *ev_data` pointer. * - MG_EV_HTTP_REPLY: HTTP reply has arrived. Parsed HTTP reply is passed as * `struct http_message` through the handler's `void *ev_data` pointer. * - MG_EV_HTTP_CHUNK: HTTP chunked-encoding chunk has arrived. * Parsed HTTP reply is passed as `struct http_message` through the * handler's `void *ev_data` pointer. `http_message::body` would contain * incomplete, reassembled HTTP body. * It will grow with every new chunk arrived, and * potentially can consume a lot of memory. An event handler may process * the body as chunks are coming, and signal Mongoose to delete processed * body by setting `MG_F_DELETE_CHUNK` in `mg_connection::flags`. When * the last zero chunk is received, * Mongoose sends `MG_EV_HTTP_REPLY` event with * full reassembled body (if handler did not signal to delete chunks) or * with empty body (if handler did signal to delete chunks). * - MG_EV_WEBSOCKET_HANDSHAKE_REQUEST: server has received websocket handshake * request. `ev_data` contains parsed HTTP request. * - MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed Websocket handshake. * `ev_data` is `NULL`. * - MG_EV_WEBSOCKET_FRAME: new websocket frame has arrived. `ev_data` is * `struct websocket_message *` */ void mg_set_protocol_http_websocket(struct mg_connection *nc); /* * Send websocket handshake to the server. * * `nc` must be a valid connection, connected to a server. `uri` is an URI * to fetch, extra_headers` is extra HTTP headers to send or `NULL`. * * This function is intended to be used by websocket client. */ void mg_send_websocket_handshake(struct mg_connection *nc, const char *uri, const char *extra_headers); /* * Send websocket frame to the remote end. * * `op_and_flags` specifies frame's type, one of: * * - WEBSOCKET_OP_CONTINUE * - WEBSOCKET_OP_TEXT * - WEBSOCKET_OP_BINARY * - WEBSOCKET_OP_CLOSE * - WEBSOCKET_OP_PING * - WEBSOCKET_OP_PONG * * Orred with one of the flags: * * - WEBSOCKET_DONT_FIN: Don't set the FIN flag on the frame to be sent. * * `data` and `data_len` contain frame data. */ void mg_send_websocket_frame(struct mg_connection *nc, int op_and_flags, const void *data, size_t data_len); /* * Send multiple websocket frames. * * Like `mg_send_websocket_frame()`, but composes a frame from multiple buffers. */ void mg_send_websocket_framev(struct mg_connection *nc, int op_and_flags, const struct mg_str *strings, int num_strings); /* * Send websocket frame to the remote end. * * Like `mg_send_websocket_frame()`, but allows to create formatted message * with `printf()`-like semantics. */ void mg_printf_websocket_frame(struct mg_connection *nc, int op_and_flags, const char *fmt, ...); /* * Send buffer `buf` of size `len` to the client using chunked HTTP encoding. * This function first sends buffer size as hex number + newline, then * buffer itself, then newline. For example, * `mg_send_http_chunk(nc, "foo", 3)` whill append `3\r\nfoo\r\n` string to * the `nc->send_mbuf` output IO buffer. * * NOTE: HTTP header "Transfer-Encoding: chunked" should be sent prior to * using this function. * * NOTE: do not forget to send empty chunk at the end of the response, * to tell the client that everything was sent. Example: * * ``` * mg_printf_http_chunk(nc, "%s", "my response!"); * mg_send_http_chunk(nc, "", 0); // Tell the client we're finished * ``` */ void mg_send_http_chunk(struct mg_connection *nc, const char *buf, size_t len); /* * Send printf-formatted HTTP chunk. * Functionality is similar to `mg_send_http_chunk()`. */ void mg_printf_http_chunk(struct mg_connection *, const char *, ...); /* * Send printf-formatted HTTP chunk, escaping HTML tags. */ void mg_printf_html_escape(struct mg_connection *, const char *, ...); /* Websocket opcodes, from http://tools.ietf.org/html/rfc6455 */ #define WEBSOCKET_OP_CONTINUE 0 #define WEBSOCKET_OP_TEXT 1 #define WEBSOCKET_OP_BINARY 2 #define WEBSOCKET_OP_CLOSE 8 #define WEBSOCKET_OP_PING 9 #define WEBSOCKET_OP_PONG 10 /* * If set causes the FIN flag to not be set on outbound * frames. This enables sending multiple fragments of a single * logical message. * * The WebSocket protocol mandates that if the FIN flag of a data * frame is not set, the next frame must be a WEBSOCKET_OP_CONTINUE. * The last frame must have the FIN bit set. * * Note that mongoose will automatically defragment incoming messages, * so this flag is used only on outbound messages. */ #define WEBSOCKET_DONT_FIN 0x100 /* * Parse a HTTP message. * * `is_req` should be set to 1 if parsing request, 0 if reply. * * Return number of bytes parsed. If HTTP message is * incomplete, `0` is returned. On parse error, negative number is returned. */ int mg_parse_http(const char *s, int n, struct http_message *hm, int is_req); /* * Search and return header `name` in parsed HTTP message `hm`. * If header is not found, NULL is returned. Example: * * struct mg_str *host_hdr = mg_get_http_header(hm, "Host"); */ struct mg_str *mg_get_http_header(struct http_message *hm, const char *name); /* * Parse HTTP header `hdr`. Find variable `var_name` and store it's value * in the buffer `buf`, `buf_size`. Return 0 if variable not found, non-zero * otherwise. * * This function is supposed to parse * cookies, authentication headers, etcetera. Example (error handling omitted): * * char user[20]; * struct mg_str *hdr = mg_get_http_header(hm, "Authorization"); * mg_http_parse_header(hdr, "username", user, sizeof(user)); * * Return length of the variable's value. If buffer is not large enough, * or variable not found, 0 is returned. */ int mg_http_parse_header(struct mg_str *hdr, const char *var_name, char *buf, size_t buf_size); /* * Parse buffer `buf`, `buf_len` that contains multipart form data chunks. * Store chunk name in a `var_name`, `var_name_len` buffer. * If a chunk is an uploaded file, then `file_name`, `file_name_len` is * filled with an uploaded file name. `chunk`, `chunk_len` * points to the chunk data. * * Return: number of bytes to skip to the next chunk, or 0 if there are * no more chunks. * * Usage example: * * static void ev_handler(struct mg_connection *nc, int ev, void *ev_data) { * switch(ev) { * case MG_EV_HTTP_REQUEST: { * struct http_message *hm = (struct http_message *) ev_data; * char var_name[100], file_name[100]; * const char *chunk; * size_t chunk_len, n1, n2; * * n1 = n2 = 0; * while ((n2 = mg_parse_multipart(hm->body.p + n1, * hm->body.len - n1, * var_name, sizeof(var_name), * file_name, sizeof(file_name), * &chunk, &chunk_len)) > 0) { * printf("var: %s, file_name: %s, size: %d, chunk: [%.*s]\n", * var_name, file_name, (int) chunk_len, * (int) chunk_len, chunk); * n1 += n2; * } * } * break; * */ size_t mg_parse_multipart(const char *buf, size_t buf_len, char *var_name, size_t var_name_len, char *file_name, size_t file_name_len, const char **chunk, size_t *chunk_len); /* * Fetch an HTTP form variable. * * Fetch a variable `name` from a `buf` into a buffer specified by * `dst`, `dst_len`. Destination is always zero-terminated. Return length * of a fetched variable. If not found, 0 is returned. `buf` must be * valid url-encoded buffer. If destination is too small, `-1` is returned. */ int mg_get_http_var(const struct mg_str *, const char *, char *dst, size_t); /* Create Digest authentication header for client request. */ int mg_http_create_digest_auth_header(char *buf, size_t buf_len, const char *method, const char *uri, const char *auth_domain, const char *user, const char *passwd); /* * Helper function that creates outbound HTTP connection. * * `url` is a URL to fetch. It must be properly URL-encoded, e.g. have * no spaces, etc. By default, `mg_connect_http()` sends Connection and * Host headers. `extra_headers` is an extra HTTP headers to send, e.g. * `"User-Agent: my-app\r\n"`. * If `post_data` is NULL, then GET request is created. Otherwise, POST request * is created with the specified POST data. Examples: * * [source,c] * ---- * nc1 = mg_connect_http(mgr, ev_handler_1, "http://www.google.com", NULL, * NULL); * nc2 = mg_connect_http(mgr, ev_handler_1, "https://github.com", NULL, NULL); * nc3 = mg_connect_http(mgr, ev_handler_1, "my_server:8000/form_submit/", * NULL, "var_1=value_1&var_2=value_2"); * ---- */ struct mg_connection *mg_connect_http(struct mg_mgr *, mg_event_handler_t event_handler, const char *url, const char *extra_headers, const char *post_data); /* * This structure defines how `mg_serve_http()` works. * Best practice is to set only required settings, and leave the rest as NULL. */ struct mg_serve_http_opts { /* Path to web root directory */ const char *document_root; /* List of index files. Default is "" */ const char *index_files; /* Path to a HTTP requests log file. Leave as NULL to disable access log. */ const char *access_log_file; /* * Leave as NULL to disable authentication. * To enable directory protection with authentication, set this to ".htpasswd" * Then, creating ".htpasswd" file in any directory automatically protects * it with digest authentication. * Use `mongoose` web server binary, or `htdigest` Apache utility to * create/manipulate passwords file. * Make sure `auth_domain` is set to a valid domain name. */ const char *per_directory_auth_file; /* Authorization domain (domain name of this web server) */ const char *auth_domain; /* * Leave as NULL to disable authentication. * Normally, only selected directories in the document root are protected. * If absolutely every access to the web server needs to be authenticated, * regardless of the URI, set this option to the path to the passwords file. * Format of that file is the same as ".htpasswd" file. Make sure that file * is located outside document root to prevent people fetching it. */ const char *global_auth_file; /* Set to "no" to disable directory listing. Enabled by default. */ const char *enable_directory_listing; /* SSI files pattern. If not set, "**.shtml$|**.shtm$" is used. */ const char *ssi_pattern; /* IP ACL. By default, NULL, meaning all IPs are allowed to connect */ const char *ip_acl; /* URL rewrites. * * Comma-separated list of `uri_pattern=file_or_directory_path` rewrites. * When HTTP request is received, Mongoose constructs a file name from the * requested URI by combining `document_root` and the URI. However, if the * rewrite option is used and `uri_pattern` matches requested URI, then * `document_root` is ignored. Instead, `file_or_directory_path` is used, * which should be a full path name or a path relative to the web server's * current working directory. Note that `uri_pattern`, as all Mongoose * patterns, is a prefix pattern. * * If uri_pattern starts with `@` symbol, then Mongoose compares it with the * HOST header of the request. If they are equal, Mongoose sets document root * to `file_or_directory_path`, implementing virtual hosts support. */ const char *url_rewrites; /* DAV document root. If NULL, DAV requests are going to fail. */ const char *dav_document_root; /* DAV passwords file. If NULL, DAV requests are going to fail. */ const char *dav_auth_file; /* Glob pattern for the files to hide. */ const char *hidden_file_pattern; /* Set to non-NULL to enable CGI, e.g. **.cgi$|**.php$" */ const char *cgi_file_pattern; /* If not NULL, ignore CGI script hashbang and use this interpreter */ const char *cgi_interpreter; /* * Comma-separated list of Content-Type overrides for path suffixes, e.g. * ".txt=text/plain; charset=utf-8,.c=text/plain" */ const char *custom_mime_types; }; /* * Serve given HTTP request according to the `options`. * * Example code snippet: * * [source,c] * .web_server.c * ---- * static void ev_handler(struct mg_connection *nc, int ev, void *ev_data) { * struct http_message *hm = (struct http_message *) ev_data; * struct mg_serve_http_opts opts = { .document_root = "/var/www" }; // C99 * * switch (ev) { * case MG_EV_HTTP_REQUEST: * mg_serve_http(nc, hm, opts); * break; * default: * break; * } * } * ---- */ void mg_serve_http(struct mg_connection *, struct http_message *, struct mg_serve_http_opts); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_HTTP_HEADER_DEFINED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === JSON-RPC */ #ifndef MG_JSON_RPC_HEADER_DEFINED #define MG_JSON_RPC_HEADER_DEFINED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /* JSON-RPC request */ struct mg_rpc_request { struct json_token *message; /* Whole RPC message */ struct json_token *id; /* Message ID */ struct json_token *method; /* Method name */ struct json_token *params; /* Method params */ }; /* JSON-RPC response */ struct mg_rpc_reply { struct json_token *message; /* Whole RPC message */ struct json_token *id; /* Message ID */ struct json_token *result; /* Remote call result */ }; /* JSON-RPC error */ struct mg_rpc_error { struct json_token *message; /* Whole RPC message */ struct json_token *id; /* Message ID */ struct json_token *error_code; /* error.code */ struct json_token *error_message; /* error.message */ struct json_token *error_data; /* error.data, can be NULL */ }; /* * Parse JSON-RPC reply contained in `buf`, `len` into JSON tokens array * `toks`, `max_toks`. If buffer contains valid reply, `reply` structure is * populated. The result of RPC call is located in `reply.result`. On error, * `error` structure is populated. Returns: the result of calling * `parse_json(buf, len, toks, max_toks)`: * * On success, an offset inside `json_string` is returned * where parsing has finished. On failure, a negative number is * returned, one of: * * - #define JSON_STRING_INVALID -1 * - #define JSON_STRING_INCOMPLETE -2 * - #define JSON_TOKEN_ARRAY_TOO_SMALL -3 */ int mg_rpc_parse_reply(const char *buf, int len, struct json_token *toks, int max_toks, struct mg_rpc_reply *, struct mg_rpc_error *); /* * Create JSON-RPC request in a given buffer. * * Return length of the request, which * can be larger then `len` that indicates an overflow. * `params_fmt` format string should conform to `json_emit()` API, * see https://github.com/cesanta/frozen */ int mg_rpc_create_request(char *buf, int len, const char *method, const char *id, const char *params_fmt, ...); /* * Create JSON-RPC reply in a given buffer. * * Return length of the reply, which * can be larger then `len` that indicates an overflow. * `result_fmt` format string should conform to `json_emit()` API, * see https://github.com/cesanta/frozen */ int mg_rpc_create_reply(char *buf, int len, const struct mg_rpc_request *req, const char *result_fmt, ...); /* * Create JSON-RPC error reply in a given buffer. * * Return length of the error, which * can be larger then `len` that indicates an overflow. * `fmt` format string should conform to `json_emit()` API, * see https://github.com/cesanta/frozen */ int mg_rpc_create_error(char *buf, int len, struct mg_rpc_request *req, int code, const char *message, const char *fmt, ...); /* JSON-RPC standard error codes */ #define JSON_RPC_PARSE_ERROR (-32700) #define JSON_RPC_INVALID_REQUEST_ERROR (-32600) #define JSON_RPC_METHOD_NOT_FOUND_ERROR (-32601) #define JSON_RPC_INVALID_PARAMS_ERROR (-32602) #define JSON_RPC_INTERNAL_ERROR (-32603) #define JSON_RPC_SERVER_ERROR (-32000) /* * Create JSON-RPC error in a given buffer. * * Return length of the error, which * can be larger then `len` that indicates an overflow. See * JSON_RPC_*_ERROR definitions for standard error values: * * - #define JSON_RPC_PARSE_ERROR (-32700) * - #define JSON_RPC_INVALID_REQUEST_ERROR (-32600) * - #define JSON_RPC_METHOD_NOT_FOUND_ERROR (-32601) * - #define JSON_RPC_INVALID_PARAMS_ERROR (-32602) * - #define JSON_RPC_INTERNAL_ERROR (-32603) * - #define JSON_RPC_SERVER_ERROR (-32000) */ int mg_rpc_create_std_error(char *, int, struct mg_rpc_request *, int code); typedef int (*mg_rpc_handler_t)(char *buf, int len, struct mg_rpc_request *); /* * Dispatches a JSON-RPC request. * * Parses JSON-RPC request contained in `buf`, `len`. * Then, dispatches the request to the correct handler method. * Valid method names should be specified in NULL * terminated array `methods`, and corresponding handlers in `handlers`. * Result is put in `dst`, `dst_len`. Return: length of the result, which * can be larger then `dst_len` that indicates an overflow. * Overflown bytes are not written to the buffer. * If method is not found, an error is automatically generated. */ int mg_rpc_dispatch(const char *buf, int, char *dst, int dst_len, const char **methods, mg_rpc_handler_t *handlers); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_JSON_RPC_HEADER_DEFINED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved * This software is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this software under a commercial * license, as set out in . */ /* * === MQTT */ #ifndef MG_MQTT_HEADER_INCLUDED #define MG_MQTT_HEADER_INCLUDED struct mg_mqtt_message { int cmd; struct mg_str payload; int qos; uint8_t connack_ret_code; /* connack */ uint16_t message_id; /* puback */ char *topic; }; struct mg_mqtt_topic_expression { const char *topic; uint8_t qos; }; struct mg_send_mqtt_handshake_opts { unsigned char flags; /* connection flags */ uint16_t keep_alive; const char *will_topic; const char *will_message; const char *user_name; const char *password; }; /* Message types */ #define MG_MQTT_CMD_CONNECT 1 #define MG_MQTT_CMD_CONNACK 2 #define MG_MQTT_CMD_PUBLISH 3 #define MG_MQTT_CMD_PUBACK 4 #define MG_MQTT_CMD_PUBREC 5 #define MG_MQTT_CMD_PUBREL 6 #define MG_MQTT_CMD_PUBCOMP 7 #define MG_MQTT_CMD_SUBSCRIBE 8 #define MG_MQTT_CMD_SUBACK 9 #define MG_MQTT_CMD_UNSUBSCRIBE 10 #define MG_MQTT_CMD_UNSUBACK 11 #define MG_MQTT_CMD_PINGREQ 12 #define MG_MQTT_CMD_PINGRESP 13 #define MG_MQTT_CMD_DISCONNECT 14 /* MQTT event types */ #define MG_MQTT_EVENT_BASE 200 #define MG_EV_MQTT_CONNECT (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_CONNECT) #define MG_EV_MQTT_CONNACK (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_CONNACK) #define MG_EV_MQTT_PUBLISH (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PUBLISH) #define MG_EV_MQTT_PUBACK (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PUBACK) #define MG_EV_MQTT_PUBREC (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PUBREC) #define MG_EV_MQTT_PUBREL (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PUBREL) #define MG_EV_MQTT_PUBCOMP (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PUBCOMP) #define MG_EV_MQTT_SUBSCRIBE (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_SUBSCRIBE) #define MG_EV_MQTT_SUBACK (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_SUBACK) #define MG_EV_MQTT_UNSUBSCRIBE (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_UNSUBSCRIBE) #define MG_EV_MQTT_UNSUBACK (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_UNSUBACK) #define MG_EV_MQTT_PINGREQ (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PINGREQ) #define MG_EV_MQTT_PINGRESP (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_PINGRESP) #define MG_EV_MQTT_DISCONNECT (MG_MQTT_EVENT_BASE + MG_MQTT_CMD_DISCONNECT) /* Message flags */ #define MG_MQTT_RETAIN 0x1 #define MG_MQTT_DUP 0x4 #define MG_MQTT_QOS(qos) ((qos) << 1) #define MG_MQTT_GET_QOS(flags) (((flags) &0x6) >> 1) #define MG_MQTT_SET_QOS(flags, qos) (flags) = ((flags) & ~0x6) | ((qos) << 1) /* Connection flags */ #define MG_MQTT_CLEAN_SESSION 0x02 #define MG_MQTT_HAS_WILL 0x04 #define MG_MQTT_WILL_RETAIN 0x20 #define MG_MQTT_HAS_PASSWORD 0x40 #define MG_MQTT_HAS_USER_NAME 0x80 #define MG_MQTT_GET_WILL_QOS(flags) (((flags) &0x18) >> 3) #define MG_MQTT_SET_WILL_QOS(flags, qos) \ (flags) = ((flags) & ~0x18) | ((qos) << 3) /* CONNACK return codes */ #define MG_EV_MQTT_CONNACK_ACCEPTED 0 #define MG_EV_MQTT_CONNACK_UNACCEPTABLE_VERSION 1 #define MG_EV_MQTT_CONNACK_IDENTIFIER_REJECTED 2 #define MG_EV_MQTT_CONNACK_SERVER_UNAVAILABLE 3 #define MG_EV_MQTT_CONNACK_BAD_AUTH 4 #define MG_EV_MQTT_CONNACK_NOT_AUTHORIZED 5 #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /* * Attach built-in MQTT event handler to the given connection. * * The user-defined event handler will receive following extra events: * * - MG_EV_MQTT_CONNACK * - MG_EV_MQTT_PUBLISH * - MG_EV_MQTT_PUBACK * - MG_EV_MQTT_PUBREC * - MG_EV_MQTT_PUBREL * - MG_EV_MQTT_PUBCOMP * - MG_EV_MQTT_SUBACK */ void mg_set_protocol_mqtt(struct mg_connection *); /* Send MQTT handshake. */ void mg_send_mqtt_handshake(struct mg_connection *nc, const char *client_id); /* Send MQTT handshake with optional parameters. */ void mg_send_mqtt_handshake_opt(struct mg_connection *, const char *client_id, struct mg_send_mqtt_handshake_opts); /* Publish a message to a given topic. */ void mg_mqtt_publish(struct mg_connection *nc, const char *topic, uint16_t message_id, int flags, const void *data, size_t len); /* Subscribe to a bunch of topics. */ void mg_mqtt_subscribe(struct mg_connection *nc, const struct mg_mqtt_topic_expression *topics, size_t topics_len, uint16_t message_id); /* Unsubscribe from a bunch of topics. */ void mg_mqtt_unsubscribe(struct mg_connection *nc, char **topics, size_t topics_len, uint16_t message_id); /* Send a DISCONNECT command. */ void mg_mqtt_disconnect(struct mg_connection *nc); /* Send a CONNACK command with a given `return_code`. */ void mg_mqtt_connack(struct mg_connection *, uint8_t); /* Send a PUBACK command with a given `message_id`. */ void mg_mqtt_puback(struct mg_connection *, uint16_t); /* Send a PUBREC command with a given `message_id`. */ void mg_mqtt_pubrec(struct mg_connection *, uint16_t); /* Send a PUBREL command with a given `message_id`. */ void mg_mqtt_pubrel(struct mg_connection *, uint16_t); /* Send a PUBCOMP command with a given `message_id`. */ void mg_mqtt_pubcomp(struct mg_connection *, uint16_t); /* * Send a SUBACK command with a given `message_id` * and a sequence of granted QoSs. */ void mg_mqtt_suback(struct mg_connection *, uint8_t *, size_t, uint16_t); /* Send a UNSUBACK command with a given `message_id`. */ void mg_mqtt_unsuback(struct mg_connection *, uint16_t); /* Send a PINGREQ command. */ void mg_mqtt_ping(struct mg_connection *); /* Send a PINGRESP command. */ void mg_mqtt_pong(struct mg_connection *); /* * Extract the next topic expression from a SUBSCRIBE command payload. * * Topic expression name will point to a string in the payload buffer. * Return the pos of the next topic expression or -1 when the list * of topics is exhausted. */ int mg_mqtt_next_subscribe_topic(struct mg_mqtt_message *, struct mg_str *, uint8_t *, int); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_MQTT_HEADER_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved * This software is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this software under a commercial * license, as set out in . */ /* * === MQTT Broker */ #ifndef MG_MQTT_BROKER_HEADER_INCLUDED #define MG_MQTT_BROKER_HEADER_INCLUDED #ifdef MG_ENABLE_MQTT_BROKER #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #define MG_MQTT_MAX_SESSION_SUBSCRIPTIONS 512; struct mg_mqtt_broker; /* MQTT session (Broker side). */ struct mg_mqtt_session { struct mg_mqtt_broker *brk; /* Broker */ struct mg_mqtt_session *next, *prev; /* mg_mqtt_broker::sessions linkage */ struct mg_connection *nc; /* Connection with the client */ size_t num_subscriptions; /* Size of `subscriptions` array */ struct mg_mqtt_topic_expression *subscriptions; void *user_data; /* User data */ }; /* MQTT broker. */ struct mg_mqtt_broker { struct mg_mqtt_session *sessions; /* Session list */ void *user_data; /* User data */ }; /* Initialize a MQTT broker. */ void mg_mqtt_broker_init(struct mg_mqtt_broker *, void *); /* * Process a MQTT broker message. * * Listening connection expects a pointer to an initialized `mg_mqtt_broker` * structure in the `user_data` field. * * Basic usage: * * [source,c] * ----- * mg_mqtt_broker_init(&brk, NULL); * * if ((nc = mg_bind(&mgr, address, mg_mqtt_broker)) == NULL) { * // fail; * } * nc->user_data = &brk; * ----- * * New incoming connections will receive a `mg_mqtt_session` structure * in the connection `user_data`. The original `user_data` will be stored * in the `user_data` field of the session structure. This allows the user * handler to store user data before `mg_mqtt_broker` creates the session. * * Since only the MG_EV_ACCEPT message is processed by the listening socket, * for most events the `user_data` will thus point to a `mg_mqtt_session`. */ void mg_mqtt_broker(struct mg_connection *, int, void *); /* * Iterate over all mqtt sessions connections. Example: * * struct mg_mqtt_session *s; * for (s = mg_mqtt_next(brk, NULL); s != NULL; s = mg_mqtt_next(brk, s)) { * // Do something * } */ struct mg_mqtt_session *mg_mqtt_next(struct mg_mqtt_broker *, struct mg_mqtt_session *); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_ENABLE_MQTT_BROKER */ #endif /* MG_MQTT_HEADER_INCLUDED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === DNS */ #ifndef MG_DNS_HEADER_DEFINED #define MG_DNS_HEADER_DEFINED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #define MG_DNS_A_RECORD 0x01 /* Lookup IP address */ #define MG_DNS_CNAME_RECORD 0x05 /* Lookup CNAME */ #define MG_DNS_AAAA_RECORD 0x1c /* Lookup IPv6 address */ #define MG_DNS_MX_RECORD 0x0f /* Lookup mail server for domain */ #define MG_MAX_DNS_QUESTIONS 32 #define MG_MAX_DNS_ANSWERS 32 #define MG_DNS_MESSAGE 100 /* High-level DNS message event */ enum mg_dns_resource_record_kind { MG_DNS_INVALID_RECORD = 0, MG_DNS_QUESTION, MG_DNS_ANSWER }; /* DNS resource record. */ struct mg_dns_resource_record { struct mg_str name; /* buffer with compressed name */ int rtype; int rclass; int ttl; enum mg_dns_resource_record_kind kind; struct mg_str rdata; /* protocol data (can be a compressed name) */ }; /* DNS message (request and response). */ struct mg_dns_message { struct mg_str pkt; /* packet body */ uint16_t flags; uint16_t transaction_id; int num_questions; int num_answers; struct mg_dns_resource_record questions[MG_MAX_DNS_QUESTIONS]; struct mg_dns_resource_record answers[MG_MAX_DNS_ANSWERS]; }; struct mg_dns_resource_record *mg_dns_next_record( struct mg_dns_message *, int, struct mg_dns_resource_record *); /* * Parse the record data from a DNS resource record. * * - A: struct in_addr *ina * - AAAA: struct in6_addr *ina * - CNAME: char buffer * * Returns -1 on error. * * TODO(mkm): MX */ int mg_dns_parse_record_data(struct mg_dns_message *, struct mg_dns_resource_record *, void *, size_t); /* * Send a DNS query to the remote end. */ void mg_send_dns_query(struct mg_connection *, const char *, int); /* * Insert a DNS header to an IO buffer. * * Return number of bytes inserted. */ int mg_dns_insert_header(struct mbuf *, size_t, struct mg_dns_message *); /* * Append already encoded body from an existing message. * * This is useful when generating a DNS reply message which includes * all question records. * * Return number of appened bytes. */ int mg_dns_copy_body(struct mbuf *, struct mg_dns_message *); /* * Encode and append a DNS resource record to an IO buffer. * * The record metadata is taken from the `rr` parameter, while the name and data * are taken from the parameters, encoded in the appropriate format depending on * record type, and stored in the IO buffer. The encoded values might contain * offsets within the IO buffer. It's thus important that the IO buffer doesn't * get trimmed while a sequence of records are encoded while preparing a DNS *reply. * * This function doesn't update the `name` and `rdata` pointers in the `rr` *struct * because they might be invalidated as soon as the IO buffer grows again. * * Return the number of bytes appened or -1 in case of error. */ int mg_dns_encode_record(struct mbuf *, struct mg_dns_resource_record *, const char *, size_t, const void *, size_t); /* Low-level: parses a DNS response. */ int mg_parse_dns(const char *, int, struct mg_dns_message *); /* * Uncompress a DNS compressed name. * * The containing dns message is required because the compressed encoding * and reference suffixes present elsewhere in the packet. * * If name is less than `dst_len` characters long, the remainder * of `dst` is terminated with `\0' characters. Otherwise, `dst` is not *terminated. * * If `dst_len` is 0 `dst` can be NULL. * Return the uncompressed name length. */ size_t mg_dns_uncompress_name(struct mg_dns_message *, struct mg_str *, char *, int); /* * Attach built-in DNS event handler to the given listening connection. * * DNS event handler parses incoming UDP packets, treating them as DNS * requests. If incoming packet gets successfully parsed by the DNS event * handler, a user event handler will receive `MG_DNS_REQUEST` event, with * `ev_data` pointing to the parsed `struct mg_dns_message`. * * See * https://github.com/cesanta/mongoose/tree/master/examples/captive_dns_server[captive_dns_server] * example on how to handle DNS request and send DNS reply. */ void mg_set_protocol_dns(struct mg_connection *); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_HTTP_HEADER_DEFINED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === DNS server * * Disabled by default; enable with `-DMG_ENABLE_DNS_SERVER`. */ #ifndef MG_DNS_SERVER_HEADER_DEFINED #define MG_DNS_SERVER_HEADER_DEFINED #ifdef MG_ENABLE_DNS_SERVER #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ #define MG_DNS_SERVER_DEFAULT_TTL 3600 struct mg_dns_reply { struct mg_dns_message *msg; struct mbuf *io; size_t start; }; /* * Create a DNS reply. * * The reply will be based on an existing query message `msg`. * The query body will be appended to the output buffer. * "reply + recursion allowed" will be added to the message flags and * message's num_answers will be set to 0. * * Answer records can be appended with `mg_dns_send_reply` or by lower * level function defined in the DNS API. * * In order to send the reply use `mg_dns_send_reply`. * It's possible to use a connection's send buffer as reply buffers, * and it will work for both UDP and TCP connections. * * Example: * * [source,c] * ----- * reply = mg_dns_create_reply(&nc->send_mbuf, msg); * for (i = 0; i < msg->num_questions; i++) { * rr = &msg->questions[i]; * if (rr->rtype == MG_DNS_A_RECORD) { * mg_dns_reply_record(&reply, rr, 3600, &dummy_ip_addr, 4); * } * } * mg_dns_send_reply(nc, &reply); * ----- */ struct mg_dns_reply mg_dns_create_reply(struct mbuf *, struct mg_dns_message *); /* * Append a DNS reply record to the IO buffer and to the DNS message. * * The message num_answers field will be incremented. It's caller's duty * to ensure num_answers is propertly initialized. * * Returns -1 on error. */ int mg_dns_reply_record(struct mg_dns_reply *, struct mg_dns_resource_record *, const char *, int, int, const void *, size_t); /* * Send a DNS reply through a connection. * * The DNS data is stored in an IO buffer pointed by reply structure in `r`. * This function mutates the content of that buffer in order to ensure that * the DNS header reflects size and flags of the mssage, that might have been * updated either with `mg_dns_reply_record` or by direct manipulation of * `r->message`. * * Once sent, the IO buffer will be trimmed unless the reply IO buffer * is the connection's send buffer and the connection is not in UDP mode. */ int mg_dns_send_reply(struct mg_connection *, struct mg_dns_reply *); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_ENABLE_DNS_SERVER */ #endif /* MG_HTTP_HEADER_DEFINED */ /* * Copyright (c) 2014 Cesanta Software Limited * All rights reserved */ /* * === Asynchronouns DNS resolver */ #ifndef MG_RESOLV_HEADER_DEFINED #define MG_RESOLV_HEADER_DEFINED #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ typedef void (*mg_resolve_callback_t)(struct mg_dns_message *, void *); /* Options for `mg_resolve_async_opt`. */ struct mg_resolve_async_opts { const char *nameserver_url; int max_retries; /* defaults to 2 if zero */ int timeout; /* in seconds; defaults to 5 if zero */ int accept_literal; /* pseudo-resolve literal ipv4 and ipv6 addrs */ int only_literal; /* only resolves literal addrs; sync cb invocation */ }; /* See `mg_resolve_async_opt()` */ int mg_resolve_async(struct mg_mgr *, const char *, int, mg_resolve_callback_t, void *data); /* * Resolved a DNS name asynchronously. * * Upon successful resolution, the user callback will be invoked * with the full DNS response message and a pointer to the user's * context `data`. * * In case of timeout while performing the resolution the callback * will receive a NULL `msg`. * * The DNS answers can be extracted with `mg_next_record` and * `mg_dns_parse_record_data`: * * [source,c] * ---- * struct in_addr ina; * struct mg_dns_resource_record *rr = mg_next_record(msg, MG_DNS_A_RECORD, * NULL); * mg_dns_parse_record_data(msg, rr, &ina, sizeof(ina)); * ---- */ int mg_resolve_async_opt(struct mg_mgr *, const char *, int, mg_resolve_callback_t, void *data, struct mg_resolve_async_opts opts); /* * Resolve a name from `/etc/hosts`. * * Returns 0 on success, -1 on failure. */ int mg_resolve_from_hosts_file(const char *host, union socket_address *usa); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_RESOLV_HEADER_DEFINED */ /* * Copyright (c) 2015 Cesanta Software Limited * All rights reserved * This software is dual-licensed: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. For the terms of this * license, see . * * You are free to use this software under the terms of the GNU General * Public License, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * Alternatively, you can license this software under a commercial * license, as set out in . */ /* * === CoAP * * CoAP message format: * * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- * |Ver| T | TKL | Code | Message ID | Token (if any, TKL bytes) ... * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- * | Options (if any) ... |1 1 1 1 1 1 1 1| Payload (if any) ... * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+- */ #ifndef MG_COAP_HEADER_INCLUDED #define MG_COAP_HEADER_INCLUDED #ifdef MG_ENABLE_COAP #define MG_COAP_MSG_TYPE_FIELD 0x2 #define MG_COAP_CODE_CLASS_FIELD 0x4 #define MG_COAP_CODE_DETAIL_FIELD 0x8 #define MG_COAP_MSG_ID_FIELD 0x10 #define MG_COAP_TOKEN_FIELD 0x20 #define MG_COAP_OPTIOMG_FIELD 0x40 #define MG_COAP_PAYLOAD_FIELD 0x80 #define MG_COAP_ERROR 0x10000 #define MG_COAP_FORMAT_ERROR (MG_COAP_ERROR | 0x20000) #define MG_COAP_IGNORE (MG_COAP_ERROR | 0x40000) #define MG_COAP_NOT_ENOUGH_DATA (MG_COAP_ERROR | 0x80000) #define MG_COAP_NETWORK_ERROR (MG_COAP_ERROR | 0x100000) #define MG_COAP_MSG_CON 0 #define MG_COAP_MSG_NOC 1 #define MG_COAP_MSG_ACK 2 #define MG_COAP_MSG_RST 3 #define MG_COAP_MSG_MAX 3 #define MG_COAP_CODECLASS_REQUEST 0 #define MG_COAP_CODECLASS_RESP_OK 2 #define MG_COAP_CODECLASS_CLIENT_ERR 4 #define MG_COAP_CODECLASS_SRV_ERR 5 #define MG_COAP_EVENT_BASE 300 #define MG_EV_COAP_CON (MG_COAP_EVENT_BASE + MG_COAP_MSG_CON) #define MG_EV_COAP_NOC (MG_COAP_EVENT_BASE + MG_COAP_MSG_NOC) #define MG_EV_COAP_ACK (MG_COAP_EVENT_BASE + MG_COAP_MSG_ACK) #define MG_EV_COAP_RST (MG_COAP_EVENT_BASE + MG_COAP_MSG_RST) /* * CoAP options. * Use mg_coap_add_option and mg_coap_free_options * for creation and destruction. */ struct mg_coap_option { struct mg_coap_option *next; uint32_t number; struct mg_str value; }; /* CoAP message. See RFC 7252 for details. */ struct mg_coap_message { uint32_t flags; uint8_t msg_type; uint8_t code_class; uint8_t code_detail; uint16_t msg_id; struct mg_str token; struct mg_coap_option *options; struct mg_str payload; struct mg_coap_option *optiomg_tail; }; #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /* Set CoAP protocol handler - trigger CoAP specific events */ int mg_set_protocol_coap(struct mg_connection *nc); /* * Add new option to mg_coap_message structure. * Returns pointer to the newly created option. */ struct mg_coap_option *mg_coap_add_option(struct mg_coap_message *cm, uint32_t number, char *value, size_t len); /* * Free the memory allocated for options, * if cm paramater doesn't contain any option does nothing. */ void mg_coap_free_options(struct mg_coap_message *cm); /* * Compose CoAP message from `mg_coap_message` * and send it into `nc` connection. * Return 0 on success. On error, it is a bitmask: * * - #define MG_COAP_ERROR 0x10000 * - #define MG_COAP_FORMAT_ERROR (MG_COAP_ERROR | 0x20000) * - #define MG_COAP_IGNORE (MG_COAP_ERROR | 0x40000) * - #define MG_COAP_NOT_ENOUGH_DATA (MG_COAP_ERROR | 0x80000) * - #define MG_COAP_NETWORK_ERROR (MG_COAP_ERROR | 0x100000) */ uint32_t mg_coap_send_message(struct mg_connection *nc, struct mg_coap_message *cm); /* * Compose CoAP acknowledgement from `mg_coap_message` * and send it into `nc` connection. * Return value: see `mg_coap_send_message()` */ uint32_t mg_coap_send_ack(struct mg_connection *nc, uint16_t msg_id); /* * Parse COAP message and fills mg_coap_message and returns cm->flags. * This is a helper function. * * NOTE: usually CoAP work over UDP, so lack of data means format error, * but in theory it is possible to use CoAP over TCP (according to RFC) * * The caller have to check results and treat COAP_NOT_ENOUGH_DATA according to * underlying protocol: * * - in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR, * - in case of TCP client can try to receive more data * * Return value: see `mg_coap_send_message()` */ uint32_t mg_coap_parse(struct mbuf *io, struct mg_coap_message *cm); /* * Composes CoAP message from mg_coap_message structure. * This is a helper function. * Return value: see `mg_coap_send_message()` */ uint32_t mg_coap_compose(struct mg_coap_message *cm, struct mbuf *io); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* MG_ENABLE_COAP */ #endif /* MG_COAP_HEADER_INCLUDED */