mongoose/README.md
2021-05-19 00:14:27 +01:00

5.0 KiB

Mongoose - Embedded Web Server / Embedded Networking Library

License: GPLv2/Commercial Build Status Code Coverage Fuzzing Status

Mongoose is a networking library for C/C++. It implements event-driven non-blocking APIs for TCP, UDP, HTTP, WebSocket, MQTT. 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, FreeRTOS, etc
  • Supported embedded architectures: ESP32, NRF52, STM32, NXP, and more
  • Built-in protocols: plain TCP/UDP, HTTP, MQTT, Websocket
  • SSL/TLS support: mbedTLS, OpenSSL or custom (via API)
  • Asynchronous DNS resolver
  • Tiny static and run-time footprint
  • Source code is both ISO C and ISO C++ compliant
  • Works with any network stack with socket API, like LwIP or FreeRTOS-Plus-TCP
  • Very easy to integrate: just copy mongoose.c and mongoose.h files to your build tree
  • Detailed documentation available

Commercial use

  • Mongoose is used by hundreds of businesses, from Fortune500 giants like Siemens, 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), Schenck Process (industrial engineering), and others
  • See Testimonials from engineers that integrated Mongoose in their commercial products
  • We provide commercial licensing, support, consultancy and integration assistance - 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).

Supplement software

This software is often used together with Mongoose:

  • mjson - a JSON parser. Used to implement RESTful APIs that use JSON, or implement data exchange (e.g. over MQTT or Websocket) that use JSON for data encapsulation
  • elk - a tiny JavaScript interpreter. Used to implement scripting support for customers

Precompiled web server binary

We have built a ready-to-go, precompiled web server binary for Windows and Mac. It is a great tool for sharing your files or website. It has a unique feature - an ability to share your local files via a global URL.

Interested? Go to download

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