Use consistent approach for sub-directory checking

apache · Jan 20, 2021 · 74b1056 · 74b1056
1 parent 3f3bf0e
commit 74b1056
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 19 deletions.
diff --git a/java/org/apache/catalina/servlets/DefaultServlet.java b/java/org/apache/catalina/servlets/DefaultServlet.java
@@ -67,6 +67,7 @@
 import org.apache.catalina.Globals;
 import org.apache.catalina.connector.RequestFacade;
 import org.apache.catalina.connector.ResponseFacade;
+import org.apache.catalina.util.FileUtil;
 import org.apache.catalina.util.IOTools;
 import org.apache.catalina.util.RequestUtil;
 import org.apache.catalina.util.ServerInfo;
@@ -1811,7 +1812,7 @@ private File validateGlobalXsltFile(File base) {
 
         // First check that the resulting path is under the provided base
         try {
-            if (!candidate.getCanonicalPath().startsWith(base.getCanonicalPath())) {
+            if (!(new FileUtil(base)).isParentOf(candidate)) {
                 return null;
             }
         } catch (IOException ioe) {

diff --git a/java/org/apache/catalina/session/FileStore.java b/java/org/apache/catalina/session/FileStore.java
@@ -32,6 +32,7 @@
 import org.apache.catalina.Context;
 import org.apache.catalina.Loader;
 import org.apache.catalina.Session;
+import org.apache.catalina.util.FileUtil;
 import org.apache.juli.logging.Log;
 import org.apache.juli.logging.LogFactory;
 import org.apache.tomcat.util.res.StringManager;
@@ -402,9 +403,10 @@ private File file(String id) throws IOException {
 
         String filename = id + FILE_EXT;
         File file = new File(storageDir, filename);
+        FileUtil storageDirUtil = new FileUtil(storageDir);
 
         // Check the file is within the storage directory
-        if (!file.getCanonicalPath().startsWith(storageDir.getCanonicalPath())) {
+        if (!storageDirUtil.isParentOf(file)) {
             log.warn(sm.getString("fileStore.invalid", file.getPath(), id));
             return null;
         }

diff --git a/java/org/apache/catalina/startup/ContextConfig.java b/java/org/apache/catalina/startup/ContextConfig.java
@@ -75,6 +75,7 @@
 import org.apache.catalina.deploy.ServletDef;
 import org.apache.catalina.deploy.WebXml;
 import org.apache.catalina.util.ContextName;
+import org.apache.catalina.util.FileUtil;
 import org.apache.catalina.util.Introspection;
 import org.apache.juli.logging.Log;
 import org.apache.juli.logging.LogFactory;
@@ -761,7 +762,7 @@ protected void fixDocBase() throws IOException {
             }
         }
 
-        if (docBase.startsWith(canonicalAppBase.getPath() + File.separatorChar)) {
+        if ((new FileUtil(canonicalAppBase)).isParentOf(docBase)) {
             docBase = docBase.substring(canonicalAppBase.getPath().length());
             docBase = docBase.replace(File.separatorChar, '/');
             if (docBase.startsWith("/")) {

diff --git a/java/org/apache/catalina/startup/ExpandWar.java b/java/org/apache/catalina/startup/ExpandWar.java
@@ -34,6 +34,7 @@
 
 import org.apache.catalina.Globals;
 import org.apache.catalina.Host;
+import org.apache.catalina.util.FileUtil;
 import org.apache.juli.logging.Log;
 import org.apache.juli.logging.LogFactory;
 import org.apache.tomcat.util.ExceptionUtils;
@@ -98,10 +99,7 @@ public static String expand(Host host, URL war, String pathname)
             throw new IOException(sm.getString("expandWar.createFailed", docBase));
 
         // Expand the WAR into the new document base directory
-        String canonicalDocBasePrefix = docBase.getCanonicalPath();
-        if (!canonicalDocBasePrefix.endsWith(File.separator)) {
-            canonicalDocBasePrefix += File.separator;
-        }
+        FileUtil docBaseUtil = new FileUtil(docBase);
         JarURLConnection juc = (JarURLConnection) war.openConnection();
         juc.setUseCaches(false);
         JarFile jarFile = null;
@@ -114,14 +112,13 @@ public static String expand(Host host, URL war, String pathname)
                 JarEntry jarEntry = jarEntries.nextElement();
                 String name = jarEntry.getName();
                 File expandedFile = new File(docBase, name);
-                if (!expandedFile.getCanonicalPath().startsWith(
-                        canonicalDocBasePrefix)) {
+                if (!docBaseUtil.isParentOf(expandedFile)) {
                     // Trying to expand outside the docBase
                     // Throw an exception to stop the deployment
                     throw new IllegalArgumentException(
                             sm.getString("expandWar.illegalPath",war, name,
                                     expandedFile.getCanonicalPath(),
-                                    canonicalDocBasePrefix));
+                                    docBaseUtil.getCanonicalPath()));
                 }
                 int last = name.lastIndexOf('/');
                 if (last >= 0) {
@@ -209,10 +206,7 @@ public static void validate(Host host, URL war, String pathname)
         File docBase = new File(appBase, pathname);
 
         // Calculate the document base directory
-        String canonicalDocBasePrefix = docBase.getCanonicalPath();
-        if (!canonicalDocBasePrefix.endsWith(File.separator)) {
-            canonicalDocBasePrefix += File.separator;
-        }
+        FileUtil docBaseUtil = new FileUtil(docBase);
         JarURLConnection juc = (JarURLConnection) war.openConnection();
         juc.setUseCaches(false);
         JarFile jarFile = null;
@@ -223,14 +217,13 @@ public static void validate(Host host, URL war, String pathname)
                 JarEntry jarEntry = jarEntries.nextElement();
                 String name = jarEntry.getName();
                 File expandedFile = new File(docBase, name);
-                if (!expandedFile.getCanonicalPath().startsWith(
-                        canonicalDocBasePrefix)) {
+                if (!docBaseUtil.isParentOf(expandedFile)) {
                     // Entry located outside the docBase
                     // Throw an exception to stop the deployment
                     throw new IllegalArgumentException(
                             sm.getString("expandWar.illegalPath",war, name,
                                     expandedFile.getCanonicalPath(),
-                                    canonicalDocBasePrefix));
+                                    docBaseUtil.getCanonicalPath()));
                 }
             }
         } catch (IOException e) {

diff --git a/java/org/apache/catalina/startup/HostConfig.java b/java/org/apache/catalina/startup/HostConfig.java
@@ -65,6 +65,7 @@
 import org.apache.catalina.core.StandardHost;
 import org.apache.catalina.security.DeployXmlPermission;
 import org.apache.catalina.util.ContextName;
+import org.apache.catalina.util.FileUtil;
 import org.apache.catalina.util.IOTools;
 import org.apache.juli.logging.Log;
 import org.apache.juli.logging.LogFactory;
@@ -690,8 +691,8 @@ protected void deployDescriptor(ContextName cn, File contextXml) {
                     docBase = new File(appBase(), context.getDocBase());
                 }
                 // If external docBase, register .xml as redeploy first
-                if (!docBase.getCanonicalPath().startsWith(
-                        appBase().getAbsolutePath() + File.separator)) {
+                FileUtil appBaseUtil = new FileUtil(appBase());
+                if (!appBaseUtil.isParentOf(docBase)) {
                     isExternal = true;
                     deployedApp.redeployResources.put(
                             contextXml.getAbsolutePath(),

diff --git a/java/org/apache/catalina/util/FileUtil.java b/java/org/apache/catalina/util/FileUtil.java
@@ -0,0 +1,50 @@
+/*
+ * 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.catalina.util;
+
+import java.io.File;
+import java.io.IOException;
+
+public class FileUtil {
+
+    private final String canonicalPath;
+
+    public FileUtil(File f) throws IOException {
+        String path = f.getCanonicalPath();
+        if (!path.endsWith(File.pathSeparator)) {
+            path += File.pathSeparatorChar;
+        }
+
+        canonicalPath = path;
+    }
+
+
+    public String getCanonicalPath() {
+        return canonicalPath;
+    }
+
+
+    public boolean isParentOf(File child) throws IOException {
+        return isParentOf(child.getCanonicalPath());
+    }
+
+
+    public boolean isParentOf(String childPath) {
+        return childPath.startsWith(canonicalPath);
+    }
+}
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
@@ -174,6 +174,10 @@
         authority are typical examples that may need to be adjusted in some
         cases. (markt)
       </fix>
+      <scode>
+        Test for one directory being a sub-directory of another in a consistent
+        way. (markt)
+      </scode>
     </changelog>
   </subsection>
   <subsection name="Other">