-
Notifications
You must be signed in to change notification settings - Fork 3.9k
File Watcher Authorization Server Interceptor #9775
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
111 changes: 111 additions & 0 deletions
111
authz/src/main/java/io/grpc/authz/FileWatcherAuthorizationServerInterceptor.java
This file contains hidden or 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,111 @@ | ||
/* | ||
* Copyright 2022 The gRPC Authors | ||
* | ||
* Licensed 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 io.grpc.authz; | ||
|
||
import static com.google.common.base.Preconditions.checkNotNull; | ||
import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
||
import io.grpc.Metadata; | ||
import io.grpc.ServerCall; | ||
import io.grpc.ServerCallHandler; | ||
import io.grpc.ServerInterceptor; | ||
import java.io.Closeable; | ||
import java.io.File; | ||
import java.io.IOException; | ||
import java.nio.file.Files; | ||
import java.util.concurrent.ScheduledExecutorService; | ||
import java.util.concurrent.ScheduledFuture; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.logging.Level; | ||
import java.util.logging.Logger; | ||
|
||
/** | ||
* Authorization server interceptor for policy from file with refresh capability. | ||
* The class will get <a href="https://github.com/grpc/proposal/blob/master/A43-grpc-authorization-api.md#user-facing-authorization-policy"> | ||
* gRPC Authorization policy</a> from a JSON file during initialization. | ||
*/ | ||
public final class FileWatcherAuthorizationServerInterceptor implements ServerInterceptor { | ||
private static final Logger logger = | ||
Logger.getLogger(FileWatcherAuthorizationServerInterceptor.class.getName()); | ||
|
||
private volatile AuthorizationServerInterceptor internalAuthzServerInterceptor; | ||
|
||
private final File policyFile; | ||
private String policyContents; | ||
|
||
private FileWatcherAuthorizationServerInterceptor(File policyFile) throws IOException { | ||
this.policyFile = policyFile; | ||
updateInternalInterceptor(); | ||
} | ||
|
||
@Override | ||
public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall( | ||
ServerCall<ReqT, RespT> call, Metadata headers, | ||
ServerCallHandler<ReqT, RespT> next) { | ||
return internalAuthzServerInterceptor.interceptCall(call, headers, next); | ||
} | ||
|
||
void updateInternalInterceptor() throws IOException { | ||
String currentPolicyContents = new String(Files.readAllBytes(policyFile.toPath()), UTF_8); | ||
if (currentPolicyContents.equals(policyContents)) { | ||
return; | ||
} | ||
policyContents = currentPolicyContents; | ||
internalAuthzServerInterceptor = AuthorizationServerInterceptor.create(policyContents); | ||
} | ||
|
||
/** | ||
* Policy is reloaded periodically as per the provided refresh interval. Unlike the | ||
* constructor, exception thrown during reload will be caught and logged and the | ||
* previous AuthorizationServerInterceptor will be used to make authorization | ||
* decisions. | ||
* | ||
* @param period the period between successive file load executions. | ||
* @param unit the time unit for period parameter | ||
* @param executor the execute service we use to read and update authorization policy | ||
* @return an object that caller should close when the file refreshes are not needed | ||
*/ | ||
public Closeable scheduleRefreshes( | ||
long period, TimeUnit unit, ScheduledExecutorService executor) throws IOException { | ||
checkNotNull(executor, "scheduledExecutorService"); | ||
if (period <= 0) { | ||
throw new IllegalArgumentException("Refresh interval must be greater than 0"); | ||
} | ||
final ScheduledFuture<?> future = | ||
executor.scheduleWithFixedDelay(new Runnable() { | ||
@Override | ||
public void run() { | ||
try { | ||
updateInternalInterceptor(); | ||
} catch (Exception e) { | ||
logger.log(Level.WARNING, "Authorization Policy file reload failed", e); | ||
} | ||
} | ||
}, period, period, unit); | ||
return new Closeable() { | ||
@Override public void close() { | ||
future.cancel(false); | ||
} | ||
}; | ||
} | ||
|
||
public static FileWatcherAuthorizationServerInterceptor create(File policyFile) | ||
throws IOException { | ||
checkNotNull(policyFile, "policyFile"); | ||
return new FileWatcherAuthorizationServerInterceptor(policyFile); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.