NegotiateStream.AuthenticateAsServerAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Handles the server side of an authentication for a client-server connection as an asynchronous operation.
Overloads
| AuthenticateAsServerAsync() |
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. |
| AuthenticateAsServerAsync(ExtendedProtectionPolicy) |
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified extended protection policy. |
| AuthenticateAsServerAsync(NetworkCredential, ProtectionLevel, TokenImpersonationLevel) |
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified server credentials and authentication options. |
| AuthenticateAsServerAsync(NetworkCredential, ExtendedProtectionPolicy, ProtectionLevel, TokenImpersonationLevel) |
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified server credentials, authentication options, and extended protection policy. |
AuthenticateAsServerAsync()
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation.
public:
virtual System::Threading::Tasks::Task ^ AuthenticateAsServerAsync();public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync ();abstract member AuthenticateAsServerAsync : unit -> System.Threading.Tasks.Task
override this.AuthenticateAsServerAsync : unit -> System.Threading.Tasks.TaskPublic Overridable Function AuthenticateAsServerAsync () As TaskReturns
The task object representing the asynchronous operation.
Exceptions
The authentication failed. You can use this object to retry the authentication.
The authentication failed. You can use this object to retry the authentication.
This object has been closed.
Windows 95 and Windows 98 are not supported.
Remarks
The authentication uses the server's DefaultCredentials. No Service Principal Name (SPN) is specified for the server. The impersonation level is Identification, and the security level is EncryptAndSign.
When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.
If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by AuthenticateAsServer().
Applies to
AuthenticateAsServerAsync(ExtendedProtectionPolicy)
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified extended protection policy.
public:
virtual System::Threading::Tasks::Task ^ AuthenticateAsServerAsync(System::Security::Authentication::ExtendedProtection::ExtendedProtectionPolicy ^ policy);public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync (System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy? policy);public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync (System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy policy);abstract member AuthenticateAsServerAsync : System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy -> System.Threading.Tasks.Task
override this.AuthenticateAsServerAsync : System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy -> System.Threading.Tasks.TaskPublic Overridable Function AuthenticateAsServerAsync (policy As ExtendedProtectionPolicy) As TaskParameters
- policy
- ExtendedProtectionPolicy
The ExtendedProtectionPolicy that is used for extended protection.
Returns
The task object representing the asynchronous operation.
Exceptions
The CustomChannelBinding and CustomServiceNames on the extended protection policy passed in the policy parameter are both null.
The authentication failed. You can use this object to retry the authentication.
The authentication failed. You can use this object to retry the authentication.
This object has been closed.
The policy parameter was set to Always on a platform that does not support extended protection.
Windows 95 and Windows 98 are not supported.
Remarks
The authentication uses the server's DefaultCredentials. No Service Principal Name (SPN) is specified for the server. The impersonation level is Identification, and the security level is EncryptAndSign.
If the policy parameter is null, then an extended protection policy is used that has PolicyEnforcement set to Never.
When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.
If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by AuthenticateAsServer(ExtendedProtectionPolicy).
See also
Applies to
AuthenticateAsServerAsync(NetworkCredential, ProtectionLevel, TokenImpersonationLevel)
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified server credentials and authentication options.
public:
virtual System::Threading::Tasks::Task ^ AuthenticateAsServerAsync(System::Net::NetworkCredential ^ credential, System::Net::Security::ProtectionLevel requiredProtectionLevel, System::Security::Principal::TokenImpersonationLevel requiredImpersonationLevel);public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync (System.Net.NetworkCredential credential, System.Net.Security.ProtectionLevel requiredProtectionLevel, System.Security.Principal.TokenImpersonationLevel requiredImpersonationLevel);abstract member AuthenticateAsServerAsync : System.Net.NetworkCredential * System.Net.Security.ProtectionLevel * System.Security.Principal.TokenImpersonationLevel -> System.Threading.Tasks.Task
override this.AuthenticateAsServerAsync : System.Net.NetworkCredential * System.Net.Security.ProtectionLevel * System.Security.Principal.TokenImpersonationLevel -> System.Threading.Tasks.TaskPublic Overridable Function AuthenticateAsServerAsync (credential As NetworkCredential, requiredProtectionLevel As ProtectionLevel, requiredImpersonationLevel As TokenImpersonationLevel) As TaskParameters
- credential
- NetworkCredential
The NetworkCredential that is used to establish the identity of the server.
- requiredProtectionLevel
- ProtectionLevel
One of the ProtectionLevel values, indicating the security services for the stream.
- requiredImpersonationLevel
- TokenImpersonationLevel
One of the TokenImpersonationLevel values, indicating how the server can use the client's credentials to access resources.
Returns
The task object representing the asynchronous operation.
Exceptions
credential is null.
requiredImpersonationLevel must be Identification, Impersonation, or Delegation,
The authentication failed. You can use this object to try to r-authenticate.
The authentication failed. You can use this object to retry the authentication.
This object has been closed.
Authentication has already occurred.
-or-
This stream was used previously to attempt authentication as the client. You cannot use the stream to retry authentication as the server.
Windows 95 and Windows 98 are not supported.
Remarks
When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.
If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by AuthenticateAsServer(NetworkCredential, ProtectionLevel, TokenImpersonationLevel).
Applies to
AuthenticateAsServerAsync(NetworkCredential, ExtendedProtectionPolicy, ProtectionLevel, TokenImpersonationLevel)
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
- Source:
- NegotiateStream.cs
Called by servers to authenticate the client, and optionally the server, in a client-server connection as an asynchronous operation. The authentication process uses the specified server credentials, authentication options, and extended protection policy.
public:
virtual System::Threading::Tasks::Task ^ AuthenticateAsServerAsync(System::Net::NetworkCredential ^ credential, System::Security::Authentication::ExtendedProtection::ExtendedProtectionPolicy ^ policy, System::Net::Security::ProtectionLevel requiredProtectionLevel, System::Security::Principal::TokenImpersonationLevel requiredImpersonationLevel);public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync (System.Net.NetworkCredential credential, System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy? policy, System.Net.Security.ProtectionLevel requiredProtectionLevel, System.Security.Principal.TokenImpersonationLevel requiredImpersonationLevel);public virtual System.Threading.Tasks.Task AuthenticateAsServerAsync (System.Net.NetworkCredential credential, System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy policy, System.Net.Security.ProtectionLevel requiredProtectionLevel, System.Security.Principal.TokenImpersonationLevel requiredImpersonationLevel);abstract member AuthenticateAsServerAsync : System.Net.NetworkCredential * System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy * System.Net.Security.ProtectionLevel * System.Security.Principal.TokenImpersonationLevel -> System.Threading.Tasks.Task
override this.AuthenticateAsServerAsync : System.Net.NetworkCredential * System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy * System.Net.Security.ProtectionLevel * System.Security.Principal.TokenImpersonationLevel -> System.Threading.Tasks.TaskPublic Overridable Function AuthenticateAsServerAsync (credential As NetworkCredential, policy As ExtendedProtectionPolicy, requiredProtectionLevel As ProtectionLevel, requiredImpersonationLevel As TokenImpersonationLevel) As TaskParameters
- credential
- NetworkCredential
The NetworkCredential that is used to establish the identity of the client.
- policy
- ExtendedProtectionPolicy
The ExtendedProtectionPolicy that is used for extended protection.
- requiredProtectionLevel
- ProtectionLevel
One of the ProtectionLevel values, indicating the security services for the stream.
- requiredImpersonationLevel
- TokenImpersonationLevel
One of the TokenImpersonationLevel values, indicating how the server can use the client's credentials to access resources.
Returns
The task object representing the asynchronous operation.
Exceptions
The CustomChannelBinding and CustomServiceNames on the extended protection policy passed in the policy parameter are both null.
credential is null.
requiredImpersonationLevel must be Identification, Impersonation, or Delegation,
The authentication failed. You can use this object to try to r-authenticate.
The authentication failed. You can use this object to retry the authentication.
Authentication has already occurred.
-or-
This stream was used previously to attempt authentication as the client. You cannot use the stream to retry authentication as the server.
This object has been closed.
The policy parameter was set to Always on a platform that does not support extended protection.
Windows 95 and Windows 98 are not supported.
Remarks
If the policy parameter is null, then an extended protection policy is used that has PolicyEnforcement set to Never.
When authentication succeeds, you must check the IsEncrypted and IsSigned properties to determine what security services are used by the NegotiateStream. Check the IsMutuallyAuthenticated property to determine whether mutual authentication occurred.
If the authentication fails, you receive an AuthenticationException or an InvalidCredentialException. In this case, you can retry the authentication with a different credential.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by AuthenticateAsServer(NetworkCredential, ExtendedProtectionPolicy, ProtectionLevel, TokenImpersonationLevel).
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for