/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014-2016 ForgeRock AS.
|
*/
|
package org.opends.server.extensions;
|
|
import java.util.ArrayList;
|
import java.util.Collection;
|
import java.util.Iterator;
|
import java.util.LinkedHashSet;
|
import java.util.LinkedList;
|
import java.util.List;
|
import java.util.Set;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.forgerock.opendj.config.server.ConfigChangeResult;
|
import org.forgerock.opendj.config.server.ConfigException;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.DN;
|
import org.forgerock.opendj.ldap.ResultCode;
|
import org.forgerock.opendj.ldap.SearchScope;
|
import org.opends.server.admin.server.ConfigurationChangeListener;
|
import org.opends.server.admin.std.server.ExactMatchIdentityMapperCfg;
|
import org.opends.server.admin.std.server.IdentityMapperCfg;
|
import org.opends.server.api.Backend;
|
import org.opends.server.api.IdentityMapper;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.protocols.internal.InternalClientConnection;
|
import org.opends.server.protocols.internal.InternalSearchOperation;
|
import org.opends.server.protocols.internal.SearchRequest;
|
import static org.opends.server.protocols.internal.Requests.*;
|
import org.forgerock.opendj.ldap.schema.AttributeType;
|
import org.opends.server.types.*;
|
|
import static org.opends.messages.ExtensionMessages.*;
|
import static org.opends.server.protocols.internal.InternalClientConnection.*;
|
import static org.opends.server.util.CollectionUtils.*;
|
|
/**
|
* This class provides an implementation of a Directory Server identity mapper
|
* that looks for the exact value provided as the ID string to appear in an
|
* attribute of a user's entry. This mapper may be configured to look in one or
|
* more attributes using zero or more search bases. In order for the mapping to
|
* be established properly, exactly one entry must have an attribute that
|
* exactly matches (according to the equality matching rule associated with that
|
* attribute) the ID value.
|
*/
|
public class ExactMatchIdentityMapper
|
extends IdentityMapper<ExactMatchIdentityMapperCfg>
|
implements ConfigurationChangeListener<
|
ExactMatchIdentityMapperCfg>
|
{
|
/** The set of attribute types to use when performing lookups. */
|
private AttributeType[] attributeTypes;
|
|
/** The DN of the configuration entry for this identity mapper. */
|
private DN configEntryDN;
|
|
/** The current configuration for this identity mapper. */
|
private ExactMatchIdentityMapperCfg currentConfig;
|
|
/** The set of attributes to return in search result entries. */
|
private LinkedHashSet<String> requestedAttributes;
|
|
|
|
/**
|
* Creates a new instance of this exact match identity mapper. All
|
* initialization should be performed in the {@code initializeIdentityMapper}
|
* method.
|
*/
|
public ExactMatchIdentityMapper()
|
{
|
super();
|
|
// Don't do any initialization here.
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public void initializeIdentityMapper(
|
ExactMatchIdentityMapperCfg configuration)
|
throws ConfigException, InitializationException
|
{
|
configuration.addExactMatchChangeListener(this);
|
|
currentConfig = configuration;
|
configEntryDN = currentConfig.dn();
|
|
|
// Get the attribute types to use for the searches. Ensure that they are
|
// all indexed for equality.
|
attributeTypes =
|
currentConfig.getMatchAttribute().toArray(new AttributeType[0]);
|
|
Set<DN> cfgBaseDNs = configuration.getMatchBaseDN();
|
if (cfgBaseDNs == null || cfgBaseDNs.isEmpty())
|
{
|
cfgBaseDNs = DirectoryServer.getPublicNamingContexts().keySet();
|
}
|
|
for (AttributeType t : attributeTypes)
|
{
|
for (DN baseDN : cfgBaseDNs)
|
{
|
Backend b = DirectoryServer.getBackend(baseDN);
|
if (b != null && ! b.isIndexed(t, IndexType.EQUALITY))
|
{
|
throw new ConfigException(ERR_EXACTMAP_ATTR_UNINDEXED.get(
|
configuration.dn(), t.getNameOrOID(), b.getBackendID()));
|
}
|
}
|
}
|
|
|
// Create the attribute list to include in search requests. We want to
|
// include all user and operational attributes.
|
requestedAttributes = newLinkedHashSet("*", "+");
|
}
|
|
|
|
/**
|
* Performs any finalization that may be necessary for this identity mapper.
|
*/
|
@Override
|
public void finalizeIdentityMapper()
|
{
|
currentConfig.removeExactMatchChangeListener(this);
|
}
|
|
|
|
/**
|
* Retrieves the user entry that was mapped to the provided identification
|
* string.
|
*
|
* @param id The identification string that is to be mapped to a user.
|
*
|
* @return The user entry that was mapped to the provided identification, or
|
* <CODE>null</CODE> if no users were found that could be mapped to
|
* the provided ID.
|
*
|
* @throws DirectoryException If a problem occurs while attempting to map
|
* the given ID to a user entry, or if there are
|
* multiple user entries that could map to the
|
* provided ID.
|
*/
|
@Override
|
public Entry getEntryForID(String id)
|
throws DirectoryException
|
{
|
ExactMatchIdentityMapperCfg config = currentConfig;
|
AttributeType[] attributeTypes = this.attributeTypes;
|
|
|
// Construct the search filter to use to make the determination.
|
SearchFilter filter;
|
if (attributeTypes.length == 1)
|
{
|
ByteString value = ByteString.valueOfUtf8(id);
|
filter = SearchFilter.createEqualityFilter(attributeTypes[0], value);
|
}
|
else
|
{
|
ArrayList<SearchFilter> filterComps = new ArrayList<>(attributeTypes.length);
|
for (AttributeType t : attributeTypes)
|
{
|
ByteString value = ByteString.valueOfUtf8(id);
|
filterComps.add(SearchFilter.createEqualityFilter(t, value));
|
}
|
|
filter = SearchFilter.createORFilter(filterComps);
|
}
|
|
|
// Iterate through the set of search bases and process an internal search
|
// to find any matching entries. Since we'll only allow a single match,
|
// then use size and time limits to constrain costly searches resulting from
|
// non-unique or inefficient criteria.
|
Collection<DN> baseDNs = config.getMatchBaseDN();
|
if (baseDNs == null || baseDNs.isEmpty())
|
{
|
baseDNs = DirectoryServer.getPublicNamingContexts().keySet();
|
}
|
|
SearchResultEntry matchingEntry = null;
|
InternalClientConnection conn = getRootConnection();
|
for (DN baseDN : baseDNs)
|
{
|
final SearchRequest request = newSearchRequest(baseDN, SearchScope.WHOLE_SUBTREE, filter)
|
.setSizeLimit(1)
|
.setTimeLimit(10)
|
.addAttribute(requestedAttributes);
|
InternalSearchOperation internalSearch = conn.processSearch(request);
|
|
switch (internalSearch.getResultCode().asEnum())
|
{
|
case SUCCESS:
|
// This is fine. No action needed.
|
break;
|
|
case NO_SUCH_OBJECT:
|
// The search base doesn't exist. Not an ideal situation, but we'll
|
// ignore it.
|
break;
|
|
case SIZE_LIMIT_EXCEEDED:
|
// Multiple entries matched the filter. This is not acceptable.
|
LocalizableMessage message = ERR_EXACTMAP_MULTIPLE_MATCHING_ENTRIES.get(id);
|
throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
|
|
case TIME_LIMIT_EXCEEDED:
|
case ADMIN_LIMIT_EXCEEDED:
|
// The search criteria was too inefficient.
|
message = ERR_EXACTMAP_INEFFICIENT_SEARCH.
|
get(id, internalSearch.getErrorMessage());
|
throw new DirectoryException(internalSearch.getResultCode(), message);
|
|
default:
|
// Just pass on the failure that was returned for this search.
|
message = ERR_EXACTMAP_SEARCH_FAILED.
|
get(id, internalSearch.getErrorMessage());
|
throw new DirectoryException(internalSearch.getResultCode(), message);
|
}
|
|
LinkedList<SearchResultEntry> searchEntries = internalSearch.getSearchEntries();
|
if (searchEntries != null && ! searchEntries.isEmpty())
|
{
|
if (matchingEntry == null)
|
{
|
Iterator<SearchResultEntry> iterator = searchEntries.iterator();
|
matchingEntry = iterator.next();
|
if (iterator.hasNext())
|
{
|
LocalizableMessage message = ERR_EXACTMAP_MULTIPLE_MATCHING_ENTRIES.get(id);
|
throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
|
}
|
}
|
else
|
{
|
LocalizableMessage message = ERR_EXACTMAP_MULTIPLE_MATCHING_ENTRIES.get(id);
|
throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
|
}
|
}
|
}
|
|
return matchingEntry;
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public boolean isConfigurationAcceptable(IdentityMapperCfg configuration,
|
List<LocalizableMessage> unacceptableReasons)
|
{
|
ExactMatchIdentityMapperCfg config =
|
(ExactMatchIdentityMapperCfg) configuration;
|
return isConfigurationChangeAcceptable(config, unacceptableReasons);
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public boolean isConfigurationChangeAcceptable(
|
ExactMatchIdentityMapperCfg configuration,
|
List<LocalizableMessage> unacceptableReasons)
|
{
|
boolean configAcceptable = true;
|
|
// Make sure that all of the configured attributes are indexed for equality
|
// in all appropriate backends.
|
Set<DN> cfgBaseDNs = configuration.getMatchBaseDN();
|
if (cfgBaseDNs == null || cfgBaseDNs.isEmpty())
|
{
|
cfgBaseDNs = DirectoryServer.getPublicNamingContexts().keySet();
|
}
|
|
for (AttributeType t : configuration.getMatchAttribute())
|
{
|
for (DN baseDN : cfgBaseDNs)
|
{
|
Backend b = DirectoryServer.getBackend(baseDN);
|
if (b != null && ! b.isIndexed(t, IndexType.EQUALITY))
|
{
|
unacceptableReasons.add(ERR_EXACTMAP_ATTR_UNINDEXED.get(
|
configuration.dn(), t.getNameOrOID(), b.getBackendID()));
|
configAcceptable = false;
|
}
|
}
|
}
|
|
return configAcceptable;
|
}
|
|
|
|
/** {@inheritDoc} */
|
@Override
|
public ConfigChangeResult applyConfigurationChange(
|
ExactMatchIdentityMapperCfg configuration)
|
{
|
final ConfigChangeResult ccr = new ConfigChangeResult();
|
|
attributeTypes =
|
configuration.getMatchAttribute().toArray(new AttributeType[0]);
|
currentConfig = configuration;
|
|
return ccr;
|
}
|
}
|
