SslStream.NegotiateClientCertificateAsync(CancellationToken) Method

Definition

Namespace:

System.Net.Security

Assembly:

System.Net.Security.dll

Source:

SslStream.cs

Negotiates the client certificate on the authenticated connection.

[System.Runtime.Versioning.SupportedOSPlatform("freebsd")]
[System.Runtime.Versioning.SupportedOSPlatform("linux")]
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public virtual System.Threading.Tasks.Task NegotiateClientCertificateAsync (System.Threading.CancellationToken cancellationToken = default);

[<System.Runtime.Versioning.SupportedOSPlatform("freebsd")>]
[<System.Runtime.Versioning.SupportedOSPlatform("linux")>]
[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
abstract member NegotiateClientCertificateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.NegotiateClientCertificateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function NegotiateClientCertificateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken

CancellationToken

The token to monitor for cancellation requests.

Returns

Task

The task object representing the asynchronous operation.

Attributes

SupportedOSPlatformAttribute

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

You can negotiate the client certificate once authentication is successfully processed via one of the AuthenticateAs... methods.