joshelser commented on a change in pull request #884: HBASE-23347 Allowable custom authentication methods for RPCs URL: https://github.com/apache/hbase/pull/884#discussion_r354535236
########## File path: hbase-server/src/main/java/org/apache/hadoop/hbase/security/provider/SaslServerAuthenticationProviders.java ########## @@ -0,0 +1,162 @@ +/** + * 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.hadoop.hbase.security.provider; + +import java.util.HashMap; +import java.util.ServiceLoader; +import java.util.concurrent.atomic.AtomicReference; +import java.util.stream.Collectors; + +import org.apache.hadoop.conf.Configuration; +import org.apache.yetus.audience.InterfaceAudience; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@InterfaceAudience.Private +public class SaslServerAuthenticationProviders { + private static final Logger LOG = LoggerFactory.getLogger(SaslClientAuthenticationProviders.class); + + public static final String EXTRA_PROVIDERS_KEY = "hbase.server.sasl.provider.extras"; + private static final AtomicReference<SaslServerAuthenticationProviders> holder = new AtomicReference<>(); + + private final Configuration conf; + private final HashMap<Byte, SaslServerAuthenticationProvider> providers; + + private SaslServerAuthenticationProviders(Configuration conf, + HashMap<Byte, SaslServerAuthenticationProvider> providers) { + this.conf = conf; + this.providers = providers; + } + + /** + * Returns the number of registered providers. + */ + public int getNumRegisteredProviders() { + return providers.size(); + } + + /** + * Returns a singleton instance of {@link SaslServerAuthenticationProviders}. + */ + public static SaslServerAuthenticationProviders getInstance(Configuration conf) { + SaslServerAuthenticationProviders providers = holder.get(); + if (null == providers) { + synchronized (holder) { + // Someone else beat us here + providers = holder.get(); + if (null != providers) { + return providers; + } + + providers = createProviders(conf); + holder.set(providers); + } + } + return providers; + } + + /** + * Removes the cached singleton instance of {@link SaslServerAuthenticationProviders}. + */ + public static void reset() { + synchronized (holder) { + holder.set(null); + } + } + + /** + * Adds the given provider into the map of providers if a mapping for the auth code does not + * already exist in the map. + */ + static void addProviderIfNotExists(SaslServerAuthenticationProvider provider, + HashMap<Byte,SaslServerAuthenticationProvider> providers) { + final byte newProviderAuthCode = provider.getSaslAuthMethod().getCode(); + final SaslServerAuthenticationProvider alreadyRegisteredProvider = providers.get( + newProviderAuthCode); + if (alreadyRegisteredProvider != null) { + throw new RuntimeException("Trying to load SaslServerAuthenticationProvider " + + provider.getClass() + ", but "+ alreadyRegisteredProvider.getClass() + + " is already registered with the same auth code"); + } + providers.put(newProviderAuthCode, provider); + } + + /** + * Adds any providers defined in the configuration. + */ + static void addExtraProviders(Configuration conf, + HashMap<Byte,SaslServerAuthenticationProvider> providers) { + for (String implName : conf.getStringCollection(EXTRA_PROVIDERS_KEY)) { + Class<?> clz; + try { + clz = Class.forName(implName); + } catch (ClassNotFoundException e) { + LOG.warn("Failed to find SaslServerAuthenticationProvider class {}", implName, e); + continue; + } + + if (!SaslServerAuthenticationProvider.class.isAssignableFrom(clz)) { + LOG.warn("Server authentication class {} is not an instance of " + + "SaslServerAuthenticationProvider", clz); + continue; + } + + try { + SaslServerAuthenticationProvider provider = + (SaslServerAuthenticationProvider) clz.newInstance(); + addProviderIfNotExists(provider, providers); + } catch (InstantiationException | IllegalAccessException e) { + LOG.warn("Failed to instantiate {}", clz, e); + } + } + } + + /** + * Loads server authentication providers from the classpath and configuration, and then creates + * the SaslServerAuthenticationProviders instance. + */ + static SaslServerAuthenticationProviders createProviders(Configuration conf) { + ServiceLoader<SaslServerAuthenticationProvider> loader = + ServiceLoader.load(SaslServerAuthenticationProvider.class); + HashMap<Byte,SaslServerAuthenticationProvider> providers = new HashMap<>(); + for (SaslServerAuthenticationProvider provider : loader) { + addProviderIfNotExists(provider, providers); + } + + addExtraProviders(conf, providers); Review comment: The expected case is that including the provider on the classpath and creating the META-INF/services entry for SaslClientAuthenticationProvider (and SaslServerAuthenticationProvider) is sufficient. However, to let unit tests work more easily (avoiding maven lifecycle issues and inherently insecure implementations from getting auto-loaded), you may also specify providers explicitly. The explicit configuration is more of a fail-safe switch, rather than the expected manner of us. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
