Skip to content

[Entitlements] Improve FileAccessTree logging #127050

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 8 commits into from
Apr 22, 2025
Merged

[Entitlements] Improve FileAccessTree logging #127050

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7f33bac
improve FileAccessTree logging
ldematte Apr 18, 2025
4e4cb37
Merge branch 'main' into entitlements/improve-fileaccesstree-logging
ldematte Apr 18, 2025
c50fd6e
Merge remote-tracking branch 'upstream/main' into entitlements/improv…
ldematte Apr 22, 2025
1823668
PR comments
ldematte Apr 22, 2025
89d0106
Merge branch 'main' into entitlements/improve-fileaccesstree-logging
ldematte Apr 22, 2025
4d69adc
fix message
ldematte Apr 22, 2025
f4007a1
Merge branch 'entitlements/improve-fileaccesstree-logging' of github.…
ldematte Apr 22, 2025
6b0fce2
Merge branch 'main' into entitlements/improve-fileaccesstree-logging
ldematte Apr 22, 2025
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
25 changes: 20 additions & 5 deletions ...ntitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/FileAccessTree.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,15 @@ private FileAccessTree(FilesEntitlement filesEntitlement, PathLookup pathLookup,
this.exclusivePaths = sortedExclusivePaths;
this.readPaths = pruneSortedPaths(readPaths).toArray(new String[0]);
this.writePaths = pruneSortedPaths(writePaths).toArray(new String[0]);

logger.debug(
() -> Strings.format(
"Created FileAccessTree with paths: exclusive [%s], read [%s], write [%s]",
String.join(",", this.exclusivePaths),
String.join(",", this.readPaths),
String.join(",", this.writePaths)
)
);
}

// package private for testing
Expand Down Expand Up @@ -305,11 +314,17 @@ public static FileAccessTree withoutExclusivePaths(
}

public boolean canRead(Path path) {
return checkPath(normalizePath(path), readPaths);
var normalizedPath = normalizePath(path);
var canRead = checkPath(normalizedPath, readPaths);
logger.trace(() -> Strings.format("checking [%s] (normalized to [%s]) for read: %b", path, normalizedPath, canRead));
return canRead;
}

public boolean canWrite(Path path) {
return checkPath(normalizePath(path), writePaths);
var normalizedPath = normalizePath(path);
var canWrite = checkPath(normalizedPath, writePaths);
logger.trace(() -> Strings.format("checking [%s] (normalized to [%s]) for write: %b", path, normalizedPath, canWrite));
return canWrite;
}

/**
Expand All @@ -327,7 +342,6 @@ static String normalizePath(Path path) {
}

private boolean checkPath(String path, String[] paths) {
logger.trace(() -> Strings.format("checking [%s] against [%s]", path, String.join(",", paths)));
if (paths.length == 0) {
return false;
}
Expand All @@ -345,8 +359,9 @@ private boolean checkPath(String path, String[] paths) {
}

private static boolean isParent(String maybeParent, String path) {
logger.trace(() -> Strings.format("checking isParent [%s] for [%s]", maybeParent, path));
return path.startsWith(maybeParent) && path.startsWith(FILE_SEPARATOR, maybeParent.length());
var isParent = path.startsWith(maybeParent) && path.startsWith(FILE_SEPARATOR, maybeParent.length());
logger.trace(() -> Strings.format("checking isParent [%s] for [%s]: %b", maybeParent, path, isParent));
return isParent;
}

@Override
Expand Down