Skip to main content

Security

//TODO: Screenshot

info

Also refer to the Maintenance docs page for security recommendations.

Admin user​

The web interface of the device can optionally be gated by an administrator username and password combination.

warning

If not set explicitly, this feature is not active and everybody who has network access to the device will be able to read and write configuration and user data (Peripheral status and historical data) from the device.

To activate the username/password authentication, fill out the form fields for

Admin user​

OptionalText

Admin password​

OptionalText

Admin password (repeat)​

OptionalText


and click the button.

To deactivate the username/password authentication, leave the form fields for the admin password empty and click the button.

warning

After setting an admin user, the web interface will not be accessible without authentication. Make sure to save the credentials in a safe place, like a password manager.

info

In case you forgot the credentials, and therefore cannot access the web interface, there is the possibility to delete the configuration (including the admin user credentials) using the reset button.

Web interface​

Redirect HTTP requests to HTTPS​

Checkbox

When checked, the device will force a redirect to all requests to http:// resources to their https:// version.

Access control​

Allow peripheral state and history read access via web interface and HTTP APIs without authentication​

Checkbox

As stated above, if the admin authentication is activated, the device configuration (read and write), as well-read access to user data (Peripheral status and historical data) on the dashboard and via HTTP APIs will only be possible after logging in.

By ticking this checkbox, the user data will still be accessible without login.

API-Key​

An API-Key is needed for the controlled device with the Box2Box feature, as well as some HTTPS APIs.

Click the button to make the device create an API-Key for this device.

After having generated an API-Key, a and a button will appear.

warning

If you regenerate or delete an API-Key, the old key will be invalid from then on. If you have Box2Box set up, you will have to repeat the process from step 2 of Box2Box: Configuring a controlled device.

Server key and certificate​

The web interface of the device is provided by an on device web server, which supports TLS.

To authenticate itself via TLS to connecting clients, a server (private) key and certificate are needed. The device provides a factory default self-signed certificate and corresponding key, which gets regenerated after the configuration is reset.

It is also possible for users to upload a custom certificate file and key file on this configuration page, which can be self-signed or an actual CA signed certificate with corresponding key for a specific domain, under which the web interface can be reached.

CA certificates​

Certificate Authority (CA) certificates are necessary for TLS encrypted (including HTTPS) connections to external servers that support TLS.

This is applicable to situations where the device connects to external servers, as with the webhooks, Box2Box, MQTT, Email and HTTP-Out watchdogs features, as long as those connections are configured to use TLS (by specifying the URL protocol as https:// instead of http:// or ticking the respective checkbox).

When browsers connect via TLS to a server, they validate the server's authenticity with the help of CA certificates that are provided with the browser itself. On successful validation, the user sees a lock icon next to the server URL.

This device does not ship with those certificates for memory space reasons. To still be able to verify the authenticity of a connected server, the user has to provide appropriate CA certificates himself by uploading them on this configuration page.

Requirements for CA certificates​

TLS version​

1.2

Certificate key​

RSA up to 4096 Bit, as well as ECC NIST P‐256, P‐384, P‐521 etc.

Hash functions for certificate​

SHA224, SHA256, SHA384, SHA512

Cipher suites​

ECDHE-ECDSA-WITH-AES-256-CBC-SHA384
ECDHE-ECDSA-WITH-AES-256-CBC-SHA
ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
ECDHE-ECDSA-WITH-AES-128-CBC-SHA256
ECDHE-ECDSA-WITH-AES-128-CBC-SHA
ECDHE-RSA-WITH-AES-256-GCM-SHA384
ECDHE-RSA-WITH-AES-256-CBC-SHA384
ECDHE-RSA-WITH-AES-256-CBC-SHA
ECDHE-RSA-WITH-AES-128-GCM-SHA256
ECDHE-RSA-WITH-AES-128-CBC-SHA256
ECDHE-RSA-WITH-AES-128-CBC-SHA
RSA-WITH-AES-256-GCM-SHA384
RSA-WITH-AES-256-CBC-SHA256
RSA-WITH-AES-256-CBC-SHA
RSA-WITH-AES-128-GCM-SHA256
RSA-WITH-AES-128-CBC-SHA256
RSA-WITH-AES-128-CBC-SHA

// TODO: Screenshots