System.Net.Security.xml 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Net.Security</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Net.Security.EncryptionPolicy">
  8. <summary>The EncryptionPolicy to use. </summary>
  9. </member>
  10. <member name="F:System.Net.Security.EncryptionPolicy.AllowNoEncryption">
  11. <summary>Prefer that full encryption be used, but allow a NULL cipher (no encryption) if the server agrees. </summary>
  12. </member>
  13. <member name="F:System.Net.Security.EncryptionPolicy.NoEncryption">
  14. <summary>Allow no encryption and request that a NULL cipher be used if the other endpoint can handle a NULL cipher.</summary>
  15. </member>
  16. <member name="F:System.Net.Security.EncryptionPolicy.RequireEncryption">
  17. <summary>Require encryption and never allow a NULL cipher.</summary>
  18. </member>
  19. <member name="T:System.Net.Security.LocalCertificateSelectionCallback">
  20. <summary>Selects the local Secure Sockets Layer (SSL) certificate used for authentication.</summary>
  21. <returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /> used for establishing an SSL connection.</returns>
  22. <param name="sender">An object that contains state information for this validation.</param>
  23. <param name="targetHost">The host server specified by the client.</param>
  24. <param name="localCertificates">An <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> containing local certificates.</param>
  25. <param name="remoteCertificate">The certificate used to authenticate the remote party.</param>
  26. <param name="acceptableIssuers">A <see cref="T:System.String" /> array of certificate issuers acceptable to the remote party.</param>
  27. </member>
  28. <member name="T:System.Net.Security.RemoteCertificateValidationCallback">
  29. <summary>Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.</summary>
  30. <returns>A <see cref="T:System.Boolean" /> value that determines whether the specified certificate is accepted for authentication.</returns>
  31. <param name="sender">An object that contains state information for this validation.</param>
  32. <param name="certificate">The certificate used to authenticate the remote party.</param>
  33. <param name="chain">The chain of certificate authorities associated with the remote certificate.</param>
  34. <param name="sslPolicyErrors">One or more errors associated with the remote certificate.</param>
  35. </member>
  36. <member name="T:System.Net.Security.SslStream">
  37. <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>
  38. </member>
  39. <member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream)">
  40. <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>
  41. <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>
  42. <exception cref="T:System.ArgumentException">
  43. <paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
  44. <exception cref="T:System.ArgumentNullException">
  45. <paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
  46. </member>
  47. <member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean)">
  48. <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>
  49. <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>
  50. <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>
  51. <exception cref="T:System.ArgumentException">
  52. <paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
  53. <exception cref="T:System.ArgumentNullException">
  54. <paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
  55. </member>
  56. <member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean,System.Net.Security.RemoteCertificateValidationCallback)">
  57. <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>
  58. <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>
  59. <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>
  60. <param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
  61. <exception cref="T:System.ArgumentException">
  62. <paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
  63. <exception cref="T:System.ArgumentNullException">
  64. <paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
  65. </member>
  66. <member name="M:System.Net.Security.SslStream.#ctor(System.IO.Stream,System.Boolean,System.Net.Security.RemoteCertificateValidationCallback,System.Net.Security.LocalCertificateSelectionCallback)">
  67. <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>
  68. <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>
  69. <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>
  70. <param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
  71. <param name="userCertificateSelectionCallback">A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> delegate responsible for selecting the certificate used for authentication.</param>
  72. <exception cref="T:System.ArgumentException">
  73. <paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.</exception>
  74. <exception cref="T:System.ArgumentNullException">
  75. <paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
  76. </member>
  77. <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)">
  78. <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>
  79. <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>
  80. <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>
  81. <param name="userCertificateValidationCallback">A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback" /> delegate responsible for validating the certificate supplied by the remote party.</param>
  82. <param name="userCertificateSelectionCallback">A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback" /> delegate responsible for selecting the certificate used for authentication.</param>
  83. <param name="encryptionPolicy">The <see cref="T:System.Net.Security.EncryptionPolicy" /> to use.</param>
  84. <exception cref="T:System.ArgumentException">
  85. <paramref name="innerStream" /> is not readable.-or-<paramref name="innerStream" /> is not writable.-or-<paramref name="encryptionPolicy" /> is not valid.</exception>
  86. <exception cref="T:System.ArgumentNullException">
  87. <paramref name="innerStream" /> is null.-or-<paramref name="innerStream" /> is equal to <see cref="F:System.IO.Stream.Null" />.</exception>
  88. </member>
  89. <member name="M:System.Net.Security.SslStream.AuthenticateAsClient(System.String)">
  90. <summary>Called by clients to authenticate the server and optionally the client in a client-server connection.</summary>
  91. <param name="targetHost">The name of the server that shares this <see cref="T:System.Net.Security.SslStream" />.</param>
  92. <exception cref="T:System.ArgumentNullException">
  93. <paramref name="targetHost" /> is null.</exception>
  94. <exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
  95. <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>
  96. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  97. </member>
  98. <member name="M:System.Net.Security.SslStream.AuthenticateAsClient(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
  99. <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>
  100. <param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
  101. <param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
  102. <param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
  103. <param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
  104. </member>
  105. <member name="M:System.Net.Security.SslStream.AuthenticateAsClientAsync(System.String)">
  106. <summary>Called by clients to authenticate the server and optionally the client in a client-server connection as an asynchronous operation.</summary>
  107. <returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
  108. <param name="targetHost">The name of the server that shares this <see cref="T:System.Net.Security.SslStream" />.</param>
  109. <exception cref="T:System.ArgumentNullException">
  110. <paramref name="targetHost" /> is null.</exception>
  111. <exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
  112. <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>
  113. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  114. </member>
  115. <member name="M:System.Net.Security.SslStream.AuthenticateAsClientAsync(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols,System.Boolean)">
  116. <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>
  117. <returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
  118. <param name="targetHost">The name of the server that will share this <see cref="T:System.Net.Security.SslStream" />.</param>
  119. <param name="clientCertificates">The <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection" /> that contains client certificates.</param>
  120. <param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
  121. <param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
  122. </member>
  123. <member name="M:System.Net.Security.SslStream.AuthenticateAsServer(System.Security.Cryptography.X509Certificates.X509Certificate)">
  124. <summary>Called by servers to authenticate the server and optionally the client in a client-server connection using the specified certificate.</summary>
  125. <param name="serverCertificate">The certificate used to authenticate the server.</param>
  126. <exception cref="T:System.ArgumentNullException">
  127. <paramref name="serverCertificate" /> is null.</exception>
  128. <exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
  129. <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>
  130. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  131. <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>
  132. </member>
  133. <member name="M:System.Net.Security.SslStream.AuthenticateAsServer(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
  134. <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>
  135. <param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
  136. <param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client must supply a certificate for authentication.</param>
  137. <param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
  138. <param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
  139. <exception cref="T:System.ArgumentNullException">
  140. <paramref name="serverCertificate" /> is null.</exception>
  141. <exception cref="T:System.ArgumentException">
  142. <paramref name="enabledSslProtocols" /> is not a valid <see cref="T:System.Security.Authentication.SslProtocols" /> value.</exception>
  143. <exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
  144. <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>
  145. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  146. <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>
  147. </member>
  148. <member name="M:System.Net.Security.SslStream.AuthenticateAsServerAsync(System.Security.Cryptography.X509Certificates.X509Certificate)">
  149. <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>
  150. <returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
  151. <param name="serverCertificate">The certificate used to authenticate the server.</param>
  152. <exception cref="T:System.ArgumentNullException">
  153. <paramref name="serverCertificate" /> is null.</exception>
  154. <exception cref="T:System.Security.Authentication.AuthenticationException">The authentication failed and left this object in an unusable state.</exception>
  155. <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>
  156. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  157. <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>
  158. </member>
  159. <member name="M:System.Net.Security.SslStream.AuthenticateAsServerAsync(System.Security.Cryptography.X509Certificates.X509Certificate,System.Boolean,System.Security.Authentication.SslProtocols,System.Boolean)">
  160. <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>
  161. <returns>Returns <see cref="T:System.Threading.Tasks.Task" />The task object representing the asynchronous operation.</returns>
  162. <param name="serverCertificate">The X509Certificate used to authenticate the server.</param>
  163. <param name="clientCertificateRequired">A <see cref="T:System.Boolean" /> value that specifies whether the client must supply a certificate for authentication.</param>
  164. <param name="enabledSslProtocols">The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</param>
  165. <param name="checkCertificateRevocation">A <see cref="T:System.Boolean" /> value that specifies whether the certificate revocation list is checked during authentication.</param>
  166. </member>
  167. <member name="P:System.Net.Security.SslStream.CanRead">
  168. <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is readable.</summary>
  169. <returns>true if authentication has occurred and the underlying stream is readable; otherwise false.</returns>
  170. </member>
  171. <member name="P:System.Net.Security.SslStream.CanSeek">
  172. <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is seekable.</summary>
  173. <returns>This property always returns false.</returns>
  174. </member>
  175. <member name="P:System.Net.Security.SslStream.CanTimeout">
  176. <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream supports time-outs.</summary>
  177. <returns>true if the underlying stream supports time-outs; otherwise, false.</returns>
  178. </member>
  179. <member name="P:System.Net.Security.SslStream.CanWrite">
  180. <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the underlying stream is writable.</summary>
  181. <returns>true if authentication has occurred and the underlying stream is writable; otherwise false.</returns>
  182. </member>
  183. <member name="P:System.Net.Security.SslStream.CheckCertRevocationStatus">
  184. <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the certificate revocation list is checked during the certificate validation process.</summary>
  185. <returns>true if the certificate revocation list is checked; otherwise, false.</returns>
  186. </member>
  187. <member name="P:System.Net.Security.SslStream.CipherAlgorithm">
  188. <summary>Gets a value that identifies the bulk encryption algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
  189. <returns>A <see cref="T:System.Security.Authentication.CipherAlgorithmType" /> value.</returns>
  190. <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>
  191. </member>
  192. <member name="P:System.Net.Security.SslStream.CipherStrength">
  193. <summary>Gets a value that identifies the strength of the cipher algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
  194. <returns>An <see cref="T:System.Int32" /> value that specifies the strength of the algorithm, in bits.</returns>
  195. </member>
  196. <member name="M:System.Net.Security.SslStream.Flush">
  197. <summary>Causes any buffered data to be written to the underlying device.</summary>
  198. </member>
  199. <member name="P:System.Net.Security.SslStream.HashAlgorithm">
  200. <summary>Gets the algorithm used for generating message authentication codes (MACs).</summary>
  201. <returns>A <see cref="T:System.Security.Authentication.HashAlgorithmType" /> value.</returns>
  202. <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>
  203. </member>
  204. <member name="P:System.Net.Security.SslStream.HashStrength">
  205. <summary>Gets a value that identifies the strength of the hash algorithm used by this instance.</summary>
  206. <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>
  207. </member>
  208. <member name="P:System.Net.Security.SslStream.KeyExchangeAlgorithm">
  209. <summary>Gets the key exchange algorithm used by this <see cref="T:System.Net.Security.SslStream" />.</summary>
  210. <returns>An <see cref="T:System.Security.Authentication.ExchangeAlgorithmType" /> value.</returns>
  211. </member>
  212. <member name="P:System.Net.Security.SslStream.KeyExchangeStrength">
  213. <summary>Gets a value that identifies the strength of the key exchange algorithm used by this instance.</summary>
  214. <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>
  215. </member>
  216. <member name="P:System.Net.Security.SslStream.Length">
  217. <summary>Gets the length of the underlying stream.</summary>
  218. <returns>A <see cref="T:System.Int64" />.The length of the underlying stream.</returns>
  219. <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>
  220. </member>
  221. <member name="P:System.Net.Security.SslStream.LocalCertificate">
  222. <summary>Gets the certificate used to authenticate the local endpoint.</summary>
  223. <returns>An X509Certificate object that represents the certificate supplied for authentication or null if no certificate was supplied.</returns>
  224. <exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
  225. </member>
  226. <member name="P:System.Net.Security.SslStream.Position">
  227. <summary>Gets or sets the current position in the underlying stream.</summary>
  228. <returns>A <see cref="T:System.Int64" />.The current position in the underlying stream.</returns>
  229. <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>
  230. </member>
  231. <member name="M:System.Net.Security.SslStream.Read(System.Byte[],System.Int32,System.Int32)">
  232. <summary>Reads data from this stream and stores it in the specified array.</summary>
  233. <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>
  234. <param name="buffer">A <see cref="T:System.Byte" /> array that receives the bytes read from this stream.</param>
  235. <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>
  236. <param name="count">A <see cref="T:System.Int32" /> that contains the maximum number of bytes to read from this stream.</param>
  237. <exception cref="T:System.ArgumentNullException">
  238. <paramref name="buffer" /> is null.</exception>
  239. <exception cref="T:System.ArgumentException">
  240. <paramref name="offset" />
  241. <paramref name="&lt;" />
  242. <paramref name="0" />.<paramref name="-or-" /><paramref name="offset" /> &gt; the length of <paramref name="buffer" />.-or-<paramref name="offset" /> + count &gt; the length of <paramref name="buffer" />.</exception>
  243. <exception cref="T:System.IO.IOException">The read operation failed. Check the inner exception, if present to determine the cause of the failure.</exception>
  244. <exception cref="T:System.NotSupportedException">There is already a read operation in progress.</exception>
  245. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  246. <exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
  247. </member>
  248. <member name="P:System.Net.Security.SslStream.ReadTimeout">
  249. <summary>Gets or sets the amount of time a read operation blocks waiting for data.</summary>
  250. <returns>A <see cref="T:System.Int32" /> that specifies the amount of time that elapses before a synchronous read operation fails.</returns>
  251. </member>
  252. <member name="P:System.Net.Security.SslStream.RemoteCertificate">
  253. <summary>Gets the certificate used to authenticate the remote endpoint.</summary>
  254. <returns>An X509Certificate object that represents the certificate supplied for authentication or null if no certificate was supplied.</returns>
  255. <exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
  256. </member>
  257. <member name="M:System.Net.Security.SslStream.Seek(System.Int64,System.IO.SeekOrigin)">
  258. <summary>Throws a <see cref="T:System.NotSupportedException" />.</summary>
  259. <returns>Always throws a <see cref="T:System.NotSupportedException" />.</returns>
  260. <param name="offset">This value is ignored.</param>
  261. <param name="origin">This value is ignored.</param>
  262. <exception cref="T:System.NotSupportedException">Seeking is not supported by <see cref="T:System.Net.Security.SslStream" /> objects.</exception>
  263. </member>
  264. <member name="M:System.Net.Security.SslStream.SetLength(System.Int64)">
  265. <summary>Sets the length of the underlying stream.</summary>
  266. <param name="value">An <see cref="T:System.Int64" /> value that specifies the length of the stream.</param>
  267. </member>
  268. <member name="P:System.Net.Security.SslStream.SslProtocol">
  269. <summary>Gets a value that indicates the security protocol used to authenticate this connection.</summary>
  270. <returns>The <see cref="T:System.Security.Authentication.SslProtocols" /> value that represents the protocol used for authentication.</returns>
  271. </member>
  272. <member name="P:System.Net.Security.SslStream.TransportContext">
  273. <summary>Gets the <see cref="T:System.Net.TransportContext" /> used for authentication using extended protection.</summary>
  274. <returns>The <see cref="T:System.Net.TransportContext" /> object that contains the channel binding token (CBT) used for extended protection.</returns>
  275. </member>
  276. <member name="M:System.Net.Security.SslStream.Write(System.Byte[])">
  277. <summary>Writes the specified data to this stream.</summary>
  278. <param name="buffer">A <see cref="T:System.Byte" /> array that supplies the bytes written to the stream.</param>
  279. <exception cref="T:System.ArgumentNullException">
  280. <paramref name="buffer" /> is null.</exception>
  281. <exception cref="T:System.IO.IOException">The write operation failed.</exception>
  282. <exception cref="T:System.NotSupportedException">There is already a write operation in progress.</exception>
  283. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  284. <exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
  285. </member>
  286. <member name="M:System.Net.Security.SslStream.Write(System.Byte[],System.Int32,System.Int32)">
  287. <summary>Write the specified number of <see cref="T:System.Byte" />s to the underlying stream using the specified buffer and offset.</summary>
  288. <param name="buffer">A <see cref="T:System.Byte" /> array that supplies the bytes written to the stream.</param>
  289. <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>
  290. <param name="count">A <see cref="T:System.Int32" /> that contains the number of bytes to read from <paramref name="buffer" />.</param>
  291. <exception cref="T:System.ArgumentNullException">
  292. <paramref name="buffer" /> is null.</exception>
  293. <exception cref="T:System.ArgumentException">
  294. <paramref name="offset" />
  295. <paramref name="&lt;" />
  296. <paramref name="0" />.<paramref name="-or-" /><paramref name="offset" /> &gt; the length of <paramref name="buffer" />.-or-<paramref name="offset" /> + count &gt; the length of <paramref name="buffer" />.</exception>
  297. <exception cref="T:System.IO.IOException">The write operation failed.</exception>
  298. <exception cref="T:System.NotSupportedException">There is already a write operation in progress.</exception>
  299. <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
  300. <exception cref="T:System.InvalidOperationException">Authentication has not occurred.</exception>
  301. </member>
  302. <member name="P:System.Net.Security.SslStream.WriteTimeout">
  303. <summary>Gets or sets the amount of time a write operation blocks waiting for data.</summary>
  304. <returns>A <see cref="T:System.Int32" /> that specifies the amount of time that elapses before a synchronous write operation fails. </returns>
  305. </member>
  306. <member name="T:System.Security.Authentication.AuthenticationException">
  307. <summary>The exception that is thrown when authentication fails for an authentication stream.</summary>
  308. </member>
  309. <member name="M:System.Security.Authentication.AuthenticationException.#ctor">
  310. <summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with no message.</summary>
  311. </member>
  312. <member name="M:System.Security.Authentication.AuthenticationException.#ctor(System.String)">
  313. <summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with the specified message.</summary>
  314. <param name="message">A <see cref="T:System.String" /> that describes the authentication failure.</param>
  315. </member>
  316. <member name="M:System.Security.Authentication.AuthenticationException.#ctor(System.String,System.Exception)">
  317. <summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.AuthenticationException" /> class with the specified message and inner exception.</summary>
  318. <param name="message">A <see cref="T:System.String" /> that describes the authentication failure.</param>
  319. <param name="innerException">The <see cref="T:System.Exception" /> that is the cause of the current exception.</param>
  320. </member>
  321. <member name="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy">
  322. <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>
  323. </member>
  324. <member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement)">
  325. <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>
  326. <param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
  327. </member>
  328. <member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ChannelBinding)">
  329. <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>
  330. <param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
  331. <param name="customChannelBinding">A <see cref="T:System.Security.Authentication.ExtendedProtection.ChannelBinding" /> that contains a custom channel binding to use for validation.</param>
  332. <exception cref="T:System.ArgumentException">
  333. <paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
  334. <exception cref="T:System.ArgumentNullException">
  335. <paramref name="customChannelBinding " />is null. </exception>
  336. </member>
  337. <member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ProtectionScenario,System.Collections.ICollection)">
  338. <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>
  339. <param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
  340. <param name="protectionScenario">A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy.</param>
  341. <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>
  342. <exception cref="T:System.ArgumentException">
  343. <paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
  344. <exception cref="T:System.ArgumentNullException">
  345. <paramref name="customServiceNames " />is nullor an empty list. </exception>
  346. </member>
  347. <member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.#ctor(System.Security.Authentication.ExtendedProtection.PolicyEnforcement,System.Security.Authentication.ExtendedProtection.ProtectionScenario,System.Security.Authentication.ExtendedProtection.ServiceNameCollection)">
  348. <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>
  349. <param name="policyEnforcement">A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced.</param>
  350. <param name="protectionScenario">A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy.</param>
  351. <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>
  352. <exception cref="T:System.ArgumentException">
  353. <paramref name="policyEnforcement" /> is specified as <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never" />.</exception>
  354. <exception cref="T:System.ArgumentNullException">
  355. <paramref name="customServiceNames " />is nullor an empty list. </exception>
  356. </member>
  357. <member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomChannelBinding">
  358. <summary>Gets a custom channel binding token (CBT) to use for validation.</summary>
  359. <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ChannelBinding" /> that contains a custom channel binding to use for validation.</returns>
  360. </member>
  361. <member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomServiceNames">
  362. <summary>Gets the custom Service Provider Name (SPN) list used to match against a client's SPN.</summary>
  363. <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>
  364. </member>
  365. <member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.OSSupportsExtendedProtection">
  366. <summary>Indicates whether the operating system supports integrated windows authentication with extended protection.</summary>
  367. <returns>true if the operating system supports integrated windows authentication with extended protection, otherwise false.</returns>
  368. </member>
  369. <member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.PolicyEnforcement">
  370. <summary>Gets when the extended protection policy should be enforced.</summary>
  371. <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement" /> value that indicates when the extended protection policy should be enforced. </returns>
  372. </member>
  373. <member name="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.ProtectionScenario">
  374. <summary>Gets the kind of protection enforced by the extended protection policy.</summary>
  375. <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> value that indicates the kind of protection enforced by the policy. </returns>
  376. </member>
  377. <member name="M:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.ToString">
  378. <summary>Gets a string representation for the extended protection policy instance.</summary>
  379. <returns>A <see cref="T:System.String" /> instance that contains the representation of the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> instance.</returns>
  380. </member>
  381. <member name="T:System.Security.Authentication.ExtendedProtection.PolicyEnforcement">
  382. <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>
  383. </member>
  384. <member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Always">
  385. <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>
  386. </member>
  387. <member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Never">
  388. <summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> is never enforced and extended protection is disabled.</summary>
  389. </member>
  390. <member name="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.WhenSupported">
  391. <summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> is enforced only if the client and server supports extended protection.</summary>
  392. </member>
  393. <member name="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario">
  394. <summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ProtectionScenario" /> enumeration specifies the protection scenario enforced by the policy.</summary>
  395. </member>
  396. <member name="F:System.Security.Authentication.ExtendedProtection.ProtectionScenario.TransportSelected">
  397. <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>
  398. </member>
  399. <member name="F:System.Security.Authentication.ExtendedProtection.ProtectionScenario.TrustedProxy">
  400. <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>
  401. </member>
  402. <member name="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection">
  403. <summary>The <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> class is a read-only collection of service principal names. </summary>
  404. </member>
  405. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.#ctor(System.Collections.ICollection)">
  406. <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>
  407. <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>
  408. <exception cref="T:System.ArgumentNullException">
  409. <paramref name="item " />is null. </exception>
  410. <exception cref="T:System.ArgumentException">
  411. <paramref name="item" /> is empty.</exception>
  412. </member>
  413. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Contains(System.String)">
  414. <summary>Returns a value indicating whether the specified string occurs within this <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> instance.</summary>
  415. <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>
  416. <param name="searchServiceName">The string to seek.</param>
  417. </member>
  418. <member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Count"></member>
  419. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.GetEnumerator"></member>
  420. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Merge(System.Collections.IEnumerable)">
  421. <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>
  422. <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>
  423. <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>
  424. <exception cref="T:System.ArgumentNullException">
  425. <paramref name="serviceNames " />is null. </exception>
  426. <exception cref="T:System.ArgumentException">
  427. <paramref name="serviceNames" /> is empty.</exception>
  428. </member>
  429. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.Merge(System.String)">
  430. <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>
  431. <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>
  432. <param name="serviceName">A string that contains the specified values of service names to be used to initialize the class.</param>
  433. <exception cref="T:System.ArgumentNullException">
  434. <paramref name="serviceNames " />is null. </exception>
  435. <exception cref="T:System.ArgumentException">
  436. <paramref name="serviceNames" /> is empty.</exception>
  437. </member>
  438. <member name="M:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)"></member>
  439. <member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#IsSynchronized"></member>
  440. <member name="P:System.Security.Authentication.ExtendedProtection.ServiceNameCollection.System#Collections#ICollection#SyncRoot"></member>
  441. </members>
  442. </doc>