Skip to content

[9.0] [Entitlements] Log message for troubleshooting if not entitled (#122948) #122963

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
elasticsearchmachine merged 1 commit into from
Feb 19, 2025
Merged

[9.0] [Entitlements] Log message for troubleshooting if not entitled (#122948) #122963

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
34 changes: 23 additions & 11 deletions ...entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

import org.elasticsearch.core.Strings;
import org.elasticsearch.core.SuppressForbidden;
import org.elasticsearch.entitlement.bootstrap.EntitlementBootstrap;
import org.elasticsearch.entitlement.instrumentation.InstrumentationService;
import org.elasticsearch.entitlement.runtime.api.NotEntitledException;
import org.elasticsearch.entitlement.runtime.policy.entitlements.CreateClassLoaderEntitlement;
Expand Down Expand Up @@ -215,7 +216,8 @@ private void neverEntitled(Class<?> callerClass, Supplier<String> operationDescr
requestingClass.getModule().getName(),
requestingClass,
operationDescription.get()
)
),
callerClass
);
}

Expand Down Expand Up @@ -274,7 +276,8 @@ public void checkFileRead(Class<?> callerClass, Path path) {
requestingClass.getModule().getName(),
requestingClass,
path
)
),
callerClass
);
}
}
Expand All @@ -299,7 +302,8 @@ public void checkFileWrite(Class<?> callerClass, Path path) {
requestingClass.getModule().getName(),
requestingClass,
path
)
),
callerClass
);
}
}
Expand Down Expand Up @@ -348,14 +352,15 @@ public void checkAllNetworkAccess(Class<?> callerClass) {
}

var classEntitlements = getEntitlements(requestingClass);
checkFlagEntitlement(classEntitlements, InboundNetworkEntitlement.class, requestingClass);
checkFlagEntitlement(classEntitlements, OutboundNetworkEntitlement.class, requestingClass);
checkFlagEntitlement(classEntitlements, InboundNetworkEntitlement.class, requestingClass, callerClass);
checkFlagEntitlement(classEntitlements, OutboundNetworkEntitlement.class, requestingClass, callerClass);
}

private static void checkFlagEntitlement(
ModuleEntitlements classEntitlements,
Class<? extends Entitlement> entitlementClass,
Class<?> requestingClass
Class<?> requestingClass,
Class<?> callerClass
) {
if (classEntitlements.hasEntitlement(entitlementClass) == false) {
notEntitled(
Expand All @@ -365,7 +370,8 @@ private static void checkFlagEntitlement(
requestingClass.getModule().getName(),
requestingClass,
PolicyParser.getEntitlementTypeName(entitlementClass)
)
),
callerClass
);
}
logger.debug(
Expand Down Expand Up @@ -405,12 +411,18 @@ public void checkWriteProperty(Class<?> callerClass, String property) {
requestingClass.getModule().getName(),
requestingClass,
property
)
),
callerClass
);
}

private static void notEntitled(String message) {
throw new NotEntitledException(message);
private static void notEntitled(String message, Class<?> callerClass) {
var exception = new NotEntitledException(message);
// don't log self tests in EntitlementBootstrap
if (EntitlementBootstrap.class.equals(callerClass) == false) {
logger.warn(message, exception);
}
throw exception;
}

public void checkManageThreadsEntitlement(Class<?> callerClass) {
Expand All @@ -422,7 +434,7 @@ private void checkEntitlementPresent(Class<?> callerClass, Class<? extends Entit
if (isTriviallyAllowed(requestingClass)) {
return;
}
checkFlagEntitlement(getEntitlements(requestingClass), entitlementClass, requestingClass);
checkFlagEntitlement(getEntitlements(requestingClass), entitlementClass, requestingClass, callerClass);
}

ModuleEntitlements getEntitlements(Class<?> requestingClass) {
Expand Down