Skip to content

Document Apache HTTP authentication APIs #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document Apache HTTP authentication APIs #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fa1f13
Document Apache HTTP authentication APIs
jonathanpeppers Aug 14, 2026
ee95d0d
Clarify BasicScheme completion state
jonathanpeppers Aug 15, 2026
4aebc29
Correct digest algorithm exception docs
jonathanpeppers Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/xml/Org.Apache.Http.Impl.Auth/AuthSchemeBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides common challenge processing for Apache HTTP authentication schemes without prescribing a challenge format or response.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -123,10 +123,10 @@
<Parameter Name="request" Type="Org.Apache.Http.IHttpRequest" />
</Parameters>
<Docs>
<param name="credentials">To be added.</param>
<param name="request">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="credentials">Credentials used to answer the challenge.</param>
<param name="request">HTTP request receiving the authentication-response header.</param>
<summary>Builds an authentication-response header for the supplied credentials and request.</summary>
<returns>An authentication-response header.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -158,9 +158,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="name">Name of the challenge parameter.</param>
<summary>Gets a named parameter from the current authentication challenge.</summary>
<returns>The parameter value, or <see langword="null" /> when the challenge does not define it.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -189,8 +189,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether the authentication exchange has completed.</summary>
<value><see langword="true" /> when the authentication exchange has completed; otherwise, <see langword="false" />.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -219,8 +219,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether the authentication scheme maintains state for a connection.</summary>
<value><see langword="true" /> when authentication is connection-based; otherwise, <see langword="false" />.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -246,8 +246,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether the current challenge was received from a proxy.</summary>
<value><see langword="true" /> when the current challenge is a proxy challenge; otherwise, <see langword="false" />.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -316,10 +316,10 @@
<Parameter Name="len" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="pos">To be added.</param>
<param name="len">To be added.</param>
<summary>To be added.</summary>
<param name="buffer">Buffer containing the authentication challenge.</param>
<param name="pos">Index at which the scheme-specific challenge begins.</param>
<param name="len">Length of the scheme-specific challenge.</param>
<summary>Parses the scheme-specific portion of an authentication challenge.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -351,8 +351,8 @@
<Parameter Name="header" Type="Org.Apache.Http.IHeader" />
</Parameters>
<Docs>
<param name="header">To be added.</param>
<summary>To be added.</summary>
<param name="header">Authentication challenge header to process.</param>
<summary>Processes an authentication challenge header and delegates its scheme-specific content for parsing.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -381,8 +381,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the realm identified by the current authentication challenge.</summary>
<value>The challenge realm, or <see langword="null" /> when the scheme has no realm.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -411,8 +411,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the authentication scheme name.</summary>
<value>The authentication scheme name.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
32 changes: 16 additions & 16 deletions docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Implements the HTTP Basic authentication scheme defined by RFC 2617.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -107,10 +107,10 @@
<Parameter Name="request" Type="Org.Apache.Http.IHttpRequest" />
</Parameters>
<Docs>
<param name="credentials">To be added.</param>
<param name="request">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="credentials">Credentials used for Basic authentication.</param>
<param name="request">HTTP request receiving the authentication-response header.</param>
<summary>Builds a Basic authentication-response header for the current challenge.</summary>
<returns>A Basic authentication-response header.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -141,11 +141,11 @@
<Parameter Name="proxy" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="credentials">To be added.</param>
<param name="charset">To be added.</param>
<param name="proxy">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="credentials">Credentials used for Basic authentication.</param>
<param name="charset">Character set used to encode the credentials.</param>
<param name="proxy"><see langword="true" /> to create a proxy authentication header; otherwise, <see langword="false" />.</param>
<summary>Builds a Basic authentication-response header with the specified credential character set and target kind.</summary>
<returns>A Basic authentication-response header.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -171,8 +171,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether the Basic authentication exchange has completed.</summary>
<value><see langword="true" /> after a Basic authentication challenge has been processed; otherwise, <see langword="false" />.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -198,8 +198,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets whether Basic authentication is connection-based.</summary>
<value><see langword="false" /> because Basic authentication is not connection-based.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -260,8 +260,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Basic authentication scheme name.</summary>
<value><c>basic</c>.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
8 changes: 4 additions & 4 deletions docs/xml/Org.Apache.Http.Impl.Auth/BasicSchemeFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Creates Basic authentication scheme instances.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -156,9 +156,9 @@
<Parameter Name="params" Type="Org.Apache.Http.Params.IHttpParams" />
</Parameters>
<Docs>
<param name="params">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="params">HTTP parameters supplied by the caller; they are not used to create the scheme.</param>
<summary>Creates a Basic authentication scheme.</summary>
<returns>A new <see cref="T:Org.Apache.Http.Impl.Auth.BasicScheme" />.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
Loading