Checkbox to automatically set the new ssl certificate alias

James Moger

2012-12-05 d63157b22bb8a7294080be29ca0fca8ecda96db9

 src/com/gitblit/GitBlitServer.java

@@ -16,20 +16,26 @@
package com.gitblit;



import java.io.BufferedReader;

import java.io.BufferedWriter;

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.io.InputStreamReader;

import java.io.OutputStream;

import java.net.InetAddress;

import java.net.ServerSocket;

import java.net.Socket;

import java.net.URI;

import java.net.URL;

import java.net.UnknownHostException;

import java.security.ProtectionDomain;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Date;

import java.util.List;

import java.util.Scanner;



import org.eclipse.jetty.ajp.Ajp13SocketConnector;

import org.eclipse.jetty.server.Connector;

import org.eclipse.jetty.server.Server;

import org.eclipse.jetty.server.bio.SocketConnector;

@@ -38,11 +44,12 @@
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.FilterMapping;

import org.eclipse.jetty.servlet.ServletHolder;

import org.eclipse.jetty.util.ssl.SslContextFactory;

import org.eclipse.jetty.util.thread.QueuedThreadPool;

import org.eclipse.jetty.webapp.WebAppContext;

import org.eclipse.jgit.http.server.GitServlet;

import org.eclipse.jgit.storage.file.FileBasedConfig;

import org.eclipse.jgit.util.FS;

import org.eclipse.jgit.util.FileUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;



@@ -50,13 +57,34 @@
import com.beust.jcommander.Parameter;

import com.beust.jcommander.ParameterException;

import com.beust.jcommander.Parameters;

import com.gitblit.authority.GitblitAuthority;

import com.gitblit.authority.NewCertificateConfig;

import com.gitblit.utils.StringUtils;

import com.gitblit.utils.TimeUtils;

import com.gitblit.utils.X509Utils;

import com.gitblit.utils.X509Utils.X509Log;

import com.gitblit.utils.X509Utils.X509Metadata;

import com.unboundid.ldap.listener.InMemoryDirectoryServer;

import com.unboundid.ldap.listener.InMemoryDirectoryServerConfig;

import com.unboundid.ldap.listener.InMemoryListenerConfig;

import com.unboundid.ldif.LDIFReader;



/**

 * 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 static Logger logger;



   public static void main(String[] args) {

   public static void main(String... args) {

      Params params = new Params();

      JCommander jc = new JCommander(params);

      try {

@@ -75,6 +103,12 @@
      }

   }



   /**

    * Display the command line usage of Gitblit GO.

    * 
    * @param jc

    * @param t

    */

   private static void usage(JCommander jc, ParameterException t) {

      System.out.println(Constants.BORDER);

      System.out.println(Constants.getGitBlitVersion());

@@ -87,13 +121,13 @@
      if (jc != null) {

         jc.usage();

         System.out

               .println("\nExample:\n  java -server -Xmx1024M -jar gitblit.jar --repos c:\\git --port 80 --securePort 443");

               .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 {

@@ -111,48 +145,114 @@
   }



   /**

    * Start Server.

    * Start Gitblit GO.

    */

   private static void start(Params params) {

      FileSettings settings = params.FILESETTINGS;

      FileSettings settings = Params.FILESETTINGS;

      if (!StringUtils.isEmpty(params.settingsfile)) {

         if (new File(params.settingsfile).exists()) {

            settings = new FileSettings(params.settingsfile);				
         }

      }



      logger = LoggerFactory.getLogger(GitBlitServer.class);

      logger.info(Constants.BORDER);

      logger.info(Constants.getGitBlitVersion());

      logger.info("            _____  _  _    _      _  _  _");

      logger.info("           |  __ \\(_)| |  | |    | |(_)| |");

      logger.info("           | |  \\/ _ | |_ | |__  | | _ | |_");

      logger.info("           | | __ | || __|| '_ \\ | || || __|");

      logger.info("           | |_\\ \\| || |_ | |_) || || || |_");

      logger.info("            \\____/|_| \\__||_.__/ |_||_| \\__|");

      int spacing = (Constants.BORDER.length() - Constants.getGitBlitVersion().length()) / 2;

      StringBuilder sb = new StringBuilder();

      while (spacing > 0) {

         spacing--;

         sb.append(' ');

      }

      logger.info(sb.toString() + Constants.getGitBlitVersion());

      logger.info("");

      logger.info(Constants.BORDER);



      System.setProperty("java.awt.headless", "true");



      String osname = System.getProperty("os.name");

      String osversion = System.getProperty("os.version");

      logger.info("Running on " + osname + " (" + osversion + ")");



      // 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} to {1}",

            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) {

         File keystore = new File("keystore");

         if (!keystore.exists()) {

            logger.info("Generating self-signed SSL certificate");

            MakeCertificate.generateSelfSignedCertificate("localhost", keystore,

                  params.storePassword);

         final File folder = new File(System.getProperty("user.dir"));

         File certificatesConf = new File(folder, X509Utils.CA_CONFIG);

         File serverKeyStore = new File(folder, X509Utils.SERVER_KEY_STORE);

         File serverTrustStore = new File(folder, X509Utils.SERVER_TRUST_STORE);

         File caRevocationList = new File(folder, X509Utils.CA_REVOCATION_LIST);



         // generate CA & web certificates, create certificate stores

         X509Metadata metadata = new X509Metadata("localhost", params.storePassword);

         // set default certificate values from config file

         if (certificatesConf.exists()) {

            FileBasedConfig config = new FileBasedConfig(certificatesConf, FS.detect());

            try {

               config.load();

            } catch (Exception e) {

               logger.error("Error parsing " + certificatesConf, e);

            }

            NewCertificateConfig certificateConfig = NewCertificateConfig.KEY.parse(config);

            certificateConfig.update(metadata);

         }

         if (keystore.exists()) {

            Connector secureConnector = createSSLConnector(keystore, params.storePassword,

                  params.useNIO, params.securePort);

			
         metadata.notAfter = new Date(System.currentTimeMillis() + 10*TimeUtils.ONEYEAR);

         X509Utils.prepareX509Infrastructure(metadata, folder, new X509Log() {

            @Override

            public void log(String message) {

               BufferedWriter writer = null;

               try {

                  writer = new BufferedWriter(new FileWriter(new File(folder, X509Utils.CERTS + File.separator + "log.txt"), true));

                  writer.write(MessageFormat.format("{0,date,yyyy-MM-dd HH:mm}: {1}", new Date(), message));

                  writer.newLine();

                  writer.flush();

               } catch (Exception e) {

                  LoggerFactory.getLogger(GitblitAuthority.class).error("Failed to append log entry!", e);

               } finally {

                  if (writer != null) {

                     try {

                        writer.close();

                     } catch (IOException e) {

                     }

                  }

               }

            }

         });



         if (serverKeyStore.exists()) {		        
            Connector secureConnector = createSSLConnector(params.alias, serverKeyStore, serverTrustStore, params.storePassword,

                  caRevocationList, params.useNIO, params.securePort, params.requireClientCertificates);

            String bindInterface = settings.getString(Keys.server.httpsBindInterface, null);

            if (!StringUtils.isEmpty(bindInterface)) {

               logger.warn(MessageFormat.format("Binding ssl connector on port {0} to {1}",

                     params.securePort, 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 {

@@ -161,13 +261,29 @@
         }

      }



      // tempDir = Directory where...

      // * WebApp is expanded

      //

      // conditionally configure the ajp connector

      if (params.ajpPort > 0) {

         Connector ajpConnector = createAJPConnector(params.ajpPort);

         String bindInterface = settings.getString(Keys.server.ajpBindInterface, null);

         if (!StringUtils.isEmpty(bindInterface)) {

            logger.warn(MessageFormat.format("Binding connector on port {0,number,0} to {1}",

                  params.ajpPort, bindInterface));

            ajpConnector.setHost(bindInterface);

         }

         if (params.ajpPort < 1024 && !isWindows()) {

            logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");

         }

         connectors.add(ajpConnector);

      }



      // 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()) {

         if (!deleteRecursively(tempDir)) {

            logger.warn("Failed to delete temp dir " + tempDir.getAbsolutePath());

         try {

            FileUtils.delete(tempDir, FileUtils.RECURSIVE | FileUtils.RETRY);

         } catch (IOException x) {

            logger.warn("Failed to delete temp dir " + tempDir.getAbsolutePath(), x);

         }

      }

      if (!tempDir.mkdirs()) {

@@ -185,7 +301,7 @@


      // 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);

@@ -197,38 +313,66 @@
      sessionManager.setSecureCookies(params.port <= 0 && params.securePort > 0);

      rootContext.getSessionHandler().setSessionManager(sessionManager);



      // JGit Filter and Servlet

      String jgitPathSpec = Constants.GIT_PATH + "*";

      rootContext.addFilter(GitFilter.class, jgitPathSpec, FilterMapping.DEFAULT);

      ServletHolder jGitServlet = rootContext.addServlet(GitServlet.class, jgitPathSpec);

      jGitServlet.setInitParameter("base-path", params.repositoriesFolder);

      jGitServlet.setInitParameter("export-all", "1");



      // Ensure there is a defined Login Service

      String realmUsers = params.realmFile;

      // Ensure there is a defined User Service

      String realmUsers = params.userService;

      if (StringUtils.isEmpty(realmUsers)) {

         logger.error(MessageFormat.format("PLEASE SPECIFY {0}!!", Keys.realm.realmFile));

         logger.error(MessageFormat.format("PLEASE SPECIFY {0}!!", Keys.realm.userService));

         return;

      }



      // Override settings from the command-line

      settings.overrideSetting(Keys.realm.userService, params.userService);

      settings.overrideSetting(Keys.git.repositoriesFolder, params.repositoriesFolder);

      

      // Update settings

//      settings.put(Keys.realm.realmFile, params.realmFile);

//      settings.put(Keys.git.repositoriesFolder, params.repositoriesFolder);

      // Start up an in-memory LDAP server, if configured

      try {

         if (StringUtils.isEmpty(params.ldapLdifFile) == false) {

            File ldifFile = new File(params.ldapLdifFile);

            if (ldifFile != null && ldifFile.exists()) {

               URI ldapUrl = new URI(settings.getRequiredString(Keys.realm.ldap.server));

               String firstLine = new Scanner(ldifFile).nextLine();

               String rootDN = firstLine.substring(4);

               String bindUserName = settings.getString(Keys.realm.ldap.username, "");

               String bindPassword = settings.getString(Keys.realm.ldap.password, "");

					
               // Get the port

               int port = ldapUrl.getPort();

               if (port == -1)

                  port = 389;

					
               InMemoryDirectoryServerConfig config = new InMemoryDirectoryServerConfig(rootDN);

               config.addAdditionalBindCredentials(bindUserName, bindPassword);

               config.setListenerConfigs(InMemoryListenerConfig.createLDAPConfig("default", port));

               config.setSchema(null);

					
               InMemoryDirectoryServer ds = new InMemoryDirectoryServer(config);

               ds.importFromLDIF(true, new LDIFReader(ldifFile));

               ds.startListening();

					
               logger.info("LDAP Server started at ldap://localhost:" + port);

            }

         }

      } catch (Exception e) {

         // Completely optional, just show a warning

         logger.warn("Unable to start LDAP server", e);

      }



      // Set the server's contexts

      server.setHandler(rootContext);



      // Setup the GitBlit context

      GitBlit gitblit = GitBlit.self();

      gitblit.configureContext(settings);

      gitblit.configureContext(settings, true);

      rootContext.addEventListener(gitblit);



      // Start the Server

      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) {

@@ -237,6 +381,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) {

@@ -256,45 +407,108 @@
      return connector;

   }



   private static Connector createSSLConnector(File keystore, String password, boolean useNIO,

         int port) {

   /**

    * 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 certAlias

    * @param keyStore

    * @param clientTrustStore

    * @param storePassword

    * @param caRevocationList

    * @param useNIO

    * @param port

    * @param requireClientCertificates

    * @return an https connector

    */

   private static Connector createSSLConnector(String certAlias, File keyStore, File clientTrustStore,

         String storePassword, File caRevocationList, boolean useNIO, int port, 
         boolean requireClientCertificates) {

      SslContextFactory sslContext = new SslContextFactory(SslContextFactory.DEFAULT_KEYSTORE_PATH);

      SslConnector connector;

      if (useNIO) {

         logger.info("Setting up NIO SslSelectChannelConnector on port " + port);

         SslSelectChannelConnector ssl = new SslSelectChannelConnector();

         SslSelectChannelConnector ssl = new SslSelectChannelConnector(sslContext);

         ssl.setSoLingerTime(-1);

         if (requireClientCertificates) {

            sslContext.setNeedClientAuth(true);

         } else {

            sslContext.setWantClientAuth(true);

         }

         ssl.setThreadPool(new QueuedThreadPool(20));

         connector = ssl;

      } else {

         logger.info("Setting up NIO SslSocketConnector on port " + port);

         SslSocketConnector ssl = new SslSocketConnector();

         SslSocketConnector ssl = new SslSocketConnector(sslContext);

         connector = ssl;

      }

      connector.setAllowRenegotiate(false);

      connector.setKeystore(keystore.getAbsolutePath());

      connector.setPassword(password);

      // 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);

         sslContext.setAllowRenegotiate(allowRenegotiation);

      }

      sslContext.setKeyStorePath(keyStore.getAbsolutePath());

      sslContext.setKeyStorePassword(storePassword);

      sslContext.setTrustStore(clientTrustStore.getAbsolutePath());

      sslContext.setTrustStorePassword(storePassword);

      sslContext.setCrlPath(caRevocationList.getAbsolutePath());

      if (!StringUtils.isEmpty(certAlias)) {

         logger.info("   certificate alias = " + certAlias);

         sslContext.setCertAlias(certAlias);

      }

      connector.setPort(port);

      connector.setMaxIdleTime(30000);

      return connector;

   }



	
   /**

    * Recursively delete a folder and its contents.

    * Creates an ajp connector.

    * 

    * @param folder

    * @param port

    * @return an ajp connector

    */

   private static boolean deleteRecursively(File folder) {

      boolean deleted = true;

      for (File file : folder.listFiles()) {

         if (file.isDirectory()) {

            deleted &= deleteRecursively(file);

         } else {

            deleted &= file.delete();

         }

   private static Connector createAJPConnector(int port) {

      logger.info("Setting up AJP Connector on port " + port);

      Ajp13SocketConnector ajp = new Ajp13SocketConnector();

      ajp.setPort(port);

      if (port < 1024 && !isWindows()) {

         logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");

      }

      return deleted && folder.delete();

      return ajp;

   }



   /**

    * Tests to see if the operating system is Windows.

    * 
    * @return true if this is a windows machine

    */

   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;

@@ -338,6 +552,9 @@
      }

   }



   /**

    * JCommander Parameters class for GitBlitServer.

    */

   @Parameters(separators = " ")

   private static class Params {



@@ -352,7 +569,7 @@
      @Parameter(names = { "--stop" }, description = "Stop Server")

      public Boolean stop = false;



      @Parameter(names = { "--tempFolder" }, description = "Server temp folder")

      @Parameter(names = { "--tempFolder" }, description = "Folder for server to extract built-in webapp")

      public String temp = FILESETTINGS.getString(Keys.server.tempFolder, "temp");



      /*

@@ -365,8 +582,9 @@
      /*

       * Authentication Parameters

       */

      @Parameter(names = { "--realmFile" }, description = "Users Realm Hash File")

      public String realmFile = FILESETTINGS.getString(Keys.realm.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

@@ -380,11 +598,29 @@
      @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 = "--ajpPort", description = "AJP port to serve.  (port <= 0 will disable this connector)")

      public Integer ajpPort = FILESETTINGS.getInteger(Keys.server.ajpPort, 0);



      @Parameter(names = "--alias", description = "Alias of SSL certificate in keystore for serving https.")

      public String alias = FILESETTINGS.getString(Keys.server.certificateAlias, "");



      @Parameter(names = "--storePassword", description = "Password for SSL (https) keystore.")

      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 = FILESETTINGS.getInteger(Keys.server.shutdownPort, 8081);



      @Parameter(names = "--requireClientCertificates", description = "Require client X509 certificates for https connections.")

      public Boolean requireClientCertificates = FILESETTINGS.getBoolean(Keys.server.requireClientCertificates, false);



      /*

       * Setting overrides

       */

      @Parameter(names = { "--settings" }, description = "Path to alternative settings")

      public String settingsfile;

		
      @Parameter(names = { "--ldapLdifFile" }, description = "Path to LDIF file.  This will cause an in-memory LDAP server to be started according to gitblit settings")

      public String ldapLdifFile;



   }

}