forked from grpc/grpc-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Handle slow security policies without blocking gRPC threads.
- Introduce PendingAuthListener to handle a ListenableFuture<Status>, progressing the gRPC through each stage in sequence once the future completes and is OK. - Move unit tests away from `checkAuthorizationForService` and into `checkAuthorizationForServiceAsync` since that should be the only method called in production now. - Some tests in `ServerSecurityPolicyTest` had their expectations updated; they previously called synchornous APIs that transformed failed `ListenableFuture<Status>` into one or another status. Now, we call the sync API, so those transformations do not happen anymore, thus the test needs to deal with failed futures directly. - I couldn't figure out if this PR needs extra tests. AFAICT `BinderSecurityTest` should already cover the new codepaths, but please let me know otherwise. This should be the last PR to address grpc#10566.
- Loading branch information
1 parent
b6947de
commit d805bd6
Showing
4 changed files
with
194 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
binder/src/main/java/io/grpc/binder/internal/PendingAuthListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package io.grpc.binder.internal; | ||
|
|
||
| import com.google.common.util.concurrent.Futures; | ||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import com.google.common.util.concurrent.MoreExecutors; | ||
|
|
||
| import io.grpc.Metadata; | ||
| import io.grpc.ServerCall; | ||
| import io.grpc.ServerCall.Listener; | ||
| import io.grpc.ServerCallHandler; | ||
| import io.grpc.Status; | ||
| import io.grpc.internal.ObjectPool; | ||
|
|
||
| import java.util.concurrent.Executor; | ||
|
|
||
| /** | ||
| * A {@link ServerCall.Listener} that can be returned by a {@link io.grpc.ServerInterceptor} to | ||
| * asynchronously advance the gRPC pending resolving a possibly asynchronous security policy check. | ||
| */ | ||
| final class PendingAuthListener<ReqT, RespT> extends ServerCall.Listener<ReqT> { | ||
|
|
||
| private final ListenableFuture<Listener<ReqT>> authStatusFuture; | ||
| private final Executor sequentialExecutor; | ||
| private final ObjectPool<? extends Executor> executorPool; | ||
| private final Executor executor; | ||
|
|
||
| /** | ||
| * @param authStatusFuture a ListenableFuture holding the result status of the authorization | ||
| * policy from a {@link io.grpc.binder.SecurityPolicy} or a | ||
| * {@link io.grpc.binder.AsyncSecurityPolicy}. The call only progresses | ||
| * if {@link Status#isOk()} is true. | ||
| * @param executorPool a pool that can provide at least one Executor under which the result | ||
| * of {@code authStatusFuture} can be handled, progressing the gRPC | ||
| * stages. | ||
| * @param call the 'call' parameter from {@link io.grpc.ServerInterceptor} | ||
| * @param headers the 'headers' parameter from {@link io.grpc.ServerInterceptor} | ||
| * @param next the 'next' parameter from {@link io.grpc.ServerInterceptor} | ||
| */ | ||
| PendingAuthListener( | ||
| ListenableFuture<Status> authStatusFuture, | ||
| ObjectPool<? extends Executor> executorPool, | ||
| ServerCall<ReqT, RespT> call, Metadata headers, | ||
| ServerCallHandler<ReqT, RespT> next) { | ||
| this.executorPool = executorPool; | ||
| this.executor = executorPool.getObject(); | ||
| this.authStatusFuture = Futures.transform(authStatusFuture, authStatus -> { | ||
| if (authStatus.isOk()) { | ||
| return next.startCall(call, headers); | ||
| } | ||
| call.close(authStatus, new Metadata()); | ||
| throw new IllegalStateException("Auth failed", authStatus.asException()); | ||
| }, executor); | ||
| this.sequentialExecutor = MoreExecutors.newSequentialExecutor(executor); | ||
| } | ||
|
|
||
| @Override | ||
| public void onCancel() { | ||
| ListenableFuture<?> unused = Futures.transform(authStatusFuture, delegate -> { | ||
| delegate.onCancel(); | ||
| executorPool.returnObject(executor); | ||
| return null; | ||
| }, sequentialExecutor); | ||
| } | ||
|
|
||
| @Override | ||
| public void onComplete() { | ||
| ListenableFuture<?> unused = Futures.transform(authStatusFuture, delegate -> { | ||
| delegate.onComplete(); | ||
| executorPool.returnObject(executor); | ||
| return null; | ||
| }, sequentialExecutor); | ||
| } | ||
|
|
||
| @Override | ||
| public void onHalfClose() { | ||
| ListenableFuture<?> unused = Futures.transform(authStatusFuture, delegate -> { | ||
| delegate.onHalfClose(); | ||
| return null; | ||
| }, sequentialExecutor); | ||
| } | ||
|
|
||
| @Override | ||
| public void onMessage(ReqT message) { | ||
| ListenableFuture<?> unused = Futures.transform(authStatusFuture, delegate -> { | ||
| delegate.onMessage(message); | ||
| return null; | ||
| }, sequentialExecutor); | ||
| } | ||
|
|
||
| @Override | ||
| public void onReady() { | ||
| ListenableFuture<?> unused = Futures.transform(authStatusFuture, delegate -> { | ||
| delegate.onReady(); | ||
| return null; | ||
| }, sequentialExecutor); | ||
| } | ||
| } |
Oops, something went wrong.