Esp8266 Based Canary device alerting with Mqtt
This is a honeypot project for a local network. It is built using an ESP8266 WiFi module and Arduino programming language. The project is designed to detect unauthorized access to an FTP server and notify the user using MQTT messages.
-Authentication for FTP server using predefined credentials.
-MQTT client to publish messages on an MQTT server.
-WiFi module to connect to a local network.
-Custom MAC address configuration.
-JSON message serialization to send alert messages to an MQTT server.
-MQTT sync topic to synchronize state between Device and Home Assistant boot.
I am not a profesional coder so my method of installation is a bit crooked.
- Install the Esp8266-Mqtt-Canary library from the arduino library manager
- File>Examples>Esp8266-Mqtt-Canary>MqttHoneypot-v3
- Add mqtt and wifi parameters
- Save file to a new folder with name MqttHoneypot-v3. Compile and upload
- To upload files to FTP. Install Esp SPIFFS upload tool
(https://randomnerdtutorials.com/install-esp8266-filesystem-uploader-arduino-ide/)
- Place files in data folder inside the MqttHoneypot-v3 folder.
- Upload with tool.
- Finished.
Here's an example YAML configuration for a MQTT binary sensor in Home Assistant that sends a JSON payload with three data points:
binary_sensor:
- platform: mqtt
name: "Canary Alert"
state_topic: "esp/canary-alert"
value_template: "{{ value_json.alert }}"
payload_on: "ON"
payload_off: "OFF"
json_attributes_topic: "esp/canary-alert"
json_attributes_template: "{{ value_json | tojson }}"
If you want manually want to call for status of the sensor, please use mqttSyncTopic set(default is esp/canary-sync). The will return the state as {"alert":"OFF":"IP":"none"}. This is useful when HA restarts.