Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not cache failed futures for async security policies indefinitely. #10743

Merged
merged 5 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;

import javax.annotation.Nullable;
import org.junit.After;
import org.junit.Before;
Expand Down Expand Up @@ -76,6 +78,7 @@ public void setupServiceDefinitionsAndMethods() {
MethodDescriptor.newBuilder(marshaller, marshaller)
.setFullMethodName(name)
.setType(MethodDescriptor.MethodType.UNARY)
.setSampledToLocalTracing(true)
.build();
ServerCallHandler<Empty, Empty> callHandler =
ServerCalls.asyncUnaryCall(
Expand Down Expand Up @@ -142,7 +145,7 @@ private void assertCallSuccess(MethodDescriptor<Empty, Empty> method) {
private void assertCallFailure(MethodDescriptor<Empty, Empty> method, Status status) {
try {
ClientCalls.blockingUnaryCall(channel, method, CallOptions.DEFAULT, null);
fail();
fail("Expected call to " + method.getFullMethodName() + " to fail but it succeeded.");
} catch (StatusRuntimeException sre) {
assertThat(sre.getStatus().getCode()).isEqualTo(status.getCode());
}
Expand Down Expand Up @@ -172,6 +175,50 @@ public void testServerDisallowsCalls() throws Exception {
}
}

@Test
public void testFailedFuturesAreNotCachedPermanently() throws Exception {
AtomicReference<Boolean> firstAttempt = new AtomicReference<>(true);
createChannel(
ServerSecurityPolicy.newBuilder()
.servicePolicy("foo", new AsyncSecurityPolicy() {
@Override
ListenableFuture<Status> checkAuthorizationAsync(int uid) {
if (firstAttempt.getAndSet(false)) {
return Futures.immediateFailedFuture(new IllegalStateException());
}
return Futures.immediateFuture(Status.OK);
}
})
.build(),
SecurityPolicies.internalOnly());
MethodDescriptor<Empty, Empty> method = methods.get("foo/method0");

assertCallFailure(method, Status.INTERNAL);
assertCallSuccess(method);
}

@Test
public void testCancelledFuturesAreNotCachedPermanently() throws Exception {
AtomicReference<Boolean> firstAttempt = new AtomicReference<>(true);
createChannel(
ServerSecurityPolicy.newBuilder()
.servicePolicy("foo", new AsyncSecurityPolicy() {
@Override
ListenableFuture<Status> checkAuthorizationAsync(int uid) {
if (firstAttempt.getAndSet(false)) {
return Futures.immediateCancelledFuture();
}
return Futures.immediateFuture(Status.OK);
}
})
.build(),
SecurityPolicies.internalOnly());
MethodDescriptor<Empty, Empty> method = methods.get("foo/method0");

assertCallFailure(method, Status.INTERNAL);
assertCallSuccess(method);
}

@Test
public void testClientDoesntTrustServer() throws Exception {
createChannel(SecurityPolicies.serverInternalOnly(), policy((uid) -> false));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,12 @@
import io.grpc.Status;
import io.grpc.internal.GrpcAttributes;

import java.util.concurrent.CancellationException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
import java.util.concurrent.Future;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;

Expand Down Expand Up @@ -103,7 +106,7 @@ public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
// Most SecurityPolicy will have synchronous implementations that provide an
// immediately-resolved Future. In that case, short-circuit to avoid unnecessary allocations
// and asynchronous code if the authorization result is already present.
if (!authStatusFuture.isDone()) {
if (!authStatusFuture.isDone() || authStatusFuture.isCancelled()) {
mateusazis marked this conversation as resolved.
Show resolved Hide resolved
return newServerCallListenerForPendingAuthResult(authStatusFuture, call, headers, next);
}

Expand Down Expand Up @@ -178,9 +181,12 @@ ListenableFuture<Status> checkAuthorization(MethodDescriptor<?, ?> method) {
boolean useCache = method.isSampledToLocalTracing();
if (useCache) {
@Nullable ListenableFuture<Status> authorization = serviceAuthorization.get(serviceName);
if (authorization != null) {
if (authorization != null && !isFailedOrCancelled(authorization)) {
// Authorization check exists and is a pending or successful future (even if for a failed
// authorization).
return authorization;
}
serviceAuthorization.remove(serviceName);
mateusazis marked this conversation as resolved.
Show resolved Hide resolved
mateusazis marked this conversation as resolved.
Show resolved Hide resolved
}
// Under high load, this may trigger a large number of concurrent authorization checks that
// perform essentially the same work and have the potential of exhausting the resources they
Expand All @@ -198,6 +204,18 @@ ListenableFuture<Status> checkAuthorization(MethodDescriptor<?, ?> method) {
}
mateusazis marked this conversation as resolved.
Show resolved Hide resolved
}

private static <T> boolean isFailedOrCancelled(Future<T> doneFuture) {
if (!doneFuture.isDone()) {
return false;
}
try {
T unused = Futures.getDone(doneFuture);
return false;
} catch (ExecutionException | CancellationException e) {
return true;
}
}

/**
* Decides whether a given Android UID is authorized to access some resource.
*
Expand Down