-
Notifications
You must be signed in to change notification settings - Fork 443
TEZ-4754: RelocalizationUtils: input handling improvements #537
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.
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
Open
abstractdog
wants to merge
1
commit into
apache:master
Choose a base branch
from
abstractdog:TEZ-4754
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+139
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ | |
| import java.io.IOException; | ||
| import java.net.URI; | ||
| import java.net.URL; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
@@ -58,13 +59,43 @@ public static void addUrlsToClassPath(List<URL> urls) { | |
| ReflectionUtils.addResourcesToSystemClassLoader(urls); | ||
| } | ||
|
|
||
| /** Validate all names up front, so callers can reject before mutating state. */ | ||
| public static void validateDestNames(Collection<String> destNames) { | ||
| if (destNames == null) { | ||
| return; | ||
| } | ||
| for (String destName : destNames) { | ||
| validateDestName(destName); | ||
| } | ||
| } | ||
|
|
||
| private static Path downloadResource(String destName, URI uri, Configuration conf, String destDir) | ||
| throws IOException { | ||
| validateDestName(destName); | ||
| FileSystem fs = FileSystem.get(uri, conf); | ||
| Path cwd = new Path(destDir); | ||
| Path dFile = new Path(cwd, destName); | ||
| Path srcPath = new Path(uri); | ||
| fs.copyToLocalFile(srcPath, dFile); | ||
| return dFile.makeQualified(FileSystem.getLocal(conf).getUri(), cwd); | ||
| } | ||
|
|
||
| static void validateDestName(String destName) { | ||
| if (destName == null || destName.isEmpty()) { | ||
| throw new IllegalArgumentException("Resource name must not be empty"); | ||
| } | ||
| if (destName.indexOf('/') >= 0 || destName.indexOf('\\') >= 0 | ||
| || destName.indexOf('\0') >= 0) { | ||
| throw new IllegalArgumentException( | ||
| "Resource name must not contain path separators: " + destName); | ||
| } | ||
| if (destName.equals(".") || destName.equals("..")) { | ||
| throw new IllegalArgumentException( | ||
| "Resource name must not be a parent-directory reference: " + destName); | ||
| } | ||
| if (new Path(destName).isAbsolute()) { | ||
|
Comment on lines
+87
to
+96
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not true, adding a unit test to prove: |
||
| throw new IllegalArgumentException( | ||
| "Resource name must not be absolute: " + destName); | ||
| } | ||
| } | ||
| } | ||
99 changes: 99 additions & 0 deletions
99
tez-common/src/test/java/org/apache/tez/dag/utils/TestRelocalizationUtils.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.tez.dag.utils; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
|
|
||
| import org.apache.hadoop.fs.Path; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class TestRelocalizationUtils { | ||
|
|
||
| @Test | ||
| public void plainFileNameIsAccepted() { | ||
| assertDoesNotThrow(() -> RelocalizationUtils.validateDestName("lib.jar")); | ||
| assertDoesNotThrow(() -> RelocalizationUtils.validateDestName("some-name_1.tar.gz")); | ||
| } | ||
|
|
||
| @Test | ||
| public void traversalIsRejected() { | ||
| // Any path separator or parent-directory reference must be refused: those | ||
| // are the shapes that let a submitter's key redirect the AM download to | ||
| // a location outside its working directory. | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("../evil.jar")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("dir/child.jar")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("dir\\child.jar")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("/absolute/path.jar")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName(".")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("..")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName("")); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName(null)); | ||
| } | ||
|
|
||
| @Test | ||
| public void validateDestNamesRejectsAnyBadNameInBatch() { | ||
| // One bad name must fail the whole batch, before any download starts. | ||
| assertDoesNotThrow(() -> RelocalizationUtils.validateDestNames( | ||
| Arrays.asList("a.jar", "b.jar"))); | ||
| assertDoesNotThrow(() -> RelocalizationUtils.validateDestNames(null)); | ||
| assertDoesNotThrow( | ||
| () -> RelocalizationUtils.validateDestNames(Collections.emptyList())); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestNames( | ||
| Arrays.asList("ok.jar", "../evil.jar"))); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestNames( | ||
| Arrays.asList("a.jar", "/absolute.jar", "b.jar"))); | ||
| } | ||
|
|
||
| /** | ||
| * A URI-scheme opaque form such as {@code "file:.."} is rejected today: the | ||
| * {@code new Path(destName)} call inside {@link RelocalizationUtils#validateDestName} | ||
| * throws {@link IllegalArgumentException} from Hadoop's URI parser | ||
| * ("Relative path in absolute URI"). And {@code new Path(cwd, "file:..")} | ||
| * — the very next construction in {@code downloadResource} — throws | ||
| * identically, so the value cannot reach {@code copyToLocalFile} and | ||
| * cannot resolve outside {@code cwd}. | ||
| */ | ||
| @Test | ||
| public void uriSchemeOpaqueFormIsRejected() { | ||
| for (String s : new String[]{"file:..", "file:../evil.jar", "file:evil.jar", | ||
| "mailto:x", "C:evil.jar"}) { | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> RelocalizationUtils.validateDestName(s), | ||
| "validateDestName should reject " + s); | ||
| assertThrows(IllegalArgumentException.class, | ||
| () -> new Path(new Path("/tmp/work"), s), | ||
| "new Path(cwd, s) should also throw for " + s); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ack, handling with an upfront check