Skip to content

Commit aea0eab

Browse files
committed
docs: Add security note to README
1 parent e2f5c8e commit aea0eab

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,16 @@ Some examples:
525525
| `rtl_433 -F json -M utc \| mosquitto_pub -t home/rtl_433 -l` | Will pipe the output to network as JSON formatted MQTT messages. A test MQTT client can be found in `examples/mqtt_rtl_433_test_client.py`.
526526
| `rtl_433 -f 433.53M -f 434.02M -H 15` | Will poll two frequencies with 15 seconds hop interval.
527527

528+
## Security
529+
530+
Please note: We aim to make `rtl_433` safe to use, but it should not be assumed secure.
531+
There is no reason to e.g. run with `sudo`, we do read and write files without any checks.
532+
533+
The output is literally pulled from thin air, it's not to be trusted.
534+
If you feed downstream systems with data make sure edge cases are checked and handled.
535+
Network inputs and outputs are for use in a trusted local network, will contain unfiltered data, and might overload the recipient
536+
(know that e.g. the MQTT output can be controlled by anyone with a radio sender).
537+
528538
## Google Group
529539

530540
Join the Google group, rtl_433, for more information about rtl_433:

0 commit comments

Comments
 (0)