In this version I'll try to implement the option to create a gateway of two seperate esp devices. One for ESP-Now communication, the second for MQTT. Last version of original project with this wat 5.0. Changes where made in commit a382009adbd. (Link is to my fork).
EnigmaIoT is an open source solution for wireless multi sensor systems. It has two main components, multiple nodes and one gateway.
A number of nodes with one or more sensors each one communicate in a secure way to a central gateway in a star network using EnigmaIoT protocol.
This protocol has been designed with security on mind. All node data is encrypted with a random key that changes periodically. Key is unique for each node and dynamically negotiated, so user do not have to enter any key. Indeed, all encryption and key agreement is transparent to user.
I designed this because I was searching for a way to have a relatively high number of nodes at home. I thought about using WiFi but it would overload my home router. So I looked for an alternative. I evaluated LoRa or cheap nRF24 modules but I wanted the simplest solution in terms of hardware.
ESP8266 and ESP32 microcontrollers implement a protocol known as ESP-NOW. It is a point to point protocol, based on vendor specific WiFi management action frames, that works in a connectionless fashion and every packet is a few milliseconds long. Because of this, it eases to have a battery powered node so that it enables designing totally wireless sensors.
But use of encryption on ESP-NOW limits the number of nodes to only 6 nodes. So I thought that I could implement encryption on payload but I found many problems I should solve to grade this as "secure enough".
Find library documentation on https://gmag11.github.io/EnigmaIOT
It you are courious to quickly test how does EnigmaIOT performs you can follow this howto guide. This will guide you on how to:
- Setup your gateway
- Build simplest EnigmaIOT node
- Configure your first node
- Develop custom nodes with advanced features
During this project conception I decided that it should fulfil this list of requirements.
- Use the simplest hardware, based on ESP8266 and/or ESP32.
- Secure by design. Make use of a secure channel for data transmission.
- Automatic dynamic key agreement.
- Do not require connection to the Internet.
- Do not overload my home WiFi infrastructure. Only Gateway will be connected to LAN.
- Able to use deep sleep to run on batteries.
- Enough wireless range for a house.
- Support for a high number of nodes.
- Encrypted communication using ChaCha20/Poly1305
- Dynamic key, shared between one node and gateway. Keys are independent for each node
- Shared keys are expired after a certain (configurable) time.
- Number of nodes is only limited by memory on gateway (60 bytes per node)
- Key is never on air so it is cannot be captured
- Key expiration and renewal is managed transparently
- Avoid repeatability attack having a new random initialization vector on every message. This is mandatory for ChaCha20/Poly1305 in order to keep cipher secure
- Automatic and transparent node attachment
- Avoid rogue node, rogue gateway and man-in-the-middle attack
Notice that network key used to implement this feature is stored on flash. ESP8266 do not allow flash encryption so network key may be recovered reading flash.
-
Pluggable physical layer communication. Right now only ESP-NOW protocol is developed but you can easily add more communication alternatives
-
When using ESP-NOW only ESP8266 or ESP32 is needed. No more electronics apart from sensor
-
Data message counter to detect lost or repeated messages
-
Designed as two libraries (one for gateway, one for node) for easier use
-
Crypto algorithm could be changed with low effort
-
Node and Gateway do store shared keys only on RAM. They are lost on power cycle. This protects system against flash reading attack. All nodes attach automatically with a new shared key after gateway is switched on
-
Downlink available. If deep sleep is used on sensor nodes, it is queued and sent just after node send a data message
-
Optional sleep mode management. In this case key and context has to be stored temporally. Normally RTC memory is the recommended place, and it is the one currently implemented. Note: There is the alternative to store context on flash memory so that node can be completely switched off between massages without requiring a new registering. Notice that on every received or sent message node updates this context so consider that a high number of writes in flash may degrade it in the medium term. If messages counters are disabled in configuration the number of writes is decreased drastically but this reduces security level as it makes possible to repeat messages.
-
Initial configuration over WiFi portal on each device
-
Node configuration while in service using control downlink commands
-
OTA over WiFi. Question: Is it really useful? Place an issue explaining an use case.
-
OTA over MQTT/ESP-NOW. Check OTA script guide.
-
Node identification by using a flashing LED. This is useful when you have a bunch of nodes together :D
-
Broadcast messages that go to all nodes. This is implemented by sending messages to broadcast address (ff:ff:ff:ff:ff:ff in esp-now). Only nodes that are always listening are able to receive these messages, they are not queued. In order to send a broadcast message using EnigmaIOTGatewayMQTT you may use
<network name>/broadcast/...as topi beginning. Any control or data message will arrive all nodes that have broadcast enabled. Control messages are processed normally except OTA and SET NAME, which are ignored. Data messages are passed to user code for processing.A shared encryption key is used to encrypt broadcast messages. It is generated automatically by Gateway on every restart.
If a node registers with broadcast flag active, gateway sends broadcast key using this message just after successful registration. Broadcast key is automatically generated on gateway on boot, so it will be different after every restart. Nodes will be synchronized as soon they register again.
A node may not send broadcast messages, only gateway can.
-
Both gateway or nodes may run on ESP32 or ESP8266
-
Simple REST API to get information and send commands to gateway and nodes. Check api.md
-
Node library includes methods to configure Home Assistant automatic integration using MQTT discovery
If you want to know the internals about EnigmaIOT check Technical Background Guide.