SslStream.AuthenticateAsClientAsync Método

Definición

Espacio de nombres:

System.Net.Security

Ensamblado:

System.Net.Security.dll

Autentica el cliente de una conexión cliente-servidor como una operación asincrónica.

Sobrecargas

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)	Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación utiliza la colección de certificados especificada y el protocolo SSL.
AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)	Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación usa la colección de certificados especificada y el protocolo SSL predeterminado del sistema.
AuthenticateAsClientAsync(String)	Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica.
AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)	Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación usa información especificada en el contenedor de propiedades sslClientAuthenticationOptions.

AuthenticateAsClientAsync(String, X509CertificateCollection, SslProtocols, Boolean)

Source:

SslStream.cs

Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación utiliza la colección de certificados especificada y el protocolo SSL.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost, System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ clientCertificates, System::Security::Authentication::SslProtocols enabledSslProtocols, bool checkCertificateRevocation);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync (string targetHost, System.Security.Cryptography.X509Certificates.X509CertificateCollection? clientCertificates, System.Security.Authentication.SslProtocols enabledSslProtocols, bool checkCertificateRevocation);

abstract member AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * System.Security.Authentication.SslProtocols * bool -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * System.Security.Authentication.SslProtocols * bool -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String, clientCertificates As X509CertificateCollection, enabledSslProtocols As SslProtocols, checkCertificateRevocation As Boolean) As Task

Parámetros

targetHost

String

El nombre del servidor que compartirá esta clase SslStream.

clientCertificates

X509CertificateCollection

La clase X509CertificateCollection que contiene certificados de cliente.

enabledSslProtocols

SslProtocols

Valor SslProtocols que representa el protocolo que se usa para la autenticación.

checkCertificateRevocation

Boolean

Valor Boolean que especifica si se comprueba la lista de revocación de certificados durante la autenticación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

AuthenticationException

No se pudo realizar la autenticación y este objeto queda en un estado no utilizable.

InvalidOperationException

Ya se ha producido la autenticación.

O bien

La autenticación de servidor con esta SslStream se intentó con anterioridad.

O bien

La autenticación ya está en curso.

ObjectDisposedException

Este objeto se ha cerrado.

Comentarios

A partir de .NET Framework 4.7, este método se autentica mediante None, que permite al sistema operativo elegir el mejor protocolo para usar y bloquear los protocolos que no sean seguros. En .NET Framework 4.6 (y .NET Framework 4.5 con las revisiones de seguridad más recientes instaladas), las versiones de los protocolos TLS/SSL permitidas son 1.0, 1.1 y 1.2 (a menos que edite el Registro de Windows para deshabilitar la criptografía robusta).

Cuando la autenticación se realiza correctamente, debe comprobar las IsEncrypted propiedades y IsSigned para determinar qué servicios de seguridad usan .SslStream Compruebe la IsMutuallyAuthenticated propiedad para determinar si se ha producido la autenticación mutua.

Si se produce un error en la autenticación, recibirá un AuthenticationExceptiony ya SslStream no se puede usar. Debe cerrar este objeto y quitar todas las referencias a él para que el recolector de elementos no utilizados pueda recopilarla.

Nota

Los certificados de cliente no se admiten en el protocolo SSL versión 2.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por AuthenticateAsClient(String, X509CertificateCollection, SslProtocols, Boolean).

AuthenticateAsClientAsync(String, X509CertificateCollection, Boolean)

Source:

SslStream.cs

Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación usa la colección de certificados especificada y el protocolo SSL predeterminado del sistema.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost, System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ clientCertificates, bool checkCertificateRevocation);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync (string targetHost, System.Security.Cryptography.X509Certificates.X509CertificateCollection? clientCertificates, bool checkCertificateRevocation);

abstract member AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * bool -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string * System.Security.Cryptography.X509Certificates.X509CertificateCollection * bool -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String, clientCertificates As X509CertificateCollection, checkCertificateRevocation As Boolean) As Task

Parámetros

targetHost

String

El nombre del servidor que compartirá esta clase SslStream.

clientCertificates

X509CertificateCollection

La clase X509CertificateCollection que contiene certificados de cliente.

checkCertificateRevocation

Boolean

Valor Boolean que especifica si se comprueba la lista de revocación de certificados durante la autenticación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

AuthenticationException

No se pudo realizar la autenticación y este objeto queda en un estado no utilizable.

InvalidOperationException

Ya se ha producido la autenticación.

O bien

La autenticación de servidor con esta SslStream se intentó con anterioridad.

O bien

La autenticación ya está en curso.

ObjectDisposedException

Este objeto se ha cerrado.

Comentarios

A partir de .NET Framework 4.7, este método se autentica mediante None, que permite al sistema operativo elegir el mejor protocolo para usar y bloquear los protocolos que no sean seguros. En .NET Framework 4.6 (y .NET Framework 4.5 con las revisiones de seguridad más recientes instaladas), las versiones de los protocolos TLS/SSL permitidas son 1.0, 1.1 y 1.2 (a menos que edite el Registro de Windows para deshabilitar la criptografía robusta).

Cuando la autenticación se realiza correctamente, debe comprobar las IsEncrypted propiedades y IsSigned para determinar qué servicios de seguridad usan .SslStream Compruebe la IsMutuallyAuthenticated propiedad para determinar si se ha producido la autenticación mutua.

Si se produce un error en la autenticación, recibirá un AuthenticationExceptiony ya SslStream no se puede usar. Debe cerrar este objeto y quitar todas las referencias a él para que el recolector de elementos no utilizados pueda recopilarla.

Nota

Los certificados de cliente no se admiten en el protocolo SSL versión 2.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por AuthenticateAsClient(String, X509CertificateCollection, Boolean).

AuthenticateAsClientAsync(String)

Source:

SslStream.cs

Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica.

public:
 virtual System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::String ^ targetHost);

public virtual System.Threading.Tasks.Task AuthenticateAsClientAsync (string targetHost);

abstract member AuthenticateAsClientAsync : string -> System.Threading.Tasks.Task
override this.AuthenticateAsClientAsync : string -> System.Threading.Tasks.Task

Public Overridable Function AuthenticateAsClientAsync (targetHost As String) As Task

Parámetros

targetHost

String

El nombre del servidor que comparte esta clase SslStream.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

ArgumentNullException

targetHost es null.

AuthenticationException

No se pudo realizar la autenticación y este objeto queda en un estado no utilizable.

InvalidOperationException

Ya se ha producido la autenticación.

O bien

La autenticación de servidor con esta SslStream se intentó con anterioridad.

O bien

La autenticación ya está en curso.

ObjectDisposedException

Este objeto se ha cerrado.

Comentarios

A partir de .NET Framework 4.7, este método se autentica mediante None, que permite al sistema operativo elegir el mejor protocolo para usar y bloquear los protocolos que no sean seguros. En .NET Framework 4.6 (y .NET Framework 4.5 con las revisiones de seguridad más recientes instaladas), las versiones de los protocolos TLS/SSL permitidas son 1.0, 1.1 y 1.2 (a menos que edite el Registro de Windows para deshabilitar la criptografía robusta). No se usan certificados de cliente en la autenticación. La lista de revocación de certificados no se comprueba durante la autenticación. El valor especificado para targetHost debe coincidir con el nombre en el certificado del servidor.

Cuando la autenticación se realiza correctamente, debe comprobar las IsEncrypted propiedades y IsSigned para determinar qué servicios de seguridad usan .SslStream Compruebe la IsMutuallyAuthenticated propiedad para determinar si se ha producido la autenticación mutua.

Si se produce un error en la autenticación, recibirá un AuthenticationExceptiony ya SslStream no se puede usar. Debe cerrar este objeto y quitar todas las referencias a él para que el recolector de elementos no utilizados pueda recopilarla.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por AuthenticateAsClient(String).

AuthenticateAsClientAsync(SslClientAuthenticationOptions, CancellationToken)

Source:

SslStream.cs

Lo llaman los clientes para autenticar el servidor y, de forma opcional, el cliente en una conexión cliente-servidor como operación asincrónica. El proceso de autenticación usa información especificada en el contenedor de propiedades sslClientAuthenticationOptions.

public:
 System::Threading::Tasks::Task ^ AuthenticateAsClientAsync(System::Net::Security::SslClientAuthenticationOptions ^ sslClientAuthenticationOptions, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task AuthenticateAsClientAsync (System.Net.Security.SslClientAuthenticationOptions sslClientAuthenticationOptions, System.Threading.CancellationToken cancellationToken = default);

member this.AuthenticateAsClientAsync : System.Net.Security.SslClientAuthenticationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function AuthenticateAsClientAsync (sslClientAuthenticationOptions As SslClientAuthenticationOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

Parámetros

sslClientAuthenticationOptions

SslClientAuthenticationOptions

Contenedor de propiedades para la conexión SSL.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

ArgumentNullException

sslClientAuthenticationOptions es null.

AuthenticationException

No se pudo realizar la autenticación y este objeto queda en un estado no utilizable.

InvalidOperationException

Ya se ha producido la autenticación.

O bien

La autenticación de servidor con esta SslStream se intentó con anterioridad.

O bien

La autenticación ya está en curso.

ObjectDisposedException

Este objeto se ha cerrado.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Cuando la autenticación se realiza correctamente, debe comprobar las IsEncrypted propiedades y IsSigned para determinar qué servicios de seguridad usan .SslStream Compruebe la IsMutuallyAuthenticated propiedad para determinar si se ha producido la autenticación mutua.

Si se produce un error en la autenticación, recibirá un AuthenticationExceptiony ya SslStream no se puede usar. Debe cerrar este objeto y quitar todas las referencias a él para que el recolector de elementos no utilizados pueda recopilarla.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por AuthenticateAsClient(SslClientAuthenticationOptions).