Apache Solr open-source search software
SOLR-17247: Fix bug - 'WWW-Authenticate' headers missing in MultiAuthPlugin (#2416)
Lamine14a219542bdc
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 067239ef5dc..2ffbaabb925 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -145,6 +145,8 @@ Bug Fixes* SOLR-16659: Properly construct V2 base urls instead of replacing substring "/solr" with "/api" (Andrey Bozhko via Eric Pugh)+* SOLR-17247: 'WWW-Authenticate' headers missing in MultiAuthPlugin (Lamine Idjeraoui via Eric Pugh)+Dependency Upgrades---------------------(No changes)diff --git a/solr/core/src/java/org/apache/solr/security/MultiAuthPlugin.java b/solr/core/src/java/org/apache/solr/security/MultiAuthPlugin.javaindex 96cd2974c21..5027cec6377 100644--- a/solr/core/src/java/org/apache/solr/security/MultiAuthPlugin.java+++ b/solr/core/src/java/org/apache/solr/security/MultiAuthPlugin.java@@ -17,6 +17,7 @@package org.apache.solr.security;import java.io.IOException;+import java.util.ArrayList;import java.util.Collections;import java.util.HashMap;import java.util.LinkedHashMap;@@ -26,6 +27,7 @@ import java.util.Map;import javax.servlet.FilterChain;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;+import org.apache.http.HttpHeaders;import org.apache.http.HttpRequest;import org.apache.http.protocol.HttpContext;import org.apache.lucene.util.ResourceLoader;@@ -59,6 +61,8 @@ public class MultiAuthPlugin extends AuthenticationPluginprivate static final String UNKNOWN_SCHEME = "";private final Map<String, AuthenticationPlugin> pluginMap = new LinkedHashMap<>();+ private final Map<String, String> realms = new LinkedHashMap<>();+ private final List<String> WWWAuthenticateHeaders = new ArrayList<>();private final ResourceLoader loader;// the first of our plugins that allows anonymous requestsprivate AuthenticationPlugin allowsUnknown = null;@@ -141,6 +145,7 @@ public class MultiAuthPlugin extends AuthenticationPlugin}initPluginForScheme((Map<String, Object>) s);}+ initWWWAuthenticateHeaders();}protected void initPluginForScheme(Map<String, Object> schemeMap) {@@ -158,6 +163,11 @@ public class MultiAuthPlugin extends AuthenticationPluginErrorCode.SERVER_ERROR, "'class' is a required attribute: " + schemeMap);}+ String realm = (String) schemeConfig.remove("realm");+ if (!StrUtils.isNullOrEmpty(realm)) {+ realms.put(scheme, realm);+ }+AuthenticationPlugin pluginForScheme = loader.newInstance(clazz, AuthenticationPlugin.class);pluginForScheme.init(schemeConfig);pluginMap.put(scheme.toLowerCase(Locale.ROOT), pluginForScheme);@@ -171,6 +181,20 @@ public class MultiAuthPlugin extends AuthenticationPlugin}}+ private void initWWWAuthenticateHeaders() {+ for (String scheme : pluginMap.keySet()) {+ String realm = realms.get(scheme);+ String realmStr = realm == null ? "" : " realm=\"" + realm + "\"";+ WWWAuthenticateHeaders.add(scheme + realmStr);+ }+ }++ private void addWWWAuthenticateHeaders(HttpServletResponse response) {+ for (String wwwAuthHeader : WWWAuthenticateHeaders) {+ response.addHeader(HttpHeaders.WWW_AUTHENTICATE, wwwAuthHeader);+ }+ }+@Overridepublic void initializeMetrics(SolrMetricsContext parentContext, String scope) {for (AuthenticationPlugin plugin : pluginMap.values()) {@@ -202,6 +226,7 @@ public class MultiAuthPlugin extends AuthenticationPluginpluginInRequest.set(plugin);result = plugin.doAuthenticate(request, response, filterChain);} else {+ addWWWAuthenticateHeaders(response);response.sendError(ErrorCode.UNAUTHORIZED.code, "No Authorization header");}return result;@@ -210,6 +235,7 @@ public class MultiAuthPlugin extends AuthenticationPluginfinal String scheme = getSchemeFromAuthHeader(authHeader);final AuthenticationPlugin plugin = pluginMap.get(scheme);if (plugin == null) {+ addWWWAuthenticateHeaders(response);response.sendError(ErrorCode.UNAUTHORIZED.code, "Authorization scheme '" + scheme + "' not supported!");return false;diff --git a/solr/core/src/test-files/solr/security/multi_auth_plugin_security.json b/solr/core/src/test-files/solr/security/multi_auth_plugin_security.jsonindex 7fac044e079..618a0ef789c 100644--- a/solr/core/src/test-files/solr/security/multi_auth_plugin_security.json+++ b/solr/core/src/test-files/solr/security/multi_auth_plugin_security.json@@ -3,6 +3,7 @@"class": "solr.MultiAuthPlugin","schemes": [{"scheme": "basic",+ "realm": "basicRealm","blockUnknown": true,"class": "solr.BasicAuthPlugin","credentials": {@@ -11,6 +12,11 @@"forwardCredentials": false},{"scheme": "mock",+ "realm": "mockRealm",+ "class": "org.apache.solr.security.MultiAuthPluginTest$MockAuthPluginForTesting",+ "blockUnknown": true+ },{+ "scheme": "mockNoRealm","class": "org.apache.solr.security.MultiAuthPluginTest$MockAuthPluginForTesting","blockUnknown": true}]diff --git a/solr/core/src/test/org/apache/solr/security/MultiAuthPluginTest.java b/solr/core/src/test/org/apache/solr/security/MultiAuthPluginTest.javaindex ec6dcd65c41..4f5810744eb 100644--- a/solr/core/src/test/org/apache/solr/security/MultiAuthPluginTest.java+++ b/solr/core/src/test/org/apache/solr/security/MultiAuthPluginTest.java@@ -28,13 +28,18 @@ import java.io.Serializable;import java.nio.charset.StandardCharsets;import java.nio.file.Files;import java.security.Principal;+import java.util.Arrays;import java.util.List;+import java.util.Locale;import java.util.Map;import java.util.Objects;import java.util.function.Predicate;+import java.util.stream.Collectors;import javax.servlet.FilterChain;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;+import org.apache.http.Header;+import org.apache.http.HttpHeaders;import org.apache.http.HttpResponse;import org.apache.http.client.HttpClient;import org.apache.http.client.methods.HttpGet;@@ -105,6 +110,10 @@ public class MultiAuthPluginTest extends SolrTestCaseJ4 {new SecurityConfHandler.SecurityConfig().setData(Utils.fromJSONString(multiAuthPluginSecurityJson)));securityConfHandler.securityConfEdited();++ // verify "WWW-Authenticate" headers are returned+ verifyWWWAuthenticateHeaders(httpClient, baseUrl);+verifySecurityStatus(httpClient,baseUrl + authcPrefix,@@ -269,6 +278,40 @@ public class MultiAuthPluginTest extends SolrTestCaseJ4 {return statusCode;}+ private void verifyWWWAuthenticateHeaders(HttpClient httpClient, String baseUrl)+ throws Exception {+ HttpGet httpGet = new HttpGet(baseUrl + "/admin/info/system");+ HttpResponse response = httpClient.execute(httpGet);+ Header[] headers = response.getHeaders(HttpHeaders.WWW_AUTHENTICATE);+ List<String> actualSchemes =+ Arrays.stream(headers).map(Header::getValue).collect(Collectors.toList());++ List<String> expectedSchemes = generateExpectedSchemes();+ actualSchemes.sort(String.CASE_INSENSITIVE_ORDER);+ expectedSchemes.sort(String.CASE_INSENSITIVE_ORDER);++ assertEquals(+ "The actual schemes and realms should match the expected ones exactly",+ expectedSchemes.stream().map(s -> s.toLowerCase(Locale.ROOT)).collect(Collectors.toList()),+ actualSchemes.stream().map(s -> s.toLowerCase(Locale.ROOT)).collect(Collectors.toList()));+ }++ @SuppressWarnings("unchecked")+ private List<String> generateExpectedSchemes() {+ Map<String, Object> data = securityConfHandler.getSecurityConfig(false).getData();+ Map<String, Object> authentication = (Map<String, Object>) data.get("authentication");+ List<Map<String, Object>> schemes = (List<Map<String, Object>>) authentication.get("schemes");++ return schemes.stream()+ .map(+ schemeMap -> {+ String scheme = (String) schemeMap.get("scheme");+ String realm = (String) schemeMap.get("realm");+ return realm != null ? scheme + " realm=\"" + realm + "\"" : scheme;+ })+ .collect(Collectors.toList());+ }+private static final class MockPrincipal implements Principal, Serializable {@Overridepublic String getName() {