Skip to content

[9.0] [Entitlements] Follows links during FileAccessTree creation (#123357) #123364

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
Feb 25, 2025
Merged

[9.0] [Entitlements] Follows links during FileAccessTree creation (#123357) #123364

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
48 changes: 40 additions & 8 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 @@ -10,18 +10,27 @@
package org.elasticsearch.entitlement.runtime.policy;

import org.elasticsearch.entitlement.runtime.policy.entitlements.FilesEntitlement;
import org.elasticsearch.entitlement.runtime.policy.entitlements.FilesEntitlement.Mode;
import org.elasticsearch.logging.LogManager;
import org.elasticsearch.logging.Logger;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import java.util.function.BiConsumer;

import static org.elasticsearch.core.PathUtils.getDefaultFileSystem;

public final class FileAccessTree {

private static final Logger logger = LogManager.getLogger(FileAccessTree.class);
private static final String FILE_SEPARATOR = getDefaultFileSystem().getSeparator();

private final String[] readPaths;
Expand All @@ -30,6 +39,27 @@ public final class FileAccessTree {
private FileAccessTree(FilesEntitlement filesEntitlement, PathLookup pathLookup) {
List<String> readPaths = new ArrayList<>();
List<String> writePaths = new ArrayList<>();
BiConsumer<Path, Mode> addPath = (path, mode) -> {
var normalized = normalizePath(path);
if (mode == Mode.READ_WRITE) {
writePaths.add(normalized);
}
readPaths.add(normalized);
};
BiConsumer<Path, Mode> addPathAndMaybeLink = (path, mode) -> {
addPath.accept(path, mode);
// also try to follow symlinks. Lucene does this and writes to the target path.
if (Files.exists(path)) {
try {
Path realPath = path.toRealPath();
if (realPath.equals(path) == false) {
addPath.accept(realPath, mode);
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
};
for (FilesEntitlement.FileData fileData : filesEntitlement.filesData()) {
var platform = fileData.platform();
if (platform != null && platform.isCurrent() == false) {
Expand All @@ -38,18 +68,20 @@ private FileAccessTree(FilesEntitlement filesEntitlement, PathLookup pathLookup)
var mode = fileData.mode();
var paths = fileData.resolvePaths(pathLookup);
paths.forEach(path -> {
var normalized = normalizePath(path);
if (mode == FilesEntitlement.Mode.READ_WRITE) {
writePaths.add(normalized);
if (path == null) {
// TODO: null paths shouldn't be allowed, but they can occur due to repo paths
return;
}
readPaths.add(normalized);
addPathAndMaybeLink.accept(path, mode);
});
}

// everything has access to the temp dir
String tempDir = normalizePath(pathLookup.tempDir());
readPaths.add(tempDir);
writePaths.add(tempDir);
// everything has access to the temp dir and the jdk
addPathAndMaybeLink.accept(pathLookup.tempDir(), Mode.READ_WRITE);

// TODO: watcher uses javax.activation which looks for known mime types configuration, should this be global or explicit in watcher?
Path jdk = Paths.get(System.getProperty("java.home"));
addPathAndMaybeLink.accept(jdk.resolve("conf"), Mode.READ);

readPaths.sort(PATH_ORDER);
writePaths.sort(PATH_ORDER);
Expand Down
44 changes: 44 additions & 0 deletions ...ement/src/test/java/org/elasticsearch/entitlement/runtime/policy/FileAccessTreeTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@
package org.elasticsearch.entitlement.runtime.policy;

import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.SuppressForbidden;
import org.elasticsearch.entitlement.runtime.policy.entitlements.FilesEntitlement;
import org.elasticsearch.test.ESTestCase;
import org.junit.BeforeClass;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
Expand All @@ -23,6 +27,7 @@
import static org.elasticsearch.core.PathUtils.getDefaultFileSystem;
import static org.hamcrest.Matchers.is;

@ESTestCase.WithoutSecurityManager
public class FileAccessTreeTests extends ESTestCase {

static Path root;
Expand Down Expand Up @@ -211,6 +216,45 @@ public void testForwardSlashes() {
assertThat(tree.canRead(path("m/n")), is(true));
}

public void testJdkAccess() {
Path jdkDir = Paths.get(System.getProperty("java.home"));
var confDir = jdkDir.resolve("conf");
var tree = accessTree(FilesEntitlement.EMPTY);

assertThat(tree.canRead(confDir), is(true));
assertThat(tree.canWrite(confDir), is(false));
assertThat(tree.canRead(jdkDir), is(false));
}

@SuppressForbidden(reason = "don't care about the directory location in tests")
public void testFollowLinks() throws IOException {
Path baseSourceDir = Files.createTempDirectory("fileaccess_source");
Path source1Dir = baseSourceDir.resolve("source1");
Files.createDirectory(source1Dir);
Path source2Dir = baseSourceDir.resolve("source2");
Files.createDirectory(source2Dir);

Path baseTargetDir = Files.createTempDirectory("fileaccess_target");
Path readTarget = baseTargetDir.resolve("read_link");
Path writeTarget = baseTargetDir.resolve("write_link");
Files.createSymbolicLink(readTarget, source1Dir);
Files.createSymbolicLink(writeTarget, source2Dir);
var tree = accessTree(entitlement(readTarget.toString(), "read", writeTarget.toString(), "read_write"));

assertThat(tree.canRead(baseSourceDir), is(false));
assertThat(tree.canRead(baseTargetDir), is(false));

assertThat(tree.canRead(readTarget), is(true));
assertThat(tree.canWrite(readTarget), is(false));
assertThat(tree.canRead(source1Dir), is(true));
assertThat(tree.canWrite(source1Dir), is(false));

assertThat(tree.canRead(writeTarget), is(true));
assertThat(tree.canWrite(writeTarget), is(true));
assertThat(tree.canRead(source2Dir), is(true));
assertThat(tree.canWrite(source2Dir), is(true));
}

public void testTempDirAccess() {
var tree = FileAccessTree.of(FilesEntitlement.EMPTY, TEST_PATH_LOOKUP);
assertThat(tree.canRead(TEST_PATH_LOOKUP.tempDir()), is(true));
Expand Down