Skip to content

Commit 26358e3

Browse files
authored
Error if installed plugin is inside plugins folder (elastic#137398) (elastic#137509)
* Error if installed plugin is inside plugins folder If a non directory file is in the plugins folder during installation, there will be a non descriptive error during findBundle, as it assumes everything is a directory. This new preemptive check adds a descripive error message to avoid this scenario. Also, for consistency and to not use a deprecated URL constructor, in the download method we now use URI. Closes elastic#27401
1 parent a53d6e2 commit 26358e3

File tree

3 files changed

+54
-9
lines changed

3 files changed

+54
-9
lines changed

distribution/tools/plugin-cli/src/main/java/org/elasticsearch/plugins/cli/InstallPluginAction.java

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
import java.nio.file.FileVisitResult;
6464
import java.nio.file.Files;
6565
import java.nio.file.Path;
66+
import java.nio.file.Paths;
6667
import java.nio.file.SimpleFileVisitor;
6768
import java.nio.file.StandardCopyOption;
6869
import java.nio.file.attribute.BasicFileAttributes;
@@ -329,10 +330,31 @@ private Path download(InstallablePlugin plugin, Path tmpDir) throws Exception {
329330
}
330331
throw new UserException(ExitCodes.USAGE, msg);
331332
}
333+
334+
verifyLocationNotInPluginsDirectory(pluginLocation);
335+
332336
terminal.println(logPrefix + "Downloading " + URLDecoder.decode(pluginLocation, StandardCharsets.UTF_8));
333337
return downloadZip(pluginLocation, tmpDir);
334338
}
335339

340+
@SuppressForbidden(reason = "Need to use Paths#get")
341+
private void verifyLocationNotInPluginsDirectory(String pluginLocation) throws URISyntaxException, IOException, UserException {
342+
if (pluginLocation == null) {
343+
return;
344+
}
345+
URI uri = new URI(pluginLocation);
346+
if ("file".equalsIgnoreCase(uri.getScheme())) {
347+
Path pluginRealPath = Paths.get(uri).toRealPath();
348+
Path pluginsDirectory = env.pluginsDir().toRealPath();
349+
if (pluginRealPath.startsWith(pluginsDirectory)) {
350+
throw new UserException(
351+
ExitCodes.USAGE,
352+
"Installation of plugin in location [" + pluginLocation + "] from inside the plugins directory is not permitted."
353+
);
354+
}
355+
}
356+
}
357+
336358
@SuppressForbidden(reason = "Need to use PathUtils#get")
337359
private Path getPluginArchivePath(String pluginId, String pluginArchiveDir) throws UserException {
338360
final Path path = PathUtils.get(pluginArchiveDir);
@@ -462,9 +484,9 @@ private static List<String> checkMisspelledPlugin(String pluginId) {
462484
/** Downloads a zip from the url, into a temp file under the given temp dir. */
463485
// pkg private for tests
464486
@SuppressForbidden(reason = "We use getInputStream to download plugins")
465-
Path downloadZip(String urlString, Path tmpDir) throws IOException {
487+
Path downloadZip(String urlString, Path tmpDir) throws IOException, URISyntaxException {
466488
terminal.println(VERBOSE, "Retrieving zip from " + urlString);
467-
URL url = new URL(urlString);
489+
URL url = new URI(urlString).toURL();
468490
Path zip = Files.createTempFile(tmpDir, null, ".zip");
469491
URLConnection urlConnection = this.proxy == null ? url.openConnection() : url.openConnection(this.proxy);
470492
urlConnection.addRequestProperty("User-Agent", "elasticsearch-plugin-installer");
@@ -548,9 +570,10 @@ private InputStream urlOpenStream(final URL url) throws IOException {
548570
* @throws IOException if an I/O exception occurs download or reading files and resources
549571
* @throws PGPException if an exception occurs verifying the downloaded ZIP signature
550572
* @throws UserException if checksum validation fails
573+
* @throws URISyntaxException is the url is invalid
551574
*/
552575
private Path downloadAndValidate(final String urlString, final Path tmpDir, final boolean officialPlugin) throws IOException,
553-
PGPException, UserException {
576+
PGPException, UserException, URISyntaxException {
554577
Path zip = downloadZip(urlString, tmpDir);
555578
pathsToDeleteOnShutdown.add(zip);
556579
String checksumUrlString = urlString + ".sha512";

distribution/tools/plugin-cli/src/test/java/org/elasticsearch/plugins/cli/InstallPluginActionTests.java

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,18 @@
6666
import java.io.BufferedReader;
6767
import java.io.ByteArrayInputStream;
6868
import java.io.ByteArrayOutputStream;
69-
import java.io.FileNotFoundException;
7069
import java.io.IOException;
7170
import java.io.InputStream;
7271
import java.io.StringReader;
73-
import java.net.MalformedURLException;
7472
import java.net.URI;
73+
import java.net.URISyntaxException;
7574
import java.net.URL;
7675
import java.nio.charset.StandardCharsets;
7776
import java.nio.file.DirectoryStream;
7877
import java.nio.file.FileAlreadyExistsException;
7978
import java.nio.file.FileSystem;
8079
import java.nio.file.Files;
80+
import java.nio.file.NoSuchFileException;
8181
import java.nio.file.Path;
8282
import java.nio.file.StandardCopyOption;
8383
import java.nio.file.attribute.GroupPrincipal;
@@ -552,8 +552,8 @@ public void testTransaction() throws Exception {
552552
pluginZip.getId() + "-does-not-exist",
553553
pluginZip.getLocation() + "-does-not-exist"
554554
);
555-
final FileNotFoundException e = expectThrows(
556-
FileNotFoundException.class,
555+
final NoSuchFileException e = expectThrows(
556+
NoSuchFileException.class,
557557
() -> installPlugins(List.of(pluginZip, nonexistentPluginZip), env.v1())
558558
);
559559
assertThat(e.getMessage(), containsString("does-not-exist"));
@@ -586,11 +586,27 @@ public void testSpaceInUrl() throws Exception {
586586
assertPlugin("fake", pluginDir, env.v2());
587587
}
588588

589+
public void testCannotInstallFromInsidePluginsDirectory() throws Exception {
590+
InstallablePlugin pluginZip = createPluginZip("fake", pluginDir);
591+
Path pluginZipInsidePlugins = env.v2().pluginsDir().resolve("fake.zip");
592+
try (InputStream in = FileSystemUtils.openFileURLStream(new URL(pluginZip.getLocation()))) {
593+
Files.copy(in, pluginZipInsidePlugins, StandardCopyOption.REPLACE_EXISTING);
594+
}
595+
String location = pluginZipInsidePlugins.toUri().toURL().toString();
596+
assumeTrue("requires file URL scheme", location.startsWith("file:"));
597+
InstallablePlugin modifiedPlugin = new InstallablePlugin("fake", location);
598+
UserException e = expectThrows(UserException.class, () -> installPlugin(modifiedPlugin));
599+
assertThat(
600+
e.getMessage(),
601+
startsWith("Installation of plugin in location [" + location + "] from inside the plugins directory is not permitted.")
602+
);
603+
}
604+
589605
public void testMalformedUrlNotMaven() {
590606
// has two colons, so it appears similar to maven coordinates
591607
InstallablePlugin plugin = new InstallablePlugin("fake", "://host:1234");
592-
MalformedURLException e = expectThrows(MalformedURLException.class, () -> installPlugin(plugin));
593-
assertThat(e.getMessage(), containsString("no protocol"));
608+
URISyntaxException e = expectThrows(URISyntaxException.class, () -> installPlugin(plugin));
609+
assertThat(e.getMessage(), containsString("Expected scheme name"));
594610
}
595611

596612
public void testFileNotMaven() {

docs/changelog/137398.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
pr: 137398
2+
summary: Error if installed plugin is inside plugins folder
3+
area: Infra/Plugins
4+
type: enhancement
5+
issues:
6+
- 27401

0 commit comments

Comments
 (0)