Add ssl API added between preview 7 and 8 #4860

aik-jahoda · 2020-09-16T13:54:27Z

Summary

Contains mainly SSL api.
One exception is System.Net.Http.WinHttpHandler.EnableMultipleHttp2Connections

opbld32 · 2020-09-16T13:57:04Z

Docs Build status updates of commit 35e8a29:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
xml/System.Net.Security/SslStream.xml	❌Error		Details
	❌Error		Details

xml/System.Net.Security/SslStream.xml

Line 0, Column 0: [Error-ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'see' start tag on line 1402 position 214 does not match the end tag of 'exception'. Line 1402, position 468.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error-ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...
Line 0, Column 0: [Error-file-not-found] Invalid file link: '.sourcemap-ecma-0.json'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

opbld31 · 2020-09-16T14:04:17Z

Docs Build status updates of commit d8d1289:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
xml/System.Net.Security/SslStream.xml	❌Error		Details
	❌Error		Details

xml/System.Net.Security/SslStream.xml

Line 0, Column 0: [Error-ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'see' start tag on line 1402 position 214 does not match the end tag of 'exception'. Line 1402, position 468.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error-ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...
Line 0, Column 0: [Error-file-not-found] Invalid file link: '.sourcemap-ecma-0.json'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

xml/System.Net.Http/WinHttpHandler.xml

gewarren · 2020-09-16T14:33:05Z

xml/System.Net.Security/ServerOptionsSelectionCallback.xml

+    <param name="clientHelloInfo">Represents an information from the Client Hello message.</param>
+    <param name="state">The information that was passed when registering the callback.</param>
+    <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    <summary>The asynchronous callback to select session properties based on name requested by client.</summary>


Suggested change

<summary>The asynchronous callback to select session properties based on name requested by client.</summary>

<summary>Represents the asynchronous callback method that will select session properties based on name requested by client.</summary>

Suggested change

<summary>The asynchronous callback to select session properties based on name requested by client.</summary>

<summary>The asynchronous callback to select session properties based on the name requested by the client.</summary>

xml/System.Net.Security/ServerOptionsSelectionCallback.xml

xml/System.Net.Security/SslClientHelloInfo.xml

xml/System.Net.Security/SslStreamCertificateContext.xml

Co-authored-by: Genevieve Warren <[email protected]>

opbld31 · 2020-09-16T19:06:22Z

Docs Build status updates of commit ba345f8:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
xml/System.Net.Security/SslStream.xml	❌Error		Details
	❌Error		Details

xml/System.Net.Security/SslStream.xml

Line 0, Column 0: [Error-ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'see' start tag on line 1456 position 214 does not match the end tag of 'exception'. Line 1456, position 468.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error-ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...
Line 0, Column 0: [Error-file-not-found] Invalid file link: '.sourcemap-ecma-0.json'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

xml/System.Net.Security/SslStream.xml

opbld30 · 2020-09-16T21:20:30Z

Docs Build status updates of commit 4fb4f93:

✅ Validation status: passed

File	Status	Preview URL
xml/System.Net.Http/WinHttpHandler.xml	✅Succeeded	View
xml/System.Net.Security/ServerOptionsSelectionCallback.xml	✅Succeeded	View
xml/System.Net.Security/SslClientHelloInfo.xml	✅Succeeded	View
xml/System.Net.Security/SslServerAuthenticationOptions.xml	✅Succeeded	View
xml/System.Net.Security/SslStream.xml	✅Succeeded	View
xml/System.Net.Security/SslStreamCertificateContext.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

wfurt

left few notes.

wfurt · 2020-09-17T03:10:37Z

xml/System.Net.Security/SslClientHelloInfo.xml

@@ -40,7 +40,7 @@
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>The host server specified by the client.</summary>


I would change that to "The host server specified by the client in Server Name extension (SNI). If the extension is not present this returns empty string.

wfurt · 2020-09-17T03:13:46Z

xml/System.Net.Security/SslClientHelloInfo.xml

@@ -61,8 +61,8 @@
        <ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
      </ReturnValue>
      <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets or sets the TLS/SSL protocols offered by client.</summary>


There really should not be setter. Both properties are readonly.

wfurt · 2020-09-17T03:16:39Z

xml/System.Net.Security/SslStreamCertificateContext.xml

@@ -14,7 +14,7 @@
  </Base>
  <Interfaces />
  <Docs>
-    <summary>To be added.</summary>
+    <summary>Represents a set of certificates used for building a certificate chain.</summary>


I would add note that the certificates are normalized and if something is missing in constructed X509Chain, SslStream will try to resolve them - either by searching certificates stores or by fetching them via network if allowed.

wfurt · 2020-09-17T03:18:14Z

xml/System.Net.Security/SslStreamCertificateContext.xml

-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="target">The server certificate.</param>
+        <param name="additionalCertificates">The certificates to chain.</param>


I would change this to something like "Supplemental certificates to build the certificate chain."
It is not quarantined that all the certificates will be used and sent out.

wfurt · 2020-09-17T03:19:21Z

xml/System.Net.Security/SslStreamCertificateContext.xml

+        <param name="target">The server certificate.</param>
+        <param name="additionalCertificates">The certificates to chain.</param>
+        <param name="offline">
+          <see langword="true" /> to indicate that the missing certificates can be downloaded; otherwise, <see langword="false" />.</param>


otherwise only available X509Certificate stores will be searched for missing certificates.

wfurt · 2020-09-17T03:20:59Z

xml/System.Net.Security/SslStreamCertificateContext.xml

+        <param name="offline">
+          <see langword="true" /> to indicate that the missing certificates can be downloaded; otherwise, <see langword="false" />.</param>
+        <summary>Attempts to build the certificate chain from the provided certificates.</summary>
+        <returns>The certificate context with the newly created certificate chain.</returns>


I would add note that it can be used across many streams to save chain construction and improve performance.
Provided certificates should not be disposed. CertificateContext does not copy them but uses references.

wfurt · 2020-09-17T03:22:27Z

xml/System.Net.Security/SslStreamCertificateContext.xml

-        <param name="offline">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="target">The server certificate.</param>


I would add bold comment that the certificate must include private key.

This reverts commit 10d2b88.

…net#4868) This reverts commit 10d2b88.

@wfurt

* Automatic port of System.OperatingSystem docs for RC2 (#4852) Co-authored-by: carlossanlop <[email protected]> * Add Missing System.Diagnostics docs (#4856) * Add Missing System.Diagnostics docs * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> * Automatically port System.Diagnostics docs for RC2 (#4853) * Automatically port System.Diagnostics docs for RC2 * Update xml/System.Diagnostics/ActivitySamplingResult.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Diagnostics/Process.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Tarek Mahmoud Sayed <[email protected]> * Automatic port of RegexParse* documentation (#4850) * Automatic port of RegexParse* documentation * Update xml/System.Text.RegularExpressions/RegexParseError.xml * Apply suggestions from code review * Update RegexParseException * Update xml/System.Text.RegularExpressions/RegexParseException.xml * Update xml/System.Text.RegularExpressions/RegexParseException.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Prashanth Govindarajan <[email protected]> * Add ssl API added between preview 7 and 8 (#4860) * Automatic port of Reflection RC2 documentation (#4851) * Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868) This reverts commit 10d2b88. * Add ssl API added between preview 7 and 8 #2 (#4869) * Add ssl API added between preview 7 and 8 * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Net.Security/SslStream.xml * Apply @wfurt comments * Add missing remark headers * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback (#4861) * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback * Apply PR comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> * Add a remark to AddEvent method (#4871) * Add a remark to AddEvent method * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> * Automatic port of CryptoStream docs (#4888) Co-authored-by: carlossanlop <[email protected]> * Automatic port of System.Buffers docs (#4882) Co-authored-by: carlossanlop <[email protected]> * resolve isprefix conflict * Automatic port of System.Data.Common docs (#4885) Co-authored-by: carlossanlop <[email protected]> * Automatic port of *PipeServerStreamAcl docs (#4880) * Automatic port of *PipeServerStreamAcl docs * Apply suggestions from code review Co-authored-by: Prashanth Govindarajan <[email protected]> Co-authored-by: David Cantú <[email protected]> * Apply suggestions from code review Co-authored-by: David Cantú <[email protected]> * Apply suggestions from code review * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Prashanth Govindarajan <[email protected]> Co-authored-by: David Cantú <[email protected]> * Automatic port of *OSPlatformAttribute docs (#4883) * Automatic port of *OSPlatformAttribute docs * Missing TargetPlatformAttribute constructor parameter description. * Apply suggestions from code review Co-authored-by: Buyaa <[email protected]> * Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Buyaa <[email protected]> * Document System.Enum (#4894) Co-authored-by: carlossanlop <[email protected]> * Document Half.op_Explicit APIs (#4893) * Document Half.op_Explicit APIs * Equals Co-authored-by: carlossanlop <[email protected]> * Automatic port of Rune.CompareTo EII (#4891) Co-authored-by: carlossanlop <[email protected]> * Add missing docs for AsnContentException. (#4895) * Add missing documentation for S.S.Cryptography (#4892) * Add missing documentation for S.S.Cryptography * Apply feedback * Automatic port of System.Threading.ExecutionContext.Restore doc (#4887) * Automatic port of System.Threading.ExecutionContext.Restore doc * Update xml/System.Threading/ExecutionContext.xml Co-authored-by: Prashanth Govindarajan <[email protected]> * Apply suggestions from code review Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Prashanth Govindarajan <[email protected]> * Automatic port of explicit interface implementation of System.Net.Http.HttpRequestOptions (#4881) * Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions * Apply suggestions from code review Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> * Document Type.IsAssignableTo (#4898) Co-authored-by: carlossanlop <[email protected]> * Document System.PlatformID.Other (#4897) Co-authored-by: carlossanlop <[email protected]> * HTTP Version Selection (#4870) * Sync docs with source comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> * Add values Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> * HttpClient sync operations (#4776) * Draft for @ManickaP * Apply suggestions from code review Co-authored-by: Marie Píchová <[email protected]> * Format verification * Format verification * Fix links * Fix links * Fix xml tag * Fix links * Fix links * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> * Fix links * Add CreateContentReadStream * Fix links * Add System.Net.Http.DelegatingHandler.Send * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> * Remove "Synchronous" information from summary * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> * Fix the exception description Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Marie Píchová <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> * adding docs for missing 5.0 apis for system.Runtime.CompilerServices.Unsafe (#4902) * adding docs for missing 5.0 apis * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> * resolve conflict * Add Sysytem.Net.* missing API (#4904) * System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections * Add Sysytem.Net.\* missing API * Apply PR comments * Apply suggestions from code review * Apply suggestions from code review * Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]> * Http sync follow up (#4905) * Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Tarek Mahmoud Sayed <[email protected]> Co-authored-by: Prashanth Govindarajan <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: David Cantú <[email protected]> Co-authored-by: Buyaa <[email protected]> Co-authored-by: Jeremy Barton <[email protected]> Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Marie Píchová <[email protected]> Co-authored-by: Anirudh Agnihotry <[email protected]>

aik-jahoda requested review from wfurt and gewarren September 16, 2020 13:54

Add ssl API added between preview 7 and 8

d8d1289

aik-jahoda changed the base branch from master to net5-rc2 September 16, 2020 14:00

aik-jahoda force-pushed the jajahoda/ssl-preview7-8 branch from 35e8a29 to d8d1289 Compare September 16, 2020 14:01

gewarren reviewed Sep 16, 2020

View reviewed changes

Apply suggestions from code review

ba345f8

Co-authored-by: Genevieve Warren <[email protected]>

gewarren reviewed Sep 16, 2020

View reviewed changes

xml/System.Net.Security/SslStream.xml Outdated Show resolved Hide resolved

Update xml/System.Net.Security/SslStream.xml

4fb4f93

gewarren approved these changes Sep 16, 2020

View reviewed changes

gewarren merged commit 10d2b88 into dotnet:net5-rc2 Sep 16, 2020

wfurt reviewed Sep 17, 2020

View reviewed changes

aik-jahoda added a commit that referenced this pull request Sep 17, 2020

Revert "Add ssl API added between preview 7 and 8 (#4860)"

6355ec0

This reverts commit 10d2b88.

aik-jahoda mentioned this pull request Sep 17, 2020

Revert "Add ssl API added between preview 7 and 8" #4868

Merged

aik-jahoda pushed a commit that referenced this pull request Sep 17, 2020

Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868)

ad72063

This reverts commit 10d2b88.

aik-jahoda mentioned this pull request Sep 17, 2020

Add ssl API added between preview 7 and 8 #2 #4869

Merged

gewarren pushed a commit to gewarren/dotnet-api-docs that referenced this pull request Sep 24, 2020

Add ssl API added between preview 7 and 8 (dotnet#4860)

9c35356

gewarren pushed a commit to gewarren/dotnet-api-docs that referenced this pull request Sep 24, 2020

Revert "Add ssl API added between preview 7 and 8 (dotnet#4860)" (dot…

6402a82

…net#4868) This reverts commit 10d2b88.

eiriktsarpalis added the area-System.Net.Security label Mar 1, 2021

carlossanlop added area-System.Net and removed area-System.Net.Security labels Mar 5, 2021

	<summary>The asynchronous callback to select session properties based on name requested by client.</summary>
	<summary>Represents the asynchronous callback method that will select session properties based on name requested by client.</summary>

Add ssl API added between preview 7 and 8 #4860

Add ssl API added between preview 7 and 8 #4860

Uh oh!

Conversation

aik-jahoda commented Sep 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

opbld32 commented Sep 16, 2020

❌ Validation status: errors

Uh oh!

opbld31 commented Sep 16, 2020

❌ Validation status: errors

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

opbld31 commented Sep 16, 2020

❌ Validation status: errors

Uh oh!

Uh oh!

opbld30 commented Sep 16, 2020

✅ Validation status: passed

Uh oh!

wfurt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aik-jahoda commented Sep 16, 2020 •

edited

Loading