Clarify NegotiateAuthentication.IsAuthenticated post-failure behavior#12724
Open
liveans wants to merge 1 commit into
Open
Clarify NegotiateAuthentication.IsAuthenticated post-failure behavior#12724liveans wants to merge 1 commit into
liveans wants to merge 1 commit into
Conversation
The IsAuthenticated property returns true after the authentication exchange has finished, including in many post-negotiation failure cases (verified across the Windows, Unix, and ManagedSpnego PAL implementations in dotnet/runtime). The previous summary (successfully completed and the session was established) implied that a true value means successful authentication, which is misleading. Update the summary, value, and remarks to clarify that callers must inspect the NegotiateAuthenticationStatusCode returned by GetOutgoingBlob to determine actual success. Also remove a misleading `(see IsAuthenticated)` reference on TargetName that reinforced the same misconception. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
the
needs-area-label
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the .NET API reference documentation for System.Net.Security.NegotiateAuthentication.IsAuthenticated to clarify that it reflects completion of the authentication exchange, not necessarily successful authentication, and directs callers to use the NegotiateAuthenticationStatusCode from GetOutgoingBlob to determine success.
Changes:
- Updated
IsAuthenticatedsummary/value/remarks to describe completion semantics and how to determine actual success. - Adjusted
TargetNameremarks to avoid implyingIsAuthenticated == truemeans authentication succeeded.
|
|
||
| This property indicates whether the authentication exchange has completed, not whether authentication succeeded. A `true` value can be returned after either successful authentication or a terminal authentication failure. | ||
|
|
||
| To determine whether authentication actually succeeded, inspect the <xref:System.Net.Security.NegotiateAuthenticationStatusCode> returned by the most recent call to <xref:System.Net.Security.NegotiateAuthentication.GetOutgoingBlob%2A>. The status is <xref:System.Net.Security.NegotiateAuthenticationStatusCode.Completed> on success; any other value indicates that authentication didn't complete successfully. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
IsAuthenticatedproperty returns true after the authentication exchange has finished, including in many post-negotiation failure cases (verified across the Windows, Unix, andManagedSpnegoPAL implementations in dotnet/runtime). The previous summary (successfully completed and the session was established) implied that a true value means successful authentication, which is misleading.Update the summary, value, and remarks to clarify that callers must inspect the
NegotiateAuthenticationStatusCodereturned byGetOutgoingBlobto determine actual success.