(httpcomponents-client) branch 5.4.x updated: Enforce Support for UTF-8 Encoding Scheme in Digest Authentication as per RFC 7616 (#508)

[ab...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

abernal pushed a commit to branch 5.4.x
in repository https://gitbox.apache.org/repos/asf/httpcomponents-client.git


The following commit(s) were added to refs/heads/5.4.x by this push:
     new e16c1bfa2 Enforce Support for UTF-8 Encoding Scheme in Digest Authentication as per RFC 7616 (#508)
e16c1bfa2 is described below

commit e16c1bfa299dc913a44167f1eb7927f6a92c0702
Author: Arturo Bernal <ab...@apache.org>
AuthorDate: Sun Dec 3 21:48:43 2023 +0100

    Enforce Support for UTF-8 Encoding Scheme in Digest Authentication as per RFC 7616 (#508)
    
    This commit enforces the use of the 'UTF-8' encoding scheme as the sole allowed value for character encoding in Digest Authentication, in alignment with the guidelines specified in RFC 7616.
---
 .../apache/hc/client5/http/impl/auth/DigestScheme.java    | 15 +++++++++++----
 .../hc/client5/http/impl/auth/DigestSchemeFactory.java    | 13 ++++++++-----
 2 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java
index e068999d9..32cd437dd 100644
--- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java
+++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java
@@ -122,13 +122,20 @@ public class DigestScheme implements AuthScheme, Serializable {
     private UsernamePasswordCredentials credentials;
 
     public DigestScheme() {
-        this(StandardCharsets.ISO_8859_1);
+        this.defaultCharset =  StandardCharsets.UTF_8;
+        this.paramMap = new HashMap<>();
+        this.complete = false;
     }
 
+    /**
+     * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding
+     * in compliance with RFC 7616 for HTTP Digest Access Authentication. Use the default constructor {@link #DigestScheme()} instead.
+     *
+     * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used.
+     */
+    @Deprecated
     public DigestScheme(final Charset charset) {
-        this.defaultCharset = charset != null ? charset : StandardCharsets.ISO_8859_1;
-        this.paramMap = new HashMap<>();
-        this.complete = false;
+        this();
     }
 
     public void initPreemptive(final Credentials credentials, final String cnonce, final String realm) {
diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java
index 2e3c5adf2..1b4b7ab7c 100644
--- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java
+++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java
@@ -28,6 +28,7 @@
 package org.apache.hc.client5.http.impl.auth;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 import org.apache.hc.client5.http.auth.AuthScheme;
 import org.apache.hc.client5.http.auth.AuthSchemeFactory;
@@ -49,22 +50,24 @@ public class DigestSchemeFactory implements AuthSchemeFactory {
      */
     public static final DigestSchemeFactory INSTANCE = new DigestSchemeFactory();
 
-    private final Charset charset;
 
     /**
-     * @since 5.1
+     * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used.
+     * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding
+     * in compliance with RFC 7616 for HTTP Digest Access Authentication. Use the default constructor {@link #DigestSchemeFactory()} instead.
      */
+    @Deprecated
     public DigestSchemeFactory(final Charset charset) {
-        this.charset = charset;
+        super();
     }
 
     public DigestSchemeFactory() {
-        this(null);
+
     }
 
     @Override
     public AuthScheme create(final HttpContext context) {
-        return new DigestScheme(charset);
+        return new DigestScheme();
     }
 
 }