Author: jfrederic.clere(a)jboss.com Date: 2010-02-10 07:35:31 -0500 (Wed, 10 Feb 2010) New Revision: 1383 Modified: trunk/java/org/apache/catalina/loader/LocalStrings.properties trunk/java/org/apache/catalina/loader/WebappClassLoader.java trunk/java/org/apache/catalina/startup/ContextConfig.java trunk/java/org/apache/catalina/startup/ExpandWar.java trunk/java/org/apache/catalina/startup/HostConfig.java trunk/java/org/apache/catalina/startup/LocalStrings.properties trunk/webapps/docs/changelog.xml Log: Port 892815 (even we don't use that part). Modified: trunk/java/org/apache/catalina/loader/LocalStrings.properties =================================================================== --- trunk/java/org/apache/catalina/loader/LocalStrings.properties 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/loader/LocalStrings.properties 2010-02-10 12:35:31 UTC (rev 1383) @@ -13,7 +13,9 @@ standardLoader.removeRepository=Removing repository {0} standardLoader.starting=Starting this Loader standardLoader.stopping=Stopping this Loader +webappClassLoader.illegalJarPath=Illegal JAR entry detected with name {0} webappClassLoader.stopped=Illegal access: this web application instance has been stopped already. Could not load {0}. The eventual following stack trace is caused by an error thrown for debugging purposes as well as to attempt to terminate the thread which caused the illegal access, and has no functional impact. +webappClassLoader.validationErrorJarPath=Unable to validate JAR entry with name {0} webappLoader.addRepository=Adding repository {0} webappLoader.deploy=Deploying class repositories to work directory {0} webappLoader.jarDeploy=Deploy JAR {0} to {1} Modified: trunk/java/org/apache/catalina/loader/WebappClassLoader.java =================================================================== --- trunk/java/org/apache/catalina/loader/WebappClassLoader.java 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/loader/WebappClassLoader.java 2010-02-10 12:35:31 UTC (rev 1383) @@ -284,8 +284,8 @@ * Path where resources loaded from JARs will be extracted. */ protected File loaderDir = null; + protected String canonicalLoaderDir = null; - /** * The PermissionCollection for each CodeSource for a web * application context. @@ -442,6 +442,18 @@ */ public void setWorkDir(File workDir) { this.loaderDir = new File(workDir, "loader"); + if (loaderDir == null) { + canonicalLoaderDir = null; + } else { + try { + canonicalLoaderDir = loaderDir.getCanonicalPath(); + if (!canonicalLoaderDir.endsWith(File.separator)) { + canonicalLoaderDir += File.separator; + } + } catch (IOException ioe) { + canonicalLoaderDir = null; + } + } } /** @@ -1514,6 +1526,18 @@ && (!jarEntry2.getName().endsWith(".class"))) { resourceFile = new File (loaderDir, jarEntry2.getName()); + try { + if (!resourceFile.getCanonicalPath().startsWith( + canonicalLoaderDir)) { + throw new IllegalArgumentException( + sm.getString("webappClassLoader.illegalJarPath", + jarEntry2.getName())); + } + } catch (IOException ioe) { + throw new IllegalArgumentException( + sm.getString("webappClassLoader.validationErrorJarPath", + jarEntry2.getName()), ioe); + } resourceFile.getParentFile().mkdirs(); FileOutputStream os = null; InputStream is = null; Modified: trunk/java/org/apache/catalina/startup/ContextConfig.java =================================================================== --- trunk/java/org/apache/catalina/startup/ContextConfig.java 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/startup/ContextConfig.java 2010-02-10 12:35:31 UTC (rev 1383) @@ -1618,9 +1618,8 @@ if (contextPath.equals("")) { contextPath = "ROOT"; } else { - if (contextPath.lastIndexOf('/') > 0) { - contextPath = "/" + contextPath.substring(1).replace('/','#'); - } + // Context path must start with '/' + contextPath = "/" + contextPath.substring(1).replace('/','#'); } if (docBase.toLowerCase().endsWith(".war") && !file.isDirectory() && unpackWARs) { URL war = new URL("jar:" + (new File(docBase)).toURI().toURL() + "!/"); @@ -1630,18 +1629,24 @@ if (context instanceof StandardContext) { ((StandardContext) context).setOriginalDocBase(origDocBase); } + } else if (docBase.toLowerCase().endsWith(".war") && + !file.isDirectory() && !unpackWARs) { + URL war = + new URL("jar:" + (new File (docBase)).toURI().toURL() + "!/"); + ExpandWar.validate(host, war, contextPath); } else { File docDir = new File(docBase); if (!docDir.exists()) { File warFile = new File(docBase + ".war"); + URL war = new URL("jar:" + warFile.toURI().toURL() + "!/"); if (warFile.exists()) { if (unpackWARs) { - URL war = new URL("jar:" + warFile.toURI().toURL() + "!/"); docBase = ExpandWar.expand(host, war, contextPath); file = new File(docBase); docBase = file.getCanonicalPath(); } else { docBase = warFile.getCanonicalPath(); + ExpandWar.validate(host, war, contextPath); } } if (context instanceof StandardContext) { @@ -2055,7 +2060,8 @@ if (!docBaseFile.isAbsolute()) { docBaseFile = new File(appBase, docBase); } - ExpandWar.delete(docBaseFile); + // No need to log failure - it is expected in this case + ExpandWar.delete(docBaseFile, false); } overlays.clear(); Modified: trunk/java/org/apache/catalina/startup/ExpandWar.java =================================================================== --- trunk/java/org/apache/catalina/startup/ExpandWar.java 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/startup/ExpandWar.java 2010-02-10 12:35:31 UTC (rev 1383) @@ -105,7 +105,8 @@ * (must start with "jar:") * @param pathname Context path name for web application * - * @exception IllegalArgumentException if this is not a "jar:" URL + * @exception IllegalArgumentException if this is not a "jar:" URL or if the + * WAR file is invalid * @exception IOException if an input/output error was encountered * during expansion */ @@ -123,6 +124,7 @@ (sm.getString("hostConfig.appBase", appBase.getAbsolutePath())); } + File docBase = new File(appBase, pathname); if (docBase.exists()) { // War file is already installed @@ -133,16 +135,29 @@ docBase.mkdir(); // Expand the WAR into the new document base directory + String canonicalDocBasePrefix = docBase.getCanonicalPath(); + if (!canonicalDocBasePrefix.endsWith(File.separator)) { + canonicalDocBasePrefix += File.separator; + } JarURLConnection juc = (JarURLConnection) war.openConnection(); juc.setUseCaches(false); JarFile jarFile = null; InputStream input = null; + boolean success = false; try { jarFile = juc.getJarFile(); Enumeration jarEntries = jarFile.entries(); while (jarEntries.hasMoreElements()) { JarEntry jarEntry = (JarEntry) jarEntries.nextElement(); String name = jarEntry.getName(); + File expandedFile = new File(docBase, name); + if (!expandedFile.getCanonicalPath().startsWith( + canonicalDocBasePrefix)) { + // Trying to expand outside the docBase + // Throw an exception to stop the deployment + throw new IllegalArgumentException( + sm.getString("expandWar.illegalPath",war, name)); + } int last = name.lastIndexOf('/'); if (last >= 0) { File parent = new File(docBase, @@ -155,21 +170,24 @@ input = jarFile.getInputStream(jarEntry); // Bugzilla 33636 - File expandedFile = expand(input, docBase, name); + expand(input, expandedFile); long lastModified = jarEntry.getTime(); - if ((lastModified != -1) && (lastModified != 0) && (expandedFile != null)) { + if ((lastModified != -1) && (lastModified != 0)) { expandedFile.setLastModified(lastModified); } input.close(); input = null; } + success = true; } catch (IOException e) { - // If something went wrong, delete expanded dir to keep things - // clean - deleteDir(docBase); throw e; } finally { + if (!success) { + // If something went wrong, delete expanded dir to keep things + // clean + deleteDir(docBase); + } if (input != null) { try { input.close(); @@ -195,6 +213,69 @@ /** + * Validate the WAR file found at the specified URL. + * + * @param host Host war is being installed for + * @param war URL of the web application archive to be validated + * (must start with "jar:") + * @param pathname Context path name for web application + * + * @exception IllegalArgumentException if this is not a "jar:" URL or if the + * WAR file is invalid + * @exception IOException if an input/output error was encountered + * during validation + */ + public static void validate(Host host, URL war, String pathname) + throws IOException { + + // Make the appBase absolute + File appBase = new File(host.getAppBase()); + if (!appBase.isAbsolute()) { + appBase = new File(System.getProperty("catalina.base"), + host.getAppBase()); + } + + File docBase = new File(appBase, pathname); + + // Calculate the document base directory + String canonicalDocBasePrefix = docBase.getCanonicalPath(); + if (!canonicalDocBasePrefix.endsWith(File.separator)) { + canonicalDocBasePrefix += File.separator; + } + JarURLConnection juc = (JarURLConnection) war.openConnection(); + juc.setUseCaches(false); + JarFile jarFile = null; + try { + jarFile = juc.getJarFile(); + Enumeration<JarEntry> jarEntries = jarFile.entries(); + while (jarEntries.hasMoreElements()) { + JarEntry jarEntry = jarEntries.nextElement(); + String name = jarEntry.getName(); + File expandedFile = new File(docBase, name); + if (!expandedFile.getCanonicalPath().startsWith( + canonicalDocBasePrefix)) { + // Entry located outside the docBase + // Throw an exception to stop the deployment + throw new IllegalArgumentException( + sm.getString("expandWar.illegalPath",war, name)); + } + } + } catch (IOException e) { + throw e; + } finally { + if (jarFile != null) { + try { + jarFile.close(); + } catch (Throwable t) { + // Ignore + } + jarFile = null; + } + } + } + + + /** * Copy the specified file or directory to the destination. * * @param src File object representing the source @@ -254,27 +335,62 @@ /** * Delete the specified directory, including all of its contents and - * subdirectories recursively. + * sub-directories recursively. Any failure will be logged. * * @param dir File object representing the directory to be deleted */ public static boolean delete(File dir) { + // Log failure by default + return delete(dir, true); + } + + /** + * Delete the specified directory, including all of its contents and + * sub-directories recursively. + * + * @param dir File object representing the directory to be deleted + * @param logFailure <code>true</code> if failure to delete the resource + * should be logged + */ + public static boolean delete(File dir, boolean logFailure) { + boolean result; if (dir.isDirectory()) { - return deleteDir(dir); + result = deleteDir(dir, logFailure); } else { - return dir.delete(); + if (dir.exists()) { + result = dir.delete(); + } else { + result = true; + } } + if (logFailure && !result) { + log.error(sm.getString( + "expandWar.deleteFailed", dir.getAbsolutePath())); + } + return result; } /** * Delete the specified directory, including all of its contents and - * subdirectories recursively. + * sub-directories recursively. Any failure will be logged. * * @param dir File object representing the directory to be deleted */ public static boolean deleteDir(File dir) { + return deleteDir(dir, true); + } + /** + * Delete the specified directory, including all of its contents and + * sub-directories recursively. + * + * @param dir File object representing the directory to be deleted + * @param logFailure <code>true</code> if failure to delete the resource + * should be logged + */ + public static boolean deleteDir(File dir, boolean logFailure) { + String files[] = dir.list(); if (files == null) { files = new String[0]; @@ -282,13 +398,26 @@ for (int i = 0; i < files.length; i++) { File file = new File(dir, files[i]); if (file.isDirectory()) { - deleteDir(file); + deleteDir(file, logFailure); } else { file.delete(); } } - return dir.delete(); + boolean result; + if (dir.exists()) { + result = dir.delete(); + } else { + result = true; + } + + if (logFailure && !result) { + log.error(sm.getString( + "expandWar.deleteFailed", dir.getAbsolutePath())); + } + + return result; + } @@ -302,11 +431,27 @@ * @return A handle to the expanded File * * @exception IOException if an input/output error occurs + * + * @deprecated */ protected static File expand(InputStream input, File docBase, String name) throws IOException { + File file = new File(docBase, name); + expand(input, file); + return file; + } - File file = new File(docBase, name); + + /** + * Expand the specified input stream into the specified file. + * + * @param input InputStream to be copied + * @param file The file to be created + * + * @exception IOException if an input/output error occurs + */ + private static void expand(InputStream input, File file) + throws IOException { BufferedOutputStream output = null; try { output = @@ -327,8 +472,6 @@ } } } - - return file; } Modified: trunk/java/org/apache/catalina/startup/HostConfig.java =================================================================== --- trunk/java/org/apache/catalina/startup/HostConfig.java 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/startup/HostConfig.java 2010-02-10 12:35:31 UTC (rev 1383) @@ -28,7 +28,9 @@ import java.io.OutputStream; import java.util.ArrayList; import java.util.HashMap; +import java.util.HashSet; import java.util.LinkedHashMap; +import java.util.Set; import java.util.jar.JarEntry; import java.util.jar.JarFile; @@ -141,6 +143,11 @@ */ protected static Digester digester = createDigester(); + /** + * The list of Wars in the appBase to be ignored because they are invalid + * (e.g. contain /../ sequences). + */ + protected Set<String> invalidWars = new HashSet<String>(); // ------------------------------------------------------------- Properties @@ -656,13 +663,22 @@ if (files[i].equalsIgnoreCase("WEB-INF")) continue; File dir = new File(appBase, files[i]); - if (files[i].toLowerCase().endsWith(".war") && dir.isFile()) { + if (files[i].toLowerCase().endsWith(".war") && dir.isFile() + && !invalidWars.contains(files[i]) ) { // Calculate the context path and make sure it is unique String contextPath = "/" + files[i].replace('#','/'); int period = contextPath.lastIndexOf("."); - if (period >= 0) - contextPath = contextPath.substring(0, period); + contextPath = contextPath.substring(0, period); + + // Check for WARs with /../ /./ or similar sequences in the name + if (!validateContextPath(appBase, contextPath)) { + log.error(sm.getString( + "hostConfig.illegalWarName", files[i])); + invalidWars.add(files[i]); + continue; + } + if (contextPath.equals("/ROOT")) contextPath = ""; @@ -680,6 +696,42 @@ } + private boolean validateContextPath(File appBase, String contextPath) { + // More complicated than the ideal as the canonical path may or may + // not end with File.separator for a directory + + StringBuilder docBase; + String canonicalDocBase = null; + + try { + String canonicalAppBase = appBase.getCanonicalPath(); + docBase = new StringBuilder(canonicalAppBase); + if (canonicalAppBase.endsWith(File.separator)) { + docBase.append(contextPath.substring(1).replace( + '/', File.separatorChar)); + } else { + docBase.append(contextPath.replace('/', File.separatorChar)); + } + // At this point docBase should be canonical but will not end + // with File.separator + + canonicalDocBase = + (new File(docBase.toString())).getCanonicalPath(); + + // If the canonicalDocBase ends with File.separator, add one to + // docBase before they are compared + if (canonicalDocBase.endsWith(File.separator)) { + docBase.append(File.separator); + } + } catch (IOException ioe) { + return false; + } + + // Compare the two. If they are not the same, the contextPath must + // have /../ like sequences in it + return canonicalDocBase.equals(docBase.toString()); + } + /** * @param contextPath * @param war Modified: trunk/java/org/apache/catalina/startup/LocalStrings.properties =================================================================== --- trunk/java/org/apache/catalina/startup/LocalStrings.properties 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/java/org/apache/catalina/startup/LocalStrings.properties 2010-02-10 12:35:31 UTC (rev 1383) @@ -47,6 +47,8 @@ engineConfig.start=EngineConfig: Processing START engineConfig.stop=EngineConfig: Processing STOP expandWar.copy=Error copying {0} to {1} +expandWar.deleteFailed=[{0}] could not be completely deleted. The presence of the remaining files may cause problems +expandWar.illegalPath=The archive [{0}] is malformed and will be ignored: an entry contains an illegal path [{1}] hostConfig.appBase=Application base directory {0} does not exist hostConfig.canonicalizing=Error delete redeploy resources from context [{0}] hostConfig.cce=Lifecycle event data object {0} is not a Host @@ -66,6 +68,7 @@ hostConfig.expand=Expanding web application archive {0} hostConfig.expand.error=Exception while expanding web application archive {0} hostConfig.expanding=Expanding discovered web application archives +hostConfig.illegalWarName=The war name [{0}] is invalid. The archive will be ignored. hostConfig.jmx.register=Register context [{0}] failed hostConfig.jmx.unregister=Unregister context [{0}] failed hostConfig.reload=Reloading context [{0}] Modified: trunk/webapps/docs/changelog.xml =================================================================== --- trunk/webapps/docs/changelog.xml 2010-02-10 09:38:30 UTC (rev 1382) +++ trunk/webapps/docs/changelog.xml 2010-02-10 12:35:31 UTC (rev 1383) @@ -70,6 +70,12 @@ <add> On demand webapp startup plumbing, submitted by Brian Stansberry. (remm) </add> + <fix> + Various (un)deployment related improvements including better handling of + failed (un)deployment, additional checking for valid zip entries that + don't make sense in a WAR and improved validation of WAR file names. + (markt) + </fix> </changelog> </subsection> <subsection name="Jasper">