From a3bde69e9b3f3cc6212b0cd5fd7310b6a3301d8c Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 01 Jun 2011 20:47:05 -0400
Subject: [PATCH] Documentation. Enforce ".git" suffix for created repositories.
---
src/com/gitblit/GitBlitServer.java | 300 ++++++++++++++++++++++++++++++++++++++---------------------
1 files changed, 191 insertions(+), 109 deletions(-)
diff --git a/src/com/gitblit/GitBlitServer.java b/src/com/gitblit/GitBlitServer.java
index ae542e8..928bf7e 100644
--- a/src/com/gitblit/GitBlitServer.java
+++ b/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,6 +26,7 @@
import java.net.URL;
import java.net.UnknownHostException;
import java.security.ProtectionDomain;
+import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
@@ -21,63 +37,59 @@
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.LoginService;
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.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.utils.StringUtils;
import com.gitblit.wicket.GitBlitWebApp;
public class GitBlitServer {
- private final static Logger logger = Log.getLogger(GitBlitServer.class.getSimpleName());
- private final static String border_star = "***********************************************************";
- private static boolean debugMode = false;
-
- public static boolean isDebugMode() {
- return debugMode;
- }
+ private static Logger logger;
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);
+ }
}
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,7 +97,8 @@
}
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 --repos c:\\git --port 80 --securePort 443");
}
System.exit(0);
}
@@ -98,7 +111,7 @@
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) {
@@ -112,35 +125,69 @@
* Start Server.
*/
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"));
+ FileSettings settings = params.FILESETTINGS;
+ String pattern = settings.getString(Keys.server.log4jPattern,
+ "%-5p %d{MM-dd HH:mm:ss.SSS} %-20.20c{1} %m%n");
+
+ // allow os override of logging pattern
+ String os = System.getProperty("os.name").toLowerCase();
+ if (os.indexOf("windows") > -1) {
+ String winPattern = settings.getString(Keys.server.log4jPattern_windows, pattern);
+ if (!StringUtils.isEmpty(winPattern)) {
+ pattern = winPattern;
+ }
+ } else if (os.indexOf("linux") > -1) {
+ String linuxPattern = settings.getString(Keys.server.log4jPattern_linux, pattern);
+ if (!StringUtils.isEmpty(linuxPattern)) {
+ pattern = linuxPattern;
+ }
+ }
+
+ PatternLayout layout = new PatternLayout(pattern);
org.apache.log4j.Logger rootLogger = org.apache.log4j.Logger.getRootLogger();
rootLogger.addAppender(new ConsoleAppender(layout));
- 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>();
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}",
+ params.port, bindInterface));
+ httpConnector.setHost(bindInterface);
+ }
connectors.add(httpConnector);
}
-
+
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");
+ 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} to {1}",
+ params.securePort, bindInterface));
+ secureConnector.setHost(bindInterface);
+ }
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.");
}
}
@@ -149,9 +196,14 @@
// * WebApp is expanded
//
File tempDir = new File(params.temp);
- if (tempDir.exists())
- deleteRecursively(tempDir);
- tempDir.mkdirs();
+ if (tempDir.exists()) {
+ if (!deleteRecursively(tempDir)) {
+ logger.warn("Failed to delete temp dir " + tempDir.getAbsolutePath());
+ }
+ }
+ if (!tempDir.mkdirs()) {
+ logger.warn("Failed to create temp dir " + tempDir.getAbsolutePath());
+ }
Server server = new Server();
server.setStopAtShutdown(true);
@@ -169,63 +221,92 @@
rootContext.setWar(location.toExternalForm());
rootContext.setTempDirectory(tempDir);
+ // 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);
+
// Wicket Filter
String wicketPathSpec = "/*";
FilterHolder wicketFilter = new FilterHolder(WicketFilter.class);
- wicketFilter.setInitParameter(ContextParamWebApplicationFactory.APP_CLASS_PARAM, GitBlitWebApp.class.getName());
+ wicketFilter.setInitParameter(ContextParamWebApplicationFactory.APP_CLASS_PARAM,
+ GitBlitWebApp.class.getName());
wicketFilter.setInitParameter(WicketFilter.FILTER_MAPPING_PARAM, wicketPathSpec);
+ wicketFilter.setInitParameter(WicketFilter.IGNORE_PATHS_PARAM, "git/");
rootContext.addFilter(wicketFilter, wicketPathSpec, FilterMapping.DEFAULT);
- // 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");
+ // Zip Servlet
+ rootContext.addServlet(DownloadZipServlet.class, Constants.ZIP_SERVLET_PATH + "*");
+ // Git Servlet
+ ServletHolder gitServlet = null;
+ String gitServletPathSpec = Constants.GIT_SERVLET_PATH + "*";
+ if (settings.getBoolean(Keys.git.enableGitServlet, true)) {
+ gitServlet = rootContext.addServlet(GitBlitServlet.class, gitServletPathSpec);
+ gitServlet.setInitParameter("base-path", params.repositoriesFolder);
+ gitServlet.setInitParameter("export-all",
+ settings.getBoolean(Keys.git.exportAll, true) ? "1" : "0");
+ }
+
+ // Login Service
+ LoginService loginService = null;
String realmUsers = params.realmFile;
+ if (!StringUtils.isEmpty(realmUsers)) {
+ File realmFile = new File(realmUsers);
+ if (realmFile.exists()) {
+ logger.info("Setting up login service from " + realmUsers);
+ JettyLoginService jettyLoginService = new JettyLoginService(realmFile);
+ GitBlit.self().setLoginService(jettyLoginService);
+ loginService = jettyLoginService;
+ }
+ }
- // Authentication Realm
+ // Determine what handler to use
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[] { "*" };
+ if (gitServlet != null) {
+ if (loginService != null) {
+ // Authenticate Clone/Push
+ logger.info("Setting up authenticated git servlet clone/push access");
+
+ Constraint constraint = new Constraint();
+ constraint.setAuthenticate(true);
+ constraint.setRoles(new String[] { "*" });
+
+ ConstraintMapping mapping = new ConstraintMapping();
+ mapping.setPathSpec(gitServletPathSpec);
+ mapping.setConstraint(constraint);
+
+ ConstraintSecurityHandler security = new ConstraintSecurityHandler();
+ security.addConstraintMapping(mapping);
+ security.setAuthenticator(new BasicAuthenticator());
+ security.setLoginService(loginService);
+ security.setStrict(false);
+
+ security.setHandler(rootContext);
+
+ handler = security;
} else {
- roles = list.toArray(new String[list.size()]);
+ // Anonymous Pull/Push
+ logger.info("Setting up anonymous git servlet pull/push access");
+ handler = rootContext;
}
- 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");
+ logger.info("Git servlet clone/push disabled");
handler = rootContext;
}
+ logger.info("Git repositories folder "
+ + new File(params.repositoriesFolder).getAbsolutePath());
+
// Set the server's contexts
server.setHandler(handler);
+
+ // Setup the GitBlit context
+ GitBlit gitblit = GitBlit.self();
+ gitblit.configureContext(settings);
+ rootContext.addEventListener(gitblit);
// Start the Server
try {
@@ -260,7 +341,8 @@
return connector;
}
- private static Connector createSSLConnector(boolean useNIO, int port, String password) {
+ 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 +355,8 @@
SslSocketConnector ssl = new SslSocketConnector();
connector = ssl;
}
- connector.setKeystore("keystore");
+ connector.setAllowRenegotiate(false);
+ connector.setKeystore(keystore.getAbsolutePath());
connector.setPassword(password);
connector.setPort(port);
connector.setMaxIdleTime(30000);
@@ -285,14 +368,16 @@
*
* @param folder
*/
- private static void deleteRecursively(File folder) {
+ private static boolean deleteRecursively(File folder) {
+ boolean deleted = true;
for (File file : folder.listFiles()) {
- if (file.isDirectory())
- deleteRecursively(file);
- else
- file.delete();
+ if (file.isDirectory()) {
+ deleted &= deleteRecursively(file);
+ } else {
+ deleted &= file.delete();
+ }
}
- folder.delete();
+ return deleted && folder.delete();
}
private static class ShutdownMonitorThread extends Thread {
@@ -300,6 +385,8 @@
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 +396,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 +407,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();
@@ -338,6 +426,8 @@
@Parameters(separators = " ")
private static class Params {
+ private static final FileSettings FILESETTINGS = new FileSettings(Constants.PROPERTIES_FILE);
+
/*
* Server parameters
*/
@@ -347,47 +437,39 @@
@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 = "Server temp folder")
+ 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 = { "--realmFile" }, description = "Users Realm Hash File")
+ public String realmFile = FILESETTINGS.getString(Keys.realm.realmFile, "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);
}
}
\ No newline at end of file
--
Gitblit v1.9.1