From 7b6c1bdaba9877397ffdaf0c8641196cfb060c39 Mon Sep 17 00:00:00 2001
From: Vitaliy Filippov <vitalif@yourcmc.ru>
Date: Thu, 01 Oct 2015 06:08:53 -0400
Subject: [PATCH] Allow to strip domain from kerberos usernames
---
src/main/java/com/gitblit/transport/ssh/SshDaemon.java | 506 +++++++++++++++++++++++++++++++++-----------------------
1 files changed, 297 insertions(+), 209 deletions(-)
diff --git a/src/main/java/com/gitblit/transport/ssh/SshDaemon.java b/src/main/java/com/gitblit/transport/ssh/SshDaemon.java
index 056735a..65d1558 100644
--- a/src/main/java/com/gitblit/transport/ssh/SshDaemon.java
+++ b/src/main/java/com/gitblit/transport/ssh/SshDaemon.java
@@ -1,209 +1,297 @@
-/*
- * Copyright 2014 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.transport.ssh;
-
-import java.io.File;
-import java.io.IOException;
-import java.net.InetSocketAddress;
-import java.text.MessageFormat;
-import java.util.concurrent.atomic.AtomicBoolean;
-
-import javax.inject.Named;
-import javax.inject.Singleton;
-
-import org.apache.sshd.server.Command;
-import org.apache.sshd.server.keyprovider.PEMGeneratorHostKeyProvider;
-import org.eclipse.jgit.internal.JGitText;
-import org.eclipse.jgit.transport.resolver.ReceivePackFactory;
-import org.eclipse.jgit.transport.resolver.UploadPackFactory;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import com.gitblit.IStoredSettings;
-import com.gitblit.Keys;
-import com.gitblit.git.GitblitReceivePackFactory;
-import com.gitblit.git.GitblitUploadPackFactory;
-import com.gitblit.git.RepositoryResolver;
-import com.gitblit.manager.IGitblit;
-import com.gitblit.transport.ssh.commands.CreateRepository;
-import com.gitblit.transport.ssh.commands.VersionCommand;
-import com.gitblit.utils.IdGenerator;
-import com.gitblit.utils.StringUtils;
-
-import dagger.Module;
-import dagger.ObjectGraph;
-import dagger.Provides;
-
-/**
- * Manager for the ssh transport. Roughly analogous to the
- * {@link com.gitblit.git.GitDaemon} class.
- *
- * @author Eric Myhre
- *
- */
-public class SshDaemon {
-
- private final Logger logger = LoggerFactory.getLogger(SshDaemon.class);
-
- /**
- * 22: IANA assigned port number for ssh. Note that this is a distinct concept
- * from gitblit's default conf for ssh port -- this "default" is what the git
- * protocol itself defaults to if it sees and ssh url without a port.
- */
- public static final int DEFAULT_PORT = 22;
-
- private static final String HOST_KEY_STORE = "sshKeyStore.pem";
-
- private InetSocketAddress myAddress;
-
- private AtomicBoolean run;
-
- private SshCommandServer sshd;
-
- private IGitblit gitblit;
-
- /**
- * Construct the Gitblit SSH daemon.
- *
- * @param gitblit
- */
- public SshDaemon(IGitblit gitblit) {
-
- this.gitblit = gitblit;
- IStoredSettings settings = gitblit.getSettings();
- int port = settings.getInteger(Keys.git.sshPort, 0);
- String bindInterface = settings.getString(Keys.git.sshBindInterface, "localhost");
-
- if (StringUtils.isEmpty(bindInterface)) {
- myAddress = new InetSocketAddress(port);
- } else {
- myAddress = new InetSocketAddress(bindInterface, port);
- }
-
- ObjectGraph graph = ObjectGraph.create(new SshModule());
- sshd = graph.get(SshCommandServer.class);
- sshd.setPort(myAddress.getPort());
- sshd.setHost(myAddress.getHostName());
- sshd.setup();
- sshd.setKeyPairProvider(new PEMGeneratorHostKeyProvider(new File(gitblit.getBaseFolder(), HOST_KEY_STORE).getPath()));
- sshd.setPublickeyAuthenticator(new SshKeyAuthenticator(gitblit));
-
- run = new AtomicBoolean(false);
- SshCommandFactory f = graph.get(SshCommandFactory.class);
- sshd.setCommandFactory(f);
- }
-
- public int getPort() {
- return myAddress.getPort();
- }
-
- public String formatUrl(String gituser, String servername, String repository) {
- if (getPort() == DEFAULT_PORT) {
- // standard port
- return MessageFormat.format("{0}@{1}/{2}", gituser, servername, repository);
- } else {
- // non-standard port
- return MessageFormat.format("ssh://{0}@{1}:{2,number,0}/{3}", gituser, servername, getPort(), repository);
- }
- }
-
- /**
- * Start this daemon on a background thread.
- *
- * @throws IOException
- * the server socket could not be opened.
- * @throws IllegalStateException
- * the daemon is already running.
- */
- public synchronized void start() throws IOException {
- if (run.get()) {
- throw new IllegalStateException(JGitText.get().daemonAlreadyRunning);
- }
-
- sshd.start();
- run.set(true);
-
- logger.info(MessageFormat.format("SSH Daemon is listening on {0}:{1,number,0}",
- myAddress.getAddress().getHostAddress(), myAddress.getPort()));
- }
-
- /** @return true if this daemon is receiving connections. */
- public boolean isRunning() {
- return run.get();
- }
-
- /** Stop this daemon. */
- public synchronized void stop() {
- if (run.get()) {
- logger.info("SSH Daemon stopping...");
- run.set(false);
-
- try {
- sshd.stop();
- } catch (InterruptedException e) {
- logger.error("SSH Daemon stop interrupted", e);
- }
- }
- }
-
- @Module(library = true,
- injects = {
- IGitblit.class,
- SshCommandFactory.class,
- SshCommandServer.class,
- })
- public class SshModule {
- @Provides @Named("create-repository") Command provideCreateRepository() {
- return new CreateRepository();
- }
-
- @Provides @Named("version") Command provideVersion() {
- return new VersionCommand();
- }
-
-// @Provides(type=Type.SET) @Named("git") Command provideVersionCommand2() {
-// return new CreateRepository();
-// }
-
-// @Provides @Named("git") DispatchCommand providesGitCommand() {
-// return new DispatchCommand("git");
-// }
-
-// @Provides (type=Type.SET) Provider<Command> provideNonCommand() {
-// return new SshCommandFactory.NonCommand();
-// }
-
- @Provides @Singleton IdGenerator provideIdGenerator() {
- return new IdGenerator();
- }
-
- @Provides @Singleton RepositoryResolver<SshSession> provideRepositoryResolver() {
- return new RepositoryResolver<SshSession>(provideGitblit());
- }
-
- @Provides @Singleton UploadPackFactory<SshSession> provideUploadPackFactory() {
- return new GitblitUploadPackFactory<SshSession>(provideGitblit());
- }
-
- @Provides @Singleton ReceivePackFactory<SshSession> provideReceivePackFactory() {
- return new GitblitReceivePackFactory<SshSession>(provideGitblit());
- }
-
- @Provides @Singleton IGitblit provideGitblit() {
- return SshDaemon.this.gitblit;
- }
- }
-}
+/*
+ * Copyright 2014 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.transport.ssh;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+import java.net.InetSocketAddress;
+import java.security.KeyPair;
+import java.security.KeyPairGenerator;
+import java.text.MessageFormat;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.apache.sshd.common.NamedFactory;
+import org.apache.sshd.common.io.IoServiceFactoryFactory;
+import org.apache.sshd.common.io.mina.MinaServiceFactoryFactory;
+import org.apache.sshd.common.io.nio2.Nio2ServiceFactoryFactory;
+import org.apache.sshd.common.util.SecurityUtils;
+import org.apache.sshd.server.SshServer;
+import org.apache.sshd.server.auth.CachingPublicKeyAuthenticator;
+import org.apache.sshd.server.auth.UserAuth;
+import org.apache.sshd.server.auth.UserAuthKeyboardInteractiveFactory;
+import org.apache.sshd.server.auth.UserAuthPasswordFactory;
+import org.apache.sshd.server.auth.UserAuthPublicKeyFactory;
+import org.apache.sshd.server.auth.gss.GSSAuthenticator;
+import org.apache.sshd.server.auth.gss.UserAuthGSSFactory;
+import org.bouncycastle.openssl.PEMWriter;
+import org.eclipse.jgit.internal.JGitText;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.gitblit.Constants;
+import com.gitblit.IStoredSettings;
+import com.gitblit.Keys;
+import com.gitblit.manager.IGitblit;
+import com.gitblit.transport.ssh.commands.SshCommandFactory;
+import com.gitblit.utils.JnaUtils;
+import com.gitblit.utils.StringUtils;
+import com.gitblit.utils.WorkQueue;
+import com.google.common.io.Files;
+
+/**
+ * Manager for the ssh transport. Roughly analogous to the
+ * {@link com.gitblit.transport.git.GitDaemon} class.
+ *
+ */
+public class SshDaemon {
+
+ private final Logger log = LoggerFactory.getLogger(SshDaemon.class);
+
+ public static enum SshSessionBackend {
+ MINA, NIO2
+ }
+
+ /**
+ * 22: IANA assigned port number for ssh. Note that this is a distinct
+ * concept from gitblit's default conf for ssh port -- this "default" is
+ * what the git protocol itself defaults to if it sees and ssh url without a
+ * port.
+ */
+ public static final int DEFAULT_PORT = 22;
+
+ private final AtomicBoolean run;
+
+ private final IGitblit gitblit;
+ private final SshServer sshd;
+
+ /**
+ * Construct the Gitblit SSH daemon.
+ *
+ * @param gitblit
+ * @param workQueue
+ */
+ public SshDaemon(IGitblit gitblit, WorkQueue workQueue) {
+ this.gitblit = gitblit;
+
+ IStoredSettings settings = gitblit.getSettings();
+
+ // Ensure that Bouncy Castle is our JCE provider
+ SecurityUtils.setRegisterBouncyCastle(true);
+ if (SecurityUtils.isBouncyCastleRegistered()) {
+ log.debug("BouncyCastle is registered as a JCE provider");
+ }
+
+ // Generate host RSA and DSA keypairs and create the host keypair provider
+ File rsaKeyStore = new File(gitblit.getBaseFolder(), "ssh-rsa-hostkey.pem");
+ File dsaKeyStore = new File(gitblit.getBaseFolder(), "ssh-dsa-hostkey.pem");
+ generateKeyPair(rsaKeyStore, "RSA", 2048);
+ generateKeyPair(dsaKeyStore, "DSA", 0);
+ FileKeyPairProvider hostKeyPairProvider = new FileKeyPairProvider();
+ hostKeyPairProvider.setFiles(new String [] { rsaKeyStore.getPath(), dsaKeyStore.getPath(), dsaKeyStore.getPath() });
+
+ // Client public key authenticator
+ SshKeyAuthenticator keyAuthenticator =
+ new SshKeyAuthenticator(gitblit.getPublicKeyManager(), gitblit);
+
+ // Configure the preferred SSHD backend
+ String sshBackendStr = settings.getString(Keys.git.sshBackend,
+ SshSessionBackend.NIO2.name());
+ SshSessionBackend backend = SshSessionBackend.valueOf(sshBackendStr);
+ System.setProperty(IoServiceFactoryFactory.class.getName(),
+ backend == SshSessionBackend.MINA
+ ? MinaServiceFactoryFactory.class.getName()
+ : Nio2ServiceFactoryFactory.class.getName());
+
+ // Create the socket address for binding the SSH server
+ int port = settings.getInteger(Keys.git.sshPort, 0);
+ String bindInterface = settings.getString(Keys.git.sshBindInterface, "");
+ InetSocketAddress addr;
+ if (StringUtils.isEmpty(bindInterface)) {
+ addr = new InetSocketAddress(port);
+ } else {
+ addr = new InetSocketAddress(bindInterface, port);
+ }
+
+ //Will do GSS ?
+ GSSAuthenticator gssAuthenticator = null;
+ if(settings.getBoolean(Keys.git.sshWithKrb5, false)) {
+ gssAuthenticator = new SshKrbAuthenticator(gitblit, settings.getBoolean(Keys.git.sshKrb5StripDomain, false));
+ String keytabString = settings.getString(Keys.git.sshKrb5Keytab,
+ "");
+ if(! keytabString.isEmpty()) {
+ gssAuthenticator.setKeytabFile(keytabString);
+ }
+ String servicePrincipalName = settings.getString(Keys.git.sshKrb5ServicePrincipalName,
+ "");
+ if(! servicePrincipalName.isEmpty()) {
+ gssAuthenticator.setServicePrincipalName(servicePrincipalName);
+ }
+ }
+
+ //Sort the authenticators for sshd
+ List<NamedFactory<UserAuth>> userAuthFactories = new ArrayList<>();
+ String sshAuthenticatorsOrderString = settings.getString(Keys.git.sshAuthenticatorsOrder,
+ "password,keyboard-interactive,publickey");
+ for(String authenticator: sshAuthenticatorsOrderString.split(",")) {
+ String authenticatorName = authenticator.trim().toLowerCase(Locale.US);
+ switch (authenticatorName) {
+ case "gssapi-with-mic":
+ if(gssAuthenticator != null) {
+ userAuthFactories.add(new UserAuthGSSFactory());
+ }
+ break;
+ case "publickey":
+ userAuthFactories.add(new UserAuthPublicKeyFactory());
+ break;
+ case "password":
+ userAuthFactories.add(new UserAuthPasswordFactory());
+ break;
+ case "keyboard-interactive":
+ userAuthFactories.add(new UserAuthKeyboardInteractiveFactory());
+ break;
+ default:
+ log.error("Unknown ssh authenticator: '{}'", authenticatorName);
+ }
+ }
+
+ // Create the SSH server
+ sshd = SshServer.setUpDefaultServer();
+ sshd.setPort(addr.getPort());
+ sshd.setHost(addr.getHostName());
+ sshd.setKeyPairProvider(hostKeyPairProvider);
+ sshd.setPublickeyAuthenticator(new CachingPublicKeyAuthenticator(keyAuthenticator));
+ sshd.setPasswordAuthenticator(new UsernamePasswordAuthenticator(gitblit));
+ if(gssAuthenticator != null) {
+ sshd.setGSSAuthenticator(gssAuthenticator);
+ }
+ sshd.setUserAuthFactories(userAuthFactories);
+ sshd.setSessionFactory(new SshServerSessionFactory());
+ sshd.setFileSystemFactory(new DisabledFilesystemFactory());
+ sshd.setTcpipForwardingFilter(new NonForwardingFilter());
+ sshd.setCommandFactory(new SshCommandFactory(gitblit, workQueue));
+ sshd.setShellFactory(new WelcomeShell(settings));
+
+ // Set the server id. This can be queried with:
+ // ssh-keyscan -t rsa,dsa -p 29418 localhost
+ String version = String.format("%s (%s-%s)", Constants.getGitBlitVersion().replace(' ', '_'),
+ sshd.getVersion(), sshBackendStr);
+ sshd.getProperties().put(SshServer.SERVER_IDENTIFICATION, version);
+
+ run = new AtomicBoolean(false);
+ }
+
+ public String formatUrl(String gituser, String servername, String repository) {
+ IStoredSettings settings = gitblit.getSettings();
+
+ int port = sshd.getPort();
+ int displayPort = settings.getInteger(Keys.git.sshAdvertisedPort, port);
+ String displayServername = settings.getString(Keys.git.sshAdvertisedHost, "");
+ if(displayServername.isEmpty()) {
+ displayServername = servername;
+ }
+ if (displayPort == DEFAULT_PORT) {
+ // standard port
+ return MessageFormat.format("ssh://{0}@{1}/{2}", gituser, displayServername,
+ repository);
+ } else {
+ // non-standard port
+ return MessageFormat.format("ssh://{0}@{1}:{2,number,0}/{3}",
+ gituser, displayServername, displayPort, repository);
+ }
+ }
+
+ /**
+ * Start this daemon on a background thread.
+ *
+ * @throws IOException
+ * the server socket could not be opened.
+ * @throws IllegalStateException
+ * the daemon is already running.
+ */
+ public synchronized void start() throws IOException {
+ if (run.get()) {
+ throw new IllegalStateException(JGitText.get().daemonAlreadyRunning);
+ }
+
+ sshd.start();
+ run.set(true);
+
+ String sshBackendStr = gitblit.getSettings().getString(Keys.git.sshBackend,
+ SshSessionBackend.NIO2.name());
+
+ log.info(MessageFormat.format(
+ "SSH Daemon ({0}) is listening on {1}:{2,number,0}",
+ sshBackendStr, sshd.getHost(), sshd.getPort()));
+ }
+
+ /** @return true if this daemon is receiving connections. */
+ public boolean isRunning() {
+ return run.get();
+ }
+
+ /** Stop this daemon. */
+ public synchronized void stop() {
+ if (run.get()) {
+ log.info("SSH Daemon stopping...");
+ run.set(false);
+
+ try {
+ ((SshCommandFactory) sshd.getCommandFactory()).stop();
+ sshd.stop();
+ } catch (IOException e) {
+ log.error("SSH Daemon stop interrupted", e);
+ }
+ }
+ }
+
+ private void generateKeyPair(File file, String algorithm, int keySize) {
+ if (file.exists()) {
+ return;
+ }
+ try {
+ KeyPairGenerator generator = SecurityUtils.getKeyPairGenerator(algorithm);
+ if (keySize != 0) {
+ generator.initialize(keySize);
+ log.info("Generating {}-{} SSH host keypair...", algorithm, keySize);
+ } else {
+ log.info("Generating {} SSH host keypair...", algorithm);
+ }
+ KeyPair kp = generator.generateKeyPair();
+
+ // create an empty file and set the permissions
+ Files.touch(file);
+ try {
+ JnaUtils.setFilemode(file, JnaUtils.S_IRUSR | JnaUtils.S_IWUSR);
+ } catch (UnsatisfiedLinkError | UnsupportedOperationException e) {
+ // Unexpected/Unsupported OS or Architecture
+ }
+
+ FileOutputStream os = new FileOutputStream(file);
+ PEMWriter w = new PEMWriter(new OutputStreamWriter(os));
+ w.writeObject(kp);
+ w.flush();
+ w.close();
+ } catch (Exception e) {
+ log.warn(MessageFormat.format("Unable to generate {0} keypair", algorithm), e);
+ return;
+ }
+ }
+}
--
Gitblit v1.9.1