Skip to content

Commit

Permalink
Fix BZ 64871. Log if file access is blocked due to symlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
markt-asf committed Nov 6, 2020
1 parent 3e872f0 commit 800b031
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
15 changes: 14 additions & 1 deletion java/org/apache/naming/resources/FileDirContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,19 @@ protected File validate(File file, String name, boolean mustExist, String absolu
canPath = normalize(canPath);
}
if (!canPath.equals(absPath)) {
if (!canPath.equalsIgnoreCase(absPath)) {
// Typically means symlinks are in use but being ignored. Given
// the symlink was likely created for a reason, log a warning
// that it was ignored.
String msg = sm.getString("fileDirContext.canonicalfileCheckFailed",
getDocBase(), absPath, canPath);
// Log issues with configuration files at a higher level
if(absPath.startsWith("/META-INF/") || absPath.startsWith("/WEB-INF/")) {
log.error(msg);
} else {
log.warn(msg);
}
}
return null;
}

Expand All @@ -900,7 +913,7 @@ private boolean isInvalidWindowsFilename(String name) {
// expression irrespective of input length.
for (int i = 0; i < len; i++) {
char c = name.charAt(i);
if (c == '\"' || c == '<' || c == '>') {
if (c == '\"' || c == '<' || c == '>' || c == ':') {
// These characters are disallowed in Windows file names and
// there are known problems for file names with these characters
// when using File#getCanonicalPath().
Expand Down
2 changes: 2 additions & 0 deletions java/org/apache/naming/resources/LocalStrings.properties
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

classpathUrlStreamHandler.notFound=Unable to load the resource [{0}] using the thread context class loader or the current class''s class loader

fileDirContext.canonicalfileCheckFailed=Resource for web application [{0}] at path [{1}] was not loaded as the canonical path [{2}] did not match. Use of symlinks is one possible cause.

fileResources.base=Document base [{0}] does not exist or is not a readable directory
fileResources.canonical.fail=A canonical path could not be determined for [{0}]
fileResources.listingNull=Could not get dir listing for [{0}]
Expand Down
4 changes: 4 additions & 0 deletions webapps/docs/changelog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@
<bug>64805</bug>: Correct imports used by <code>JMXProxyServlet</code>.
(markt)
</fix>
<add>
<bug>64871</bug>: Log a warning if Tomcat blocks access to a file
because it uses symlinks. (markt)
</add>
</changelog>
</subsection>
<subsection name="Coyote">
Expand Down

0 comments on commit 800b031

Please sign in to comment.