Plugins: plugin script to set proper plugin bin dir attributes

This commit makes sure that the plugin script looks at user, group and permissions of the elasticsearch bin dir and copies them over to the plugin bin subdirectory, whatever they are, so that they get properly setup depending on how elasticsearch was installed. We also make sure that execute permissions are added for files (we already did this before).

Relates to #11016
Closes #14088
This commit is contained in:
javanna 2015-10-13 17:34:56 +02:00 committed by Luca Cavanna
parent 461ce98ff5
commit 736823163f
3 changed files with 66 additions and 15 deletions

View File

@ -359,25 +359,37 @@ public class PluginManager {
throw new IOException("Could not move [" + sourcePluginBinDirectory + "] to [" + destPluginBinDirectory + "]", e); throw new IOException("Could not move [" + sourcePluginBinDirectory + "] to [" + destPluginBinDirectory + "]", e);
} }
if (Environment.getFileStore(destPluginBinDirectory).supportsFileAttributeView(PosixFileAttributeView.class)) { if (Environment.getFileStore(destPluginBinDirectory).supportsFileAttributeView(PosixFileAttributeView.class)) {
// add read and execute permissions to existing perms, so execution will work. PosixFileAttributes parentDirAttributes = Files.getFileAttributeView(destPluginBinDirectory.getParent(), PosixFileAttributeView.class).readAttributes();
// read should generally be set already, but set it anyway: don't rely on umask... //copy permissions from parent bin directory
final Set<PosixFilePermission> executePerms = new HashSet<>(); Set<PosixFilePermission> filePermissions = new HashSet<>();
executePerms.add(PosixFilePermission.OWNER_READ); for (PosixFilePermission posixFilePermission : parentDirAttributes.permissions()) {
executePerms.add(PosixFilePermission.GROUP_READ); switch (posixFilePermission) {
executePerms.add(PosixFilePermission.OTHERS_READ); case OWNER_EXECUTE:
executePerms.add(PosixFilePermission.OWNER_EXECUTE); case GROUP_EXECUTE:
executePerms.add(PosixFilePermission.GROUP_EXECUTE); case OTHERS_EXECUTE:
executePerms.add(PosixFilePermission.OTHERS_EXECUTE); break;
default:
filePermissions.add(posixFilePermission);
}
}
// add file execute permissions to existing perms, so execution will work.
filePermissions.add(PosixFilePermission.OWNER_EXECUTE);
filePermissions.add(PosixFilePermission.GROUP_EXECUTE);
filePermissions.add(PosixFilePermission.OTHERS_EXECUTE);
Files.walkFileTree(destPluginBinDirectory, new SimpleFileVisitor<Path>() { Files.walkFileTree(destPluginBinDirectory, new SimpleFileVisitor<Path>() {
@Override @Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
if (attrs.isRegularFile()) { if (attrs.isRegularFile()) {
Set<PosixFilePermission> perms = Files.getPosixFilePermissions(file); setPosixFileAttributes(file, parentDirAttributes.owner(), parentDirAttributes.group(), filePermissions);
perms.addAll(executePerms);
Files.setPosixFilePermissions(file, perms);
} }
return FileVisitResult.CONTINUE; return FileVisitResult.CONTINUE;
} }
@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
setPosixFileAttributes(dir, parentDirAttributes.owner(), parentDirAttributes.group(), parentDirAttributes.permissions());
return FileVisitResult.CONTINUE;
}
}); });
} else { } else {
terminal.println(VERBOSE, "Skipping posix permissions - filestore doesn't support posix permission"); terminal.println(VERBOSE, "Skipping posix permissions - filestore doesn't support posix permission");

View File

@ -41,6 +41,7 @@ import java.util.Set;
import java.util.zip.ZipEntry; import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream; import java.util.zip.ZipOutputStream;
import static java.nio.file.attribute.PosixFilePermission.*;
import static org.elasticsearch.common.settings.Settings.settingsBuilder; import static org.elasticsearch.common.settings.Settings.settingsBuilder;
import static org.elasticsearch.plugins.PluginInfoTests.writeProperties; import static org.elasticsearch.plugins.PluginInfoTests.writeProperties;
import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.*; import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.*;
@ -283,6 +284,39 @@ public class PluginManagerPermissionTests extends ESTestCase {
assertThat(pluginConfigFileAttributes.permissions(), equalTo(expectedFilePermissions)); assertThat(pluginConfigFileAttributes.permissions(), equalTo(expectedFilePermissions));
} }
public void testBinDirectoryOwnerGroupAndPermissions() throws IOException {
assumeTrue("File system does not support permissions, skipping", supportsPermissions);
URL pluginUrl = createPlugin(true, false);
PluginManager pluginManager = new PluginManager(environment, pluginUrl, PluginManager.OutputMode.VERBOSE, TimeValue.timeValueSeconds(10));
pluginManager.downloadAndExtract(pluginName, terminal);
PosixFileAttributes parentFileAttributes = Files.getFileAttributeView(environment.binFile(), PosixFileAttributeView.class).readAttributes();
Path binPath = environment.binFile().resolve(pluginName);
PosixFileAttributes pluginBinDirAttributes = Files.getFileAttributeView(binPath, PosixFileAttributeView.class).readAttributes();
assertThat(pluginBinDirAttributes.owner(), equalTo(parentFileAttributes.owner()));
assertThat(pluginBinDirAttributes.group(), equalTo(parentFileAttributes.group()));
assertThat(pluginBinDirAttributes.permissions(), equalTo(parentFileAttributes.permissions()));
Path executableFile = binPath.resolve("my-binary");
PosixFileAttributes pluginExecutableFileAttributes = Files.getFileAttributeView(executableFile, PosixFileAttributeView.class).readAttributes();
assertThat(pluginExecutableFileAttributes.owner(), equalTo(parentFileAttributes.owner()));
assertThat(pluginExecutableFileAttributes.group(), equalTo(parentFileAttributes.group()));
Set<PosixFilePermission> expectedFilePermissions = new HashSet<>();
expectedFilePermissions.add(OWNER_EXECUTE);
expectedFilePermissions.add(GROUP_EXECUTE);
expectedFilePermissions.add(OTHERS_EXECUTE);
for (PosixFilePermission parentPermission : parentFileAttributes.permissions()) {
switch(parentPermission) {
case OWNER_EXECUTE:
case GROUP_EXECUTE:
case OTHERS_EXECUTE:
break;
default:
expectedFilePermissions.add(parentPermission);
}
}
assertThat(pluginExecutableFileAttributes.permissions(), equalTo(expectedFilePermissions));
}
private URL createPlugin(boolean withBinDir, boolean withConfigDir) throws IOException { private URL createPlugin(boolean withBinDir, boolean withConfigDir) throws IOException {
final Path structure = createTempDir().resolve("fake-plugin"); final Path structure = createTempDir().resolve("fake-plugin");
writeProperties(structure, "description", "fake desc", writeProperties(structure, "description", "fake desc",
@ -301,7 +335,7 @@ public class PluginManagerPermissionTests extends ESTestCase {
// create executable // create executable
Path executable = binDir.resolve("my-binary"); Path executable = binDir.resolve("my-binary");
Files.createFile(executable); Files.createFile(executable);
Files.setPosixFilePermissions(executable, PosixFilePermissions.fromString("rwxr-xr-x")); Files.setPosixFilePermissions(executable, PosixFilePermissions.fromString("rw-r--r--"));
} }
if (withConfigDir) { if (withConfigDir) {
// create bin dir // create bin dir

View File

@ -79,8 +79,13 @@ install_jvm_example() {
local relativePath=${1:-$(readlink -m jvm-example-*.zip)} local relativePath=${1:-$(readlink -m jvm-example-*.zip)}
install_jvm_plugin jvm-example "$relativePath" install_jvm_plugin jvm-example "$relativePath"
assert_file_exist "$ESHOME/bin/jvm-example" #owner group and permissions vary depending on how es was installed
assert_file_exist "$ESHOME/bin/jvm-example/test" #just make sure that everything is the same as the parent bin dir, which was properly set up during install
bin_user=$(find "$ESHOME/bin" -maxdepth 0 -printf "%u")
bin_owner=$(find "$ESHOME/bin" -maxdepth 0 -printf "%g")
bin_privileges=$(find "$ESHOME/bin" -maxdepth 0 -printf "%m")
assert_file "$ESHOME/bin/jvm-example" d $bin_user $bin_owner $bin_privileges
assert_file "$ESHOME/bin/jvm-example/test" f $bin_user $bin_owner $bin_privileges
#owner group and permissions vary depending on how es was installed #owner group and permissions vary depending on how es was installed
#just make sure that everything is the same as $CONFIG_DIR, which was properly set up during install #just make sure that everything is the same as $CONFIG_DIR, which was properly set up during install