-
Notifications
You must be signed in to change notification settings - Fork 238
[CALCITE-6590] Use reflection to handle Java SecurityManager deprecation in Avatica #251
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
Closed
Closed
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
b254987
[CALCITE-6590] Use reflection to handle Java SecurityManager deprecat…
stoty 29d7cc2
polish
stoty 19ef2de
fix comment
stoty faee982
remove misinformation in comment
stoty 7261b32
unwrap InvocationTargetExceptions
stoty f74774f
remove getSecurityManager and checkPermission
stoty 4723233
revert unwrapInvocationTargetException
stoty 00fbfd6
[email protected] suggested changes
chrisdennis e6959da
remove addSuppressed
stoty 15a0c7d
javadoc fix
stoty d789ab5
re-rename sneakyThrow
stoty 8094ca4
let callAs() throw Exceptions
stoty bb97b60
Revert "let callAs() throw Exceptions"
stoty f5185f5
add CompletionException to callAs() signature
stoty 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
203 changes: 203 additions & 0 deletions
203
core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.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,203 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to you 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 org.apache.calcite.avatica.util; | ||
|
|
||
| import java.lang.invoke.MethodHandle; | ||
| import java.lang.invoke.MethodHandles; | ||
| import java.lang.invoke.MethodType; | ||
| import java.security.PrivilegedAction; | ||
| import java.security.PrivilegedActionException; | ||
| import java.security.PrivilegedExceptionAction; | ||
| import java.util.concurrent.Callable; | ||
| import java.util.concurrent.CompletionException; | ||
| import javax.security.auth.Subject; | ||
|
|
||
| /** | ||
| * This class is loosely based on SecurityUtils in Jetty 12.0 | ||
| * | ||
| * <p>Collections of utility methods to deal with the scheduled removal | ||
| * of the security classes defined by <a href="https://openjdk.org/jeps/411">JEP 411</a>.</p> | ||
| */ | ||
| public class SecurityUtils { | ||
| private static final MethodHandle CALL_AS = lookupCallAs(); | ||
| private static final MethodHandle CURRENT = lookupCurrent(); | ||
| private static final MethodHandle DO_PRIVILEGED = lookupDoPrivileged(); | ||
|
|
||
| private SecurityUtils() { | ||
| } | ||
|
|
||
| private static MethodHandle lookupCallAs() { | ||
| MethodHandles.Lookup lookup = MethodHandles.lookup(); | ||
| try { | ||
| try { | ||
| // Subject.doAs() is deprecated for removal and replaced by Subject.callAs(). | ||
| // Lookup first the new API, since for Java versions where both exist, the | ||
| // new API delegates to the old API (for example Java 18, 19 and 20). | ||
| // Otherwise (Java 17), lookup the old API. | ||
| return lookup.findStatic(Subject.class, "callAs", | ||
| MethodType.methodType(Object.class, Subject.class, Callable.class)); | ||
| } catch (NoSuchMethodException x) { | ||
| try { | ||
| // Lookup the old API. | ||
| MethodType oldSignature = | ||
| MethodType.methodType(Object.class, Subject.class, PrivilegedExceptionAction.class); | ||
| MethodHandle doAs = lookup.findStatic(Subject.class, "doAs", oldSignature); | ||
| // Convert the Callable used in the new API to the PrivilegedAction used in the old | ||
| // API. | ||
| MethodType convertSignature = | ||
| MethodType.methodType(PrivilegedExceptionAction.class, Callable.class); | ||
| MethodHandle converter = | ||
| lookup.findStatic(SecurityUtils.class, "callableToPrivilegedExceptionAction", | ||
| convertSignature); | ||
| return MethodHandles.filterArguments(doAs, 1, converter); | ||
| } catch (NoSuchMethodException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| } | ||
| } catch (IllegalAccessException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| } | ||
|
|
||
| private static MethodHandle lookupDoPrivileged() { | ||
| try { | ||
| // Use reflection to work with Java versions that have and don't have AccessController. | ||
| Class<?> klass = | ||
| ClassLoader.getSystemClassLoader().loadClass("java.security.AccessController"); | ||
| MethodHandles.Lookup lookup = MethodHandles.lookup(); | ||
| return lookup.findStatic(klass, "doPrivileged", | ||
| MethodType.methodType(Object.class, PrivilegedAction.class)); | ||
| } catch (NoSuchMethodException | IllegalAccessException x) { | ||
| // Assume that single methods won't be removed from AcessController | ||
| throw new AssertionError(x); | ||
| } catch (ClassNotFoundException e) { | ||
| return null; | ||
zabetak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| private static MethodHandle lookupCurrent() { | ||
| MethodHandles.Lookup lookup = MethodHandles.lookup(); | ||
| try { | ||
| // Subject.getSubject(AccessControlContext) is deprecated for removal and replaced by | ||
| // Subject.current(). | ||
| // Lookup first the new API, since for Java versions where both exists, the | ||
| // new API delegates to the old API (for example Java 18, 19 and 20). | ||
| // Otherwise (Java 17), lookup the old API. | ||
| return lookup.findStatic(Subject.class, "current", | ||
| MethodType.methodType(Subject.class)); | ||
| } catch (NoSuchMethodException e) { | ||
| MethodHandle getContext = lookupGetContext(); | ||
| MethodHandle getSubject = lookupGetSubject(); | ||
| return MethodHandles.filterReturnValue(getContext, getSubject); | ||
| } catch (IllegalAccessException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| } | ||
|
|
||
| private static MethodHandle lookupGetSubject() { | ||
| MethodHandles.Lookup lookup = MethodHandles.lookup(); | ||
| try { | ||
| Class<?> contextklass = | ||
| ClassLoader.getSystemClassLoader() | ||
| .loadClass("java.security.AccessControlContext"); | ||
| return lookup.findStatic(Subject.class, "getSubject", | ||
| MethodType.methodType(Subject.class, contextklass)); | ||
| } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| } | ||
|
|
||
| private static MethodHandle lookupGetContext() { | ||
| try { | ||
| // Use reflection to work with Java versions that have and don't have AccessController. | ||
| Class<?> controllerKlass = | ||
| ClassLoader.getSystemClassLoader().loadClass("java.security.AccessController"); | ||
| Class<?> contextklass = | ||
| ClassLoader.getSystemClassLoader() | ||
| .loadClass("java.security.AccessControlContext"); | ||
|
|
||
| MethodHandles.Lookup lookup = MethodHandles.lookup(); | ||
| return lookup.findStatic(controllerKlass, "getContext", | ||
| MethodType.methodType(contextklass)); | ||
| } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException e) { | ||
| throw new AssertionError(e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Maps to AccessController#doPrivileged if available, otherwise returns action.run(). | ||
| * @param action the action to run | ||
| * @return the result of running the action | ||
| * @param <T> the type of the result | ||
| */ | ||
| public static <T> T doPrivileged(PrivilegedAction<T> action) { | ||
| // Keep this method short and inlineable. | ||
| if (DO_PRIVILEGED == null) { | ||
| return action.run(); | ||
| } | ||
zabetak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return doPrivileged(DO_PRIVILEGED, action); | ||
| } | ||
|
|
||
| private static <T> T doPrivileged(MethodHandle doPrivileged, PrivilegedAction<T> action) { | ||
| try { | ||
| return (T) doPrivileged.invoke(action); | ||
| } catch (Throwable t) { | ||
| throw sneakyThrow(t); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Maps to Subject.callAs() if available, otherwise maps to Subject.doAs() | ||
| * @param subject the subject this action runs as | ||
| * @param action the action to run | ||
| * @return the result of the action | ||
| * @param <T> the type of the result | ||
| * @throws CompletionException | ||
| */ | ||
| public static <T> T callAs(Subject subject, Callable<T> action) throws CompletionException { | ||
| try { | ||
| return (T) CALL_AS.invoke(subject, action); | ||
| } catch (PrivilegedActionException e) { | ||
| throw new CompletionException(e.getCause()); | ||
| } catch (Throwable t) { | ||
| throw sneakyThrow(t); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Maps to Subject.currect() is available, otherwise maps to Subject.getSubject() | ||
| * @return the current subject | ||
| */ | ||
| public static Subject currentSubject() { | ||
| try { | ||
| return (Subject) CURRENT.invoke(); | ||
| } catch (Throwable t) { | ||
| throw sneakyThrow(t); | ||
| } | ||
| } | ||
|
|
||
| @SuppressWarnings("unused") | ||
| private static <T> PrivilegedExceptionAction<T> callableToPrivilegedExceptionAction( | ||
| Callable<T> callable) { | ||
| return callable::call; | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static <E extends Throwable> RuntimeException sneakyThrow(Throwable e) throws E { | ||
| throw (E) e; | ||
| } | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ | |
| import org.apache.calcite.avatica.remote.KerberosConnection; | ||
| import org.apache.calcite.avatica.remote.Service.RpcMetadataResponse; | ||
| import org.apache.calcite.avatica.server.AvaticaHandler; | ||
| import org.apache.calcite.avatica.util.SecurityUtils; | ||
|
|
||
| import org.apache.kerby.kerberos.kerb.KrbException; | ||
| import org.apache.kerby.kerberos.kerb.server.SimpleKdcServer; | ||
|
|
@@ -38,7 +39,6 @@ | |
| import java.io.OutputStreamWriter; | ||
| import java.net.ServerSocket; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.security.AccessController; | ||
| import java.security.Principal; | ||
| import java.security.PrivilegedAction; | ||
| import javax.security.auth.login.Configuration; | ||
|
|
@@ -138,8 +138,9 @@ public static void refreshJaasConfiguration() { | |
| // Configuration keeps a static instance of Configuration that it will return once it | ||
| // has been initialized. We need to nuke that static instance to make sure our | ||
| // serverSpnegoConfigFile gets read. | ||
| AccessController.doPrivileged(new PrivilegedAction<Configuration>() { | ||
| public Configuration run() { | ||
| SecurityUtils.doPrivileged(new PrivilegedAction<Configuration>() { | ||
| @Override | ||
| public Configuration run() { | ||
| return Configuration.getConfiguration(); | ||
| } | ||
| }).refresh(); | ||
|
Comment on lines
138
to
146
This comment was marked as outdated.
Sorry, something went wrong.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unhidden by accident |
||
|
|
||
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
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.