From 4c835e61e8ea2d5af2acf0c85c3c1f0d06f419df Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 26 Oct 2011 17:19:55 -0400
Subject: [PATCH] Documentation.
---
src/com/gitblit/GitBlitServer.java | 152 +++++++++++++++++++++++++++++++++++++-------------
1 files changed, 112 insertions(+), 40 deletions(-)
diff --git a/src/com/gitblit/GitBlitServer.java b/src/com/gitblit/GitBlitServer.java
index 678c9d4..1b079de 100644
--- a/src/com/gitblit/GitBlitServer.java
+++ b/src/com/gitblit/GitBlitServer.java
@@ -40,6 +40,7 @@
import org.eclipse.jetty.server.ssl.SslSocketConnector;
import org.eclipse.jetty.util.thread.QueuedThreadPool;
import org.eclipse.jetty.webapp.WebAppContext;
+import org.eclipse.jgit.util.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -49,11 +50,22 @@
import com.beust.jcommander.Parameters;
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 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 {
@@ -72,6 +84,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());
@@ -84,13 +102,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 {
@@ -108,10 +126,10 @@
}
/**
- * Start Server.
+ * Start Gitblit GO.
*/
private static void start(Params params) {
- FileSettings settings = params.FILESETTINGS;
+ FileSettings settings = Params.FILESETTINGS;
logger = LoggerFactory.getLogger(GitBlitServer.class);
logger.info(Constants.BORDER);
@@ -122,23 +140,28 @@
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");
+ logger.info("Generating self-signed SSL certificate for localhost");
MakeCertificate.generateSelfSignedCertificate("localhost", keystore,
params.storePassword);
}
@@ -147,9 +170,12 @@
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} to {1}",
+ 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 {
@@ -158,13 +184,14 @@
}
}
- // 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()) {
- 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()) {
@@ -182,7 +209,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);
@@ -194,31 +221,33 @@
sessionManager.setSecureCookies(params.port <= 0 && params.securePort > 0);
rootContext.getSessionHandler().setSessionManager(sessionManager);
- // 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;
}
-
- // Update settings
-// settings.put(Keys.realm.realmFile, params.realmFile);
-// settings.put(Keys.git.repositoriesFolder, params.repositoriesFolder);
+
+ // Override settings from the command-line
+ settings.overrideSetting(Keys.realm.userService, params.userService);
+ settings.overrideSetting(Keys.git.repositoriesFolder, params.repositoriesFolder);
// 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) {
@@ -227,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) {
@@ -243,9 +279,24 @@
connector.setPort(port);
connector.setMaxIdleTime(30000);
+ if (port < 1024 && !isWindows()) {
+ logger.warn("Gitblit needs to run with ROOT permissions for ports < 1024!");
+ }
return connector;
}
+ /**
+ * 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;
@@ -260,7 +311,24 @@
SslSocketConnector ssl = new SslSocketConnector();
connector = ssl;
}
- connector.setAllowRenegotiate(false);
+ // 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);
@@ -269,22 +337,22 @@
}
/**
- * 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 boolean deleteRecursively(File folder) {
- boolean deleted = true;
- for (File file : folder.listFiles()) {
- if (file.isDirectory()) {
- deleted &= deleteRecursively(file);
- } else {
- deleted &= file.delete();
- }
- }
- return deleted && 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;
@@ -328,6 +396,9 @@
}
}
+ /**
+ * JCommander Parameters class for GitBlitServer.
+ */
@Parameters(separators = " ")
private static class Params {
@@ -342,7 +413,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");
/*
@@ -355,8 +426,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
--
Gitblit v1.9.1