Jetty 10.0.x 6497 alias checkers alt (#6681)
* Issue #6497 - Replace the Alias checkers with new implementation. Signed-off-by: Lachlan Roberts <lachlan@webtide.com> Signed-off-by: Greg Wilkins <gregw@webtide.com> Co-authored-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
parent
6ee9940a7a
commit
aa793eeafe
|
@ -43,6 +43,8 @@ import org.eclipse.jetty.toolchain.test.jupiter.WorkDir;
|
||||||
import org.eclipse.jetty.toolchain.test.jupiter.WorkDirExtension;
|
import org.eclipse.jetty.toolchain.test.jupiter.WorkDirExtension;
|
||||||
import org.eclipse.jetty.util.BufferUtil;
|
import org.eclipse.jetty.util.BufferUtil;
|
||||||
import org.eclipse.jetty.util.IO;
|
import org.eclipse.jetty.util.IO;
|
||||||
|
import org.eclipse.jetty.util.resource.PathResource;
|
||||||
|
import org.eclipse.jetty.util.resource.Resource;
|
||||||
import org.junit.jupiter.api.Assertions;
|
import org.junit.jupiter.api.Assertions;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.junit.jupiter.api.TestInfo;
|
import org.junit.jupiter.api.TestInfo;
|
||||||
|
@ -545,4 +547,59 @@ public class IOTest
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testSymbolicLink(TestInfo testInfo) throws Exception
|
||||||
|
{
|
||||||
|
File dir = MavenTestingUtils.getTargetTestingDir(testInfo.getDisplayName());
|
||||||
|
FS.ensureEmpty(dir);
|
||||||
|
File realFile = new File(dir, "real");
|
||||||
|
Path realPath = realFile.toPath();
|
||||||
|
FS.touch(realFile);
|
||||||
|
|
||||||
|
File linkFile = new File(dir, "link");
|
||||||
|
Path linkPath = linkFile.toPath();
|
||||||
|
Files.createSymbolicLink(linkPath, realPath);
|
||||||
|
Path targPath = linkPath.toRealPath();
|
||||||
|
|
||||||
|
System.err.printf("realPath = %s%n", realPath);
|
||||||
|
System.err.printf("linkPath = %s%n", linkPath);
|
||||||
|
System.err.printf("targPath = %s%n", targPath);
|
||||||
|
|
||||||
|
assertFalse(Files.isSymbolicLink(realPath));
|
||||||
|
assertTrue(Files.isSymbolicLink(linkPath));
|
||||||
|
|
||||||
|
Resource link = new PathResource(dir).addPath("link");
|
||||||
|
assertThat(link.isAlias(), is(true));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testSymbolicLinkDir(TestInfo testInfo) throws Exception
|
||||||
|
{
|
||||||
|
File dir = MavenTestingUtils.getTargetTestingDir(testInfo.getDisplayName());
|
||||||
|
FS.ensureEmpty(dir);
|
||||||
|
|
||||||
|
File realDirFile = new File(dir, "real");
|
||||||
|
Path realDirPath = realDirFile.toPath();
|
||||||
|
Files.createDirectories(realDirPath);
|
||||||
|
|
||||||
|
File linkDirFile = new File(dir, "link");
|
||||||
|
Path linkDirPath = linkDirFile.toPath();
|
||||||
|
Files.createSymbolicLink(linkDirPath, realDirPath);
|
||||||
|
|
||||||
|
File realFile = new File(realDirFile, "file");
|
||||||
|
Path realPath = realFile.toPath();
|
||||||
|
FS.touch(realFile);
|
||||||
|
|
||||||
|
File linkFile = new File(linkDirFile, "file");
|
||||||
|
Path linkPath = linkFile.toPath();
|
||||||
|
Path targPath = linkPath.toRealPath();
|
||||||
|
|
||||||
|
System.err.printf("realPath = %s%n", realPath);
|
||||||
|
System.err.printf("linkPath = %s%n", linkPath);
|
||||||
|
System.err.printf("targPath = %s%n", targPath);
|
||||||
|
|
||||||
|
assertFalse(Files.isSymbolicLink(realPath));
|
||||||
|
assertFalse(Files.isSymbolicLink(linkPath));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -351,18 +351,18 @@ public class MavenWebAppContext extends WebAppContext
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Resource getResource(String uriInContext) throws MalformedURLException
|
public Resource getResource(String pathInContext) throws MalformedURLException
|
||||||
{
|
{
|
||||||
Resource resource = null;
|
Resource resource = null;
|
||||||
// Try to get regular resource
|
// Try to get regular resource
|
||||||
resource = super.getResource(uriInContext);
|
resource = super.getResource(pathInContext);
|
||||||
|
|
||||||
// If no regular resource exists check for access to /WEB-INF/lib or
|
// If no regular resource exists check for access to /WEB-INF/lib or
|
||||||
// /WEB-INF/classes
|
// /WEB-INF/classes
|
||||||
if ((resource == null || !resource.exists()) && uriInContext != null && _classes != null)
|
if ((resource == null || !resource.exists()) && pathInContext != null && _classes != null)
|
||||||
{
|
{
|
||||||
// Canonicalize again to look for the resource inside /WEB-INF subdirectories.
|
// Canonicalize again to look for the resource inside /WEB-INF subdirectories.
|
||||||
String uri = URIUtil.canonicalPath(uriInContext);
|
String uri = URIUtil.canonicalPath(pathInContext);
|
||||||
if (uri == null)
|
if (uri == null)
|
||||||
return null;
|
return null;
|
||||||
|
|
||||||
|
|
|
@ -134,5 +134,5 @@ public class OSGiWebappConstants
|
||||||
/**
|
/**
|
||||||
* Set of extra dirs that must not be served by osgi webapps
|
* Set of extra dirs that must not be served by osgi webapps
|
||||||
*/
|
*/
|
||||||
public static final String[] DEFAULT_PROTECTED_OSGI_TARGETS = {"/osgi-inf", "/osgi-opts"};
|
public static final String[] DEFAULT_PROTECTED_OSGI_TARGETS = {"/OSGI-INF", "/OSGI-OPTS"};
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,205 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2021 Mort Bay Consulting Pty Ltd and others.
|
||||||
|
//
|
||||||
|
// This program and the accompanying materials are made available under the
|
||||||
|
// terms of the Eclipse Public License v. 2.0 which is available at
|
||||||
|
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
|
||||||
|
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
|
||||||
|
// ========================================================================
|
||||||
|
//
|
||||||
|
|
||||||
|
package org.eclipse.jetty.server;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.LinkOption;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
import java.nio.file.Paths;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.server.handler.ContextHandler;
|
||||||
|
import org.eclipse.jetty.util.component.AbstractLifeCycle;
|
||||||
|
import org.eclipse.jetty.util.resource.PathResource;
|
||||||
|
import org.eclipse.jetty.util.resource.Resource;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <p>This will approve any alias to anything inside of the {@link ContextHandler}s resource base which
|
||||||
|
* is not protected by a protected target as defined by {@link ContextHandler#getProtectedTargets()} at start.</p>
|
||||||
|
* <p>Aliases approved by this may still be able to bypass SecurityConstraints, so this class would need to be extended
|
||||||
|
* to enforce any additional security constraints that are required.</p>
|
||||||
|
*/
|
||||||
|
public class AllowedResourceAliasChecker extends AbstractLifeCycle implements ContextHandler.AliasCheck
|
||||||
|
{
|
||||||
|
private static final Logger LOG = LoggerFactory.getLogger(AllowedResourceAliasChecker.class);
|
||||||
|
protected static final LinkOption[] FOLLOW_LINKS = new LinkOption[0];
|
||||||
|
protected static final LinkOption[] NO_FOLLOW_LINKS = new LinkOption[]{LinkOption.NOFOLLOW_LINKS};
|
||||||
|
|
||||||
|
private final ContextHandler _contextHandler;
|
||||||
|
private final List<Path> _protected = new ArrayList<>();
|
||||||
|
protected Path _base;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param contextHandler the context handler to use.
|
||||||
|
*/
|
||||||
|
public AllowedResourceAliasChecker(ContextHandler contextHandler)
|
||||||
|
{
|
||||||
|
_contextHandler = contextHandler;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected ContextHandler getContextHandler()
|
||||||
|
{
|
||||||
|
return _contextHandler;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doStart() throws Exception
|
||||||
|
{
|
||||||
|
_base = getPath(_contextHandler.getBaseResource());
|
||||||
|
if (_base == null)
|
||||||
|
_base = Paths.get("/").toAbsolutePath();
|
||||||
|
if (Files.exists(_base, NO_FOLLOW_LINKS))
|
||||||
|
_base = _base.toRealPath(FOLLOW_LINKS);
|
||||||
|
|
||||||
|
String[] protectedTargets = _contextHandler.getProtectedTargets();
|
||||||
|
if (protectedTargets != null)
|
||||||
|
{
|
||||||
|
for (String s : protectedTargets)
|
||||||
|
_protected.add(_base.getFileSystem().getPath(_base.toString(), s));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected void doStop() throws Exception
|
||||||
|
{
|
||||||
|
_base = null;
|
||||||
|
_protected.clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean check(String pathInContext, Resource resource)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// The existence check resolves the symlinks.
|
||||||
|
if (!resource.exists())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
Path path = getPath(resource);
|
||||||
|
if (path == null)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return check(pathInContext, path);
|
||||||
|
}
|
||||||
|
catch (Throwable t)
|
||||||
|
{
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
LOG.debug("Failed to check alias", t);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected boolean check(String pathInContext, Path path)
|
||||||
|
{
|
||||||
|
// Allow any aliases (symlinks, 8.3, casing, etc.) so long as
|
||||||
|
// the resulting real file is allowed.
|
||||||
|
return isAllowed(getRealPath(path));
|
||||||
|
}
|
||||||
|
|
||||||
|
protected boolean isAllowed(Path path)
|
||||||
|
{
|
||||||
|
// If the resource doesn't exist we cannot determine whether it is protected so we assume it is.
|
||||||
|
if (path != null && Files.exists(path))
|
||||||
|
{
|
||||||
|
// Walk the path parent links looking for the base resource, but failing if any steps are protected
|
||||||
|
while (path != null)
|
||||||
|
{
|
||||||
|
// If the path is the same file as the base, then it is contained in the base and
|
||||||
|
// is not protected.
|
||||||
|
if (isSameFile(path, _base))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
// If the path is the same file as any protected resources, then it is protected.
|
||||||
|
for (Path p : _protected)
|
||||||
|
{
|
||||||
|
if (isSameFile(path, p))
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Walks up the aliased path name, not the real path name.
|
||||||
|
// If WEB-INF is a link to /var/lib/webmeta then after checking
|
||||||
|
// a URI of /WEB-INF/file.xml the parent is /WEB-INF and not /var/lib/webmeta
|
||||||
|
path = path.getParent();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected boolean isSameFile(Path path1, Path path2)
|
||||||
|
{
|
||||||
|
if (Objects.equals(path1, path2))
|
||||||
|
return true;
|
||||||
|
try
|
||||||
|
{
|
||||||
|
if (Files.isSameFile(path1, path2))
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
catch (Throwable t)
|
||||||
|
{
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
LOG.debug("ignored", t);
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static Path getRealPath(Path path)
|
||||||
|
{
|
||||||
|
if (path == null || !Files.exists(path))
|
||||||
|
return null;
|
||||||
|
try
|
||||||
|
{
|
||||||
|
path = path.toRealPath(FOLLOW_LINKS);
|
||||||
|
if (Files.exists(path))
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
catch (IOException e)
|
||||||
|
{
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
LOG.debug("No real path for {}", path, e);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected Path getPath(Resource resource)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
if (resource instanceof PathResource)
|
||||||
|
return ((PathResource)resource).getPath();
|
||||||
|
return resource.getFile().toPath();
|
||||||
|
}
|
||||||
|
catch (Throwable t)
|
||||||
|
{
|
||||||
|
LOG.trace("getPath() failed", t);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString()
|
||||||
|
{
|
||||||
|
return String.format("%s@%x{base=%s,protected=%s}",
|
||||||
|
this.getClass().getSimpleName(),
|
||||||
|
hashCode(),
|
||||||
|
_base,
|
||||||
|
Arrays.asList(_contextHandler.getProtectedTargets()));
|
||||||
|
}
|
||||||
|
}
|
|
@ -39,13 +39,15 @@ import org.slf4j.LoggerFactory;
|
||||||
* or Linux on XFS) the the actual file could be stored using UTF-16,
|
* or Linux on XFS) the the actual file could be stored using UTF-16,
|
||||||
* but be accessed using NFD UTF-8 or NFC UTF-8 for the same file.
|
* but be accessed using NFD UTF-8 or NFC UTF-8 for the same file.
|
||||||
* </p>
|
* </p>
|
||||||
|
* @deprecated use {@link org.eclipse.jetty.server.AllowedResourceAliasChecker} instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
public class SameFileAliasChecker implements AliasCheck
|
public class SameFileAliasChecker implements AliasCheck
|
||||||
{
|
{
|
||||||
private static final Logger LOG = LoggerFactory.getLogger(SameFileAliasChecker.class);
|
private static final Logger LOG = LoggerFactory.getLogger(SameFileAliasChecker.class);
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean check(String uri, Resource resource)
|
public boolean check(String pathInContext, Resource resource)
|
||||||
{
|
{
|
||||||
// Only support PathResource alias checking
|
// Only support PathResource alias checking
|
||||||
if (!(resource instanceof PathResource))
|
if (!(resource instanceof PathResource))
|
||||||
|
|
|
@ -0,0 +1,86 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2021 Mort Bay Consulting Pty Ltd and others.
|
||||||
|
//
|
||||||
|
// This program and the accompanying materials are made available under the
|
||||||
|
// terms of the Eclipse Public License v. 2.0 which is available at
|
||||||
|
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
|
||||||
|
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
|
||||||
|
// ========================================================================
|
||||||
|
//
|
||||||
|
|
||||||
|
package org.eclipse.jetty.server;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.server.handler.ContextHandler;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An extension of {@link AllowedResourceAliasChecker} which will allow symlinks alias to arbitrary
|
||||||
|
* targets, so long as the symlink file itself is an allowed resource.
|
||||||
|
*/
|
||||||
|
public class SymlinkAllowedResourceAliasChecker extends AllowedResourceAliasChecker
|
||||||
|
{
|
||||||
|
private static final Logger LOG = LoggerFactory.getLogger(SymlinkAllowedResourceAliasChecker.class);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param contextHandler the context handler to use.
|
||||||
|
*/
|
||||||
|
public SymlinkAllowedResourceAliasChecker(ContextHandler contextHandler)
|
||||||
|
{
|
||||||
|
super(contextHandler);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected boolean check(String pathInContext, Path path)
|
||||||
|
{
|
||||||
|
// do not allow any file separation characters in the URI, as we need to know exactly what are the segments
|
||||||
|
if (File.separatorChar != '/' && pathInContext.indexOf(File.separatorChar) >= 0)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
// Split the URI path into segments, to walk down the resource tree and build the realURI of any symlink found
|
||||||
|
// We rebuild the realURI, segment by segment, getting the real name at each step, so that we can distinguish between
|
||||||
|
// alias types. Specifically, so we can allow a symbolic link so long as it's realpath is not protected.
|
||||||
|
String[] segments = pathInContext.substring(1).split("/");
|
||||||
|
Path fromBase = _base;
|
||||||
|
StringBuilder realURI = new StringBuilder();
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
for (String segment : segments)
|
||||||
|
{
|
||||||
|
// Add the segment to the path and realURI.
|
||||||
|
fromBase = fromBase.resolve(segment);
|
||||||
|
realURI.append("/").append(fromBase.toRealPath(NO_FOLLOW_LINKS).getFileName());
|
||||||
|
|
||||||
|
// If the ancestor of the alias is a symlink, then check if the real URI is protected, otherwise allow.
|
||||||
|
// This allows symlinks like /other->/WEB-INF and /external->/var/lib/docroot
|
||||||
|
// This does not allow symlinks like /WeB-InF->/var/lib/other
|
||||||
|
if (Files.isSymbolicLink(fromBase))
|
||||||
|
return !getContextHandler().isProtectedTarget(realURI.toString());
|
||||||
|
|
||||||
|
// If the ancestor is not allowed then do not allow.
|
||||||
|
if (!isAllowed(fromBase))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
// TODO as we are building the realURI of the resource, it would be possible to
|
||||||
|
// re-check that against security constraints.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Throwable t)
|
||||||
|
{
|
||||||
|
if (LOG.isDebugEnabled())
|
||||||
|
LOG.debug("Failed to check alias", t);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// No symlink found, so must be allowed. Double check it is the right path we checked.
|
||||||
|
return isSameFile(fromBase, path);
|
||||||
|
}
|
||||||
|
}
|
|
@ -28,13 +28,20 @@ import org.slf4j.LoggerFactory;
|
||||||
* to check resources that are aliased to other locations. The checker uses the
|
* to check resources that are aliased to other locations. The checker uses the
|
||||||
* Java {@link Files#readSymbolicLink(Path)} and {@link Path#toRealPath(java.nio.file.LinkOption...)}
|
* Java {@link Files#readSymbolicLink(Path)} and {@link Path#toRealPath(java.nio.file.LinkOption...)}
|
||||||
* APIs to check if a file is aliased with symbolic links.</p>
|
* APIs to check if a file is aliased with symbolic links.</p>
|
||||||
|
* @deprecated use {@link org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker} instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
public class AllowSymLinkAliasChecker implements AliasCheck
|
public class AllowSymLinkAliasChecker implements AliasCheck
|
||||||
{
|
{
|
||||||
private static final Logger LOG = LoggerFactory.getLogger(AllowSymLinkAliasChecker.class);
|
private static final Logger LOG = LoggerFactory.getLogger(AllowSymLinkAliasChecker.class);
|
||||||
|
|
||||||
|
public AllowSymLinkAliasChecker()
|
||||||
|
{
|
||||||
|
LOG.warn("Deprecated, use SymlinkAllowedResourceAliasChecker instead.");
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean check(String uri, Resource resource)
|
public boolean check(String pathInContext, Resource resource)
|
||||||
{
|
{
|
||||||
// Only support PathResource alias checking
|
// Only support PathResource alias checking
|
||||||
if (!(resource instanceof PathResource))
|
if (!(resource instanceof PathResource))
|
||||||
|
|
|
@ -63,6 +63,7 @@ import javax.servlet.http.HttpSessionListener;
|
||||||
|
|
||||||
import org.eclipse.jetty.http.HttpURI;
|
import org.eclipse.jetty.http.HttpURI;
|
||||||
import org.eclipse.jetty.http.MimeTypes;
|
import org.eclipse.jetty.http.MimeTypes;
|
||||||
|
import org.eclipse.jetty.server.AllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.server.ClassLoaderDump;
|
import org.eclipse.jetty.server.ClassLoaderDump;
|
||||||
import org.eclipse.jetty.server.Connector;
|
import org.eclipse.jetty.server.Connector;
|
||||||
import org.eclipse.jetty.server.Dispatcher;
|
import org.eclipse.jetty.server.Dispatcher;
|
||||||
|
@ -70,6 +71,7 @@ import org.eclipse.jetty.server.Handler;
|
||||||
import org.eclipse.jetty.server.HandlerContainer;
|
import org.eclipse.jetty.server.HandlerContainer;
|
||||||
import org.eclipse.jetty.server.Request;
|
import org.eclipse.jetty.server.Request;
|
||||||
import org.eclipse.jetty.server.Server;
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.util.Attributes;
|
import org.eclipse.jetty.util.Attributes;
|
||||||
import org.eclipse.jetty.util.AttributesMap;
|
import org.eclipse.jetty.util.AttributesMap;
|
||||||
import org.eclipse.jetty.util.Index;
|
import org.eclipse.jetty.util.Index;
|
||||||
|
@ -81,6 +83,7 @@ import org.eclipse.jetty.util.annotation.ManagedAttribute;
|
||||||
import org.eclipse.jetty.util.annotation.ManagedObject;
|
import org.eclipse.jetty.util.annotation.ManagedObject;
|
||||||
import org.eclipse.jetty.util.component.DumpableCollection;
|
import org.eclipse.jetty.util.component.DumpableCollection;
|
||||||
import org.eclipse.jetty.util.component.Graceful;
|
import org.eclipse.jetty.util.component.Graceful;
|
||||||
|
import org.eclipse.jetty.util.component.LifeCycle;
|
||||||
import org.eclipse.jetty.util.resource.Resource;
|
import org.eclipse.jetty.util.resource.Resource;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
|
@ -103,8 +106,8 @@ import org.slf4j.LoggerFactory;
|
||||||
* The executor is made available via a context attributed {@code org.eclipse.jetty.server.Executor}.
|
* The executor is made available via a context attributed {@code org.eclipse.jetty.server.Executor}.
|
||||||
* </p>
|
* </p>
|
||||||
* <p>
|
* <p>
|
||||||
* By default, the context is created with alias checkers for {@link AllowSymLinkAliasChecker} (unix only) and {@link ApproveNonExistentDirectoryAliases}. If
|
* By default, the context is created with the {@link AllowedResourceAliasChecker} which is configured to allow symlinks. If
|
||||||
* these alias checkers are not required, then {@link #clearAliasChecks()} or {@link #setAliasChecks(List)} should be called.
|
* this alias checker is not required, then {@link #clearAliasChecks()} or {@link #setAliasChecks(List)} should be called.
|
||||||
* </p>
|
* </p>
|
||||||
*/
|
*/
|
||||||
@ManagedObject("URI Context")
|
@ManagedObject("URI Context")
|
||||||
|
@ -263,9 +266,8 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
_scontext = context == null ? new Context() : context;
|
_scontext = context == null ? new Context() : context;
|
||||||
_attributes = new AttributesMap();
|
_attributes = new AttributesMap();
|
||||||
_initParams = new HashMap<>();
|
_initParams = new HashMap<>();
|
||||||
addAliasCheck(new ApproveNonExistentDirectoryAliases());
|
|
||||||
if (File.separatorChar == '/')
|
if (File.separatorChar == '/')
|
||||||
addAliasCheck(new AllowSymLinkAliasChecker());
|
addAliasCheck(new SymlinkAllowedResourceAliasChecker(this));
|
||||||
|
|
||||||
if (contextPath != null)
|
if (contextPath != null)
|
||||||
setContextPath(contextPath);
|
setContextPath(contextPath);
|
||||||
|
@ -1918,14 +1920,14 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
/**
|
/**
|
||||||
* Attempt to get a Resource from the Context.
|
* Attempt to get a Resource from the Context.
|
||||||
*
|
*
|
||||||
* @param path the path within the resource to attempt to get
|
* @param pathInContext the path within the base resource to attempt to get
|
||||||
* @return the resource, or null if not available.
|
* @return the resource, or null if not available.
|
||||||
* @throws MalformedURLException if unable to form a Resource from the provided path
|
* @throws MalformedURLException if unable to form a Resource from the provided path
|
||||||
*/
|
*/
|
||||||
public Resource getResource(String path) throws MalformedURLException
|
public Resource getResource(String pathInContext) throws MalformedURLException
|
||||||
{
|
{
|
||||||
if (path == null || !path.startsWith(URIUtil.SLASH))
|
if (pathInContext == null || !pathInContext.startsWith(URIUtil.SLASH))
|
||||||
throw new MalformedURLException(path);
|
throw new MalformedURLException(pathInContext);
|
||||||
|
|
||||||
if (_baseResource == null)
|
if (_baseResource == null)
|
||||||
return null;
|
return null;
|
||||||
|
@ -1935,9 +1937,9 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
// addPath with accept non-canonical paths that don't go above the root,
|
// addPath with accept non-canonical paths that don't go above the root,
|
||||||
// but will treat them as aliases. So unless allowed by an AliasChecker
|
// but will treat them as aliases. So unless allowed by an AliasChecker
|
||||||
// they will be rejected below.
|
// they will be rejected below.
|
||||||
Resource resource = _baseResource.addPath(path);
|
Resource resource = _baseResource.addPath(pathInContext);
|
||||||
|
|
||||||
if (checkAlias(path, resource))
|
if (checkAlias(pathInContext, resource))
|
||||||
return resource;
|
return resource;
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
@ -2071,6 +2073,10 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
public void addAliasCheck(AliasCheck check)
|
public void addAliasCheck(AliasCheck check)
|
||||||
{
|
{
|
||||||
getAliasChecks().add(check);
|
getAliasChecks().add(check);
|
||||||
|
if (check instanceof LifeCycle)
|
||||||
|
addManaged((LifeCycle)check);
|
||||||
|
else
|
||||||
|
addBean(check);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -2086,7 +2092,7 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
*/
|
*/
|
||||||
public void setAliasChecks(List<AliasCheck> checks)
|
public void setAliasChecks(List<AliasCheck> checks)
|
||||||
{
|
{
|
||||||
getAliasChecks().clear();
|
clearAliasChecks();
|
||||||
getAliasChecks().addAll(checks);
|
getAliasChecks().addAll(checks);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2095,7 +2101,9 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
*/
|
*/
|
||||||
public void clearAliasChecks()
|
public void clearAliasChecks()
|
||||||
{
|
{
|
||||||
getAliasChecks().clear();
|
List<AliasCheck> aliasChecks = getAliasChecks();
|
||||||
|
aliasChecks.forEach(this::removeBean);
|
||||||
|
aliasChecks.clear();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -3019,20 +3027,22 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
/**
|
/**
|
||||||
* Check an alias
|
* Check an alias
|
||||||
*
|
*
|
||||||
* @param path The path the aliased resource was created for
|
* @param pathInContext The path the aliased resource was created for
|
||||||
* @param resource The aliased resourced
|
* @param resource The aliased resourced
|
||||||
* @return True if the resource is OK to be served.
|
* @return True if the resource is OK to be served.
|
||||||
*/
|
*/
|
||||||
boolean check(String path, Resource resource);
|
boolean check(String pathInContext, Resource resource);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Approve all aliases.
|
* Approve all aliases.
|
||||||
|
* @deprecated use {@link org.eclipse.jetty.server.AllowedResourceAliasChecker} instead.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
public static class ApproveAliases implements AliasCheck
|
public static class ApproveAliases implements AliasCheck
|
||||||
{
|
{
|
||||||
@Override
|
@Override
|
||||||
public boolean check(String path, Resource resource)
|
public boolean check(String pathInContext, Resource resource)
|
||||||
{
|
{
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
@ -3041,10 +3051,11 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
|
||||||
/**
|
/**
|
||||||
* Approve Aliases of a non existent directory. If a directory "/foobar/" does not exist, then the resource is aliased to "/foobar". Accept such aliases.
|
* Approve Aliases of a non existent directory. If a directory "/foobar/" does not exist, then the resource is aliased to "/foobar". Accept such aliases.
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
public static class ApproveNonExistentDirectoryAliases implements AliasCheck
|
public static class ApproveNonExistentDirectoryAliases implements AliasCheck
|
||||||
{
|
{
|
||||||
@Override
|
@Override
|
||||||
public boolean check(String path, Resource resource)
|
public boolean check(String pathInContext, Resource resource)
|
||||||
{
|
{
|
||||||
if (resource.exists())
|
if (resource.exists())
|
||||||
return false;
|
return false;
|
||||||
|
|
|
@ -27,6 +27,7 @@ import java.util.stream.Stream;
|
||||||
import org.eclipse.jetty.http.HttpTester;
|
import org.eclipse.jetty.http.HttpTester;
|
||||||
import org.eclipse.jetty.server.LocalConnector;
|
import org.eclipse.jetty.server.LocalConnector;
|
||||||
import org.eclipse.jetty.server.Server;
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.toolchain.test.FS;
|
import org.eclipse.jetty.toolchain.test.FS;
|
||||||
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||||
import org.eclipse.jetty.util.BufferUtil;
|
import org.eclipse.jetty.util.BufferUtil;
|
||||||
|
@ -179,7 +180,7 @@ public class AllowSymLinkAliasCheckerTest
|
||||||
fileResourceContext.setBaseResource(new PathResource(rootPath));
|
fileResourceContext.setBaseResource(new PathResource(rootPath));
|
||||||
|
|
||||||
fileResourceContext.clearAliasChecks();
|
fileResourceContext.clearAliasChecks();
|
||||||
fileResourceContext.addAliasCheck(new AllowSymLinkAliasChecker());
|
fileResourceContext.addAliasCheck(new SymlinkAllowedResourceAliasChecker(fileResourceContext));
|
||||||
|
|
||||||
server.setHandler(fileResourceContext);
|
server.setHandler(fileResourceContext);
|
||||||
server.start();
|
server.start();
|
||||||
|
|
|
@ -20,6 +20,7 @@ import java.nio.file.Files;
|
||||||
import java.util.concurrent.atomic.AtomicBoolean;
|
import java.util.concurrent.atomic.AtomicBoolean;
|
||||||
|
|
||||||
import org.eclipse.jetty.server.Server;
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.toolchain.test.FS;
|
import org.eclipse.jetty.toolchain.test.FS;
|
||||||
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||||
import org.eclipse.jetty.util.resource.Resource;
|
import org.eclipse.jetty.util.resource.Resource;
|
||||||
|
@ -104,19 +105,21 @@ public class ContextHandlerGetResourceTest
|
||||||
server = new Server();
|
server = new Server();
|
||||||
context = new ContextHandler("/");
|
context = new ContextHandler("/");
|
||||||
context.clearAliasChecks();
|
context.clearAliasChecks();
|
||||||
context.addAliasCheck(new ContextHandler.ApproveNonExistentDirectoryAliases());
|
|
||||||
context.setBaseResource(Resource.newResource(docroot));
|
context.setBaseResource(Resource.newResource(docroot));
|
||||||
context.addAliasCheck(new ContextHandler.AliasCheck()
|
context.addAliasCheck(new ContextHandler.AliasCheck()
|
||||||
{
|
{
|
||||||
final AllowSymLinkAliasChecker symlinkcheck = new AllowSymLinkAliasChecker();
|
final SymlinkAllowedResourceAliasChecker symlinkcheck = new SymlinkAllowedResourceAliasChecker(context);
|
||||||
|
{
|
||||||
|
context.addBean(symlinkcheck);
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean check(String path, Resource resource)
|
public boolean check(String pathInContext, Resource resource)
|
||||||
{
|
{
|
||||||
if (allowAliases.get())
|
if (allowAliases.get())
|
||||||
return true;
|
return true;
|
||||||
if (allowSymlinks.get())
|
if (allowSymlinks.get())
|
||||||
return symlinkcheck.check(path, resource);
|
return symlinkcheck.check(pathInContext, resource);
|
||||||
return allowAliases.get();
|
return allowAliases.get();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
|
@ -643,7 +643,7 @@ public class ContextHandlerTest
|
||||||
public void testProtected() throws Exception
|
public void testProtected() throws Exception
|
||||||
{
|
{
|
||||||
ContextHandler handler = new ContextHandler();
|
ContextHandler handler = new ContextHandler();
|
||||||
String[] protectedTargets = {"/foo-inf", "/bar-inf"};
|
String[] protectedTargets = {"/FOO-INF", "/BAR-INF"};
|
||||||
handler.setProtectedTargets(protectedTargets);
|
handler.setProtectedTargets(protectedTargets);
|
||||||
|
|
||||||
assertTrue(handler.isProtectedTarget("/foo-inf"));
|
assertTrue(handler.isProtectedTarget("/foo-inf"));
|
||||||
|
|
|
@ -47,13 +47,13 @@ import org.eclipse.jetty.http.HttpHeader;
|
||||||
import org.eclipse.jetty.http.HttpStatus;
|
import org.eclipse.jetty.http.HttpStatus;
|
||||||
import org.eclipse.jetty.http.HttpTester;
|
import org.eclipse.jetty.http.HttpTester;
|
||||||
import org.eclipse.jetty.logging.StacklessLogging;
|
import org.eclipse.jetty.logging.StacklessLogging;
|
||||||
|
import org.eclipse.jetty.server.AllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.server.HttpConfiguration;
|
import org.eclipse.jetty.server.HttpConfiguration;
|
||||||
import org.eclipse.jetty.server.LocalConnector;
|
import org.eclipse.jetty.server.LocalConnector;
|
||||||
import org.eclipse.jetty.server.ResourceContentFactory;
|
import org.eclipse.jetty.server.ResourceContentFactory;
|
||||||
import org.eclipse.jetty.server.ResourceService;
|
import org.eclipse.jetty.server.ResourceService;
|
||||||
import org.eclipse.jetty.server.SameFileAliasChecker;
|
|
||||||
import org.eclipse.jetty.server.Server;
|
import org.eclipse.jetty.server.Server;
|
||||||
import org.eclipse.jetty.server.handler.AllowSymLinkAliasChecker;
|
import org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;
|
||||||
import org.eclipse.jetty.toolchain.test.FS;
|
import org.eclipse.jetty.toolchain.test.FS;
|
||||||
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||||
import org.eclipse.jetty.toolchain.test.jupiter.WorkDir;
|
import org.eclipse.jetty.toolchain.test.jupiter.WorkDir;
|
||||||
|
@ -1081,8 +1081,7 @@ public class DefaultServletTest
|
||||||
response = HttpTester.parseResponse(rawResponse);
|
response = HttpTester.parseResponse(rawResponse);
|
||||||
assertThat(response.toString(), response.getStatus(), is(HttpStatus.NOT_FOUND_404));
|
assertThat(response.toString(), response.getStatus(), is(HttpStatus.NOT_FOUND_404));
|
||||||
|
|
||||||
context.addAliasCheck(new AllowSymLinkAliasChecker());
|
context.addAliasCheck(new SymlinkAllowedResourceAliasChecker(context));
|
||||||
|
|
||||||
rawResponse = connector.getResponse("GET /context/dir/link.txt HTTP/1.0\r\n\r\n");
|
rawResponse = connector.getResponse("GET /context/dir/link.txt HTTP/1.0\r\n\r\n");
|
||||||
response = HttpTester.parseResponse(rawResponse);
|
response = HttpTester.parseResponse(rawResponse);
|
||||||
assertThat(response.toString(), response.getStatus(), is(HttpStatus.OK_200));
|
assertThat(response.toString(), response.getStatus(), is(HttpStatus.OK_200));
|
||||||
|
@ -2056,7 +2055,7 @@ public class DefaultServletTest
|
||||||
FS.ensureEmpty(docRoot);
|
FS.ensureEmpty(docRoot);
|
||||||
|
|
||||||
context.addServlet(DefaultServlet.class, "/");
|
context.addServlet(DefaultServlet.class, "/");
|
||||||
context.addAliasCheck(new SameFileAliasChecker());
|
context.addAliasCheck(new AllowedResourceAliasChecker(context));
|
||||||
|
|
||||||
// Create file with UTF-8 NFC format
|
// Create file with UTF-8 NFC format
|
||||||
String filename = "swedish-" + new String(TypeUtil.fromHexString("C3A5"), UTF_8) + ".txt";
|
String filename = "swedish-" + new String(TypeUtil.fromHexString("C3A5"), UTF_8) + ".txt";
|
||||||
|
@ -2096,7 +2095,7 @@ public class DefaultServletTest
|
||||||
FS.ensureEmpty(docRoot);
|
FS.ensureEmpty(docRoot);
|
||||||
|
|
||||||
context.addServlet(DefaultServlet.class, "/");
|
context.addServlet(DefaultServlet.class, "/");
|
||||||
context.addAliasCheck(new SameFileAliasChecker());
|
context.addAliasCheck(new AllowedResourceAliasChecker(context));
|
||||||
|
|
||||||
// Create file with UTF-8 NFD format
|
// Create file with UTF-8 NFD format
|
||||||
String filename = "swedish-a" + new String(TypeUtil.fromHexString("CC8A"), UTF_8) + ".txt";
|
String filename = "swedish-a" + new String(TypeUtil.fromHexString("CC8A"), UTF_8) + ".txt";
|
||||||
|
|
|
@ -158,7 +158,7 @@ public class WebAppContext extends ServletContextHandler implements WebAppClassL
|
||||||
public static final String SERVER_SYS_CLASSES = "org.eclipse.jetty.webapp.systemClasses";
|
public static final String SERVER_SYS_CLASSES = "org.eclipse.jetty.webapp.systemClasses";
|
||||||
public static final String SERVER_SRV_CLASSES = "org.eclipse.jetty.webapp.serverClasses";
|
public static final String SERVER_SRV_CLASSES = "org.eclipse.jetty.webapp.serverClasses";
|
||||||
|
|
||||||
private static String[] __dftProtectedTargets = {"/web-inf", "/meta-inf"};
|
private static String[] __dftProtectedTargets = {"/WEB-INF", "/META-INF"};
|
||||||
|
|
||||||
// System classes are classes that cannot be replaced by
|
// System classes are classes that cannot be replaced by
|
||||||
// the web application, and they are *always* loaded via
|
// the web application, and they are *always* loaded via
|
||||||
|
@ -395,23 +395,23 @@ public class WebAppContext extends ServletContextHandler implements WebAppClassL
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Resource getResource(String uriInContext) throws MalformedURLException
|
public Resource getResource(String pathInContext) throws MalformedURLException
|
||||||
{
|
{
|
||||||
if (uriInContext == null || !uriInContext.startsWith(URIUtil.SLASH))
|
if (pathInContext == null || !pathInContext.startsWith(URIUtil.SLASH))
|
||||||
throw new MalformedURLException(uriInContext);
|
throw new MalformedURLException(pathInContext);
|
||||||
|
|
||||||
MalformedURLException mue = null;
|
MalformedURLException mue = null;
|
||||||
Resource resource = null;
|
Resource resource = null;
|
||||||
int loop = 0;
|
int loop = 0;
|
||||||
while (uriInContext != null && loop++ < 100)
|
while (pathInContext != null && loop++ < 100)
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
resource = super.getResource(uriInContext);
|
resource = super.getResource(pathInContext);
|
||||||
if (resource != null && resource.exists())
|
if (resource != null && resource.exists())
|
||||||
return resource;
|
return resource;
|
||||||
|
|
||||||
uriInContext = getResourceAlias(uriInContext);
|
pathInContext = getResourceAlias(pathInContext);
|
||||||
}
|
}
|
||||||
catch (MalformedURLException e)
|
catch (MalformedURLException e)
|
||||||
{
|
{
|
||||||
|
|
|
@ -0,0 +1,222 @@
|
||||||
|
//
|
||||||
|
// ========================================================================
|
||||||
|
// Copyright (c) 1995-2021 Mort Bay Consulting Pty Ltd and others.
|
||||||
|
//
|
||||||
|
// This program and the accompanying materials are made available under the
|
||||||
|
// terms of the Eclipse Public License v. 2.0 which is available at
|
||||||
|
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
|
||||||
|
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
|
||||||
|
// ========================================================================
|
||||||
|
//
|
||||||
|
|
||||||
|
package org.eclipse.jetty.test;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.net.URI;
|
||||||
|
import java.net.URL;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
import java.util.stream.Stream;
|
||||||
|
|
||||||
|
import org.eclipse.jetty.client.HttpClient;
|
||||||
|
import org.eclipse.jetty.client.api.ContentResponse;
|
||||||
|
import org.eclipse.jetty.http.HttpStatus;
|
||||||
|
import org.eclipse.jetty.server.AllowedResourceAliasChecker;
|
||||||
|
import org.eclipse.jetty.server.Server;
|
||||||
|
import org.eclipse.jetty.server.ServerConnector;
|
||||||
|
import org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;
|
||||||
|
import org.eclipse.jetty.server.handler.AllowSymLinkAliasChecker;
|
||||||
|
import org.eclipse.jetty.server.handler.ContextHandler;
|
||||||
|
import org.eclipse.jetty.servlet.DefaultServlet;
|
||||||
|
import org.eclipse.jetty.servlet.ServletContextHandler;
|
||||||
|
import org.eclipse.jetty.util.IO;
|
||||||
|
import org.eclipse.jetty.util.resource.PathResource;
|
||||||
|
import org.junit.jupiter.api.AfterAll;
|
||||||
|
import org.junit.jupiter.api.BeforeAll;
|
||||||
|
import org.junit.jupiter.params.ParameterizedTest;
|
||||||
|
import org.junit.jupiter.params.provider.Arguments;
|
||||||
|
import org.junit.jupiter.params.provider.MethodSource;
|
||||||
|
|
||||||
|
import static org.hamcrest.MatcherAssert.assertThat;
|
||||||
|
import static org.hamcrest.Matchers.is;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||||
|
|
||||||
|
public class AliasCheckerSymlinkTest
|
||||||
|
{
|
||||||
|
private static Server _server;
|
||||||
|
private static ServerConnector _connector;
|
||||||
|
private static HttpClient _client;
|
||||||
|
private static ServletContextHandler _context;
|
||||||
|
|
||||||
|
private static Path _symlinkFile;
|
||||||
|
private static Path _symlinkExternalFile;
|
||||||
|
private static Path _symlinkDir;
|
||||||
|
private static Path _symlinkParentDir;
|
||||||
|
private static Path _symlinkSiblingDir;
|
||||||
|
private static Path _webInfSymlink;
|
||||||
|
private static Path _webrootSymlink;
|
||||||
|
|
||||||
|
private static Path getResource(String path) throws Exception
|
||||||
|
{
|
||||||
|
URL url = AliasCheckerSymlinkTest.class.getClassLoader().getResource(path);
|
||||||
|
assertNotNull(url);
|
||||||
|
return new File(url.toURI()).toPath();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void delete(Path path)
|
||||||
|
{
|
||||||
|
IO.delete(path.toFile());
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void setAliasChecker(ContextHandler.AliasCheck aliasChecker)
|
||||||
|
{
|
||||||
|
_context.clearAliasChecks();
|
||||||
|
if (aliasChecker != null)
|
||||||
|
_context.addAliasCheck(aliasChecker);
|
||||||
|
}
|
||||||
|
|
||||||
|
@BeforeAll
|
||||||
|
public static void beforeAll() throws Exception
|
||||||
|
{
|
||||||
|
Path webRootPath = getResource("webroot");
|
||||||
|
Path fileInWebroot = webRootPath.resolve("file");
|
||||||
|
|
||||||
|
// Create symlink file that targets inside the webroot directory.
|
||||||
|
_symlinkFile = webRootPath.resolve("symlinkFile");
|
||||||
|
delete(_symlinkFile);
|
||||||
|
Files.createSymbolicLink(_symlinkFile, fileInWebroot).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Create symlink file that targets outside the webroot directory.
|
||||||
|
_symlinkExternalFile = webRootPath.resolve("symlinkExternalFile");
|
||||||
|
delete(_symlinkExternalFile);
|
||||||
|
Files.createSymbolicLink(_symlinkExternalFile, getResource("file")).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Symlink to a directory inside of the webroot.
|
||||||
|
_symlinkDir = webRootPath.resolve("symlinkDir");
|
||||||
|
delete(_symlinkDir);
|
||||||
|
Files.createSymbolicLink(_symlinkDir, webRootPath.resolve("documents")).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Symlink to a directory parent of the webroot.
|
||||||
|
_symlinkParentDir = webRootPath.resolve("symlinkParentDir");
|
||||||
|
delete(_symlinkParentDir);
|
||||||
|
Files.createSymbolicLink(_symlinkParentDir, webRootPath.resolve("..")).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Symlink to a directory outside of the webroot.
|
||||||
|
_symlinkSiblingDir = webRootPath.resolve("symlinkSiblingDir");
|
||||||
|
delete(_symlinkSiblingDir);
|
||||||
|
Files.createSymbolicLink(_symlinkSiblingDir, webRootPath.resolve("../sibling")).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Symlink to the WEB-INF directory.
|
||||||
|
_webInfSymlink = webRootPath.resolve("webInfSymlink");
|
||||||
|
delete(_webInfSymlink);
|
||||||
|
Files.createSymbolicLink(_webInfSymlink, webRootPath.resolve("WEB-INF")).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// External symlink to webroot.
|
||||||
|
_webrootSymlink = webRootPath.resolve("../webrootSymlink");
|
||||||
|
delete(_webrootSymlink);
|
||||||
|
Files.createSymbolicLink(_webrootSymlink, webRootPath).toFile().deleteOnExit();
|
||||||
|
|
||||||
|
// Create and start Server and Client.
|
||||||
|
_server = new Server();
|
||||||
|
_connector = new ServerConnector(_server);
|
||||||
|
_server.addConnector(_connector);
|
||||||
|
_context = new ServletContextHandler();
|
||||||
|
_context.setContextPath("/");
|
||||||
|
_context.setBaseResource(new PathResource(webRootPath));
|
||||||
|
_context.setWelcomeFiles(new String[]{"index.html"});
|
||||||
|
_context.setProtectedTargets(new String[]{"/WEB-INF", "/META-INF"});
|
||||||
|
_context.getMimeTypes().addMimeMapping("txt", "text/plain;charset=utf-8");
|
||||||
|
_server.setHandler(_context);
|
||||||
|
_context.addServlet(DefaultServlet.class, "/");
|
||||||
|
_context.clearAliasChecks();
|
||||||
|
_server.start();
|
||||||
|
|
||||||
|
_client = new HttpClient();
|
||||||
|
_client.start();
|
||||||
|
}
|
||||||
|
|
||||||
|
@AfterAll
|
||||||
|
public static void afterAll() throws Exception
|
||||||
|
{
|
||||||
|
// Try to delete all files now so that the symlinks do not confuse other tests.
|
||||||
|
Files.delete(_symlinkFile);
|
||||||
|
Files.delete(_symlinkExternalFile);
|
||||||
|
Files.delete(_symlinkDir);
|
||||||
|
Files.delete(_symlinkParentDir);
|
||||||
|
Files.delete(_symlinkSiblingDir);
|
||||||
|
Files.delete(_webInfSymlink);
|
||||||
|
Files.delete(_webrootSymlink);
|
||||||
|
|
||||||
|
_client.stop();
|
||||||
|
_server.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static Stream<Arguments> testCases()
|
||||||
|
{
|
||||||
|
AllowedResourceAliasChecker allowedResource = new AllowedResourceAliasChecker(_context);
|
||||||
|
SymlinkAllowedResourceAliasChecker symlinkAllowedResource = new SymlinkAllowedResourceAliasChecker(_context);
|
||||||
|
AllowSymLinkAliasChecker allowSymlinks = new AllowSymLinkAliasChecker();
|
||||||
|
ContextHandler.ApproveAliases approveAliases = new ContextHandler.ApproveAliases();
|
||||||
|
|
||||||
|
return Stream.of(
|
||||||
|
// AllowedResourceAliasChecker that checks the target of symlinks.
|
||||||
|
Arguments.of(allowedResource, "/symlinkFile", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(allowedResource, "/symlinkExternalFile", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(allowedResource, "/symlinkDir/file", HttpStatus.OK_200, "This file is inside webroot/documents."),
|
||||||
|
Arguments.of(allowedResource, "/symlinkParentDir/webroot/file", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(allowedResource, "/symlinkParentDir/webroot/WEB-INF/web.xml", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(allowedResource, "/symlinkSiblingDir/file", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(allowedResource, "/webInfSymlink/web.xml", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
|
||||||
|
// SymlinkAllowedResourceAliasChecker that does not check the target of symlinks, but only approves files obtained through a symlink.
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkFile", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkExternalFile", HttpStatus.OK_200, "This file is outside webroot."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkDir/file", HttpStatus.OK_200, "This file is inside webroot/documents."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkParentDir/webroot/file", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkParentDir/webroot/WEB-INF/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/symlinkSiblingDir/file", HttpStatus.OK_200, "This file is inside a sibling dir to webroot."),
|
||||||
|
Arguments.of(symlinkAllowedResource, "/webInfSymlink/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
|
||||||
|
// The AllowSymLinkAliasChecker.
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkFile", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkExternalFile", HttpStatus.OK_200, "This file is outside webroot."),
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkDir/file", HttpStatus.OK_200, "This file is inside webroot/documents."),
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkParentDir/webroot/file", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkParentDir/webroot/WEB-INF/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
Arguments.of(allowSymlinks, "/symlinkSiblingDir/file", HttpStatus.OK_200, "This file is inside a sibling dir to webroot."),
|
||||||
|
Arguments.of(allowSymlinks, "/webInfSymlink/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
|
||||||
|
// The ApproveAliases (approves everything regardless).
|
||||||
|
Arguments.of(approveAliases, "/symlinkFile", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(approveAliases, "/symlinkExternalFile", HttpStatus.OK_200, "This file is outside webroot."),
|
||||||
|
Arguments.of(approveAliases, "/symlinkDir/file", HttpStatus.OK_200, "This file is inside webroot/documents."),
|
||||||
|
Arguments.of(approveAliases, "/symlinkParentDir/webroot/file", HttpStatus.OK_200, "This file is inside webroot."),
|
||||||
|
Arguments.of(approveAliases, "/symlinkParentDir/webroot/WEB-INF/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
Arguments.of(approveAliases, "/symlinkSiblingDir/file", HttpStatus.OK_200, "This file is inside a sibling dir to webroot."),
|
||||||
|
Arguments.of(approveAliases, "/webInfSymlink/web.xml", HttpStatus.OK_200, "This is the web.xml file."),
|
||||||
|
|
||||||
|
// No alias checker (any symlink should be an alias).
|
||||||
|
Arguments.of(null, "/symlinkFile", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/symlinkExternalFile", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/symlinkDir/file", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/symlinkParentDir/webroot/file", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/symlinkParentDir/webroot/WEB-INF/web.xml", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/symlinkSiblingDir/file", HttpStatus.NOT_FOUND_404, null),
|
||||||
|
Arguments.of(null, "/webInfSymlink/web.xml", HttpStatus.NOT_FOUND_404, null)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@ParameterizedTest
|
||||||
|
@MethodSource("testCases")
|
||||||
|
public void test(ContextHandler.AliasCheck aliasChecker, String path, int httpStatus, String responseContent) throws Exception
|
||||||
|
{
|
||||||
|
setAliasChecker(aliasChecker);
|
||||||
|
URI uri = URI.create("http://localhost:" + _connector.getLocalPort() + path);
|
||||||
|
ContentResponse response = _client.GET(uri);
|
||||||
|
assertThat(response.getStatus(), is(httpStatus));
|
||||||
|
if (responseContent != null)
|
||||||
|
assertThat(response.getContentAsString(), is(responseContent));
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1 @@
|
||||||
|
This file is outside webroot.
|
|
@ -0,0 +1 @@
|
||||||
|
This file is inside a sibling dir to webroot.
|
|
@ -0,0 +1 @@
|
||||||
|
This is the web.xml file.
|
|
@ -0,0 +1 @@
|
||||||
|
This file is inside webroot/documents.
|
|
@ -0,0 +1 @@
|
||||||
|
This file is inside webroot.
|
|
@ -0,0 +1,4 @@
|
||||||
|
<html>
|
||||||
|
<h1>hello world</h1>
|
||||||
|
<p>body of index.html</p>
|
||||||
|
</html>
|
Loading…
Reference in New Issue