This topic has not yet been rated - Rate this topic

SslStream.BeginAuthenticateAsServer Method (X509Certificate, Boolean, SslProtocols, Boolean, AsyncCallback, Object)

Called by servers to begin an asynchronous operation to authenticate the server and optionally the client using the specified certificates, requirements and security protocol.

Namespace:  System.Net.Security
Assembly:  System (in System.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual IAsyncResult BeginAuthenticateAsServer(
	X509Certificate serverCertificate,
	bool clientCertificateRequired,
	SslProtocols enabledSslProtocols,
	bool checkCertificateRevocation,
	AsyncCallback asyncCallback,
	Object asyncState
)

Parameters

serverCertificate
Type: System.Security.Cryptography.X509Certificates.X509Certificate
The X509Certificate used to authenticate the server.
clientCertificateRequired
Type: System.Boolean
A Boolean value that specifies whether the client must supply a certificate for authentication.
enabledSslProtocols
Type: System.Security.Authentication.SslProtocols
The SslProtocols value that represents the protocol used for authentication.
checkCertificateRevocation
Type: System.Boolean
A Boolean value that specifies whether the certificate revocation list is checked during authentication.
asyncCallback
Type: System.AsyncCallback
An AsyncCallback delegate that references the method to invoke when the authentication is complete.
asyncState
Type: System.Object
A user-defined object that contains information about the operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

Type: System.IAsyncResult
An IAsyncResult object that indicates the status of the asynchronous operation.
ExceptionCondition
ArgumentNullException

serverCertificate is null.

ArgumentException

enabledSslProtocols is not a valid SslProtocols value.

AuthenticationException

The authentication failed and left this object in an unusable state.

InvalidOperationException

Authentication has already occurred.

-or-

Server authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

PlatformNotSupportedException

The BeginAuthenticateAsServer method is not supported on Windows 95, Windows 98, or Windows Millennium.

The asynchronous authentication operation must be completed by calling the EndAuthenticateAsServer method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block while the operation completes. To block until the operation completes, use one of the AuthenticateAsServer method overloads.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

If you receive a AuthenticationException, this SslStream is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition Platform Note: The BeginAuthenticateAsServer method is not supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.