Mosquitto: MQTT API authentication with Node-RED

This documentation is part of the API authentication guide. You can view the complete guide here: How to authenticate thousands of devices using an external API.

👋 Welcome to the Stackhero documentation!

Stackhero provides you with a fully managed Mosquitto MQTT cloud environment, designed for reliability and flexibility:

• Unlimited message throughput and data transfers, so your workflows never encounter artificial limits.
• Unlimited device authentication via your own external API, making onboarding and access management straightforward.
• Advanced ACLs for precise control over topics, users, and actions.
• A custom domain name with integrated HTTPS for secure, branded endpoints (for example: https://mqtt.your-company.com).
• Effortless updates: apply improvements or security patches with a single click.
• Consistent performance and enhanced security, with every instance running on a private, dedicated infrastructure.

Accelerate your IoT projects and reduce operational overhead. You can have a secure, production-ready Mosquitto MQTT cloud hosting instance up and running in just a few minutes.

Stackhero for Node-RED includes a Mosquitto server. Nevertheless, for advanced usage, having a standalone Mosquitto service is recommended. This example shows how to use the API authentication system with a standalone Mosquitto service and a Node-RED service. If you use the Mosquitto service included with your Node-RED, this guide does not apply to you.

Stackhero for Node-RED provides an example of an MQTT API connection in the flow named "MQTT authentication." This flow is also used with the integrated Mosquitto server in Stackhero for Node-RED.

Configuring Mosquitto to use Node-RED as authentication API

To use Node-RED as your API authentication endpoint, update your Mosquitto configuration as follows:

1. Enable the API authentication option.
2. Set the Host field to your Node-RED domain.
3. Choose HTTPS as the Protocol and enter 443 for the Port.
4. Specify the User route as /mqttAuthentication/userGet.
5. Specify the ACLs route as /mqttAuthentication/aclCheck.

For debugging, you might set the "Authentication cache time" to 1 second. Once your setup is operating smoothly, the recommended value is 30 seconds.

Mosquitto configuration example

Configuring Node-RED as an MQTT authentication API

After updating the Mosquitto configuration, launch Node-RED and open the MQTT authentication flow. Edit the Users node to configure your user credentials. The provided examples include several username and password combinations. Feel free to add as many users as necessary.

Node-RED MQTT authentication flow