|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
|
<doc>
|
|
|
<assembly>
|
|
|
<name>System.Net.Security</name>
|
|
|
</assembly>
|
|
|
<members>
|
|
|
<member name="T:System.Net.Security.EncryptionPolicy">
|
|
|
<summary>The EncryptionPolicy to use. </summary>
|
|
|
</member>
|
|
|
<member name="F:System.Net.Security.EncryptionPolicy.AllowNoEncryption">
|
|
|
<summary>Prefer that full encryption be used, but allow a NULL cipher (no encryption) if the server agrees. </summary>
|
|
|
</member>
|
|
|
<member name="F:System.Net.Security.EncryptionPolicy.NoEncryption">
|
|
|
<summary>Allow no encryption and request that a NULL cipher be used if the other endpoint can handle a NULL cipher.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Net.Security.EncryptionPolicy.RequireEncryption">
|
|
|
<summary>Require encryption and never allow a NULL cipher.</summary>
|
|
|
</member>
|
|
|
<member name="T:System.Net.Security.LocalCertificateSelectionCallback">
|
|
|
<summary>Selects the local Secure Sockets Layer (SSL) certificate used for authentication.</summary>
|
|
|
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /> used for establishing an SSL connection.</returns>
|
|
|
<param name="sender">An object that contains state information for this validation.</param>
|
|
|
<param name="targetHost">The host server specified by the client.</param>
|
|
|
<param name="localCertificates">An <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> containing local certificates.</param>
|
|
|
<param name="remoteCertificate">The certificate used to authenticate the remote party.</param>
|
|
|
<param name="acceptableIssuers">A <see cref="T:System.String" /> array of certificate issuers acceptable to the remote party.</param>
|
|
|
</member>
|
|
|
<member name="T:System.Net.Security.RemoteCertificateValidationCallback">
|
|
|
<summary>Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.</summary>
|
|
|
<returns>A <see cref="T:System.Boolean" /> value that determines whether the specified certificate is accepted for authentication.</returns>
|
|
|
<param name="sender">An object that contains state information for this validation.</param>
|
|
|
<param name="certificate">The certificate used to authenticate the remote party.</param>
|
|
|
<param name="chain">The chain of certificate authorities associated with the remote certificate.</param>
|
|
|
<param name="sslPolicyErrors">One or more errors associated with the remote certificate.</param>
|
|
|
</member>
|
|
|
<member name="T:System.Net.Security.SslStream">
|
|
|
<summary>Provides a stream used for client-server communication that uses the Secure Socket Layer (SSL) security protocol to authenticate the server and optionally the client.</summary>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslStream" /> class using the specified <see cref="T:System.IO.Stream" />.</summary>
|
|
|
<param name="innerStream">A <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslStream" /> class using the specified <see cref="T:System.IO.Stream" /> and stream closure behavior.</summary>
|
|
|
<param name="innerStream">A <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data.</param>
|
|
|
<param name="leaveInnerStreamOpen">A Boolean value that indicates the closure behavior of the <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data. This parameter indicates if the inner stream is left open.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean,System.Net.Security.RemoteCertificateValidationCallback)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslStream" /> class using the specified <see cref="T:System.IO.Stream" />, stream closure behavior and certificate validation delegate.</summary>
|
|
|
<param name="innerStream">A <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data.</param>
|
|
|
<param name="leaveInnerStreamOpen">A Boolean value that indicates the closure behavior of the <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data. This parameter indicates if the inner stream is left open.</param>
|
|
|
<param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean,System.Net.Security.RemoteCertificateValidationCallback,System.Net.Security.LocalCertificateSelectionCallback)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslStream" /> class using the specified <see cref="T:System.IO.Stream" />, stream closure behavior, certificate validation delegate and certificate selection delegate.</summary>
|
|
|
<param name="innerStream">A <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data.</param>
|
|
|
<param name="leaveInnerStreamOpen">A Boolean value that indicates the closure behavior of the <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data. This parameter indicates if the inner stream is left open.</param>
|
|
|
<param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
|
|
|
<param name="userCertificateSelectionCallback">A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> delegate responsible for selecting the certificate used for authentication.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean,System.Net.Security.RemoteCertificateValidationCallback,System.Net.Security.LocalCertificateSelectionCallback,System.Net.Security.EncryptionPolicy)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslStream" /> class using the specified <see cref="T:System.IO.Stream" /></summary>
|
|
|
<param name="innerStream">A <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data.</param>
|
|
|
<param name="leaveInnerStreamOpen">A Boolean value that indicates the closure behavior of the <see cref="T:System.IO.Stream" /> object used by the <see cref="T:System.Net.Security.SslStream" /> for sending and receiving data. This parameter indicates if the inner stream is left open.</param>
|
|
|
<param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
|
|
|
<param name="userCertificateSelectionCallback">A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> delegate responsible for selecting the certificate used for authentication.</param>
|
|
|
<param name="encryptionPolicy">The <see cref="T:System.Net.Security.EncryptionPolicy" /> to use.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.-or-<paramref name="encryptionPolicy" /> is not valid.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsClient(System.String)">
|
|
|
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection.</summary>
|
|
|
<param name="targetHost">The name of the server that shares this <see cref="T:System.Net.Security.SslStream" />.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="targetHost" /> is null.</exception>
|
|
|
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.-or-Server authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.-or- Authentication is already in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsClient(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
|
|
|
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection. The authentication process uses the specified certificate collection and SSL protocol.</summary>
|
|
|
<param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
|
|
|
<param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
|
|
|
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
|
|
|
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsClientAsync(System.String)">
|
|
|
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation.</summary>
|
|
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
|
|
|
<param name="targetHost">The name of the server that shares this <see cref="T:System.Net.Security.SslStream" />.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="targetHost" /> is null.</exception>
|
|
|
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.-or-Server authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.-or- Authentication is already in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsClientAsync(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
|
|
|
<summary>Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation. The authentication process uses the specified certificate collection and SSL protocol.</summary>
|
|
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
|
|
|
<param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
|
|
|
<param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
|
|
|
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
|
|
|
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsServer(System.Security.Cryptography.X509Certificates.X509Certificate)">
|
|
|
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificate.</summary>
|
|
|
<param name="serverCertificate">The certificate used to authenticate the server.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="serverCertificate" /> is null.</exception>
|
|
|
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.-or-Client authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.-or- Authentication is already in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.PlatformNotSupportedException">The <see cref="Overload:System.Net.Security.SslStream.AuthenticateAsServer" /> method is not supported on Windows 95, Windows 98, or Windows Millennium.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsServer(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
|
|
|
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificates, requirements and security protocol.</summary>
|
|
|
<param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
|
|
|
<param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client must supply a certificate for authentication.</param>
|
|
|
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
|
|
|
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="serverCertificate" /> is null.</exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="enabledSslProtocols" /> is not a valid <see cref="T:System.Security.Authentication.SslProtocols" /> value.</exception>
|
|
|
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.-or-Client authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.-or- Authentication is already in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.PlatformNotSupportedException">The <see cref="Overload:System.Net.Security.SslStream.AuthenticateAsServer" /> method is not supported on Windows 95, Windows 98, or Windows Millennium.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsServerAsync(System.Security.Cryptography.X509Certificates.X509Certificate)">
|
|
|
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificate as an asynchronous operation.</summary>
|
|
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
|
|
|
<param name="serverCertificate">The certificate used to authenticate the server.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="serverCertificate" /> is null.</exception>
|
|
|
<exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has already occurred.-or-Client authentication using this <see cref="T:System.Net.Security.SslStream" /> was tried previously.-or- Authentication is already in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.PlatformNotSupportedException">The <see cref="Overload:System.Net.Security.SslStream.AuthenticateAsServerAsync" /> method is not supported on Windows 95, Windows 98, or Windows Millennium.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.AuthenticateAsServerAsync(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
|
|
|
<summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificates, requirements and security protocol as an asynchronous operation.</summary>
|
|
|
<returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
|
|
|
<param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
|
|
|
<param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client must supply a certificate for authentication.</param>
|
|
|
<param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
|
|
|
<param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CanRead">
|
|
|
<summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is readable.</summary>
|
|
|
<returns>true if authentication has occurred and the underlying stream is readable; otherwise false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CanSeek">
|
|
|
<summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is seekable.</summary>
|
|
|
<returns>This property always returns false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CanTimeout">
|
|
|
<summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream supports time-outs.</summary>
|
|
|
<returns>true if the underlying stream supports time-outs; otherwise, false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CanWrite">
|
|
|
<summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is writable.</summary>
|
|
|
<returns>true if authentication has occurred and the underlying stream is writable; otherwise false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CheckCertRevocationStatus">
|
|
|
<summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the certificate revocation list is checked during the certificate validation process.</summary>
|
|
|
<returns>true if the certificate revocation list is checked; otherwise, false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CipherAlgorithm">
|
|
|
<summary>Gets a value that identifies the bulk encryption algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.CipherAlgorithmType" /> value.</returns>
|
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Net.Security.SslStream.CipherAlgorithm" /> property was accessed before the completion of the authentication process or the authentication process failed.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.CipherStrength">
|
|
|
<summary>Gets a value that identifies the strength of the cipher algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
|
|
|
<returns>An <see cref="T:System.Int32" /> value that specifies the strength of the algorithm, in bits.</returns>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.Flush">
|
|
|
<summary>Causes any buffered data to be written to the underlying device.</summary>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.HashAlgorithm">
|
|
|
<summary>Gets the algorithm used for generating message authentication codes (MACs).</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.HashAlgorithmType" /> value.</returns>
|
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Net.Security.SslStream.HashAlgorithm" /> property was accessed before the completion of the authentication process or the authentication process failed.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.HashStrength">
|
|
|
<summary>Gets a value that identifies the strength of the hash algorithm used by this instance.</summary>
|
|
|
<returns>An <see cref="T:System.Int32" /> value that specifies the strength of the <see cref="T:System.Security.Authentication.HashAlgorithmType" /> algorithm, in bits. Valid values are 128 or 160.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.KeyExchangeAlgorithm">
|
|
|
<summary>Gets the key exchange algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
|
|
|
<returns>An <see cref="T:System.Security.Authentication.ExchangeAlgorithmType" /> value.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.KeyExchangeStrength">
|
|
|
<summary>Gets a value that identifies the strength of the key exchange algorithm used by this instance.</summary>
|
|
|
<returns>An <see cref="T:System.Int32" /> value that specifies the strength of the <see cref="T:System.Security.Authentication.ExchangeAlgorithmType" /> algorithm, in bits.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.Length">
|
|
|
<summary>Gets the length of the underlying stream.</summary>
|
|
|
<returns>A <see cref="T:System.Int64" />.The length of the underlying stream.</returns>
|
|
|
<exception cref="T:System.NotSupportedException">Getting the value of this property is not supported when the underlying stream is a <see cref="T:System.Net.Sockets.NetworkStream" />.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.LocalCertificate">
|
|
|
<summary>Gets the certificate used to authenticate the local endpoint.</summary>
|
|
|
<returns>An X509Certificate object that represents the certificate supplied for authentication or null if no certificate was supplied.</returns>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.Position">
|
|
|
<summary>Gets or sets the current position in the underlying stream.</summary>
|
|
|
<returns>A <see cref="T:System.Int64" />.The current position in the underlying stream.</returns>
|
|
|
<exception cref="T:System.NotSupportedException">Setting this property is not supported.-or-Getting the value of this property is not supported when the underlying stream is a <see cref="T:System.Net.Sockets.NetworkStream" />.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
|
<summary>Reads data from this stream and stores it in the specified array.</summary>
|
|
|
<returns>A <see cref="T:System.Int32" /> value that specifies the number of bytes read. When there is no more data to be read, returns 0.</returns>
|
|
|
<param name="buffer">A <see cref="T:System.Byte" /> array that receives the bytes read from this stream.</param>
|
|
|
<param name="offset">A <see cref="T:System.Int32" /> that contains the zero-based location in <paramref name="buffer" /> at which to begin storing the data read from this stream.</param>
|
|
|
<param name="count">A <see cref="T:System.Int32" /> that contains the maximum number of bytes to read from this stream.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="buffer" /> is null.</exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="offset" />
|
|
|
<paramref name="<" />
|
|
|
<paramref name="0" />.<paramref name="-or-" /><paramref name="offset" /> > the length of <paramref name="buffer" />.-or-<paramref name="offset" /> + count > the length of <paramref name="buffer" />.</exception>
|
|
|
<exception cref="T:System.IO.IOException">The read operation failed. Check the inner exception, if present to determine the cause of the failure.</exception>
|
|
|
<exception cref="T:System.NotSupportedException">There is already a read operation in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.ReadTimeout">
|
|
|
<summary>Gets or sets the amount of time a read operation blocks waiting for data.</summary>
|
|
|
<returns>A <see cref="T:System.Int32" /> that specifies the amount of time that elapses before a synchronous read operation fails.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.RemoteCertificate">
|
|
|
<summary>Gets the certificate used to authenticate the remote endpoint.</summary>
|
|
|
<returns>An X509Certificate object that represents the certificate supplied for authentication or null if no certificate was supplied.</returns>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
|
<summary>Throws a <see cref="T:System.NotSupportedException" />.</summary>
|
|
|
<returns>Always throws a <see cref="T:System.NotSupportedException" />.</returns>
|
|
|
<param name="offset">This value is ignored.</param>
|
|
|
<param name="origin">This value is ignored.</param>
|
|
|
<exception cref="T:System.NotSupportedException">Seeking is not supported by <see cref="T:System.Net.Security.SslStream" /> objects.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.SetLength(System.Int64)">
|
|
|
<summary>Sets the length of the underlying stream.</summary>
|
|
|
<param name="value">An <see cref="T:System.Int64" /> value that specifies the length of the stream.</param>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.SslProtocol">
|
|
|
<summary>Gets a value that indicates the security protocol used to authenticate this connection.</summary>
|
|
|
<returns>The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.TransportContext">
|
|
|
<summary>Gets the <see cref="T:System.Net.TransportContext" /> used for authentication using extended protection.</summary>
|
|
|
<returns>The <see cref="T:System.Net.TransportContext" /> object that contains the channel binding token (CBT) used for extended protection.</returns>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.Write(System.Byte[])">
|
|
|
<summary>Writes the specified data to this stream.</summary>
|
|
|
<param name="buffer">A <see cref="T:System.Byte" /> array that supplies the bytes written to the stream.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="buffer" /> is null.</exception>
|
|
|
<exception cref="T:System.IO.IOException">The write operation failed.</exception>
|
|
|
<exception cref="T:System.NotSupportedException">There is already a write operation in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Net.Security.SslStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
|
<summary>Write the specified number of <see cref="T:System.Byte" />s to the underlying stream using the specified buffer and offset.</summary>
|
|
|
<param name="buffer">A <see cref="T:System.Byte" /> array that supplies the bytes written to the stream.</param>
|
|
|
<param name="offset">A <see cref="T:System.Int32" /> that contains the zero-based location in <paramref name="buffer" /> at which to begin reading bytes to be written to the stream.</param>
|
|
|
<param name="count">A <see cref="T:System.Int32" /> that contains the number of bytes to read from <paramref name="buffer" />.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="buffer" /> is null.</exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="offset" />
|
|
|
<paramref name="<" />
|
|
|
<paramref name="0" />.<paramref name="-or-" /><paramref name="offset" /> > the length of <paramref name="buffer" />.-or-<paramref name="offset" /> + count > the length of <paramref name="buffer" />.</exception>
|
|
|
<exception cref="T:System.IO.IOException">The write operation failed.</exception>
|
|
|
<exception cref="T:System.NotSupportedException">There is already a write operation in progress.</exception>
|
|
|
<exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
|
|
|
<exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
|
|
|
</member>
|
|
|
<member name="P:System.Net.Security.SslStream.WriteTimeout">
|
|
|
<summary>Gets or sets the amount of time a write operation blocks waiting for data.</summary>
|
|
|
<returns>A <see cref="T:System.Int32" /> that specifies the amount of time that elapses before a synchronous write operation fails. </returns>
|
|
|
</member>
|
|
|
<member name="T:System.Security.Authentication.AuthenticationException">
|
|
|
<summary>The exception that is thrown when authentication fails for an authentication stream.</summary>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.AuthenticationException.#ctor">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with no message.</summary>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.AuthenticationException.#ctor(System.String)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with the specified message.</summary>
|
|
|
<param name="message">A <see cref="T:System.String" /> that describes the authentication failure.</param>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.AuthenticationException.#ctor(System.String,System.Exception)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with the specified message and inner exception.</summary>
|
|
|
<param name="message">A <see cref="T:System.String" /> that describes the authentication failure.</param>
|
|
|
<param name="innerException">The <see cref="T:System.Exception" /> that is the cause of the current exception.</param>
|
|
|
</member>
|
|
|
<member name="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> class represents the extended protection policy used by the server to validate incoming client connections. </summary>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> class that specifies when the extended protection policy should be enforced.</summary>
|
|
|
<param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ChannelBinding)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> class that specifies when the extended protection policy should be enforced and the channel binding token (CBT) to be used.</summary>
|
|
|
<param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
|
|
|
<param name="customChannelBinding">A <see cref="T:System.Security.Authentication.ExtendedProtection.ChannelBinding" /> that contains a custom channel binding to use for validation.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="customChannelBinding " />is null. </exception>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ProtectionScenario,System.Collections.ICollection)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> class that specifies when the extended protection policy should be enforced, the kind of protection enforced by the policy, and a custom Service Provider Name (SPN) list that is used to match against a client's SPN.</summary>
|
|
|
<param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
|
|
|
<param name="protectionScenario">A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy.</param>
|
|
|
<param name="customServiceNames">A <see cref="T:System.Collections.ICollection" /> that contains the custom SPN list that is used to match against a client's SPN.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="customServiceNames " />is nullor an empty list. </exception>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ProtectionScenario,System.Security.Authentication.ExtendedProtection.ServiceNameCollection)">
|
|
|
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> class that specifies when the extended protection policy should be enforced, the kind of protection enforced by the policy, and a custom Service Provider Name (SPN) list that is used to match against a client's SPN.</summary>
|
|
|
<param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
|
|
|
<param name="protectionScenario">A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy.</param>
|
|
|
<param name="customServiceNames">A <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> that contains the custom SPN list that is used to match against a client's SPN.</param>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="customServiceNames " />is nullor an empty list. </exception>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomChannelBinding">
|
|
|
<summary>Gets a custom channel binding token (CBT) to use for validation.</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ChannelBinding" /> that contains a custom channel binding to use for validation.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomServiceNames">
|
|
|
<summary>Gets the custom Service Provider Name (SPN) list used to match against a client's SPN.</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> that contains the custom SPN list that is used to match against a client's SPN.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.OSSupportsExtendedProtection">
|
|
|
<summary>Indicates whether the operating system supports integrated windows authentication with extended protection.</summary>
|
|
|
<returns>true if the operating system supports integrated windows authentication with extended protection, otherwise false.</returns>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.PolicyEnforcement">
|
|
|
<summary>Gets when the extended protection policy should be enforced.</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced. </returns>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.ProtectionScenario">
|
|
|
<summary>Gets the kind of protection enforced by the extended protection policy.</summary>
|
|
|
<returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy. </returns>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.ToString">
|
|
|
<summary>Gets a string representation for the extended protection policy instance.</summary>
|
|
|
<returns>A <see cref="T:System.String" /> instance that contains the representation of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> instance.</returns>
|
|
|
</member>
|
|
|
<member name="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> enumeration specifies when the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> should be enforced.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Always">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> is always enforced. Clients that don’t support extended protection will fail to authenticate.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> is never enforced and extended protection is disabled.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.WhenSupported">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> is enforced only if the client and server supports extended protection.</summary>
|
|
|
</member>
|
|
|
<member name="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> enumeration specifies the protection scenario enforced by the policy.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Security.Authentication.ExtendedProtection.ProtectionScenario.TransportSelected">
|
|
|
<summary>The transport will select between a secure and standard protection scenario depending on the type of channel used. For secure protection, integrated Windows authentication is wrapped in a secure channel and has an exactly matching channel binding token with no Service Provider Name (SPN) validation. For standard protection, integrated Windows authentication is optionally wrapped in a secure channel with an optional channel binding token and SPN validation is required. So if the request comes through a secure channel, the channel binding token (CBT) is checked, otherwise the SPN is checked.</summary>
|
|
|
</member>
|
|
|
<member name="F:System.Security.Authentication.ExtendedProtection.ProtectionScenario.TrustedProxy">
|
|
|
<summary>Integrated Windows authentication is wrapped in a secure channel terminated by a trusted proxy and has a channel binding token with SPN validation required. This requires the presence of a CBT, but the CBT is not checked while the SPN is checked.</summary>
|
|
|
</member>
|
|
|
<member name="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection">
|
|
|
<summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> class is a read-only collection of service principal names. </summary>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.#ctor(System.Collections.ICollection)">
|
|
|
<summary>Initializes a new read-only instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> class based on an existing <see cref="T:System.Collections.ICollection" />. </summary>
|
|
|
<param name="items">An instance of the <see cref="T:System.Collections.ICollection" /> class that contains the specified values of service names to be used to initialize the class.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="item " />is null. </exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="item" /> is empty.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Contains(System.String)">
|
|
|
<summary>Returns a value indicating whether the specified string occurs within this <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance.</summary>
|
|
|
<returns>Returns <see cref="T:System.Boolean" />.true if the <paramref name="searchServiceName" /> parameter occurs within this <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance; otherwise, false.</returns>
|
|
|
<param name="searchServiceName">The string to seek.</param>
|
|
|
</member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Count"></member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.GetEnumerator"></member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Merge(System.Collections.IEnumerable)">
|
|
|
<summary>Merges the current <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> with the specified values to create a new <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> containing the union.</summary>
|
|
|
<returns>A new <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance that contains the union of the existing <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance merged with the specified values.</returns>
|
|
|
<param name="serviceNames">An instance of the <see cref="T:System.Collections.IEnumerable" /> class that contains the specified values of service names to be merged.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="serviceNames " />is null. </exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="serviceNames" /> is empty.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Merge(System.String)">
|
|
|
<summary>Merges the current <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> with the specified values to create a new <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> containing the union.</summary>
|
|
|
<returns>A new <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance that contains the union of the existing <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance merged with the specified values.</returns>
|
|
|
<param name="serviceName">A string that contains the specified values of service names to be used to initialize the class.</param>
|
|
|
<exception cref="T:System.ArgumentNullException">
|
|
|
<paramref name="serviceNames " />is null. </exception>
|
|
|
<exception cref="T:System.ArgumentException">
|
|
|
<paramref name="serviceNames" /> is empty.</exception>
|
|
|
</member>
|
|
|
<member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)"></member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#IsSynchronized"></member>
|
|
|
<member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#SyncRoot"></member>
|
|
|
</members>
|
|
|
</doc> |