repository·master·Indexed 27 days ago
https://github.com/eclipse-mosquitto/mosquittoAn open source MQTT broker supporting versions 5.0, 3.1.1, and 3.1. It includes a server implementation, C/C++ client libraries, and command-line utilities. Documentation covers Docker deployment (including mount points for /mosquitto/config, /mosquitto/data, and /mosquitto/log), authentication and authorization configurations, persistence and logging setup, and the development of the Mosquitto Dashboard UI.
sparkplug-aware plugin implements the 'awareness' requirements of the Sparkplug 3.0 specification for the Mosquitto broker. This allows the broker to be aware of Sparkplug-specific state and requirements.Mosquitto is a standards-compliant implementation of the MQTT messaging protocol designed for lightweight messaging on constrained devices. The project consists of three primary components:
mosquitto server: The main MQTT broker.mosquitto_pub and mosquitto_sub for communicating with an MQTT server via the command line.The Dynamic Security plugin provides role-based authentication and access control that can be updated via a topic-based API while the broker is running. It is supported in Mosquitto 2.0+ but is not activated by default.
The plugin manages three primary object types:
Clients: Represents a device or user. Attributes include:
Username: Unique primary key used for authentication.Password: Used during the CONNECT packet. Can be updated dynamically.Client ID: Optional. If set, the username, password, and client ID must all match for a connection to succeed.Groups: Membership in one or more groups.Roles: Assignment of one or more roles.Disabled: A boolean state. Disabling a client disconnects current sessions and prevents reconnection.Groups: Collections of clients. Groups can have roles assigned to them, making them useful for applying the same access rules to multiple clients.
Group name: Primary identifier used for modifications.Roles: Roles assigned to the group.Roles: Containers for Access Control Lists (ACLs). Roles can be assigned to both clients and groups.
Mosquitto provides three flavors of MQTT client libraries to interact with the broker:
libmosquitto).mosquittopp).Note: As of version 0.8, the library interfaces are considered experimental. For C and C++ users, detailed function call overviews and examples are available in the libmosquitto.3 man page, while mosquitto.h and mosquittopp.h provide complete coverage and class details respectively.
Mosquitto supports certificate-based SSL/TLS encryption for the broker, client libraries, and pub/sub clients. This allows clients to verify the server's identity and enables client certificate authentication.
For constrained or embedded devices, TLS-PSK (Pre-Shared Key) is available as a simpler encryption interface. Note that TLS-PSK support is not available in the Python client library.
Authentication plugins provide more advanced control than password files. The configuration key depends on the plugin's compatibility with the Mosquitto version:
plugin option.auth_plugin option.Available Plugins:
per_listener_settings option is deprecated as of version 2.1 and will be removed in version 3.0. To maintain per-listener security and plugin functionality, you must transition to using listener-specific options and plugins. This migration requires version 2.1 or later.mount_point configuration option in your broker, you must upgrade to at least version 1.4.8. In versions prior to 1.4.8, clients could bypass their restricted mount_point by using a Will to inject messages into unauthorized topics. Upgrading ensures that Wills published by clients correctly obey the defined mount_point.google_powermeter_update_mysql.pl script.You can use the vcpkg dependency manager to download and install Mosquitto by following these steps:
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install mosquittoIn Mosquitto 2.0+, running the broker without a configuration file (e.g., mosquitto or mosquitto -p 1883) causes it to bind only to the loopback interfaces (127.0.0.1 and/or ::1). In this mode, anonymous access is allowed for local testing.
To allow connections from remote machines, you must use a configuration file and define a listener. By default, defining a listener binds it to all interfaces (0.0.0.0 or ::).