zabetak commented on code in PR #251: URL: https://github.com/apache/calcite-avatica/pull/251#discussion_r1930576570
########## core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.java: ########## @@ -0,0 +1,202 @@ +/* + * 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; + } + } + + 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(); + } + 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 inferAndCast(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 + */ + public static <T> T callAs(Subject subject, Callable<T> action) { + try { + return (T) CALL_AS.invoke(subject, action); + } catch (PrivilegedActionException e) { + throw new CompletionException(e.getCause()); + } catch (Throwable t) { + throw inferAndCast(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 inferAndCast(t); + } + } + + @SuppressWarnings("unused") + private static <T> PrivilegedExceptionAction<T> callableToPrivilegedExceptionAction( + Callable<T> callable) { + return callable::call; + } + + @SuppressWarnings("unchecked") + private static <E extends Throwable> RuntimeException inferAndCast(Throwable e) throws E { + throw (E) e; + } Review Comment: The current name is misleading since the method does not actually infer something; it does not really cast either. This pattern that allows to throw a checked exception without declaring in the method is usually known as "sneakyThrow". I am not sure how many people are familiar with this hack so it may be better to rename this method accordingly. I think its also possible to change the return type to `void` and possibly change `throw inferAndCast(t)` to `sneakyThrow(t)`. ########## core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.java: ########## @@ -0,0 +1,286 @@ +/* + * 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.lang.reflect.InvocationTargetException; +import java.security.Permission; +import java.security.PrivilegedAction; +import java.util.concurrent.Callable; +import java.util.concurrent.CompletionException; +import javax.security.auth.Subject; + +/** + * This class is heavily 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 static final MethodHandle GET_SUBJECT = lookupGetSubject(); + private static final MethodHandle GET_CONTEXT = lookupGetContext(); + + private static MethodHandle lookupCallAs() { + MethodHandles.Lookup lookup = MethodHandles.lookup(); + 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 (Throwable x) { + try { + // Lookup the old API. + MethodType oldSignature = + MethodType.methodType(Object.class, Subject.class, PrivilegedAction.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(PrivilegedAction.class, Callable.class); + MethodHandle converter = + lookup.findStatic(SecurityUtils.class, "callableToPrivilegedAction", + convertSignature); + return MethodHandles.filterArguments(doAs, 1, converter); + } catch (Throwable t) { + return null; + } + } + } + + 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 (Throwable x) { + return null; + } + } + + 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 (Throwable x) { + try { + // This is a bit awkward, but the code is more symmetrical this way + return lookup.findStatic(SecurityUtils.class, "getSubjectFallback", + MethodType.methodType(Subject.class)); + } catch (Throwable t) { + return null; + } + } + } + + 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 (Throwable t) { + return null; + } + } + + 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 (Throwable x) { + return null; + } + } + + /** + * Get the current security manager, if available. + * @return the current security manager, if available, null otherwise + */ + public static Object getSecurityManager() { + try { + // Use reflection to work with Java versions that have and don't have SecurityManager. + return System.class.getMethod("getSecurityManager").invoke(null); + } catch (InvocationTargetException x) { + return unwrapInvocationTargetException(x); + } catch (Throwable ignored) { + return null; + } + } + + /** + * <p> + * Checks the given permission, if the {@link #getSecurityManager() security manager} is set. + * </p> + * @param permission the permission to check + * @throws SecurityException if the permission check fails + */ + public static void checkPermission(Permission permission) throws SecurityException { + Object securityManager = SecurityUtils.getSecurityManager(); + if (securityManager == null) { + return; + } + try { + securityManager.getClass().getMethod("checkPermission").invoke(securityManager, + permission); + } catch (InvocationTargetException x) { + unwrapInvocationTargetException(x); + } catch (Throwable ignored) { + } + } + + /** + * <p> + * Runs the given action with the calling context restricted to just the calling frame, not all + * the frames in the stack. + * </p> + * @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(); + } Review Comment: I went over the past discussions and after browsing a bit the JDK code I understand why it is important to call the `doPrivileged` method. In addition, the fact that the method becomes a NOOP seems OK based on the fact that [AccessController.java](https://github.com/openjdk/jdk/blob/7d6055a786ba5e146bcdd6f58b5d47f968a4af90/src/java.base/share/classes/java/security/AccessController.java#L73) does exactly the same thing in more recent JDKs. ########## core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.java: ########## @@ -0,0 +1,202 @@ +/* + * 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; Review Comment: There seems to be some inconsistency between this method and `lookupGetContext`. In this method, if we fail to find the `AccessController` we will just return null and continue while the same does not hold for the context method that will fail directly with an `AssertionError`. ########## core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.java: ########## @@ -0,0 +1,266 @@ +/* + * 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.Permission; +import java.security.PrivilegedAction; +import java.util.concurrent.Callable; +import java.util.concurrent.CompletionException; +import javax.security.auth.Subject; + +/** + * This class is heavily based on SecurityUtils in Jetty 12.0 Review Comment: The provided links are not about source headers and file modifications but more about how to document which license is picked when more than one apply to the work. Having said the class already differs quite a bit from the original one present in Jetty (after the multiple review rounds) so it may no longer be that pertinent to consider it as a copy/third-party work. Anyways since the original Jetty code is also under AL2 this discussion may not be that important after all. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
