diff --git a/param-docs/parameter-pages/MQTT/CACert.md b/param-docs/parameter-pages/MQTT/CACert.md index ab48eb4..5ee45b4 100644 --- a/param-docs/parameter-pages/MQTT/CACert.md +++ b/param-docs/parameter-pages/MQTT/CACert.md @@ -8,5 +8,11 @@ Example: `/config/certs/RootCA.pem`. Path to the CA certificate file. +This is part of the configuration to enable TLS for MQTT. +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. + +Usually there is a common RootCA certificate for the MQTT broker + !!! 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`! diff --git a/param-docs/parameter-pages/MQTT/ClientCert.md b/param-docs/parameter-pages/MQTT/ClientCert.md index ab35a8d..9cb4924 100644 --- a/param-docs/parameter-pages/MQTT/ClientCert.md +++ b/param-docs/parameter-pages/MQTT/ClientCert.md @@ -8,5 +8,12 @@ Example: `/config/certs/client.pem.crt`. Path to the Client Certificate file. +This is part of the configuration to enable TLS for MQTT. +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. + +Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker + !!! Note + 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`! diff --git a/param-docs/parameter-pages/MQTT/ClientKey.md b/param-docs/parameter-pages/MQTT/ClientKey.md index 2b5557e..af862f0 100644 --- a/param-docs/parameter-pages/MQTT/ClientKey.md +++ b/param-docs/parameter-pages/MQTT/ClientKey.md @@ -8,5 +8,12 @@ Example: `/config/certs/client.pem.key`. Path to the Client Key file. +This is part of the configuration to enable TLS for MQTT. +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. + +Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker + !!! Note + 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`!