chrisdennis commented on code in PR #251: URL: https://github.com/apache/calcite-avatica/pull/251#discussion_r1926082828
########## 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 + * + * <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 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, "callAs", + MethodType.methodType(Object.class, Subject.class, Callable.class)); + } catch (Throwable x) { Review Comment: I understand that this is likely pulled from the Jetty 12.0 code... but catching Throwable here seems like overkill (and is at a minimum a code smell). Better would be to catch `NoSuchMethodException` for the expected missing class situation and respond appropriately, and imho to throw `AssertionError` for the `IllegalAccessException` instances, since those should (I believe) be 'impossible'. ########## 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 + * + * <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 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, "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 (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 (SecurityException x) { + throw 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(); + } + return doPrivileged(DO_PRIVILEGED, action); + } + + @SuppressWarnings("unchecked") + private static <T> T doPrivileged(MethodHandle doPrivileged, PrivilegedAction<T> action) { + try { + return (T) doPrivileged.invoke(action); + } catch (RuntimeException | Error x) { + throw x; + } catch (Throwable x) { + // Unlikely to happen, as we catch Errors and RuntimeExceptions above, and doPrivileged + // does not throw checked exceptions + throw new RuntimeException(x); + } + } + + /** + * <p> + * Runs the given action as the given subject. + * </p> + * @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 + */ + @SuppressWarnings("unchecked") + public static <T> T callAs(Subject subject, Callable<T> action) { + try { + if (CALL_AS == null) { Review Comment: Can't see why this (and other similar code) shouldn't be failing during static initialization. Why not have the initialization throw, that way you can also throw something that indicates *why* it's null rather than a delayed failure absent important context? ########## 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 + * + * <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 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, "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 (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 (SecurityException x) { Review Comment: I think this is wrong... it's being invoked via reflection so you'll need to catch `InvocationTargetException` and examine the contents. ########## 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 + * + * <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 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, "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 (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 (SecurityException x) { + throw 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(); + } + return doPrivileged(DO_PRIVILEGED, action); + } + + @SuppressWarnings("unchecked") + private static <T> T doPrivileged(MethodHandle doPrivileged, PrivilegedAction<T> action) { + try { + return (T) doPrivileged.invoke(action); + } catch (RuntimeException | Error x) { + throw x; + } catch (Throwable x) { + // Unlikely to happen, as we catch Errors and RuntimeExceptions above, and doPrivileged + // does not throw checked exceptions + throw new RuntimeException(x); + } + } + + /** + * <p> + * Runs the given action as the given subject. + * </p> + * @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 + */ + @SuppressWarnings("unchecked") + public static <T> T callAs(Subject subject, Callable<T> action) { + try { + if (CALL_AS == null) { + throw new RuntimeException( + "Was unable to run either of Subject.callAs() or Subject.doAs()"); + } + return (T) CALL_AS.invoke(subject, action); + } catch (RuntimeException | Error x) { + throw x; + } catch (Throwable x) { + throw new CompletionException(x); + } + } + + /** + * <p> + * Gets the current subject + * </p> + * @return the current subject + */ + @SuppressWarnings("unchecked") + public static Subject currentSubject() { + if (CURRENT == null) { + throw new RuntimeException( + "Was unable to run either of Subject.current() or Subject.getSubject()"); + } + try { + MethodHandle methodHandle = CURRENT; + return (Subject) methodHandle.invoke(); + } catch (Throwable x) { + throw new RuntimeException("Error while trying to get the current user", x); + } + + } + + private static <T> PrivilegedAction<T> callableToPrivilegedAction(Callable<T> callable) { Review Comment: Not investigated the wider context here... but I do wonder if this should map to `PrivilegedExceptionAction`? ########## 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 + * + * <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 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, "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 (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 (SecurityException x) { + throw 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(); + } + return doPrivileged(DO_PRIVILEGED, action); + } + + @SuppressWarnings("unchecked") + private static <T> T doPrivileged(MethodHandle doPrivileged, PrivilegedAction<T> action) { + try { + return (T) doPrivileged.invoke(action); + } catch (RuntimeException | Error x) { + throw x; + } catch (Throwable x) { + // Unlikely to happen, as we catch Errors and RuntimeExceptions above, and doPrivileged + // does not throw checked exceptions + throw new RuntimeException(x); + } + } + + /** + * <p> + * Runs the given action as the given subject. + * </p> + * @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 + */ + @SuppressWarnings("unchecked") + public static <T> T callAs(Subject subject, Callable<T> action) { + try { + if (CALL_AS == null) { + throw new RuntimeException( + "Was unable to run either of Subject.callAs() or Subject.doAs()"); + } + return (T) CALL_AS.invoke(subject, action); + } catch (RuntimeException | Error x) { + throw x; + } catch (Throwable x) { Review Comment: The `CompletionException` is thrown directly... why do we rewrap it? -- 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]
