Skip to content

Clarify NegotiateAuthentication.IsAuthenticated post-failure behavior #12724

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.

Sign up for GitHub

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

Open
liveans wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −4
Open

Clarify NegotiateAuthentication.IsAuthenticated post-failure behavior #12724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions xml/System.Net.Security/NegotiateAuthentication.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,9 +287,19 @@ When <xref:System.Net.Security.NegotiateAuthenticationStatusCode.ContinueNeeded>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether authentication was successfully completed and the session was established.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the authentication exchange has completed.</summary>
<value><see langword="true" /> if the authentication exchange has completed; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsEncrypted">
Expand Down Expand Up @@ -544,7 +554,7 @@ The negotiated level of protection is only available when the session
## Remarks

For the server side of the authentication, the property returns the target name
specified by the client after successful authentication (see <xref:System.Net.Security.NegotiateAuthentication.IsAuthenticated>).
specified by the client after authentication completes successfully.

For the client side of the authentication, the property returns the target name
specified in <xref:System.Net.Security.NegotiateAuthenticationClientOptions.TargetName>.
Expand Down
Loading