James Moger
2011-10-31 17820f3a1153250a325fed23dfc2da59ce6ba777
src/com/gitblit/GitBlitServer.java
@@ -1,3 +1,18 @@
/*
 * Copyright 2011 gitblit.com.
 *
 * Licensed 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 com.gitblit;
import java.io.BufferedReader;
@@ -11,73 +26,74 @@
import java.net.URL;
import java.net.UnknownHostException;
import java.security.ProtectionDomain;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.PatternLayout;
import org.apache.wicket.protocol.http.ContextParamWebApplicationFactory;
import org.apache.wicket.protocol.http.WicketFilter;
import org.eclipse.jetty.http.security.Constraint;
import org.eclipse.jetty.security.ConstraintMapping;
import org.eclipse.jetty.security.ConstraintSecurityHandler;
import org.eclipse.jetty.security.HashLoginService;
import org.eclipse.jetty.security.authentication.BasicAuthenticator;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.bio.SocketConnector;
import org.eclipse.jetty.server.nio.SelectChannelConnector;
import org.eclipse.jetty.server.session.HashSessionManager;
import org.eclipse.jetty.server.ssl.SslConnector;
import org.eclipse.jetty.server.ssl.SslSelectChannelConnector;
import org.eclipse.jetty.server.ssl.SslSocketConnector;
import org.eclipse.jetty.servlet.FilterHolder;
import org.eclipse.jetty.servlet.FilterMapping;
import org.eclipse.jetty.servlet.ServletHolder;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.thread.QueuedThreadPool;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jgit.http.server.GitServlet;
import org.eclipse.jgit.util.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.ParameterException;
import com.beust.jcommander.Parameters;
import com.gitblit.wicket.GitBlitWebApp;
import com.gitblit.utils.StringUtils;
/**
 * GitBlitServer is the embedded Jetty server for Gitblit GO. This class starts
 * and stops an instance of Jetty that is configured from a combination of the
 * gitblit.properties file and command line parameters. JCommander is used to
 * simplify command line parameter processing. This class also automatically
 * generates a self-signed certificate for localhost, if the keystore does not
 * already exist.
 *
 * @author James Moger
 *
 */
public class GitBlitServer {
   private final static Logger logger = Log.getLogger(GitBlitServer.class.getSimpleName());
   private final static String border_star = "***********************************************************";
   private static boolean debugMode = false;
   private static Logger logger;
   public static boolean isDebugMode() {
      return debugMode;
   }
   public static void main(String[] args) {
   public static void main(String... args) {
      Params params = new Params();
      JCommander jc = new JCommander(params);
      try {
         jc.parse(args);
         if (params.help)
         if (params.help) {
            usage(jc, null);
         }
      } catch (ParameterException t) {
         usage(jc, t);
      }
      if (params.stop)
      if (params.stop) {
         stop(params);
      else
      } else {
         start(params);
      }
   }
   /**
    * Display the command line usage of Gitblit GO.
    *
    * @param jc
    * @param t
    */
   private static void usage(JCommander jc, ParameterException t) {
      System.out.println(border_star);
      System.out.println(Constants.getRunningVersion());
      System.out.println(border_star);
      System.out.println(Constants.BORDER);
      System.out.println(Constants.getGitBlitVersion());
      System.out.println(Constants.BORDER);
      System.out.println();
      if (t != null) {
         System.out.println(t.getMessage());
@@ -85,20 +101,21 @@
      }
      if (jc != null) {
         jc.usage();
         System.out.println("\nExample:\n  java -server -Xmx1024M -jar go-git-go.jar --repos c:\\git --port 80 --securePort 443");
         System.out
               .println("\nExample:\n  java -server -Xmx1024M -jar gitblit.jar --repositoriesFolder c:\\git --httpPort 80 --httpsPort 443");
      }
      System.exit(0);
   }
   /**
    * Stop Server.
    * Stop Gitblt GO.
    */
   public static void stop(Params params) {
      try {
         Socket s = new Socket(InetAddress.getByName("127.0.0.1"), params.shutdownPort);
         OutputStream out = s.getOutputStream();
         System.out.println("Sending Shutdown Request to " + Constants.NAME);
         out.write(("\r\n").getBytes());
         out.write("\r\n".getBytes());
         out.flush();
         s.close();
      } catch (UnknownHostException e) {
@@ -109,49 +126,77 @@
   }
   /**
    * Start Server.
    * Start Gitblit GO.
    */
   private static void start(Params params) {
      PatternLayout layout = new PatternLayout(StoredSettings.getString("log4jPattern", "%-5p %d{MM-dd HH:mm:ss.SSS}  %-20.20c{1}  %m%n"));
      org.apache.log4j.Logger rootLogger = org.apache.log4j.Logger.getRootLogger();
      rootLogger.addAppender(new ConsoleAppender(layout));
      FileSettings settings = Params.FILESETTINGS;
      logger.info(border_star);
      logger.info(Constants.getRunningVersion());
      logger.info(border_star);
      logger = LoggerFactory.getLogger(GitBlitServer.class);
      logger.info(Constants.BORDER);
      logger.info(Constants.getGitBlitVersion());
      logger.info(Constants.BORDER);
      String osname = System.getProperty("os.name");
      String osversion = System.getProperty("os.version");
      logger.info("Running on " + osname + " (" + osversion + ")");
      if (params.debug) {
         logger.warn("DEBUG Mode");
      }
      // Determine port connectors
      List<Connector> connectors = new ArrayList<Connector>();
      // conditionally configure the http connector
      if (params.port > 0) {
         Connector httpConnector = createConnector(params.useNIO, params.port);
         String bindInterface = settings.getString(Keys.server.httpBindInterface, null);
         if (!StringUtils.isEmpty(bindInterface)) {
            logger.warn(MessageFormat.format("Binding connector on port {0,number,0} to {1}",
                  params.port, bindInterface));
            httpConnector.setHost(bindInterface);
         }
         if (params.port < 1024 && !isWindows()) {
            logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");
         }
         connectors.add(httpConnector);
      }
      // conditionally configure the https connector
      if (params.securePort > 0) {
         if (new File("keystore").exists()) {
            Connector secureConnector = createSSLConnector(params.useNIO, params.securePort, params.storePassword);
         File keystore = new File("keystore");
         if (!keystore.exists()) {
            logger.info("Generating self-signed SSL certificate for localhost");
            MakeCertificate.generateSelfSignedCertificate("localhost", keystore,
                  params.storePassword);
         }
         if (keystore.exists()) {
            Connector secureConnector = createSSLConnector(keystore, params.storePassword,
                  params.useNIO, params.securePort);
            String bindInterface = settings.getString(Keys.server.httpsBindInterface, null);
            if (!StringUtils.isEmpty(bindInterface)) {
               logger.warn(MessageFormat.format("Binding ssl connector on port {0,number,0} to {1}",
                     params.securePort, bindInterface));
               secureConnector.setHost(bindInterface);
            }
            if (params.securePort < 1024 && !isWindows()) {
               logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");
            }
            connectors.add(secureConnector);
         } else {
            logger.warn("Failed to find Keystore?  Did you run \"makekeystore\"?");
            logger.warn("Failed to find or load Keystore?");
            logger.warn("SSL connector DISABLED.");
         }
      }
      // tempDir = Directory where...
      // * WebApp is expanded
      //
      // tempDir is where the embedded Gitblit web application is expanded and
      // where Jetty creates any necessary temporary files
      File tempDir = new File(params.temp);
      if (tempDir.exists())
         deleteRecursively(tempDir);
      tempDir.mkdirs();
      if (tempDir.exists()) {
         try {
            FileUtils.delete(tempDir, FileUtils.RECURSIVE | FileUtils.RETRY);
         } catch (IOException x) {
            logger.warn("Failed to delete temp dir " + tempDir.getAbsolutePath(), x);
         }
      }
      if (!tempDir.mkdirs()) {
         logger.warn("Failed to create temp dir " + tempDir.getAbsolutePath());
      }
      Server server = new Server();
      server.setStopAtShutdown(true);
@@ -164,75 +209,45 @@
      // Root WebApp Context
      WebAppContext rootContext = new WebAppContext();
      rootContext.setContextPath("/");
      rootContext.setContextPath(settings.getString(Keys.server.contextPath, "/"));
      rootContext.setServer(server);
      rootContext.setWar(location.toExternalForm());
      rootContext.setTempDirectory(tempDir);
      // Wicket Filter
      String wicketPathSpec = "/*";
      FilterHolder wicketFilter = new FilterHolder(WicketFilter.class);
      wicketFilter.setInitParameter(ContextParamWebApplicationFactory.APP_CLASS_PARAM, GitBlitWebApp.class.getName());
      wicketFilter.setInitParameter(WicketFilter.FILTER_MAPPING_PARAM, wicketPathSpec);
      rootContext.addFilter(wicketFilter, wicketPathSpec, FilterMapping.DEFAULT);
      // Set cookies HttpOnly so they are not accessible to JavaScript engines
      HashSessionManager sessionManager = new HashSessionManager();
      sessionManager.setHttpOnly(true);
      // Use secure cookies if only serving https
      sessionManager.setSecureCookies(params.port <= 0 && params.securePort > 0);
      rootContext.getSessionHandler().setSessionManager(sessionManager);
      // GIT Servlet
      String gitServletPathSpec = "/git/*";
      ServletHolder gitServlet = rootContext.addServlet(GitServlet.class, gitServletPathSpec);
      gitServlet.setInitParameter("base-path", params.repositoriesFolder);
      gitServlet.setInitParameter("export-all", params.exportAll ? "1" : "0");
      String realmUsers = params.realmFile;
      // Authentication Realm
      Handler handler;
      if (realmUsers != null && new File(realmUsers).exists() && params.authenticateAccess) {
         List<String> list = StoredSettings.getStrings("gitRoles");
         String[] roles;
         if (list.size() == 0) {
            roles = new String[] { "*" };
         } else {
            roles = list.toArray(new String[list.size()]);
         }
         logger.info("Authentication required for GIT access");
         logger.info("Setting up realm from " + realmUsers);
         HashLoginService loginService = new HashLoginService(Constants.NAME, realmUsers);
         Constraint constraint = new Constraint();
         constraint.setName("auth");
         constraint.setAuthenticate(true);
         constraint.setRoles(roles);
         ConstraintMapping mapping = new ConstraintMapping();
         mapping.setPathSpec(gitServletPathSpec);
         mapping.setConstraint(constraint);
         ConstraintSecurityHandler security = new ConstraintSecurityHandler();
         security.addConstraintMapping(mapping);
         for (String role : roles) {
            security.addRole(role);
         }
         security.setAuthenticator(new BasicAuthenticator());
         security.setLoginService(loginService);
         security.setStrict(false);
         security.setHandler(rootContext);
         handler = security;
      } else {
         logger.info("Setting up anonymous access");
         handler = rootContext;
      // Ensure there is a defined User Service
      String realmUsers = params.userService;
      if (StringUtils.isEmpty(realmUsers)) {
         logger.error(MessageFormat.format("PLEASE SPECIFY {0}!!", Keys.realm.userService));
         return;
      }
      // Set the server's contexts
      server.setHandler(handler);
      // Override settings from the command-line
      settings.overrideSetting(Keys.realm.userService, params.userService);
      settings.overrideSetting(Keys.git.repositoriesFolder, params.repositoriesFolder);
      // Start the Server
      // Set the server's contexts
      server.setHandler(rootContext);
      // Setup the GitBlit context
      GitBlit gitblit = GitBlit.self();
      gitblit.configureContext(settings, true);
      rootContext.addEventListener(gitblit);
      try {
         // start the shutdown monitor
         if (params.shutdownPort > 0) {
            Thread shutdownMonitor = new ShutdownMonitorThread(server, params);
            shutdownMonitor.start();
         }
         // start Jetty
         server.start();
         server.join();
      } catch (Exception e) {
@@ -241,6 +256,13 @@
      }
   }
   /**
    * Creates an http connector.
    *
    * @param useNIO
    * @param port
    * @return an http connector
    */
   private static Connector createConnector(boolean useNIO, int port) {
      Connector connector;
      if (useNIO) {
@@ -257,10 +279,26 @@
      connector.setPort(port);
      connector.setMaxIdleTime(30000);
      if (port < 1024 && !isWindows()) {
         logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");
      }
      return connector;
   }
   private static Connector createSSLConnector(boolean useNIO, int port, String password) {
   /**
    * Creates an https connector.
    *
    * SSL renegotiation will be enabled if the JVM is 1.6.0_22 or later.
    * oracle.com/technetwork/java/javase/documentation/tlsreadme2-176330.html
    *
    * @param keystore
    * @param password
    * @param useNIO
    * @param port
    * @return an https connector
    */
   private static Connector createSSLConnector(File keystore, String password, boolean useNIO,
         int port) {
      SslConnector connector;
      if (useNIO) {
         logger.info("Setting up NIO SslSelectChannelConnector on port " + port);
@@ -273,7 +311,25 @@
         SslSocketConnector ssl = new SslSocketConnector();
         connector = ssl;
      }
      connector.setKeystore("keystore");
      // disable renegotiation unless this is a patched JVM
      boolean allowRenegotiation = false;
      String v = System.getProperty("java.version");
      if (v.startsWith("1.7")) {
         allowRenegotiation = true;
      } else if (v.startsWith("1.6")) {
         // 1.6.0_22 was first release with RFC-5746 implemented fix.
         if (v.indexOf('_') > -1) {
            String b = v.substring(v.indexOf('_') + 1);
            if (Integer.parseInt(b) >= 22) {
               allowRenegotiation = true;
            }
         }
      }
      if (allowRenegotiation) {
         logger.info("   allowing SSL renegotiation on Java " + v);
         connector.setAllowRenegotiate(allowRenegotiation);
      }
      connector.setKeystore(keystore.getAbsolutePath());
      connector.setPassword(password);
      connector.setPort(port);
      connector.setMaxIdleTime(30000);
@@ -281,25 +337,29 @@
   }
   /**
    * Recursively delete a folder and its contents.
    * Tests to see if the operating system is Windows.
    * 
    * @param folder
    * @return true if this is a windows machine
    */
   private static void deleteRecursively(File folder) {
      for (File file : folder.listFiles()) {
         if (file.isDirectory())
            deleteRecursively(file);
         else
            file.delete();
      }
      folder.delete();
   private static boolean isWindows() {
      return System.getProperty("os.name").toLowerCase().indexOf("windows") > -1;
   }
   /**
    * The ShutdownMonitorThread opens a socket on a specified port and waits
    * for an incoming connection. When that connection is accepted a shutdown
    * message is issued to the running Jetty server.
    *
    * @author James Moger
    *
    */
   private static class ShutdownMonitorThread extends Thread {
      private final ServerSocket socket;
      private final Server server;
      private final Logger logger = LoggerFactory.getLogger(ShutdownMonitorThread.class);
      public ShutdownMonitorThread(Server server, Params params) {
         this.server = server;
@@ -309,7 +369,7 @@
         try {
            skt = new ServerSocket(params.shutdownPort, 1, InetAddress.getByName("127.0.0.1"));
         } catch (Exception e) {
            logger.warn(e);
            logger.warn("Could not open shutdown monitor on port " + params.shutdownPort, e);
         }
         socket = skt;
      }
@@ -320,11 +380,12 @@
         Socket accept;
         try {
            accept = socket.accept();
            BufferedReader reader = new BufferedReader(new InputStreamReader(accept.getInputStream()));
            BufferedReader reader = new BufferedReader(new InputStreamReader(
                  accept.getInputStream()));
            reader.readLine();
            logger.info(border_star);
            logger.info(Constants.BORDER);
            logger.info("Stopping " + Constants.NAME);
            logger.info(border_star);
            logger.info(Constants.BORDER);
            server.stop();
            server.setStopAtShutdown(false);
            accept.close();
@@ -335,8 +396,13 @@
      }
   }
   /**
    * JCommander Parameters class for GitBlitServer.
    */
   @Parameters(separators = " ")
   private static class Params {
      private static final FileSettings FILESETTINGS = new FileSettings(Constants.PROPERTIES_FILE);
      /*
       * Server parameters
@@ -347,47 +413,40 @@
      @Parameter(names = { "--stop" }, description = "Stop Server")
      public Boolean stop = false;
      @Parameter(names = { "--temp" }, description = "Server temp folder")
      public String temp = StoredSettings.getString("tempFolder", "temp");
      @Parameter(names = { "--debug" }, description = "Run server in DEBUG mode")
      public Boolean debug = StoredSettings.getBoolean("debug", false);
      @Parameter(names = { "--tempFolder" }, description = "Folder for server to extract built-in webapp")
      public String temp = FILESETTINGS.getString(Keys.server.tempFolder, "temp");
      /*
       * GIT Servlet Parameters
       */
      @Parameter(names = { "--repos" }, description = "GIT Repositories Folder")
      public String repositoriesFolder = StoredSettings.getString("repositoriesFolder", "repos");
      @Parameter(names = { "--exportAll" }, description = "Export All Found Repositories")
      public Boolean exportAll = StoredSettings.getBoolean("exportAll", true);
      @Parameter(names = { "--repositoriesFolder" }, description = "Git Repositories Folder")
      public String repositoriesFolder = FILESETTINGS.getString(Keys.git.repositoriesFolder,
            "repos");
      /*
       * Authentication Parameters
       */
      @Parameter(names = { "--authenticateAccess" }, description = "Authenticate GIT access")
      public Boolean authenticateAccess = StoredSettings.getBoolean("authenticateAccess", true);
      @Parameter(names = { "--realm" }, description = "Users Realm Hash File")
      public String realmFile = StoredSettings.getString("realmFile", "users.properties");
      @Parameter(names = { "--userService" }, description = "Authentication and Authorization Service (filename or fully qualified classname)")
      public String userService = FILESETTINGS.getString(Keys.realm.userService,
            "users.properties");
      /*
       * JETTY Parameters
       */
      @Parameter(names = { "--nio" }, description = "Use NIO Connector else use Socket Connector.")
      public Boolean useNIO = StoredSettings.getBoolean("useNio", true);
      @Parameter(names = { "--useNio" }, description = "Use NIO Connector else use Socket Connector.")
      public Boolean useNIO = FILESETTINGS.getBoolean(Keys.server.useNio, true);
      @Parameter(names = "--port", description = "HTTP port for to serve. (port <= 0 will disable this connector)")
      public Integer port = StoredSettings.getInteger("httpPort", 80);
      @Parameter(names = "--httpPort", description = "HTTP port for to serve. (port <= 0 will disable this connector)")
      public Integer port = FILESETTINGS.getInteger(Keys.server.httpPort, 80);
      @Parameter(names = "--securePort", description = "HTTPS port to serve.  (port <= 0 will disable this connector)")
      public Integer securePort = StoredSettings.getInteger("httpsPort", 443);
      @Parameter(names = "--httpsPort", description = "HTTPS port to serve.  (port <= 0 will disable this connector)")
      public Integer securePort = FILESETTINGS.getInteger(Keys.server.httpsPort, 443);
      @Parameter(names = "--storePassword", description = "Password for SSL (https) keystore.")
      public String storePassword = StoredSettings.getString("storePassword", "");
      public String storePassword = FILESETTINGS.getString(Keys.server.storePassword, "");
      @Parameter(names = "--shutdownPort", description = "Port for Shutdown Monitor to listen on. (port <= 0 will disable this monitor)")
      public Integer shutdownPort = StoredSettings.getInteger("shutdownPort", 8081);
      public Integer shutdownPort = FILESETTINGS.getInteger(Keys.server.shutdownPort, 8081);
   }
}