Introduce Realm useAbsoluteURI and omitQuery, close AsyncHttpClient#553

Author: Stephane Landelle

api/src/main/java/org/asynchttpclient/Realm.java

@@ -50,14 +50,16 @@ public class Realm {
     private final boolean messageType2Received;
     private final String domain;
     private final Charset charset;
+    private final boolean useAbsoluteURI;
+    private final boolean omitQuery;
 
     public enum AuthScheme {
         DIGEST, BASIC, NTLM, SPNEGO, KERBEROS, NONE
     }
 
     private Realm(AuthScheme scheme, String principal, String password, String realmName, String nonce, String algorithm, String response,
             String qop, String nc, String cnonce, String uri, String method, boolean usePreemptiveAuth, String domain, String enc,
-            String host, boolean messageType2Received, String opaque) {
+            String host, boolean messageType2Received, String opaque, boolean useAbsoluteURI, boolean omitQuery) {
 
         this.principal = principal;
         this.password = password;
@@ -78,6 +80,8 @@ private Realm(AuthScheme scheme, String principal, String password, String realm
         this.host = host;
         this.messageType2Received = messageType2Received;
         this.charset = enc != null ? Charset.forName(enc) : null;
+        this.useAbsoluteURI = useAbsoluteURI;
+        this.omitQuery = omitQuery;
     }
 
     public String getPrincipal() {
@@ -176,6 +180,14 @@ public boolean isNtlmMessageType2Received() {
         return messageType2Received;
     }
 
+    public boolean isUseAbsoluteURI() {
+        return useAbsoluteURI;
+    }
+
+    public boolean isOmitQuery() {
+        return omitQuery;
+    }
+    
     @Override
     public boolean equals(Object o) {
         if (this == o)
@@ -207,15 +219,17 @@ public boolean equals(Object o) {
             return false;
         if (uri != null ? !uri.equals(realm.uri) : realm.uri != null)
             return false;
-
+        if (useAbsoluteURI != !realm.useAbsoluteURI) return false;
+        if (omitQuery != !realm.omitQuery) return false;
         return true;
     }
 
     @Override
     public String toString() {
         return "Realm{" + "principal='" + principal + '\'' + ", scheme=" + scheme + ", realmName='" + realmName + '\'' + ", nonce='"
                 + nonce + '\'' + ", algorithm='" + algorithm + '\'' + ", response='" + response + '\'' + ", qop='" + qop + '\'' + ", nc='"
-                + nc + '\'' + ", cnonce='" + cnonce + '\'' + ", uri='" + uri + '\'' + ", methodName='" + methodName + '\'' + '}';
+                + nc + '\'' + ", cnonce='" + cnonce + '\'' + ", uri='" + uri + '\'' + ", methodName='" + methodName + '\'' + ", useAbsoluteURI='" + useAbsoluteURI + '\''
+                + ", omitQuery='" + omitQuery + '\'' +'}';
     }
 
     @Override
@@ -261,6 +275,8 @@ public static class RealmBuilder {
         private String enc = StandardCharsets.UTF_8.name();
         private String host = "localhost";
         private boolean messageType2Received = false;
+        private boolean useAbsoluteURI = true;
+        private boolean omitQuery = false;
 
         public String getNtlmDomain() {
             return domain;
@@ -397,6 +413,29 @@ public RealmBuilder setUsePreemptiveAuth(boolean usePreemptiveAuth) {
             return this;
         }
 
+        public RealmBuilder setNtlmMessageType2Received(boolean messageType2Received) {
+            this.messageType2Received = messageType2Received;
+            return this;
+        }
+
+        public boolean isUseAbsoluteURI() {
+            return useAbsoluteURI;
+        }
+        
+        public RealmBuilder setUseAbsoluteURI(boolean useAbsoluteURI) {
+            this.useAbsoluteURI = useAbsoluteURI;
+            return this;
+        }
+        
+        public boolean isOmitQuery() {
+            return omitQuery;
+        }
+        
+        public RealmBuilder setOmitQuery(boolean omitQuery) {
+            this.omitQuery = omitQuery;
+            return this;
+        }
+            
         public RealmBuilder parseWWWAuthenticateHeader(String headerLine) {
             setRealmName(match(headerLine, "realm"));
             setNonce(match(headerLine, "nonce"));
@@ -427,11 +466,6 @@ public RealmBuilder parseProxyAuthenticateHeader(String headerLine) {
             return this;
         }
 
-        public RealmBuilder setNtlmMessageType2Received(boolean messageType2Received) {
-            this.messageType2Received = messageType2Received;
-            return this;
-        }
-
         public RealmBuilder clone(Realm clone) {
             setRealmName(clone.getRealmName());
             setAlgorithm(clone.getAlgorithm());
@@ -574,7 +608,7 @@ public Realm build() {
             }
 
             return new Realm(scheme, principal, password, realmName, nonce, algorithm, response, qop, nc, cnonce, uri, methodName,
-                    usePreemptive, domain, enc, host, messageType2Received, opaque);
+                    usePreemptive, domain, enc, host, messageType2Received, opaque, useAbsoluteURI, omitQuery);
         }
     }
 }

providers/netty/src/main/java/org/asynchttpclient/providers/netty/handler/HttpProtocol.java

@@ -61,6 +61,7 @@
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.List;
 
 final class HttpProtocol extends Protocol {
@@ -202,6 +203,27 @@ private void markAsDone(NettyResponseFuture<?> future, final Channel channel) th
         }
     }
 
+    private final String computeRealmURI(Realm realm, URI requestURI) throws URISyntaxException {
+        if (realm.isUseAbsoluteURI()) {
+            if (realm.isOmitQuery() && isNonEmpty(requestURI.getQuery())) {
+                return new URI(
+                        requestURI.getScheme(),
+                        requestURI.getAuthority(),
+                        requestURI.getPath(),
+                        null,
+                        null).toString();
+            } else {
+                return requestURI.toString();
+            }
+        } else {
+            if (realm.isOmitQuery() && isNonEmpty(requestURI.getQuery())) {
+                return requestURI.getPath();
+            } else {
+                return requestURI.getPath() + "?" + requestURI.getQuery();
+            }
+        }
+    }
+
     private boolean handleUnauthorizedAndExit(int statusCode, Realm realm, final Request request, HttpResponse response,
             final NettyResponseFuture<?> future, ProxyServer proxyServer, final Channel channel) throws Exception {
         if (statusCode == UNAUTHORIZED.code() && realm != null) {
@@ -227,7 +249,8 @@ private boolean handleUnauthorizedAndExit(int statusCode, Realm realm, final Req
                             .parseWWWAuthenticateHeader(authenticateHeaders.get(0)).build();
                 }
 
-                Realm nr = new Realm.RealmBuilder().clone(newRealm).setUri(request.getURI().getPath()).build();
+                String realmURI = computeRealmURI(newRealm, request.getURI());
+                Realm nr = new Realm.RealmBuilder().clone(newRealm).setUri(realmURI).build();
                 final Request nextRequest = new RequestBuilder(future.getRequest()).setHeaders(request.getHeaders()).setRealm(nr).build();
 
                 LOGGER.debug("Sending authentication to {}", request.getUrl());