Skip to content

mTLS PoP: fix misleading region-required error messages + doc comments#6127

Merged
Robbie-Microsoft merged 4 commits into
mainfrom
rginsburg/mtls-region-msg-fix
Jul 15, 2026
Merged

mTLS PoP: fix misleading region-required error messages + doc comments#6127
Robbie-Microsoft merged 4 commits into
mainfrom
rginsburg/mtls-region-msg-fix

Conversation

@Robbie-Microsoft

Copy link
Copy Markdown
Contributor

Splits the message-accuracy fix out of #6100 so it can ship in 4.86.0 on its own.

The RegionRequiredForMtlsPop, MtlsPopWithoutRegion, and MtlsBearerWithoutRegion error strings and XML doc comments claimed mTLS PoP requires an Azure region. It doesn't — when no region is set, MSAL falls back to the cloud's global mtlsauth endpoint. Also fixes garbled ****** redaction text in two of the strings.

No public API or behavior change: the constants are unchanged and are no longer raised. The broader SNI / S2S-FIC tests + docs stay in #6100.

Copilot AI review requested due to automatic review settings July 15, 2026 17:07
@Robbie-Microsoft
Robbie-Microsoft requested a review from a team as a code owner July 15, 2026 17:07
…omments

A region is optional for mTLS Proof-of-Possession: when none is set, MSAL uses
the cloud's global mtlsauth endpoint. Rewords the RegionRequiredForMtlsPop /
MtlsPopWithoutRegion / MtlsBearerWithoutRegion error strings and XML doc comments
(also fixes garbled redaction text). Public constants are unchanged and no longer
raised, so there is no API or behavior change.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Comment thread CHANGELOG.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR corrects MSAL.NET mTLS PoP “region required” messaging by updating the affected error-message strings, XML doc comments, and the changelog to reflect that Azure region configuration is optional (MSAL falls back to the cloud’s global mTLS endpoint when no region is set).

Changes:

  • Updated MsalErrorMessage strings (MtlsPopWithoutRegion, MtlsBearerWithoutRegion, RegionRequiredForMtlsPopMessage) to remove the incorrect “region required” claim and clarify the global-endpoint fallback.
  • Updated MsalError XML doc comments for the corresponding public error-code constants to reflect that these errors are no longer raised and the constants remain for backward compatibility.
  • Added a 4.86.0 changelog entry describing the correction and reaffirming that the public constants are unchanged.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
src/client/Microsoft.Identity.Client/MsalErrorMessage.cs Corrects user-facing error-message text about region requirements for mTLS PoP / Bearer-over-mTLS.
src/client/Microsoft.Identity.Client/MsalError.cs Updates XML docs for the related public error-code constants to reflect correct behavior and backward-compat retention.
CHANGELOG.md Documents the messaging/doc correction in the 4.86.0 release notes.

Comment thread src/client/Microsoft.Identity.Client/MsalErrorMessage.cs Outdated
Comment thread src/client/Microsoft.Identity.Client/MsalError.cs Outdated
Comment thread src/client/Microsoft.Identity.Client/MsalError.cs Outdated
Comment thread src/client/Microsoft.Identity.Client/MsalError.cs Outdated
Robbie-Microsoft added a commit that referenced this pull request Jul 15, 2026
Revert MsalError.cs and MsalErrorMessage.cs to baseline so this PR carries
only the SNI / S2S-FIC tests and docs. The misleading region-required
message + doc-comment fix now ships separately in #6127. Drop the
message-fix clause from the CHANGELOG (docs + tests entries retained).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 15, 2026 17:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread src/client/Microsoft.Identity.Client/MsalError.cs Outdated
Comment thread src/client/Microsoft.Identity.Client/MsalError.cs Outdated
… spacing

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 15, 2026 17:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread src/client/Microsoft.Identity.Client/MsalErrorMessage.cs Outdated
Comment thread src/client/Microsoft.Identity.Client/MsalErrorMessage.cs Outdated
….WithAzureRegion(...)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 15, 2026 17:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@Robbie-Microsoft
Robbie-Microsoft enabled auto-merge (squash) July 15, 2026 17:28
@Robbie-Microsoft
Robbie-Microsoft merged commit a43d09e into main Jul 15, 2026
16 checks passed
@Robbie-Microsoft
Robbie-Microsoft deleted the rginsburg/mtls-region-msg-fix branch July 15, 2026 17:48
This was referenced Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants