Merge branch 'master' of https://github.com/justcoding121/Titanium-Web-Proxy

Author: justcoding121

Titanium.Web.Proxy/ProxyServer.cs

@@ -212,7 +212,7 @@ public ExceptionHandler ExceptionFunc
 
         /// <summary>
         ///     A callback to authenticate clients.
-        ///     Parameters are username & password as provided by client.
+        ///     Parameters are username and password as provided by client.
         ///     Return true for successful authentication.
         /// </summary>
         public Func<string, string, Task<bool>> AuthenticateUserFunc { get; set; }

docs/api/Titanium.Web.Proxy.EventArguments.AsyncEventHandler-1.html

@@ -83,7 +83,8 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_AsyncEventHandler_1" data-uid="Titanium.Web.Proxy.EventArguments.AsyncEventHandler`1" class="text-break">Delegate AsyncEventHandler&lt;TEventArgs&gt;
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>A generic asynchronous event handler used by this proxy.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <h6><strong>Namespace</strong>: <a class="xref" href="Titanium.Web.Proxy.EventArguments.html">Titanium.Web.Proxy.EventArguments</a></h6>
   <h6><strong>Assembly</strong>: Titanium.Web.Proxy.dll</h6>
@@ -104,12 +105,14 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
         <td><span class="parametername">sender</span></td>
-        <td></td>
+        <td><p>The proxy server instance.</p>
+</td>
       </tr>
       <tr>
         <td><span class="xref">TEventArgs</span></td>
         <td><span class="parametername">e</span></td>
-        <td></td>
+        <td><p>The event arguments.</p>
+</td>
       </tr>
     </tbody>
   </table>

docs/api/Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.html

@@ -83,7 +83,8 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs" class="text-break">Class BeforeSslAuthenticateEventArgs
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>This is used in transparent endpoint before authenticating client. </p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -130,7 +131,10 @@ <h3 id="properties">Properties
 
   <a id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_DecryptSsl_" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.DecryptSsl*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_DecryptSsl" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.DecryptSsl">DecryptSsl</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Should we decrypt the SSL request?
+If true we decrypt with fake certificate.
+If false we relay the connection to the hostname mentioned in SniHostname.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -155,7 +159,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_SniHostName_" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.SniHostName*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_SniHostName" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.SniHostName">SniHostName</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The server name indication hostname.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -182,7 +187,8 @@ <h3 id="methods">Methods
 
   <a id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_TerminateSession_" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.TerminateSession*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_BeforeSslAuthenticateEventArgs_TerminateSession" data-uid="Titanium.Web.Proxy.EventArguments.BeforeSslAuthenticateEventArgs.TerminateSession">TerminateSession()</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Terminate the request abruptly.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">

docs/api/Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.html

@@ -83,7 +83,7 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs" class="text-break">Class CertificateSelectionEventArgs
   </h1>
-  <div class="markdown level0 summary"><p>An argument passed on to user for client certificate selection during mutual SSL authentication</p>
+  <div class="markdown level0 summary"><p>An argument passed on to user for client certificate selection during mutual SSL authentication.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
@@ -131,7 +131,7 @@ <h3 id="properties">Properties
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_AcceptableIssuers_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.AcceptableIssuers*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_AcceptableIssuers" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.AcceptableIssuers">AcceptableIssuers</h4>
-  <div class="markdown level1 summary"><p>Acceptable issuers.</p>
+  <div class="markdown level1 summary"><p>Acceptable issuers mentioned by server.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -157,7 +157,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_ClientCertificate_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.ClientCertificate*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_ClientCertificate" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.ClientCertificate">ClientCertificate</h4>
-  <div class="markdown level1 summary"><p>Client Certificate.</p>
+  <div class="markdown level1 summary"><p>Client Certificate we selected.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -183,7 +183,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_LocalCertificates_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.LocalCertificates*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_LocalCertificates" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.LocalCertificates">LocalCertificates</h4>
-  <div class="markdown level1 summary"><p>Local certificates.</p>
+  <div class="markdown level1 summary"><p>Local certificates with matching issuers.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -209,7 +209,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_RemoteCertificate_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.RemoteCertificate*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_RemoteCertificate" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.RemoteCertificate">RemoteCertificate</h4>
-  <div class="markdown level1 summary"><p>Remote certificate.</p>
+  <div class="markdown level1 summary"><p>Remote certificate of the server.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -235,7 +235,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_Sender_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.Sender*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_Sender" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.Sender">Sender</h4>
-  <div class="markdown level1 summary"><p>Sender object.</p>
+  <div class="markdown level1 summary"><p>The proxy server instance.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -261,7 +261,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_TargetHost_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.TargetHost*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateSelectionEventArgs_TargetHost" data-uid="Titanium.Web.Proxy.EventArguments.CertificateSelectionEventArgs.TargetHost">TargetHost</h4>
-  <div class="markdown level1 summary"><p>Target host.</p>
+  <div class="markdown level1 summary"><p>The host to which we are authenticating against.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>

docs/api/Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.html

@@ -83,7 +83,8 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs" class="text-break">Class CertificateValidationEventArgs
   </h1>
-  <div class="markdown level0 summary"><p>An argument passed on to the user for validating the server certificate during SSL authentication</p>
+  <div class="markdown level0 summary"><p>An argument passed on to the user for validating the server certificate
+during SSL authentication.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
@@ -131,7 +132,7 @@ <h3 id="properties">Properties
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_Certificate_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.Certificate*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_Certificate" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.Certificate">Certificate</h4>
-  <div class="markdown level1 summary"><p>Certificate</p>
+  <div class="markdown level1 summary"><p>Server certificate.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -157,7 +158,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_Chain_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.Chain*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_Chain" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.Chain">Chain</h4>
-  <div class="markdown level1 summary"><p>Certificate chain</p>
+  <div class="markdown level1 summary"><p>Certificate chain.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -183,7 +184,7 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_IsValid_" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.IsValid*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_CertificateValidationEventArgs_IsValid" data-uid="Titanium.Web.Proxy.EventArguments.CertificateValidationEventArgs.IsValid">IsValid</h4>
-  <div class="markdown level1 summary"><p>is a valid certificate?</p>
+  <div class="markdown level1 summary"><p>Is the given server certificate is valid?</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>

docs/api/Titanium.Web.Proxy.EventArguments.DataEventArgs.html

@@ -83,7 +83,8 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_DataEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs" class="text-break">Class DataEventArgs
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Wraps the data sent/received by a proxy server instance.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -130,7 +131,8 @@ <h3 id="properties">Properties
 
   <a id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Buffer_" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Buffer" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Buffer">Buffer</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The buffer with data.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -155,7 +157,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Count_" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Count*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Count" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Count">Count</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Length from offset in Buffer with valid data.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -180,7 +183,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset_" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_DataEventArgs_Offset" data-uid="Titanium.Web.Proxy.EventArguments.DataEventArgs.Offset">Offset</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Offset in Buffer where valid data begins.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">

docs/api/Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.html

@@ -83,7 +83,8 @@
 
   <h1 id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs" class="text-break">Class MultipartRequestPartSentEventArgs
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Class that wraps the multipart sent request arguments.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -164,7 +165,8 @@ <h3 id="properties">Properties
 
   <a id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Boundary_" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Boundary*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Boundary" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Boundary">Boundary</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Boundary</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -189,7 +191,8 @@ <h5 class="propertyValue">Property Value</h5>
 
   <a id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Headers_" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Headers*"></a>
   <h4 id="Titanium_Web_Proxy_EventArguments_MultipartRequestPartSentEventArgs_Headers" data-uid="Titanium.Web.Proxy.EventArguments.MultipartRequestPartSentEventArgs.Headers">Headers</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>The header collection.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">