/*
|
* 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 2013-2014 ForgeRock AS.
|
*/
|
package org.forgerock.opendj.rest2ldap;
|
|
import java.io.Closeable;
|
import java.util.LinkedHashMap;
|
import java.util.Map;
|
import java.util.concurrent.ConcurrentLinkedQueue;
|
import java.util.concurrent.CountDownLatch;
|
|
import org.forgerock.json.resource.InternalServerErrorException;
|
import org.forgerock.json.resource.ResourceException;
|
import org.forgerock.json.resource.SecurityContext;
|
import org.forgerock.json.resource.ServerContext;
|
import org.forgerock.opendj.ldap.AbstractAsynchronousConnection;
|
import org.forgerock.opendj.ldap.Connection;
|
import org.forgerock.opendj.ldap.ConnectionEventListener;
|
import org.forgerock.opendj.ldap.DN;
|
import org.forgerock.opendj.ldap.ErrorResultException;
|
import org.forgerock.opendj.ldap.FutureResult;
|
import org.forgerock.opendj.ldap.IntermediateResponseHandler;
|
import org.forgerock.opendj.ldap.ResultHandler;
|
import org.forgerock.opendj.ldap.SearchResultHandler;
|
import org.forgerock.opendj.ldap.SearchScope;
|
import org.forgerock.opendj.ldap.controls.Control;
|
import org.forgerock.opendj.ldap.controls.ProxiedAuthV2RequestControl;
|
import org.forgerock.opendj.ldap.requests.AbandonRequest;
|
import org.forgerock.opendj.ldap.requests.AddRequest;
|
import org.forgerock.opendj.ldap.requests.BindRequest;
|
import org.forgerock.opendj.ldap.requests.CompareRequest;
|
import org.forgerock.opendj.ldap.requests.DeleteRequest;
|
import org.forgerock.opendj.ldap.requests.ExtendedRequest;
|
import org.forgerock.opendj.ldap.requests.ModifyDNRequest;
|
import org.forgerock.opendj.ldap.requests.ModifyRequest;
|
import org.forgerock.opendj.ldap.requests.Request;
|
import org.forgerock.opendj.ldap.requests.SearchRequest;
|
import org.forgerock.opendj.ldap.requests.UnbindRequest;
|
import org.forgerock.opendj.ldap.responses.BindResult;
|
import org.forgerock.opendj.ldap.responses.CompareResult;
|
import org.forgerock.opendj.ldap.responses.ExtendedResult;
|
import org.forgerock.opendj.ldap.responses.Result;
|
import org.forgerock.opendj.ldap.responses.SearchResultEntry;
|
import org.forgerock.opendj.ldap.responses.SearchResultReference;
|
import org.forgerock.util.promise.FailureHandler;
|
import org.forgerock.util.promise.SuccessHandler;
|
|
import static org.forgerock.opendj.rest2ldap.Rest2LDAP.*;
|
import static org.forgerock.opendj.rest2ldap.Utils.*;
|
|
/**
|
* Common context information passed to containers and mappers. A new context is
|
* allocated for each REST request.
|
*/
|
final class Context implements Closeable {
|
|
/*
|
* A cached read request - see cachedReads for more information.
|
*/
|
private static final class CachedRead implements SearchResultHandler, ResultHandler<Result> {
|
private SearchResultEntry cachedEntry;
|
private final String cachedFilterString;
|
private FutureResult<Result> cachedFuture; // Guarded by latch.
|
private final CountDownLatch cachedFutureLatch = new CountDownLatch(1);
|
private final SearchRequest cachedRequest;
|
private volatile Result cachedResult;
|
private final ConcurrentLinkedQueue<SearchResultHandler> waitingResultHandlers =
|
new ConcurrentLinkedQueue<SearchResultHandler>();
|
|
CachedRead(final SearchRequest request, final SearchResultHandler resultHandler) {
|
this.cachedRequest = request;
|
this.cachedFilterString = request.getFilter().toString();
|
this.waitingResultHandlers.add(resultHandler);
|
}
|
|
@Override
|
public boolean handleEntry(final SearchResultEntry entry) {
|
cachedEntry = entry;
|
return true;
|
}
|
|
@Override
|
public void handleError(final ErrorResultException error) {
|
handleResult(error.getResult());
|
}
|
|
@Override
|
public boolean handleReference(final SearchResultReference reference) {
|
// Ignore - should never happen for a base object search.
|
return true;
|
}
|
|
@Override
|
public void handleResult(final Result result) {
|
cachedResult = result;
|
drainQueue();
|
}
|
|
void addResultHandler(final SearchResultHandler resultHandler) {
|
// Fast path.
|
if (cachedResult != null) {
|
invokeResultHandler(resultHandler);
|
return;
|
}
|
// Enqueue and re-check.
|
waitingResultHandlers.add(resultHandler);
|
if (cachedResult != null) {
|
drainQueue();
|
}
|
}
|
|
FutureResult<Result> getFutureResult() {
|
/*
|
* Perform uninterrupted wait since this method is unlikely to block
|
* for a long time.
|
*/
|
boolean wasInterrupted = false;
|
while (true) {
|
try {
|
cachedFutureLatch.await();
|
if (wasInterrupted) {
|
Thread.currentThread().interrupt();
|
}
|
return cachedFuture;
|
} catch (final InterruptedException e) {
|
wasInterrupted = true;
|
}
|
}
|
}
|
|
boolean isMatchingRead(final SearchRequest request) {
|
// Cached reads are always base object.
|
if (!request.getScope().equals(SearchScope.BASE_OBJECT)) {
|
return false;
|
}
|
|
// Filters must match.
|
if (!request.getFilter().toString().equals(cachedFilterString)) {
|
return false;
|
}
|
|
// List of requested attributes must match.
|
if (!request.getAttributes().equals(cachedRequest.getAttributes())) {
|
return false;
|
}
|
|
// Don't need to check anything else.
|
return true;
|
}
|
|
void setFuture(final FutureResult<Result> future) {
|
cachedFuture = future;
|
cachedFutureLatch.countDown();
|
}
|
|
private void drainQueue() {
|
SearchResultHandler resultHandler;
|
while ((resultHandler = waitingResultHandlers.poll()) != null) {
|
invokeResultHandler(resultHandler);
|
}
|
}
|
|
private void invokeResultHandler(final SearchResultHandler searchResultHandler) {
|
if (cachedEntry != null) {
|
searchResultHandler.handleEntry(cachedEntry);
|
}
|
}
|
|
}
|
|
/*
|
* An LRU cache of recent reads requests. This is used in order to reduce
|
* the number of repeated read operations performed when resolving DN
|
* references.
|
*/
|
@SuppressWarnings("serial")
|
private final Map<DN, CachedRead> cachedReads = new LinkedHashMap<DN, CachedRead>() {
|
private static final int MAX_CACHED_ENTRIES = 32;
|
|
@Override
|
protected boolean removeEldestEntry(final Map.Entry<DN, CachedRead> eldest) {
|
return size() > MAX_CACHED_ENTRIES;
|
}
|
};
|
|
private final Config config;
|
private final ServerContext context;
|
private Connection connection;
|
private Control proxiedAuthzControl = null;
|
|
Context(final Config config, final ServerContext context) {
|
this.config = config;
|
this.context = context;
|
|
/*
|
* Re-use the pre-authenticated connection if available and the
|
* authorization policy allows.
|
*/
|
if (config.getAuthorizationPolicy() != AuthorizationPolicy.NONE
|
&& context.containsContext(AuthenticatedConnectionContext.class)) {
|
this.connection = wrap(context.asContext(AuthenticatedConnectionContext.class).getConnection());
|
} else {
|
this.connection = null; // We'll allocate the connection.
|
}
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public void close() {
|
connection.close();
|
}
|
|
Config getConfig() {
|
return config;
|
}
|
|
Connection getConnection() {
|
return connection;
|
}
|
|
ServerContext getServerContext() {
|
return context;
|
}
|
|
/**
|
* Performs common processing required before handling an HTTP request,
|
* including calculating the proxied authorization request control, and
|
* obtaining an LDAP connection.
|
* <p>
|
* This method should be called at most once per request.
|
*
|
* @param handler
|
* The result handler which should be invoked if an error is
|
* detected.
|
* @param runnable
|
* The runnable which will be invoked once the common processing
|
* has completed. Implementations will be able to call
|
* {@link #getConnection()} to get the LDAP connection for use
|
* with subsequent LDAP requests.
|
*/
|
void run(final org.forgerock.json.resource.ResultHandler<?> handler, final Runnable runnable) {
|
/*
|
* Compute the proxied authorization control from the content of the
|
* security context if present. Only do this if we are not using a
|
* cached connection since cached connections are supposed to have been
|
* pre-authenticated and therefore do not require proxied authorization.
|
*/
|
if (connection == null && config.getAuthorizationPolicy() == AuthorizationPolicy.PROXY) {
|
if (context.containsContext(SecurityContext.class)) {
|
try {
|
final SecurityContext securityContext = context.asContext(SecurityContext.class);
|
final String authzId = config.getProxiedAuthorizationTemplate().formatAsAuthzId(
|
securityContext.getAuthorizationId(), config.schema());
|
proxiedAuthzControl = ProxiedAuthV2RequestControl.newControl(authzId);
|
} catch (final ResourceException e) {
|
handler.handleError(e);
|
return;
|
}
|
} else {
|
handler.handleError(new InternalServerErrorException(
|
i18n("The request could not be authorized because it did not contain a security context")));
|
return;
|
}
|
}
|
|
/*
|
* Now get the LDAP connection to use for processing subsequent LDAP
|
* requests. A null factory indicates that Rest2LDAP has been configured
|
* to re-use the LDAP connection which was used for authentication.
|
*/
|
if (connection != null) {
|
// Invoke the handler immediately since a connection is available.
|
runnable.run();
|
} else if (config.connectionFactory() != null) {
|
config.connectionFactory().getConnectionAsync().onSuccess(new SuccessHandler<Connection>() {
|
@Override
|
public final void handleResult(final Connection result) {
|
connection = wrap(result);
|
runnable.run();
|
}
|
}).onFailure(new FailureHandler<ErrorResultException>() {
|
@Override
|
public final void handleError(final ErrorResultException error) {
|
handler.handleError(asResourceException(error));
|
}
|
});
|
} else {
|
handler.handleError(new InternalServerErrorException(
|
i18n("The request could not be processed because there was no LDAP connection available for use")));
|
}
|
}
|
|
/*
|
* Adds read caching support to the provided connection as well
|
* functionality which automatically adds the proxied authorization control
|
* if needed.
|
*/
|
private Connection wrap(final Connection connection) {
|
/*
|
* We only use async methods so no need to wrap sync methods.
|
*/
|
return new AbstractAsynchronousConnection() {
|
@Override
|
public FutureResult<Void> abandonAsync(final AbandonRequest request) {
|
return connection.abandonAsync(request);
|
}
|
|
@Override
|
public FutureResult<Result> addAsync(final AddRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
return connection.addAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public void addConnectionEventListener(final ConnectionEventListener listener) {
|
connection.addConnectionEventListener(listener);
|
}
|
|
@Override
|
public FutureResult<BindResult> bindAsync(final BindRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
/*
|
* Simple brute force implementation in case the bind operation
|
* modifies an entry: clear the cachedReads.
|
*/
|
evictAll();
|
return connection.bindAsync(request, intermediateResponseHandler);
|
}
|
|
@Override
|
public void close() {
|
connection.close();
|
}
|
|
@Override
|
public void close(final UnbindRequest request, final String reason) {
|
connection.close(request, reason);
|
}
|
|
@Override
|
public FutureResult<CompareResult> compareAsync(final CompareRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
return connection.compareAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public FutureResult<Result> deleteAsync(final DeleteRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
evict(request.getName());
|
return connection.deleteAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public <R extends ExtendedResult> FutureResult<R> extendedRequestAsync(final ExtendedRequest<R> request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
/*
|
* Simple brute force implementation in case the extended
|
* operation modifies an entry: clear the cachedReads.
|
*/
|
evictAll();
|
return connection.extendedRequestAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public boolean isClosed() {
|
return connection.isClosed();
|
}
|
|
@Override
|
public boolean isValid() {
|
return connection.isValid();
|
}
|
|
@Override
|
public FutureResult<Result> modifyAsync(final ModifyRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
evict(request.getName());
|
return connection.modifyAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public FutureResult<Result> modifyDNAsync(final ModifyDNRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler) {
|
// Simple brute force implementation: clear the cachedReads.
|
evictAll();
|
return connection.modifyDNAsync(withControls(request), intermediateResponseHandler);
|
}
|
|
@Override
|
public void removeConnectionEventListener(final ConnectionEventListener listener) {
|
connection.removeConnectionEventListener(listener);
|
}
|
|
/*
|
* Try and re-use a cached result if possible.
|
*/
|
@Override
|
public FutureResult<Result> searchAsync(final SearchRequest request,
|
final IntermediateResponseHandler intermediateResponseHandler, final SearchResultHandler entryHandler) {
|
/*
|
* Don't attempt caching if this search is not a read (base
|
* object), or if the search request passed in an intermediate
|
* response handler.
|
*/
|
if (!request.getScope().equals(SearchScope.BASE_OBJECT) || intermediateResponseHandler != null) {
|
return connection.searchAsync(withControls(request), intermediateResponseHandler, entryHandler);
|
}
|
|
// This is a read request and a candidate for caching.
|
final CachedRead cachedRead;
|
synchronized (cachedReads) {
|
cachedRead = cachedReads.get(request.getName());
|
}
|
if (cachedRead != null && cachedRead.isMatchingRead(request)) {
|
// The cached read matches this read request.
|
cachedRead.addResultHandler(entryHandler);
|
return cachedRead.getFutureResult();
|
} else {
|
// Cache the read, possibly evicting a non-matching cached read.
|
final CachedRead pendingCachedRead = new CachedRead(request, entryHandler);
|
synchronized (cachedReads) {
|
cachedReads.put(request.getName(), pendingCachedRead);
|
}
|
final FutureResult<Result> future = (FutureResult<Result>) connection
|
.searchAsync(withControls(request), intermediateResponseHandler, pendingCachedRead)
|
.onSuccess(pendingCachedRead).onFailure(pendingCachedRead);
|
pendingCachedRead.setFuture(future);
|
return future;
|
}
|
}
|
|
@Override
|
public String toString() {
|
return connection.toString();
|
}
|
|
private void evict(final DN name) {
|
synchronized (cachedReads) {
|
cachedReads.remove(name);
|
}
|
}
|
|
private void evictAll() {
|
synchronized (cachedReads) {
|
cachedReads.clear();
|
}
|
}
|
|
private <R extends Request> R withControls(final R request) {
|
if (proxiedAuthzControl != null) {
|
request.addControl(proxiedAuthzControl);
|
}
|
return request;
|
}
|
};
|
}
|
|
}
|
