From c44816efee7f351906c1561f7cc8b6f296acb9ec Mon Sep 17 00:00:00 2001 From: Fredrik Lindqvist Date: Mon, 21 Jan 2019 17:51:21 +0100 Subject: [PATCH] Add simple step for securing Zigbee network (#899) * Add simple step for securing zigbee network * Update configuration.md * Update how_to_secure_network.md * Update index.md --- docs/configuration/configuration.md | 5 +++-- docs/getting_started/pairing_devices.md | 3 ++- docs/how_tos/how_to_secure_network.md | 16 ++++++++++++++++ docs/index.md | 1 + 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/how_tos/how_to_secure_network.md diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index 27cdedd39..8995b7e95 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -7,7 +7,8 @@ The values shown are the default ones. # Required: Home Assistant integration (MQTT discovery) homeassistant: false -# Required: allow new devices to join +# Required: allow new devices to join. +# WARNING: Disable this after all devices have been paired! permit_join: true # Required: MQTT settings @@ -53,4 +54,4 @@ advanced: rtscts: true # Optional: soft reset ZNP after timeout (in seconds); 0 is disabled soft_reset_timeout: 0 -``` \ No newline at end of file +``` diff --git a/docs/getting_started/pairing_devices.md b/docs/getting_started/pairing_devices.md index 0e1e5f047..7320f2a6b 100644 --- a/docs/getting_started/pairing_devices.md +++ b/docs/getting_started/pairing_devices.md @@ -1,4 +1,5 @@ **IMPORTANT:** Before you start, make sure that `permit_join: true` is set in your `configuration.yaml`. Otherwise new devices cannot join the network! +It's equally important that `permit_join: false` is set in your `configuration.yaml` after initial setup is done to keep your Zigbee network safe and to avoid accidental joining of other Zigbee devices. Start by checking if your Zigbee device is supported, see [Supported devices](../information/supported_devices.md). @@ -65,4 +66,4 @@ Factory reset by: (at the 3rd, the 10th, and the 15th second). - After releasing the Binding Key, press the Switch Key within 2 seconds. The network indicator will rapidly flash green. -- After fast flashes, Z809A will reboot, and the restore is completed. The socket will automatically connect now. \ No newline at end of file +- After fast flashes, Z809A will reboot, and the restore is completed. The socket will automatically connect now. diff --git a/docs/how_tos/how_to_secure_network.md b/docs/how_tos/how_to_secure_network.md new file mode 100644 index 000000000..f9c342655 --- /dev/null +++ b/docs/how_tos/how_to_secure_network.md @@ -0,0 +1,16 @@ +# How to secure your Zigbee network +By default your Zigbee network isn't as secured as possible. The following settings are recommeded to apply to your configuration. + +## Disabled joining +To disable joining it's important that `permit_join: false` is set in your `configuration.yaml`. + +## Change Zigbee network encryption key +**Changing the key requires repairing of all devices!** + +Zigbee2mqtt uses a default encryption key. Therefore it is recommended to use a different one. To use a different encryption key add the following to you `configuration.yaml`: + +**Do not use the following key.** +``` +advanced: + network_key: [7, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 11, 12, 13], +``` diff --git a/docs/index.md b/docs/index.md index 0faa808a0..c22e98064 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,6 +25,7 @@ Welcome to the Zigbee2mqtt documentation! * [How to support new devices](how_tos/how_to_support_new_devices.md) * [How to debug](how_tos/how_to_debug.md) * [How to support new devices on Hass.io](how_tos/how_to_support_new_devices_on_hassio.md) +* [How to secure your Zigbee network](how_tos/how_to_secure_network.md) ### Information * [Supported devices](information/supported_devices.md)