Skip to content
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

[CALCITE-6590] Use reflection to handle Java SecurityManager deprecation in Avatica #251

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@
*/
package org.apache.calcite.avatica.remote;

import java.security.PrivilegedAction;
import org.apache.calcite.avatica.util.SecurityUtils;

import java.util.Objects;
import javax.security.auth.Subject;
import java.util.concurrent.Callable;

/**
* HTTP client implementation which invokes the wrapped HTTP client in a doAs with the provided
Expand All @@ -33,9 +34,10 @@ public DoAsAvaticaHttpClient(AvaticaHttpClient wrapped, KerberosConnection kerbe
this.kerberosUtil = Objects.requireNonNull(kerberosUtil);
}

@Override public byte[] send(final byte[] request) {
return Subject.doAs(kerberosUtil.getSubject(), new PrivilegedAction<byte[]>() {
@Override public byte[] run() {
@Override
public byte[] send(final byte[] request) {
return SecurityUtils.callAs(kerberosUtil.getSubject(), new Callable<byte[]>() {
@Override public byte[] call() {
return wrapped.send(request);
}
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Entry<RenewalTask, Thread> createRenewalThread(LoginContext originalContext,
renewalPeriod);
Thread t = new Thread(task);

// Don't prevent the JVM from existing
// Don't prevent the JVM from exiting
t.setDaemon(true);
// Log an error message if this thread somehow dies
t.setUncaughtExceptionHandler(new UncaughtExceptionHandler() {
Expand Down
266 changes: 266 additions & 0 deletions core/src/main/java/org/apache/calcite/avatica/util/SecurityUtils.java
Original file line number Diff line number Diff line change
@@ -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);
stoty marked this conversation as resolved.
Show resolved Hide resolved
}
}

/**
* <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) {
return () -> {
try {
return callable.call();
} catch (RuntimeException | Error x) {
throw x;
} catch (Throwable x) {
throw new RuntimeException(x);
}
};
}

private static Subject getSubjectFallback() {
try {
Object context = GET_CONTEXT.invoke();
return (Subject) GET_SUBJECT.invoke(context);
} catch (Throwable x) {
throw new RuntimeException("Error trying to get the current Subject", x);
}
}

private SecurityUtils() {
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.apache.calcite.avatica.remote.Driver.Serialization;
import org.apache.calcite.avatica.remote.Service;
import org.apache.calcite.avatica.remote.Service.RpcMetadataResponse;
import org.apache.calcite.avatica.util.SecurityUtils;

import org.eclipse.jetty.security.Authenticator;
import org.eclipse.jetty.security.ConfigurableSpnegoLoginService;
Expand Down Expand Up @@ -53,7 +54,6 @@
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.security.Principal;
import java.security.PrivilegedAction;
import java.security.SecureRandom;
import java.time.Duration;
import java.util.ArrayList;
Expand Down Expand Up @@ -205,8 +205,8 @@ static AvaticaHandler wrapJettyHandler(Handler handler) {
public void start() {
if (null != subject) {
// Run the start in the privileged block (as the kerberos-identified user)
Subject.doAs(subject, new PrivilegedAction<Void>() {
@Override public Void run() {
SecurityUtils.callAs(subject, new Callable<Void>() {
@Override public Void call() {
internalStart();
return null;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,20 @@
*/
package org.apache.calcite.avatica.server;

import java.security.AccessController;
import org.apache.calcite.avatica.util.SecurityUtils;

import java.security.PrivilegedAction;
import java.util.concurrent.Callable;
import java.util.concurrent.ThreadFactory;
import javax.security.auth.Subject;

/**
* Encapsulates creating the new Thread in a doPrivileged and a doAs call.
* The doPrivilieged block is taken from Jetty, and prevents some classloader leak isses.
*
* Also according to Jetty, the referred leak was fixed in JDK17, and the doPriviliged block
* is no longer needed in 17 and later-
*
* Saving the subject, and creating the Thread in the inner doAs call works around
* doPriviliged resetting the kerberos subject, which breaks SPNEGO authentication.
*
Expand All @@ -39,12 +45,13 @@ class SubjectPreservingPrivilegedThreadFactory implements ThreadFactory {
* @param Runnable object for the thread
* @return a new thread, protected from classloader pinning, but keeping the current Subject
*/
@Override
public Thread newThread(Runnable runnable) {
Subject subject = Subject.getSubject(AccessController.getContext());
return AccessController.doPrivileged(new PrivilegedAction<Thread>() {
Subject subject = SecurityUtils.currentSubject();
return SecurityUtils.doPrivileged(new PrivilegedAction<Thread>() {
@Override public Thread run() {
return Subject.doAs(subject, new PrivilegedAction<Thread>() {
@Override public Thread run() {
return SecurityUtils.callAs(subject, new Callable<Thread>() {
@Override public Thread call() {
Thread thread = new Thread(runnable);
thread.setDaemon(true);
thread.setName("avatica_qtp" + hashCode() + "-" + thread.getId());
Expand Down
Loading
Loading