如何禁用 Jetty 的 WebAppContext 的目录列表？答案

【问题标题】：How to disable directory listing for Jetty's WebAppContext?如何禁用 Jetty 的 WebAppContext 的目录列表？
【发布时间】：2011-11-05 06:54:10
【问题描述】：

我正在将 Jetty（版本 7.4.5.v20110725）嵌入到 Java 应用程序中。我正在使用 Jetty 的 WebAppContext 在 ./webapps/jsp/ 中提供 JSP 页面，但是如果我访问 localhost:8080/jsp/，我会得到 ./webapps/jsp/ 的全部内容的 Jetty 目录列表。我尝试在 WebAppContext 上将 dirAllowed 参数设置为 false，它不会更改目录列表行为。

在 ResourceHandler 上禁用目录列表只需将 false 传递给 setDirectoriesListed，即可按预期工作。有人可以告诉我如何为 WebAppContext 执行此操作吗？

import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.handler.ContextHandler;
import org.eclipse.jetty.server.handler.HandlerList;
import org.eclipse.jetty.server.handler.ResourceHandler;
import org.eclipse.jetty.server.nio.SelectChannelConnector;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;
import org.eclipse.jetty.webapp.WebAppContext;

public class Test {

    public static void main(String[] args) throws Exception {
        Server server = new Server();
        SelectChannelConnector connector = new SelectChannelConnector();
        connector.setHost("127.0.0.1");
        connector.setPort(8080);
        server.addConnector(connector);

        // Create a resource handler for static content.
        ResourceHandler staticResourceHandler = new ResourceHandler();
        staticResourceHandler.setResourceBase("./webapps/static/");
        staticResourceHandler.setDirectoriesListed(false);

        // Create context handler for static resource handler.
        ContextHandler staticContextHandler = new ContextHandler();
        staticContextHandler.setContextPath("/static");
        staticContextHandler.setHandler(staticResourceHandler);

        // Create WebAppContext for JSP files.
        WebAppContext webAppContext = new WebAppContext();
        webAppContext.setContextPath("/jsp");
        webAppContext.setResourceBase("./webapps/jsp/");
        // ??? THIS DOES NOT STOP DIR LISTING OF ./webapps/jsp/ ???
        webAppContext.setInitParameter("dirAllowed", "false");

        // Create a handler list to store our static and servlet context handlers.
        HandlerList handlers = new HandlerList();
        handlers.setHandlers(new Handler[] { staticContextHandler, webAppContext });

        // Add the handlers to the server and start jetty.
        server.setHandler(handlers);
        server.start();
        server.join();
    }

}

【问题讨论】：

标签： java jetty embedded-jetty

【解决方案1】：

你可以设置org.eclipse.jetty.servlet.Default.dirAllowed而不是dirAllowed：

webAppContext.setInitParameter("org.eclipse.jetty.servlet.Default.dirAllowed", "false");

针对 Jetty 7.4.5.v20110725、8.1.4.v20120524、9.0.2.v20130417 和 9.2.0.v20140526 进行了测试。

【讨论】：

我们如何在 bean 配置的项目中设置 dirAllowed。我已将我面临的问题与代码一起包含在此link 中。有人可以帮忙吗？

【解决方案2】：

对于使用web.xml 的任何人，您也可以在此处禁止它。找到默认的servlet（Jetty的DefaultServlet），将dirAllowed参数设置为false：

<servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.eclipse.jetty.servlet.DefaultServlet</servlet-class>
    <init-param>
        <param-name>dirAllowed</param-name>
        <param-value>false</param-value>
    </init-param>
</servlet>

【讨论】：

【解决方案3】：

这适用于 Jetty v9.4.3：

web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">

    <context-param>
        <param-name>org.eclipse.jetty.servlet.Default.dirAllowed</param-name>
        <param-value>false</param-value>
    </context-param>

</web-app>

【讨论】：

【解决方案4】：

如果有人遇到这种情况，正在 Jetty 6 中寻找等价物：

    <bean id="webAppContext" class="org.mortbay.jetty.webapp.WebAppContext">
    .
    .
    <property name="initParams">
        <map>               
            <entry key="org.mortbay.jetty.servlet.Default.dirAllowed" value="false" />
        </map>
    </property>

【讨论】：

【解决方案5】：

我在网上找到了描述相同问题的以下页面：

jetty-users-How-can-I-prevent-Directory-Listing-in-WebAppContext

我引用该帖子的其中一个条目中提到的内容作为问题的原因：

问题是由于某种原因 Jetty 没有合并使用嵌入模式时，webdefault.xml 与用户 web.xml 正确

以下是用于解决问题的代码：

HashMap hmap = new HashMap<String, String>();
   hmap.put("dirAllowed", "false");
   hmap.put("redirectWelcome", "false");
   hmap.put("aliases", "false");
   ServletHolder []svh = wc.getServletHandler().getServlets();
   if(svh != null && svh.length > 0)
   {
           for(int j = 0; j < svh.length; j++)
      {
              ServletHolder svh1 = svh[j];
            if(svh1.getClassName() != null && svh1.getClassName().endsWith(DEFAULT_SERVLET))
            {
               svh1.setInitParameters(hmap);
             }
       }
   }

希望它能为您解决问题。

【讨论】：

不幸的是它没有帮助：ServletHolder[] svh = webAppContext.getServletHandler().getServlets(); 返回一个零长度数组。

【解决方案6】：

目前未提及的替代解决方案是添加 index.html 文件。可能这不是一个非常通用的解决方案，但它符合我的需求。附加值是这对用户更加友好 - 不小心输入您的应用程序 URL 的用户将获得您选择的人类可读描述，而不是来自 Jetty 的一些通用错误页面。

对我来说，这适用于嵌入式 Jetty 版本。 9.4.5.

我已将 index.html 放在 WEB-INF 目录旁边。

【讨论】：

【解决方案7】：

在带有 Jetty 9.2 的 Linux 中（但我认为它与 9.x 相同）适用于所有基于 Jetty 和 Jetty 的实例。

您可以更改文件/etc/jetty9/webdefault.xml:

<init-param>
  <param-name>dirAllowed</param-name>
  <param-value>false</param-value>
</init-param>

我也变了：

<init-param>
     <param-name>welcomeServlets</param-name>
     <param-value>true</param-value>
  </init-param>
  <init-param>
     <param-name>redirectWelcome</param-name>
     <param-value>true</param-value>
  </init-param>

【讨论】：

【解决方案8】：

另一种可行的方法是将此配置应用于jetty-web.xml：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN"
          "http://www.eclipse.org/jetty/configure_9_3.dtd">
<Configure class="org.eclipse.jetty.webapp.WebAppContext">

  <Call name="setInitParameter">
    <Arg>org.eclipse.jetty.servlet.Default.dirAllowed</Arg>
    <Arg type="boolean">False</Arg>
  </Call>

</Configure>

【讨论】：