-
Notifications
You must be signed in to change notification settings - Fork 26
Breaking-change announcement for MQTT CN validation enforcement #3941
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
rohitjoshi-c8y
merged 6 commits into
develop
from
doc/MTM-65166/mqtt-service-cn-validation-announcement
Dec 2, 2025
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c884b7d
MTM-65166 Add breaking-change announcement for MQTT CN validation enf…
rohitjoshi-c8y 06ec92b
Apply suggestions from code review
rohitjoshi-c8y 48863d6
Addressed Review Comments
rohitjoshi-c8y de351d5
Apply review suggestions
rohitjoshi-c8y 554cfd4
Apply review suggestions
rohitjoshi-c8y dc8127a
Added date
rohitjoshi-c8y File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
.../change-logs/platform-services/mqtt-service-0.9.x-cn-validation-announcement.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| date: 2025-12-02 | ||
| title: MQTT Service will enforce Common Name validation for certificate-authenticated clients | ||
| change_type: | ||
| - value: change-inv-3bw8e | ||
| label: Announcement | ||
| product_area: Platform services | ||
| component: | ||
| - value: component-LcWEQW5gs | ||
| label: MQTT | ||
| build_artifact: | ||
| - value: tc-hc5Tfixeqqei | ||
| label: mqtt-service | ||
| issue: MTM-65167 | ||
| --- | ||
|
|
||
| {{< c8y-admon-caution >}} | ||
| This change only affects the new {{< product-c8y-iot >}} [MQTT Service](/device-integration/mqtt-service/) capability. | ||
|
|
||
| The existing {{< product-c8y-iot >}} [Core MQTT](/device-integration/mqtt/) capability is **not** affected. | ||
| {{< /c8y-admon-caution >}} | ||
|
|
||
| ### Introduction | ||
|
|
||
| To strengthen identity assurance for certificate-authenticated MQTT clients, the {{< product-c8y-iot >}} [MQTT Service](/device-integration/mqtt-service/) will begin enforcing **Common Name (CN) validation** during client certificate authentication. | ||
|
|
||
| Currently, the MQTT Service accepts certificates where the CN does not match the MQTT client ID. | ||
| After this change, the CN must match the client ID used during connection. | ||
| This tight binding of certificates to devices will significantly reduce the risk of certificate misuse. | ||
|
|
||
| ### What is changing? | ||
|
|
||
| When an MQTT client connects using certificate-based authentication, **the Common Name (CN) in the certificate must match the MQTT device ID**. | ||
|
|
||
| MQTT clients may identify themselves using either of the following client ID formats: | ||
| 1. `<deviceId>` – standard format | ||
| 2. `d:<deviceId>` – supported only for legacy SmartREST devices migrating to the MQTT Service. This format must **not** be used for new devices. | ||
|
|
||
| However, in **both** cases, the certificate’s CN must be: | ||
|
|
||
| * `CN == <deviceId>` | ||
|
|
||
| Any certificate whose CN does not equal the device ID will fail authentication. | ||
|
|
||
| Only certificate-authenticated clients are affected; all other authentication methods remain unchanged. | ||
|
|
||
| ### Impact on existing MQTT clients | ||
|
|
||
| This is a **breaking change**. | ||
| Devices using certificates whose CN does not match the device ID will fail authentication once enforcement begins. | ||
|
|
||
| Customers should verify and update their certificate issuance processes during the grace period. | ||
|
|
||
| Please contact [Cumulocity Support](/additional-resources/contacting-support/) if you have any questions or concerns about these changes. | ||
|
|
||
| ### Roll-out plan | ||
|
|
||
| {{< c8y-admon-info >}} | ||
| Because the {{< product-c8y-iot >}} [MQTT Service](/device-integration/mqtt-service/) is currently in Public Preview, it is not subject to the standard 6-month compatibility notice period defined in the Cumulocity IoT [Compatibility policy](/service-terms/compatibility-policy/). | ||
| {{< /c8y-admon-info >}} | ||
|
|
||
| To allow a smooth transition, CN validation will be introduced no sooner than **four weeks after this announcement**. | ||
rohitjoshi-c8y marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.