You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by GitBox <gi...@apache.org> on 2021/10/20 10:40:59 UTC

[GitHub] [solr] janhoy commented on a change in pull request #355: SOLR-12666: Add authn & authz plugins that supports multiple authentication schemes, such as Bearer and Basic

janhoy commented on a change in pull request #355:
URL: https://github.com/apache/solr/pull/355#discussion_r732636861



##########
File path: solr/core/src/java/org/apache/solr/security/MultiAuthPlugin.java
##########
@@ -0,0 +1,275 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.security;
+
+import javax.servlet.FilterChain;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+import org.apache.http.HttpRequest;
+import org.apache.http.protocol.HttpContext;
+import org.apache.lucene.util.ResourceLoader;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.common.SolrException.ErrorCode;
+import org.apache.solr.common.SpecProvider;
+import org.apache.solr.common.StringUtils;
+import org.apache.solr.common.util.CommandOperation;
+import org.apache.solr.common.util.Utils;
+import org.apache.solr.common.util.ValidatingJsonMap;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.metrics.SolrMetricsContext;
+import org.eclipse.jetty.client.api.Request;
+
+/**
+ * Authentication plugin that supports multiple Authorization schemes, such as Bearer and Basic.
+ * The impl simply delegates to one of Solr's other AuthenticationPlugins, such as the BasicAuthPlugin or JWTAuthPlugin.
+ */
+public class MultiAuthPlugin extends AuthenticationPlugin implements ConfigEditablePlugin, SpecProvider {
+  public static final String PROPERTY_SCHEMES = "schemes";
+  public static final String PROPERTY_DEFAULT_SCHEME = "default-scheme";
+  public static final String PROPERTY_SCHEME = "scheme";
+  public static final String AUTHORIZATION_HEADER = "Authorization";
+
+  private static final ThreadLocal<AuthenticationPlugin> pluginInRequest = new ThreadLocal<>();
+  private final String UNKNOWN_SCHEME = "";
+
+  private final Map<String, AuthenticationPlugin> pluginMap = new LinkedHashMap<>();
+  private final ResourceLoader loader;
+
+  // We forward to this scheme where we're asked to auth w/o an Authorization header
+  private String defaultScheme = null;
+
+  // Get the loader from the CoreContainer so we can load the sub-plugins, such as the BasicAuthPlugin for Basic
+  public MultiAuthPlugin(CoreContainer cc) {
+    this.loader = cc.getResourceLoader();
+  }
+
+  @Override
+  @SuppressWarnings({"unchecked"})
+  public void init(Map<String, Object> pluginConfig) {
+    Object o = pluginConfig.get(PROPERTY_SCHEMES);
+    if (!(o instanceof List)) {
+      throw new SolrException(ErrorCode.SERVER_ERROR, "Invalid config: MultiAuthPlugin requires a list of schemes!");
+    }
+
+    List<Object> schemeList = (List<Object>) o;
+    // if you only have one scheme, then you don't need to use this class
+    if (schemeList.size() < 2) {
+      throw new SolrException(ErrorCode.SERVER_ERROR, "Invalid config: MultiAuthPlugin requires at least two schemes!");
+    }
+
+    for (Object s : schemeList) {
+      if (!(s instanceof Map)) {
+        throw new SolrException(ErrorCode.SERVER_ERROR, "Invalid scheme config, expected JSON object but found: " + s);
+      }
+      initPluginForScheme((Map<String, Object>) s);
+    }
+
+    defaultScheme = (String) pluginConfig.get(PROPERTY_DEFAULT_SCHEME);
+    if (defaultScheme != null) {
+      if (!pluginMap.containsKey(defaultScheme)) {
+        throw new SolrException(ErrorCode.SERVER_ERROR, "Default scheme '" + defaultScheme + "' not configured!");
+      }
+    } else {
+      // first scheme listed in the config is the default

Review comment:
       I think for `Set`, order is not guaranteed, so this is not deterministic? Perhaps use `schemeList.get(0).get("scheme")` instead?

##########
File path: solr/core/src/java/org/apache/solr/security/MultiAuthRuleBasedAuthorizationPlugin.java
##########
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.security;
+
+import java.security.Principal;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.lucene.util.ResourceLoader;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.common.StringUtils;
+import org.apache.solr.core.CoreContainer;
+
+/**
+ * Authorization plugin designed to work with the MultiAuthPlugin to support different AuthorizationPlugin per scheme.
+ */
+public class MultiAuthRuleBasedAuthorizationPlugin extends RuleBasedAuthorizationPluginBase {
+  private final Map<String, RuleBasedAuthorizationPluginBase> pluginMap = new LinkedHashMap<>();
+  private final ResourceLoader loader;
+
+  // Need the CC to get the resource loader for loading the sub-plugins
+  public MultiAuthRuleBasedAuthorizationPlugin(CoreContainer cc) {
+    this.loader = cc.getResourceLoader();
+  }
+
+  @Override
+  @SuppressWarnings({"unchecked"})
+  public void init(Map<String, Object> initInfo) {
+    super.init(initInfo);
+
+    Object o = initInfo.get(MultiAuthPlugin.PROPERTY_SCHEMES);
+    if (!(o instanceof List)) {
+      throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "Invalid config: "+getClass().getName()+" requires a list of schemes!");
+    }
+
+    List<Object> schemeList = (List<Object>) o;
+    if (schemeList.size() < 2) {
+      throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "Invalid config: "+getClass().getName()+" requires at least two schemes!");
+    }
+
+    for (Object s : schemeList) {
+      if (!(s instanceof Map)) {
+        throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "Invalid scheme config, expected JSON object but found: " + s);
+      }
+      initPluginForScheme((Map<String, Object>) s);
+    }
+  }
+
+  protected void initPluginForScheme(Map<String, Object> schemeMap) {
+    Map<String, Object> schemeConfig = new HashMap<>(schemeMap);
+
+    String scheme = (String) schemeConfig.remove(MultiAuthPlugin.PROPERTY_SCHEME);
+    if (StringUtils.isEmpty(scheme)) {
+      throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "'scheme' is a required attribute: " + schemeMap);
+    }
+
+    String clazz = (String) schemeConfig.remove("class");
+    if (StringUtils.isEmpty(clazz)) {
+      throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, "'class' is a required attribute: " + schemeMap);
+    }
+
+    RuleBasedAuthorizationPluginBase pluginForScheme = loader.newInstance(clazz, RuleBasedAuthorizationPluginBase.class);
+    pluginForScheme.init(schemeConfig);
+    pluginMap.put(scheme.toLowerCase(Locale.ROOT), pluginForScheme);
+  }
+
+  /**
+   * Pulls roles from the Principal
+   *
+   * @param principal the user Principal which should contain roles
+   * @return set of roles as strings
+   */
+  @Override
+  public Set<String> getUserRoles(Principal principal) {
+    for (RuleBasedAuthorizationPluginBase plugin : pluginMap.values()) {
+      final Set<String> userRoles = plugin.getUserRoles(principal);
+      if (userRoles != null && !userRoles.isEmpty()) {
+        return userRoles; // first non-empty match wins

Review comment:
       I guess this works if a certain user is registered only in one scheme, i.e. either BasicAuth or JWT. Think it's safe..




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org