mongoose/README.md

84 lines
5.1 KiB
Markdown
Raw Normal View History

# Mongoose - Embedded Web Server / Embedded Networking Library
2012-08-26 05:48:14 +08:00
2021-05-04 20:46:44 +08:00
[![License: GPLv2/Commercial](https://img.shields.io/badge/License-GPLv2%20or%20Commercial-green.svg)](https://opensource.org/licenses/gpl-2.0.php)
2020-12-18 19:32:59 +08:00
[![Build Status]( https://github.com/cesanta/mongoose/workflows/build/badge.svg)](https://github.com/cesanta/mongoose/actions)
2020-12-07 16:08:21 +08:00
[![Code Coverage](https://codecov.io/gh/cesanta/mongoose/branch/master/graph/badge.svg)](https://codecov.io/gh/cesanta/mongoose)
2021-01-06 02:10:01 +08:00
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/mongoose.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:mongoose)
2014-04-10 01:10:49 +08:00
Mongoose is a network library for C/C++.
It implements event-driven
2021-05-04 20:46:44 +08:00
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
2020-12-07 05:12:05 +08:00
International Space Station! Mongoose makes embedded network programming fast,
2021-05-04 20:46:44 +08:00
robust, and easy. Features include:
2023-02-17 18:46:16 +08:00
- Cross-platform:
2023-02-17 18:44:55 +08:00
- works on Linux/UNIX, MacOS, Windows, Android
2023-02-17 18:46:45 +08:00
- works on STM32, NXP, ESP32, NRF52, TI, Microchip, and other
2023-02-17 18:44:55 +08:00
- write code once - and it'll work everywhere
2023-02-17 18:46:16 +08:00
- ideal for the unification of the network infrastructure code across company
2023-07-02 03:28:28 +08:00
- Built-in protocols: plain TCP/UDP, SNTP, HTTP, MQTT, Websocket
2021-05-04 20:46:44 +08:00
- 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
2023-02-17 18:49:05 +08:00
- Very easy to integrate: just copy `mongoose.c` and `mongoose.h` files to your source tree. See
[exact steps](https://mongoose.ws/documentation/#2-minute-integration-guide)
- Works with any network stack with socket API, like LwIP or FreeRTOS-Plus-TCP
2023-09-25 04:18:02 +08:00
- Built-in TCP/IP stack with drivers for bare metal or RTOS systems
2023-10-09 16:36:43 +08:00
- Available drivers: STM32 F4, F7, H5, H7; NXP RT1020; TI TM4C; Microchip SAME54; Wiznet W5500
2023-09-25 04:18:02 +08:00
- A complete Web device dashboard on bare metal
[Nucleo-F429ZI](examples/stm32/nucleo-f429zi-baremetal) is only 6 files
2022-10-27 15:12:12 +08:00
- For comparison, a CubeIDE generated HTTP example is 400+ files
2023-09-25 04:18:02 +08:00
- Built-in firmware updates for STM32H5, STM32H7, and more coming
2023-03-14 20:54:29 +08:00
- Detailed [user guide, API reference and tons of tutorials](https://mongoose.ws/documentation/) available
2021-05-04 20:46:44 +08:00
# Commercial use
2021-05-05 00:03:53 +08:00
- Mongoose is used by hundreds of businesses, from Fortune500 giants like
2021-07-01 22:02:51 +08:00
Siemens, Schneider Electric, Broadcom, Bosch, Google, Samsung, Qualcomm, Caterpillar to the small businesses
2021-05-04 20:46:44 +08:00
- 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
2021-05-04 23:54:16 +08:00
- Deployed to hundreds of millions devices in production environment worldwide
2021-10-05 23:54:34 +08:00
- See [Case Studies](https://mongoose.ws/case-studies/) from our respected
customers like [Schneider Electric](https://mongoose.ws/case-studies/schneider-electric/) (industrial automation), [Broadcom](https://mongoose.ws/case-studies/broadcom/) (semiconductors), [Pilz](https://mongoose.ws/case-studies/pilz/) (industrial automation), and others
- See [Testimonials](https://mongoose.ws/testimonials/) from engineers that integrated Mongoose in their commercial products
- We provide [Evaluation and Commercial licensing](https://mongoose.ws/licensing/), [support](https://mongoose.ws/support/), consultancy and [integration
services](https://mongoose.ws/integration/) - don't hesitate to [contact us](https://mongoose.ws/contact/)
2021-05-04 20:46:44 +08:00
# Security
We take security seriously:
1. Mongoose repository runs a
[continuous integration test powered by GitHub](https://github.com/cesanta/mongoose/actions),
which runs through hundreds of unit tests on every commit to the repository.
Our [unit tests](https://github.com/cesanta/mongoose/tree/master/test)
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](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:mongoose)
which scans for potential vulnerabilities continuously
3. We receive periodic vulnerability reports from the independent security
groups like
[Cisco Talos](https://www.cisco.com/c/en/us/products/security/talos.html),
[Microsoft Security Response Center](https://www.microsoft.com/en-us/msrc),
[MITRE Corporation](https://www.mitre.org/),
[Compass Security](https://www.compass-security.com/en/) 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
2021-05-04 20:55:45 +08:00
customers that have an appropriate subscription
2021-05-05 00:02:46 +08:00
4. Some of our customers (for example NASA)
2021-05-04 20:46:44 +08:00
have specific security requirements and run independent security audits,
of which we get notified and in case of any issue, act similar to (3).
2016-03-01 18:41:24 +08:00
# Contributions
Contributions are welcome! Please follow the guidelines below:
- Sign [Cesanta CLA](https://cesanta.com/cla.html) and send GitHub pull request
2021-05-04 20:46:44 +08:00
- Make sure that PRs have only one commit, and deal with one issue only