mongoose/README.md

Mongoose - Embedded Web Server / Embedded Network Library

Mongoose is a network library for C/C++. It provides event-driven non-blocking APIs for TCP, UDP, HTTP, WebSocket, MQTT, and other protocols. It is designed for connecting devices and bringing them online. On the market since 2004, used by vast number of open source and commercial products - it even runs on the International Space Station! Mongoose makes embedded network programming fast, robust, and easy. Features include:

• Cross-platform:
  • works on Linux/UNIX, MacOS, Windows, Android
  • works on STM32, NXP, ESP32, NRF52, TI, Microchip, and other
  • write code once - and it'll work everywhere
  • ideal for the unification of the network infrastructure code across company
• Built-in protocols: plain TCP/UDP, SNTP, HTTP, MQTT, Websocket, and other
• Asynchronous DNS resolver
• Tiny static and run-time footprint
• Source code is both ISO C and ISO C++ compliant
• Easy to integrate: just copy mongoose.c and mongoose.h files to your source tree
• Built-in TCP/IP stack with drivers for bare metal or RTOS systems
  • Available drivers: STM32F, STM32H; NXP RT1xxx; TI TM4C; Microchip SAME54; Wiznet W5500
  • A complete Web device dashboard on bare metal ST Nucleo boards is only 6 files
  • For comparison, a CubeIDE generated HTTP example is 400+ files
• Can run on top of an existing TCP/IP stack with BSD API, e.g. lwIP, Zephyr, Azure, etc
• Built-in TLS 1.3 stack. Aslo can use external TLS libraries - mbedTLS, OpenSSL, or other
• Does not depend on any other software to implement networking
• Built-in firmware updates for STM32 H5, STM32 H7

See https://mongoose.ws/ for more details.

Usage

See 2-minute integration guide for complete instructions. Below there are quick snippets that should give an idea, how simple the API is, and how easy it is to create applications with it.

Create a simple web server that serves a directory. The behavior of the HTTP server is specified by its event handler function:

#include "mongoose.h"

int main(void) {
  struct mg_mgr mgr;  // Declare event manager
  mg_mgr_init(&mgr);  // Initialise event manager
  mg_http_listen(&mgr, "http://0.0.0.0:8000", fn, NULL);  // Setup listener
  for (;;) {
    mg_mgr_poll(&mgr, 1000);  // Run an infinite event loop
  }
  return 0;
}

// HTTP server event handler function
void fn(struct mg_connection *c, int ev, void *ev_data) {
  if (ev == MG_EV_HTTP_MSG) {
    struct mg_http_message *hm = (struct mg_http_message *) ev_data;
    struct mg_http_serve_opts opts = { .root_dir = "./web_root/" };
    mg_http_serve_dir(c, hm, &opts);
  }
}

HTTP server implements a REST API that returns current time. JSON formatting:

static void fn(struct mg_connection *c, int ev, void *ev_data) {
  if (ev == MG_EV_HTTP_MSG) {
    struct mg_http_message *hm = (struct mg_http_message *) ev_data;
    if (mg_http_match_uri(hm, "/api/time/get")) {
      mg_http_reply(c, 200, "", "{%m:%lu}\n", MG_ESC("time"), time(NULL));
    } else {
      mg_http_reply(c, 500, "", "{%m:%m}\n", MG_ESC("error"), MG_ESC("Unsupported URI")); 
    }
  }
}

MQTT client that subscribes to a topic aa/bb and prints all incoming messages:

static void fn(struct mg_connection *c, int ev, void *ev_data) {
  if (ev == MG_EV_MQTT_OPEN) {
    struct mg_mqtt_opts opts = {.qos = 1, .topic = mg_str("aa/bb")};
    mg_mqtt_sub(c, &opts);
  } else if (ev == MG_EV_MQTT_MSG) {
    struct mg_mqtt_message *mm = (struct mg_mqtt_message *) ev_data;
    printf("Topic: %.*s, Message: %.*s",
           mm->topic.len, mm->topic.ptr,
           mm->data.len, mm->data.ptr);
  }
}

Commercial use

• Mongoose is used by hundreds of businesses, from Fortune500 giants like Siemens, Schneider Electric, Broadcom, Bosch, Google, Samsung, Qualcomm, Caterpillar to the small businesses
• Used to solve a wide range of business needs, like implementing Web UI interface on devices, RESTful API services, telemetry data exchange, remote control for a product, remote software updates, remote monitoring, and others
• Deployed to hundreds of millions devices in production environment worldwide
• See Case Studies from our respected customers like Schneider Electric (industrial automation), Broadcom (semiconductors), Pilz (industrial automation), and others
• See Testimonials from engineers that integrated Mongoose in their commercial products
• We provide Evaluation and Commercial licensing, support, consultancy and integration services - don't hesitate to contact us

Security

We take security seriously:

1. Mongoose repository runs a continuous integration test powered by GitHub, which runs through hundreds of unit tests on every commit to the repository. Our unit tests are built with modern address sanitizer technologies, which help to find security vulnerabilities early
2. Mongoose repository is integrated into Google's oss-fuzz continuous fuzzer which scans for potential vulnerabilities continuously
3. We receive periodic vulnerability reports from the independent security groups like Cisco Talos, Microsoft Security Response Center, MITRE Corporation, Compass Security and others. In case of the vulnerability found, we act according to the industry best practice: hold on to the publication, fix the software and notify all our customers that have an appropriate subscription
4. Some of our customers (for example NASA) have specific security requirements and run independent security audits, of which we get notified and in case of any issue, act similar to (3).

Contributions

Contributions are welcome! Please follow the guidelines below:

• Sign Cesanta CLA and send GitHub pull request
• Make sure that PRs have only one commit, and deal with one issue only