From 8fa1f13f3219f0b047afdd1451d854b0bad4fc25 Mon Sep 17 00:00:00 2001 From: Jonathan Peppers Date: Fri, 14 Aug 2026 18:35:42 -0500 Subject: [PATCH 1/3] Document Apache HTTP authentication APIs Refs #311 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../AuthSchemeBase.xml | 48 +++++++++---------- .../Org.Apache.Http.Impl.Auth/BasicScheme.xml | 32 ++++++------- .../BasicSchemeFactory.xml | 8 ++-- .../DigestScheme.xml | 32 ++++++------- .../DigestSchemeFactory.xml | 8 ++-- .../Org.Apache.Http.Impl.Auth/INTLMEngine.xml | 24 +++++----- .../NTLMEngineException.xml | 2 +- .../Org.Apache.Http.Impl.Auth/NTLMScheme.xml | 44 ++++++++--------- .../RFC2617Scheme.xml | 24 +++++----- .../UnsupportedDigestAlgorithmException.xml | 2 +- docs/xml/ns-Org.Apache.Http.Impl.Auth.xml | 11 ++++- 11 files changed, 121 insertions(+), 114 deletions(-) diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/AuthSchemeBase.xml b/docs/xml/Org.Apache.Http.Impl.Auth/AuthSchemeBase.xml index 7b3620a5a..9c5c34fdd 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/AuthSchemeBase.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/AuthSchemeBase.xml @@ -39,7 +39,7 @@ - To be added. + Provides common challenge processing for Apache HTTP authentication schemes without prescribing a challenge format or response. @@ -123,10 +123,10 @@ - To be added. - To be added. - To be added. - To be added. + Credentials used to answer the challenge. + HTTP request receiving the authentication-response header. + Builds an authentication-response header for the supplied credentials and request. + An authentication-response header. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -158,9 +158,9 @@ - To be added. - To be added. - To be added. + Name of the challenge parameter. + Gets a named parameter from the current authentication challenge. + The parameter value, or when the challenge does not define it. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -189,8 +189,8 @@ System.Boolean - To be added. - To be added. + Gets whether the authentication exchange has completed. + when the authentication exchange has completed; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -219,8 +219,8 @@ System.Boolean - To be added. - To be added. + Gets whether the authentication scheme maintains state for a connection. + when authentication is connection-based; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -246,8 +246,8 @@ System.Boolean - To be added. - To be added. + Gets whether the current challenge was received from a proxy. + when the current challenge is a proxy challenge; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -316,10 +316,10 @@ - To be added. - To be added. - To be added. - To be added. + Buffer containing the authentication challenge. + Index at which the scheme-specific challenge begins. + Length of the scheme-specific challenge. + Parses the scheme-specific portion of an authentication challenge. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -351,8 +351,8 @@ - To be added. - To be added. + Authentication challenge header to process. + Processes an authentication challenge header and delegates its scheme-specific content for parsing. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -381,8 +381,8 @@ System.String - To be added. - To be added. + Gets the realm identified by the current authentication challenge. + The challenge realm, or when the scheme has no realm. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -411,8 +411,8 @@ System.String - To be added. - To be added. + Gets the authentication scheme name. + The authentication scheme name. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml b/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml index b18b86fdd..071235f64 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml @@ -26,7 +26,7 @@ - To be added. + Implements the HTTP Basic authentication scheme defined by RFC 2617. @@ -107,10 +107,10 @@ - To be added. - To be added. - To be added. - To be added. + Credentials used for Basic authentication. + HTTP request receiving the authentication-response header. + Builds a Basic authentication-response header for the current challenge. + A Basic authentication-response header. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -141,11 +141,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Credentials used for Basic authentication. + Character set used to encode the credentials. + to create a proxy authentication header; otherwise, . + Builds a Basic authentication-response header with the specified credential character set and target kind. + A Basic authentication-response header. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -171,8 +171,8 @@ System.Boolean - To be added. - To be added. + Gets whether the Basic authentication exchange has completed. + after the challenge has been answered; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -198,8 +198,8 @@ System.Boolean - To be added. - To be added. + Gets whether Basic authentication is connection-based. + because Basic authentication is not connection-based. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -260,8 +260,8 @@ System.String - To be added. - To be added. + Gets the Basic authentication scheme name. + basic. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/BasicSchemeFactory.xml b/docs/xml/Org.Apache.Http.Impl.Auth/BasicSchemeFactory.xml index 629d5cda7..709e7b74f 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/BasicSchemeFactory.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/BasicSchemeFactory.xml @@ -39,7 +39,7 @@ - To be added. + Creates Basic authentication scheme instances. @@ -156,9 +156,9 @@ - To be added. - To be added. - To be added. + HTTP parameters supplied by the caller; they are not used to create the scheme. + Creates a Basic authentication scheme. + A new . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/DigestScheme.xml b/docs/xml/Org.Apache.Http.Impl.Auth/DigestScheme.xml index 93d48bf91..b4d9dfdf2 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/DigestScheme.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/DigestScheme.xml @@ -26,7 +26,7 @@ - To be added. + Implements RFC 2617 HTTP Digest authentication with MD5 or MD5-sess and qop=auth or no qop. @@ -107,10 +107,10 @@ - To be added. - To be added. - To be added. - To be added. + Credentials used for Digest authentication. + HTTP request receiving the authentication-response header. + Builds a Digest authentication-response header for the current challenge. + A Digest authentication-response header. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -137,8 +137,8 @@ - To be added. - To be added. + Generates a client nonce for a Digest authentication response. + A newly generated client nonce. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -164,8 +164,8 @@ System.Boolean - To be added. - To be added. + Gets whether the Digest authentication exchange has completed. + when the challenge marks credentials as stale; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -191,8 +191,8 @@ System.Boolean - To be added. - To be added. + Gets whether Digest authentication is connection-based. + because Digest authentication is not connection-based. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -253,9 +253,9 @@ - To be added. - To be added. - To be added. + Name of the challenge parameter to replace. + Replacement parameter value. + Replaces a parameter in the current Digest authentication challenge. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -285,8 +285,8 @@ System.String - To be added. - To be added. + Gets the Digest authentication scheme name. + digest. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/DigestSchemeFactory.xml b/docs/xml/Org.Apache.Http.Impl.Auth/DigestSchemeFactory.xml index 8c896289e..ba2c1e576 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/DigestSchemeFactory.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/DigestSchemeFactory.xml @@ -39,7 +39,7 @@ - To be added. + Creates Digest authentication scheme instances. @@ -156,9 +156,9 @@ - To be added. - To be added. - To be added. + HTTP parameters supplied by the caller; they are not used to create the scheme. + Creates a Digest authentication scheme. + A new . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/INTLMEngine.xml b/docs/xml/Org.Apache.Http.Impl.Auth/INTLMEngine.xml index 1fa6e0d57..2290b8f84 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/INTLMEngine.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/INTLMEngine.xml @@ -29,7 +29,7 @@ - To be added. + Generates NTLM Type 1 messages and Type 3 messages that answer Type 2 challenges. @@ -64,10 +64,10 @@ - To be added. - To be added. - To be added. - To be added. + Client domain to include in the message. + Client workstation to include in the message. + Generates an NTLM Type 1 message. + The generated Type 1 message. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -100,13 +100,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + User name for the authentication response. + Password for the authentication response. + User domain for the authentication response. + Client workstation for the authentication response. + Type 2 challenge received from the server. + Generates an NTLM Type 3 message in response to a Type 2 challenge. + The generated Type 3 message. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/NTLMEngineException.xml b/docs/xml/Org.Apache.Http.Impl.Auth/NTLMEngineException.xml index 8fd546cc1..afdb701b9 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/NTLMEngineException.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/NTLMEngineException.xml @@ -26,7 +26,7 @@ - To be added. + Indicates a failure while processing the NTLM protocol. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/NTLMScheme.xml b/docs/xml/Org.Apache.Http.Impl.Auth/NTLMScheme.xml index 97e16039a..68cc41247 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/NTLMScheme.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/NTLMScheme.xml @@ -26,7 +26,7 @@ - To be added. + Implements the connection-based NTLM authentication exchange. @@ -57,8 +57,8 @@ - To be added. - To be added. + Engine used to generate NTLM messages. + Initializes an NTLM authentication scheme with the engine that generates its protocol messages. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -111,10 +111,10 @@ - To be added. - To be added. - To be added. - To be added. + NTLM credentials used to answer the challenge. + HTTP request receiving the authentication-response header. + Builds the next NTLM authentication-response header in the current exchange. + The next NTLM authentication-response header. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -143,9 +143,9 @@ - To be added. - To be added. - To be added. + Name of the requested parameter. + Gets a named NTLM challenge parameter. + because NTLM challenges do not expose named parameters. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -171,8 +171,8 @@ System.Boolean - To be added. - To be added. + Gets whether the NTLM exchange has completed. + after a Type 3 message is generated or the exchange fails; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -198,8 +198,8 @@ System.Boolean - To be added. - To be added. + Gets whether NTLM authentication is connection-based. + because NTLM authentication is connection-based. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -265,10 +265,10 @@ - To be added. - To be added. - To be added. - To be added. + Buffer containing the authentication challenge. + Index at which the NTLM challenge begins. + Length of the NTLM challenge. + Parses an NTLM challenge and advances the authentication exchange state. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -294,8 +294,8 @@ System.String - To be added. - To be added. + Gets the realm for the current NTLM challenge. + because NTLM does not use authentication realms. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -321,8 +321,8 @@ System.String - To be added. - To be added. + Gets the NTLM authentication scheme name. + ntlm. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/RFC2617Scheme.xml b/docs/xml/Org.Apache.Http.Impl.Auth/RFC2617Scheme.xml index bf59acfa7..dcec8228e 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/RFC2617Scheme.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/RFC2617Scheme.xml @@ -26,7 +26,7 @@ - To be added. + Provides common behavior for authentication schemes that comply with RFC 2617. @@ -106,9 +106,9 @@ - To be added. - To be added. - To be added. + Name of the challenge parameter. + Gets a named parameter from the RFC 2617 authentication challenge. + The parameter value, or when it is not present. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -169,8 +169,8 @@ System.Collections.Generic.IDictionary<System.String,System.String> - To be added. - To be added. + Gets the parameters parsed from the current authentication challenge. + The parsed challenge parameters. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -201,10 +201,10 @@ - To be added. - To be added. - To be added. - To be added. + Buffer containing the authentication challenge. + Index at which the challenge parameters begin. + Length of the challenge parameters. + Parses the comma-delimited parameters of an RFC 2617 authentication challenge. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -234,8 +234,8 @@ System.String - To be added. - To be added. + Gets the realm parameter from the current authentication challenge. + The realm parameter value, or when it is not present. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml b/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml index e442708d1..5c7c014ad 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml @@ -26,7 +26,7 @@ - To be added. + Indicates that credentials required to answer an authentication challenge are invalid. diff --git a/docs/xml/ns-Org.Apache.Http.Impl.Auth.xml b/docs/xml/ns-Org.Apache.Http.Impl.Auth.xml index 94ad9ea48..099eb0289 100644 --- a/docs/xml/ns-Org.Apache.Http.Impl.Auth.xml +++ b/docs/xml/ns-Org.Apache.Http.Impl.Auth.xml @@ -1,6 +1,13 @@ - To be added. - + Provides implementations of the legacy Apache HTTP authentication schemes. + + + + Android Open Source Project source + + + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + From ee95d0d97dab9dd7ffa208b15164997515e1f48e Mon Sep 17 00:00:00 2001 From: Jonathan Peppers Date: Sat, 15 Aug 2026 09:32:50 -0500 Subject: [PATCH 2/3] Clarify BasicScheme completion state Refs #311 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml b/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml index 071235f64..728d1b5bc 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/BasicScheme.xml @@ -172,7 +172,7 @@ Gets whether the Basic authentication exchange has completed. - after the challenge has been answered; otherwise, . + after a Basic authentication challenge has been processed; otherwise, . Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. From 4aebc29f1e988a53514e8954b8e015cc94e5d6be Mon Sep 17 00:00:00 2001 From: Jonathan Peppers Date: Sat, 15 Aug 2026 09:43:33 -0500 Subject: [PATCH 3/3] Correct digest algorithm exception docs Refs #311 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../UnsupportedDigestAlgorithmException.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml b/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml index 5c7c014ad..705a185d4 100644 --- a/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml +++ b/docs/xml/Org.Apache.Http.Impl.Auth/UnsupportedDigestAlgorithmException.xml @@ -26,7 +26,7 @@ - Indicates that credentials required to answer an authentication challenge are invalid. + Indicates that a message-digest algorithm required for Digest authentication is unsupported.