introduction
MQTT est un protocole de messagerie de machine à machine, conçu pour fournir une communication de publication / abonnement légère aux périphériques «Internet des objets». Il est couramment utilisé pour la géolocalisation de parcs de véhicules, la domotique, les réseaux de capteurs environnementaux et la collecte de données à grande échelle.
Mosquitto est un serveur MQTT populaire (oubroker, dans le langage MQTT) qui bénéficie d'un excellent support communautaire et est facile à installer et à configurer.
Dans ce didacticiel, nous allons installer Mosquitto, récupérer les certificats SSL de Let’s Encrypt et configurer notre courtier pour qu’il utilise SSL afin de sécuriser nos communications MQTT protégées par mot de passe.
Conditions préalables
Avant de commencer ce tutoriel, vous aurez besoin de:
-
Un serveur Ubuntu 16.04 avec un utilisateur non root, compatible sudo et un pare-feu de base configuré, comme détaillé dansthis Ubuntu 16.04 server setup tutorial.
-
Un nom de domaine pointé vers votre serveur, selonHow to Set Up a Host Name with DigitalOcean. Ce didacticiel utilisera
mqtt.example.com
partout.
[[step-1 -—- Installing-mosquitto]] == Étape 1 - Installation de Mosquitto
Ubuntu 16.04 a une version assez récente de Mosquitto dans son référentiel de logiciels par défaut. Connectez-vous avec votre utilisateur non root et installez Mosquitto avecapt-get
.
sudo apt-get install mosquitto mosquitto-clients
Par défaut, Ubuntu démarrera le service Mosquitto après l’installation. Testons la configuration par défaut. Nous allons utiliser l’un des clients Mosquitto que nous venons d’installer pour souscrire à un sujet de notre courtier.
Topics sont des libellés auxquels vous publiez des messages et auxquels vous vous abonnez. Ils sont organisés sous forme de hiérarchie, vous pouvez donc avoirsensors/outside/temp
etsensors/outside/humidity
, par exemple. La façon dont vous organisez les sujets dépend de vous et de vos besoins. Tout au long de ce tutoriel, nous utiliserons un sujet de test simple pour tester nos modifications de configuration.
Connectez-vous une seconde fois à votre serveur pour disposer de deux terminaux côte à côte. Dans le nouveau terminal, utilisezmosquitto_sub
pour vous abonner au sujet de test:
mosquitto_sub -h localhost -t test
-h
est utilisé pour spécifier le nom d'hôte du serveur MQTT et-t
est le nom de la rubrique. Vous ne verrez aucune sortie après avoir frappéENTER
carmosquitto_sub
attend l'arrivée des messages. Revenez sur votre autre terminal et publiez un message:
mosquitto_pub -h localhost -t test -m "hello world"
Les options pourmosquitto_pub
sont les mêmes que pourmosquitto_sub
, bien que cette fois nous utilisons l'option-m
supplémentaire pour spécifier notre message. Appuyez surENTER
et vous devriez voir apparaîtrehello world dans l'autre terminal. Vous avez envoyé votre premier message MQTT!
EntrezCTRL+C
dans le second terminal pour quittermosquitto_sub
, mais gardez la connexion au serveur ouverte. Nous allons l’utiliser à nouveau pour un autre test à l’étape 5.
Ensuite, nous allons sécuriser notre installation avec SSL en utilisant Certbot, le nouveau client Let’s Encrypt.
[[step-2 -—- Installing-certbot-for-let-39-s-encrypt-certificates]] == Étape 2 - Installation de Certbot pour les certificats Let’s Encrypt
Let’s Encrypt est un nouveau service proposant des certificats SSL gratuits via une API automatisée. De nombreux clients peuvent communiquer avec l’API et Ubuntu inclut le client officiel dans son référentiel par défaut, mais c’est un peu obsolète et il lui manque une fonctionnalité importante dont nous avons besoin.
Au lieu de cela, nous installerons le client officiel à partir d'un PPA Ubuntu, ouPersonal Package Archive. Ce sont des référentiels alternatifs qui regroupent des logiciels plus récents ou plus obscurs. Tout d'abord, ajoutez le référentiel.
sudo add-apt-repository ppa:certbot/certbot
Vous devrez appuyer surENTER
pour accepter. Ensuite, mettez à jour la liste des packages pour récupérer les informations de package du nouveau référentiel.
sudo apt-get update
Et enfin, installez le client officiel Let’s Encrypt, appelécertbot
.
sudo apt-get install certbot
Maintenant quecertbot
est installé, exécutons-le pour obtenir notre certificat.
[[step-3 -—- running-certbot]] == Étape 3 - Exécution de Certbot
certbot
doit répondre à un défi cryptographique émis par l'API Let’s Encrypt afin de prouver que nous contrôlons notre domaine. Il utilise les ports80
(HTTP) et / ou443
(HTTPS) pour ce faire. Nous n'utiliserons que le port80
, alors autorisons maintenant le trafic entrant sur ce port:
sudo ufw allow http
OutputRule added
Nous pouvons maintenant exécuter Certbot pour obtenir notre certificat. Nous utiliserons l'option--standalone
pour indiquer à Certbot de gérer lui-même la demande de défi HTTP, et--standalone-supported-challenges http-01
limite la communication au port80
. -d
est utilisé pour spécifier le domaine pour lequel vous souhaitez obtenir un certificat, etcertonly
indique à Certbot de simplement récupérer le certificat sans effectuer aucune autre étape de configuration.
sudo certbot certonly --standalone --standalone-supported-challenges http-01 -d mqtt.example.com
Lors de l'exécution de la commande, vous serez invité à entrer une adresse électronique et à accepter les conditions d'utilisation. Après cela, vous devriez voir un message vous informant que le processus a abouti et où vos certificats sont stockés.
Nous avons nos certificats. Nous devons maintenant nous assurer que Certbot les renouvelle automatiquement au moment de leur expiration.
[[step-4 -—- setting-up-certbot-automatic-renewals]] == Étape 4 - Configuration des renouvellements automatiques Certbot
Les certificats de Let Encrypt ne sont valables que quatre-vingt-dix jours. Cela encourage les utilisateurs à automatiser leur processus de renouvellement des certificats. Nous devons définir une commande d'exécution régulière pour vérifier l'expiration des certificats et les renouveler automatiquement.
Pour exécuter le contrôle de renouvellement tous les jours, nous utiliseronscron
, un service système standard pour exécuter des travaux périodiques. Nous disons àcron
ce qu'il faut faire en ouvrant et en éditant un fichier appelécrontab
.
sudo crontab -e
Vous serez invité à sélectionner un éditeur de texte. Choisissez votre favori, et vous serez présenté avec lecrontab
par défaut qui contient du texte d'aide. Collez la ligne suivante à la fin du fichier, puis enregistrez-le et fermez-le.
crontab
. . .
15 3 * * * certbot renew --noninteractive --post-hook "systemctl restart mosquitto"
La partie15 3 * * *
de cette ligne signifie «exécuter la commande suivante à 3 h 15, tous les jours». La commanderenew
pour Certbot vérifie tous les certificats installés sur le système et met à jour ceux qui sont configurés pour expirer dans moins de trente jours. --noninteractive
dit à Certbot de ne pas attendre l'entrée de l'utilisateur.
--post-hook "systemctl restart mosquitto"
redémarrera Mosquitto pour récupérer le nouveau certificat, mais uniquement si le certificat a été renouvelé. Cette fonctionnalitépost-hook
est ce qui manquait aux anciennes versions du client Let’s Encrypt, et pourquoi nous avons installé à partir d’un PPA au lieu du référentiel Ubuntu par défaut. Sans cela, nous devrions redémarrer Mosquitto tous les jours, même si aucun certificat n’a été mis à jour. Bien que vos clients MQTT doivent être configurés pour se reconnecter automatiquement, il est conseillé d’éviter de les interrompre quotidiennement sans raison valable.
Maintenant que le renouvellement automatique du certificat est terminé, nous allons revenir à la configuration de Mosquitto pour qu'il soit plus sécurisé.
[[step-5 -—- configuring-mqtt-passwords]] == Étape 5 - Configuration des mots de passe MQTT
Configurons Mosquitto pour utiliser des mots de passe. Mosquitto inclut un utilitaire pour générer un fichier de mot de passe spécial appelémosquitto_passwd
. Cette commande vous invitera à entrer un mot de passe pour le nom d'utilisateur spécifié et à placer les résultats dans/etc/mosquitto/passwd
.
sudo mosquitto_passwd -c /etc/mosquitto/passwd sammy
Nous allons maintenant ouvrir un nouveau fichier de configuration pour Mosquitto et lui dire d’utiliser ce fichier de mots de passe pour exiger la connexion à toutes les connexions:
sudo nano /etc/mosquitto/conf.d/default.conf
Cela devrait ouvrir un fichier vide. Coller dans ce qui suit:
/etc/mosquitto/conf.d/default.conf
allow_anonymous false
password_file /etc/mosquitto/passwd
allow_anonymous false
désactivera toutes les connexions non authentifiées et la lignepassword_file
indique à Mosquitto où chercher les informations sur l'utilisateur et le mot de passe. Enregistrez et quittez le fichier.
Nous devons maintenant redémarrer Mosquitto et tester nos modifications.
sudo systemctl restart mosquitto
Essayez de publier un message sans mot de passe:
mosquitto_pub -h localhost -t "test" -m "hello world"
Le message devrait être rejeté:
OutputConnection Refused: not authorised.
Error: The connection was refused.
Avant de réessayer avec le mot de passe, revenez à la fenêtre de votre deuxième terminal et abonnez-vous à la rubrique "test", en utilisant le nom d'utilisateur et le mot de passe cette fois:
mosquitto_sub -h localhost -t test -u "sammy" -P "password"
Il devrait se connecter et s'asseoir, en attente de messages. Vous pouvez laisser ce terminal ouvert et connecté pendant le reste du didacticiel, car nous lui enverrons périodiquement des messages de test.
Publiez maintenant un message avec votre autre terminal, en utilisant à nouveau le nom d'utilisateur et le mot de passe:
mosquitto_pub -h localhost -t "test" -m "hello world" -u "sammy" -P "password"
Le message devrait passer comme à l'étape 1. Nous avons ajouté avec succès la protection par mot de passe à Mosquitto. Malheureusement, nous envoyons des mots de passe non cryptés sur Internet. Nous allons résoudre ce problème en ajoutant le cryptage SSL à Mosquitto.
[[step-6 -—- configuring-mqtt-ssl]] == Étape 6 - Configuration de MQTT SSL
Pour activer le cryptage SSL, nous devons indiquer à Mosquitto où sont stockés nos certificats Let’s Encrypt. Ouvrez le fichier de configuration que nous avons précédemment lancé:
sudo nano /etc/mosquitto/conf.d/default.conf
Collez ce qui suit à la fin du fichier, en laissant les deux lignes que nous avons déjà ajoutées:
/etc/mosquitto/conf.d/default.conf
. . .
listener 1883 localhost
listener 8883
certfile /etc/letsencrypt/live/mqtt.example.com/cert.pem
cafile /etc/letsencrypt/live/mqtt.example.com/chain.pem
keyfile /etc/letsencrypt/live/mqtt.example.com/privkey.pem
Nous ajoutons deux blocslistener
séparés à la configuration. Le premier,listener 1883 localhost
, met à jour l'écouteur MQTT par défaut sur le port1883
, auquel nous nous sommes connectés jusqu'à présent. 1883
est le port MQTT non chiffré standard. La partielocalhost
de la ligne indique à Mosquitto de ne lier ce port qu'à l'interface localhost, de sorte qu'il n'est pas accessible de l'extérieur. Les demandes externes auraient de toute façon été bloquées par notre pare-feu, mais il est bon d’être explicite.
listener 8883
configure un écouteur chiffré sur le port8883
. Il s'agit du port standard pour MQTT + SSL, souvent appelé MQTTS. Les trois lignes suivantes,certfile
,cafile
etkeyfile
, pointent toutes Mosquitto vers les fichiers Let’s Encrypt appropriés pour configurer les connexions chiffrées.
Enregistrez et quittez le fichier, puis redémarrez Mosquitto pour mettre à jour les paramètres:
sudo systemctl restart mosquitto
Mettez à jour le pare-feu pour autoriser les connexions au port8883
.
sudo ufw allow 8883
OutputRule added
Maintenant, nous testons à nouveau en utilisantmosquitto_pub
, avec quelques options différentes pour SSL:
mosquitto_pub -h mqtt.example.com -t test -m "hello again" -p 8883 --capath /etc/ssl/certs/ -u "sammy" -P "password"
Notez que nous utilisons le nom d'hôte complet au lieu delocalhost
. Comme notre certificat SSL est émis pourmqtt.example.com
, si nous tentons une connexion sécurisée àlocalhost
, nous obtiendrons une erreur disant que le nom d'hôte ne correspond pas au nom d'hôte du certificat (même s'ils pointent tous les deux vers le même Mosquitto serveur).
--capath /etc/ssl/certs/
active SSL pourmosquitto_pub
et lui indique où chercher les certificats racine. Celles-ci sont généralement installées par votre système d'exploitation, le chemin est donc différent pour Mac OS, Windows, etc. mosquitto_pub
utilise le certificat racine pour vérifier que le certificat du serveur Mosquitto a été correctement signé par l’autorité de certification Let’s Encrypt. Il est important de noter quemosquitto_pub
etmosquitto_sub
ne tenteront pas de connexion SSL sans cette option (ou l'option similaire--cafile
), même si vous vous connectez au port sécurisé standard de8883
.
Si tout se passe bien avec le test, nous verronshello again apparaître dans l’autre terminalmosquitto_sub
. Cela signifie que votre serveur est entièrement configuré! Si vous souhaitez étendre le protocole MQTT pour qu’il fonctionne avec des websockets, vous pouvez suivre la dernière étape.
[[step-7 -—- configuring-mqtt-over-websockets-optional]] == Étape 7 - Configuration de MQTT via Websockets (facultatif)
Afin de parler MQTT à l'aide de JavaScript à partir de navigateurs Web, le protocole a été adapté pour fonctionner sur des Websockets standard. Si vous n’avez pas besoin de cette fonctionnalité, vous pouvez ignorer cette étape.
Nous devons ajouter un autre bloclistener
à notre configuration Mosqiutto:
sudo nano /etc/mosquitto/conf.d/default.conf
A la fin du fichier, ajoutez ce qui suit:
/etc/mosquitto/conf.d/default.conf
. . .
listener 8083
protocol websockets
certfile /etc/letsencrypt/live/mqtt.example.com/cert.pem
cafile /etc/letsencrypt/live/mqtt.example.com/chain.pem
keyfile /etc/letsencrypt/live/mqtt.example.com/privkey.pem
C'est pratiquement le même que le bloc précédent, à l'exception du numéro de port et de la ligneprotocol websockets
. Il n'y a pas de port standardisé officiel pour MQTT sur les Websockets, mais8083
est le plus courant.
Enregistrez et quittez le fichier, puis redémarrez Mosquitto.
sudo systemctl restart mosquitto
Maintenant, ouvrez le port8083
dans le pare-feu.
sudo ufw allow 8083
Pour tester cette fonctionnalité, nous allons utiliser un client MQTT public basé sur un navigateur. Il y en a quelques-uns, mais lesEclipse Paho JavaScript Client sont simples et simples à utiliser. Open the Paho client in your browser. Vous verrez ce qui suit:
Remplissez les informations de connexion comme suit:
-
Host doit être le domaine de votre serveur Mosquitto,
mqtt.example.com
. -
Port doit être
8083
. -
ClientId peut être laissé à la valeur par défaut,js-utility-DI1m6.
-
Path peut être laissé à la valeur par défaut,/ws.
-
Username doit être votre nom d'utilisateur Mosquitto; ici, nous avons utilisésammy.
-
Password doit être le mot de passe que vous avez choisi.
Les champs restants peuvent être laissés à leurs valeurs par défaut.
Après avoir appuyé surConnect, le client basé sur le navigateur Paho se connectera à votre serveur Mosquitto.
Pour publier un message, accédez au voletPublish Message, remplissezTopic en tant quetest et entrez n'importe quel message dans la sectionMessage. Ensuite, appuyez surPublish. Le message apparaîtra dans votre terminalmosquitto_sub
.
Conclusion
Nous avons maintenant configuré un serveur MQTT sécurisé, protégé par un mot de passe, avec renouvellement automatique des certificats SSL à partir du service Let’s Encrypt. Cela servira de plate-forme de messagerie robuste et sécurisée pour tous les projets que vous rêvez. Certains logiciels et matériels courants qui fonctionnent bien avec le protocole MQTT comprennent:
-
OwnTracks, une application de géolocalisation open source que vous pouvez installer sur votre téléphone. OwnTracks transmettra périodiquement des informations de position à votre serveur MQTT, que vous pourrez ensuite stocker et afficher sur une carte, ou créer des alertes et activer le matériel IoT en fonction de votre emplacement.
-
Node-RED est une interface graphique basée sur un navigateur pour «câbler» l’Internet des objets. Vous faites glisser la sortie d'un nœud vers l'entrée d'un autre et vous pouvez acheminer des informations via des filtres, entre divers protocoles, dans des bases de données, etc. MQTT est très bien supporté par Node-RED.
-
LeESP8266 est un microcontrôleur wifi peu coûteux avec des capacités MQTT. Vous pouvez en câbler une pour publier des données de température sur un sujet, ou peut-être souscrire à un sujet de pression barométrique et faire retentir une sonnerie lorsqu'un orage arrive!
Ce ne sont que quelques exemples populaires de l'écosystème MQTT. Il y a beaucoup plus de matériel et de logiciels qui parlent le protocole. Si vous avez déjà une plate-forme matérielle favorite ou un langage logiciel, celle-ci dispose probablement des fonctionnalités MQTT. Amusez-vous à parler de vos «choses»!