Skip to content

[9.0] Split out jvm and operating system actions in entitlement tests (#125122) #125331

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.

Sign up for GitHub

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 1 commit into from
Mar 20, 2025
Merged

[9.0] Split out jvm and operating system actions in entitlement tests (#125122) #125331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 34 additions & 2 deletions .../qa/test/WritePropertiesCheckActions.java → ...earch/entitlement/qa/test/JvmActions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,20 @@
import org.elasticsearch.core.SuppressForbidden;
import org.elasticsearch.entitlement.qa.entitled.EntitledPlugin;

import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Locale;
import java.util.TimeZone;

import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.ALWAYS_DENIED;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;

@SuppressForbidden(reason = "testing entitlements")
class WritePropertiesCheckActions {
private WritePropertiesCheckActions() {}
@SuppressWarnings({ "unused" /* called via reflection */ })
class JvmActions {

@EntitlementTest(expectedAccess = PLUGINS)
static void setSystemProperty() {
System.setProperty("es.entitlements.checkSetSystemProperty", "true");
try {
Expand All @@ -29,24 +36,49 @@ static void setSystemProperty() {

}

@EntitlementTest(expectedAccess = PLUGINS)
static void clearSystemProperty() {
EntitledPlugin.selfTest(); // TODO: find a better home
System.clearProperty("es.entitlements.checkClearSystemProperty");
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void setSystemProperties() {
System.setProperties(System.getProperties()); // no side effect in case if allowed (but shouldn't)
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void setDefaultLocale() {
Locale.setDefault(Locale.getDefault());
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void setDefaultLocaleForCategory() {
Locale.setDefault(Locale.Category.DISPLAY, Locale.getDefault(Locale.Category.DISPLAY));
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void setDefaultTimeZone() {
TimeZone.setDefault(TimeZone.getDefault());
}

@EntitlementTest(expectedAccess = PLUGINS)
static void createClassLoader() throws IOException {
try (var classLoader = new URLClassLoader("test", new URL[0], RestEntitlementsCheckAction.class.getClassLoader())) {
// intentionally empty, just let the loader close
}
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void createLogManager() {
new java.util.logging.LogManager() {
};
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void thread$$setDefaultUncaughtExceptionHandler() {
Thread.setDefaultUncaughtExceptionHandler(Thread.getDefaultUncaughtExceptionHandler());
}

private JvmActions() {}
}
27 changes: 27 additions & 0 deletions ...st-plugin/src/main/java/org/elasticsearch/entitlement/qa/test/OperatingSystemActions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the "Elastic License
* 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/

package org.elasticsearch.entitlement.qa.test;

import java.io.IOException;
import java.util.List;

@SuppressWarnings({ "unused" /* called via reflection */ })
class OperatingSystemActions {

static void processBuilder_start() throws IOException {
new ProcessBuilder("").start();
}

static void processBuilder_startPipeline() throws IOException {
ProcessBuilder.startPipeline(List.of());
}

private OperatingSystemActions() {}
}
45 changes: 3 additions & 42 deletions ...ugin/src/main/java/org/elasticsearch/entitlement/qa/test/RestEntitlementsCheckAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
import java.net.Socket;
import java.net.SocketException;
import java.net.URL;
import java.net.URLClassLoader;
import java.net.URLConnection;
import java.net.URLStreamHandler;
import java.net.spi.URLStreamHandlerProvider;
Expand All @@ -63,7 +62,6 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.SERVER_ONLY;
import static org.elasticsearch.entitlement.qa.test.RestEntitlementsCheckAction.CheckAction.alwaysDenied;
import static org.elasticsearch.entitlement.qa.test.RestEntitlementsCheckAction.CheckAction.deniedToPlugins;
import static org.elasticsearch.entitlement.qa.test.RestEntitlementsCheckAction.CheckAction.forPlugins;
import static org.elasticsearch.rest.RestRequest.Method.GET;

Expand Down Expand Up @@ -95,26 +93,10 @@ static CheckAction alwaysDenied(CheckedRunnable<Exception> action) {

private static final Map<String, CheckAction> checkActions = Stream.of(
Stream.<Entry<String, CheckAction>>of(
entry("create_classloader", forPlugins(RestEntitlementsCheckAction::createClassLoader)),
entry("processBuilder_start", deniedToPlugins(RestEntitlementsCheckAction::processBuilder_start)),
entry("processBuilder_startPipeline", deniedToPlugins(RestEntitlementsCheckAction::processBuilder_startPipeline)),
entry("set_https_connection_properties", forPlugins(RestEntitlementsCheckAction::setHttpsConnectionProperties)),
entry("set_default_ssl_socket_factory", alwaysDenied(RestEntitlementsCheckAction::setDefaultSSLSocketFactory)),
entry("set_default_hostname_verifier", alwaysDenied(RestEntitlementsCheckAction::setDefaultHostnameVerifier)),
entry("set_default_ssl_context", alwaysDenied(RestEntitlementsCheckAction::setDefaultSSLContext)),
entry(
"thread_setDefaultUncaughtExceptionHandler",
alwaysDenied(RestEntitlementsCheckAction::thread$$setDefaultUncaughtExceptionHandler)
),
entry("logManager", alwaysDenied(RestEntitlementsCheckAction::logManager$)),

entry("locale_setDefault", alwaysDenied(WritePropertiesCheckActions::setDefaultLocale)),
entry("locale_setDefaultForCategory", alwaysDenied(WritePropertiesCheckActions::setDefaultLocaleForCategory)),
entry("timeZone_setDefault", alwaysDenied(WritePropertiesCheckActions::setDefaultTimeZone)),

entry("system_setProperty", forPlugins(WritePropertiesCheckActions::setSystemProperty)),
entry("system_clearProperty", forPlugins(WritePropertiesCheckActions::clearSystemProperty)),
entry("system_setSystemProperties", alwaysDenied(WritePropertiesCheckActions::setSystemProperties)),

// This group is a bit nasty: if entitlements don't prevent these, then networking is
// irreparably borked for the remainder of the test run.
Expand Down Expand Up @@ -211,7 +193,9 @@ static CheckAction alwaysDenied(CheckedRunnable<Exception> action) {
getTestEntries(SpiActions.class),
getTestEntries(SystemActions.class),
getTestEntries(URLConnectionFileActions.class),
getTestEntries(URLConnectionNetworkActions.class)
getTestEntries(URLConnectionNetworkActions.class),
getTestEntries(JvmActions.class),
getTestEntries(OperatingSystemActions.class)
)
.flatMap(Function.identity())
.filter(entry -> entry.getValue().fromJavaVersion() == null || Runtime.version().feature() >= entry.getValue().fromJavaVersion())
Expand Down Expand Up @@ -323,33 +307,10 @@ private static void setDefaultSSLSocketFactory() {
HttpsURLConnection.setDefaultSSLSocketFactory(new DummyImplementations.DummySSLSocketFactory());
}

private static void createClassLoader() throws IOException {
try (var classLoader = new URLClassLoader("test", new URL[0], RestEntitlementsCheckAction.class.getClassLoader())) {
logger.info("Created URLClassLoader [{}]", classLoader.getName());
}
}

private static void processBuilder_start() throws IOException {
new ProcessBuilder("").start();
}

private static void processBuilder_startPipeline() throws IOException {
ProcessBuilder.startPipeline(List.of());
}

private static void setHttpsConnectionProperties() {
new DummyImplementations.DummyHttpsURLConnection().setSSLSocketFactory(new DummyImplementations.DummySSLSocketFactory());
}

private static void thread$$setDefaultUncaughtExceptionHandler() {
Thread.setDefaultUncaughtExceptionHandler(Thread.getDefaultUncaughtExceptionHandler());
}

private static void logManager$() {
new java.util.logging.LogManager() {
};
}

@SuppressWarnings("deprecation")
@SuppressForbidden(reason = "We're required to prevent calls to this forbidden API")
private static void datagramSocket$$setDatagramSocketImplFactory() throws IOException {
Expand Down