org.apache.hadoop.security.RuleBasedLdapGroupsMapping Maven / Gradle / Ivy
/**
* 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.security;
import org.apache.hadoop.thirdparty.com.google.common.annotations.VisibleForTesting;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.util.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
import java.util.stream.Collectors;
/**
* This class uses {@link LdapGroupsMapping} for group lookup and applies the
* rule configured on the group names.
*/
@InterfaceAudience.LimitedPrivate({"HDFS"})
@InterfaceStability.Evolving
public class RuleBasedLdapGroupsMapping extends LdapGroupsMapping {
public static final String CONVERSION_RULE_KEY = LDAP_CONFIG_PREFIX +
".conversion.rule";
private static final String CONVERSION_RULE_DEFAULT = "none";
private static final Logger LOG =
LoggerFactory.getLogger(RuleBasedLdapGroupsMapping.class);
private Rule rule;
/**
* Supported rules applicable for group name modification.
*/
private enum Rule {
TO_UPPER, TO_LOWER, NONE
}
@Override
public synchronized void setConf(Configuration conf) {
super.setConf(conf);
String value = conf.get(CONVERSION_RULE_KEY, CONVERSION_RULE_DEFAULT);
try {
rule = Rule.valueOf(value.toUpperCase());
} catch (IllegalArgumentException iae) {
LOG.warn("Invalid {} configured: '{}'. Using default value: '{}'",
CONVERSION_RULE_KEY, value, CONVERSION_RULE_DEFAULT);
}
}
/**
* Returns list of groups for a user.
* This calls {@link LdapGroupsMapping}'s getGroups and applies the
* configured rules on group names before returning.
*
* @param user get groups for this user
* @return list of groups for a given user
*/
@Override
public synchronized List getGroups(String user) {
List groups = super.getGroups(user);
switch (rule) {
case TO_UPPER:
return groups.stream().map(StringUtils::toUpperCase).collect(
Collectors.toList());
case TO_LOWER:
return groups.stream().map(StringUtils::toLowerCase).collect(
Collectors.toList());
case NONE:
default:
return groups;
}
}
}