Mirror/AI-on-the-edge-device
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device.git synced 2025-12-08 04:26:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

TOOLTIPs_revised

Browse Source
This commit is contained in:
michael
2025-02-02 22:14:58 +01:00
parent a73cd97629
commit fea0c1b859
4 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
param-docs/parameter-pages/MQTT/CACert.md
View File

@@ -1,25 +1,24 @@
# Parameter `CACert` # Parameter `CACert`
Default Value: `""` Default Value: `""`
Example: `/config/certs/RootCA.pem`. Example: `/config/certs/RootCA.crt`.
!!! Warning !!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does! This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the CA certificate file. Path to the CA certificate file.
This is part of the configuration to enable TLS for MQTT. This is part of the configuration to enable TLS 1.2 for MQTT.<br>
The CA Certificate is used by the client to validate the broker is who it claims to be. The CA Certificate is used by the client to validate the broker is who it claims to be.
It allows the client to authenticate the server, which is the first part of the MTLS handshake. It allows the client to authenticate the server, which is the first part of the MTLS handshake.
Usually there is a common RootCA certificate for the MQTT broker. Usually there is a common RootCA certificate for the MQTT broker.
More information is available [here](https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/#mqtt-tls). More information is available [here](https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/#mqtt-tls).
For more information on how to create your own certificate, see: [mosquitto.org](https://mosquitto.org/man/mosquitto-tls-7.html) or [emqx.com](https://www.emqx.com/en/blog/emqx-server-ssl-tls-secure-connection-configuration-guide).
!!! Note !!! Note
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`! This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!
!!! Note
Only TLS 1.2 is supported!
!!! Note
Only Certificates up to 4096 Bit are supported! Only Certificates up to 4096 Bit are supported!

12
param-docs/parameter-pages/MQTT/ClientCert.md
View File

@@ -1,23 +1,23 @@
# Parameter `ClientCert` # Parameter `ClientCert`
Default Value: `""` Default Value: `""`
Example: `/config/certs/client.pem.crt`. Example: `/config/certs/client.crt`.
!!! Warning !!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does! This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the Client Certificate file. Path to the Client Certificate file.
This is part of the configuration to enable TLS for MQTT. This is part of the configuration to enable TLS 1.2 for MQTT.<br>
The Client Certificate is used by the client to prove its identity to the server, in conjunction with the Client Key. The Client Certificate is used by the client to prove its identity to the server, in conjunction with the Client Key.
It is the second part of the MTLS handshake. It is the second part of the MTLS handshake.
Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker. Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker.
More information is available [here](https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/#mqtt-tls). More information is available [here](https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/#mqtt-tls).
!!! Note For more information on how to create your own certificate, see: [mosquitto.org](https://mosquitto.org/man/mosquitto-tls-7.html) or [emqx.com](https://www.emqx.com/en/blog/emqx-server-ssl-tls-secure-connection-configuration-guide).
If set, `ClientKey` must be set too
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!
!!! Note !!! Note
Only TLS 1.2 is supported! If set, `ClientKey` must be set too.
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!

12
param-docs/parameter-pages/MQTT/ClientKey.md
View File

@@ -1,22 +1,22 @@
# Parameter `ClientKey` # Parameter `ClientKey`
Default Value: `""` Default Value: `""`
Example: `/config/certs/client.pem.key`. Example: `/config/certs/client.key`.
!!! Warning !!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does! This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the Client Key file. Path to the Client Key file.
This is part of the configuration to enable TLS for MQTT. This is part of the configuration to enable TLS 1.2 for MQTT.<br>
The Client Key is used by the client to prove its identity to the server, in conjunction with the Client Certificate. The Client Key is used by the client to prove its identity to the server, in conjunction with the Client Certificate.
It is the second part of the MTLS handshake. It is the second part of the MTLS handshake.
Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker
!!! Note For more information on how to create your own certificate, see: [mosquitto.org](https://mosquitto.org/man/mosquitto-tls-7.html) or [emqx.com](https://www.emqx.com/en/blog/emqx-server-ssl-tls-secure-connection-configuration-guide).
If set, `ClientCert` must be set too
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!
!!! Note !!! Note
Only TLS 1.2 is supported! If set, `ClientCert` must be set too.
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!

11
param-docs/parameter-pages/MQTT/ValidateServerCert.md
View File

@@ -5,15 +5,16 @@ Default Value: `true`
!!! Warning !!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does! This is an **Expert Parameter**! Only change it if you understand what it does!
Enable or disable the validation of the server certificate. Enable or disable the validation of the server certificate CN field.<br>
If `enabled (true)`, the certificate sent by the server is validated using the configured [Root CA Certificate file](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-cacert).<br> If `enabled (true)`, the certificate sent by the server is validated using the configured [Root CA Certificate file](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-cacert).<br>
The server name in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) is compared with the CN field of the server certificate.<br> The server name in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) is compared with the CN field of the server certificate.<br>
A connection will be only established if these match.<br> A connection is only established if they agree. It ensures the origin of the server.
It ensures the origin of the server.
If `disabled (false)`, only the validity of the certificate (e.g. expiry) is checked, not the origin (CN field).<br> If `disabled (false)`, the ESP32 skipped any validation of server certificate CN field.<br>
If you use public brokers, make sure to set this parameter to "enabled", to avoid potential MITM-Attacks! This reduces the security of TLS and makes the *MQTT* client susceptible to MITM attacks.
!!! Note !!! Note
This also means that you might have to change the protocol and port in to `mqtts://example.com:8883`! This also means that you might have to change the protocol and port in to `mqtts://example.com:8883`!
If you use public brokers, is recommended to set this parameter to "enabled (true)".