Create git and gitblit dispatchers

James Moger

2014-03-17 9d44ade215922fd9e7bda7c604b31c31d217d750

 src/main/java/com/gitblit/transport/ssh/SshDaemon.java

@@ -21,28 +21,32 @@
import java.text.MessageFormat;
import java.util.concurrent.atomic.AtomicBoolean;

import javax.inject.Singleton;

import org.apache.sshd.SshServer;
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.server.keyprovider.PEMGeneratorHostKeyProvider;
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.git.GitblitReceivePackFactory;
import com.gitblit.git.GitblitUploadPackFactory;
import com.gitblit.git.RepositoryResolver;
import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IGitblit;
import com.gitblit.transport.ssh.commands.CreateRepository;
import com.gitblit.transport.ssh.commands.DispatchCommand;
import com.gitblit.transport.ssh.commands.VersionCommand;
import com.gitblit.utils.IdGenerator;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.WorkQueue;

import dagger.Module;
import dagger.ObjectGraph;
import dagger.Provides;

/**
 * Manager for the ssh transport. Roughly analogous to the
 * {@link com.gitblit.git.GitDaemon} class.
 * {@link com.gitblit.transport.git.GitDaemon} class.
 *
 * @author Eric Myhre
 *
@@ -50,6 +54,10 @@
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
@@ -63,12 +71,9 @@

   private final AtomicBoolean run;

   @SuppressWarnings("unused")
   private final IGitblit gitblit;

   private final IdGenerator idGenerator;

   private final SshServer sshd;
   private final ObjectGraph injector;

   /**
    * Construct the Gitblit SSH daemon.
@@ -77,12 +82,22 @@
    */
   public SshDaemon(IGitblit gitblit, IdGenerator idGenerator) {
      this.gitblit = gitblit;
      this.idGenerator = idGenerator;
      this.injector = ObjectGraph.create(new SshModule());

      IStoredSettings settings = gitblit.getSettings();
      int port = settings.getInteger(Keys.git.sshPort, 0);
      String bindInterface = settings.getString(Keys.git.sshBindInterface,
            "localhost");

      IKeyManager keyManager = getKeyManager();

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

      InetSocketAddress addr;
      if (StringUtils.isEmpty(bindInterface)) {
@@ -91,34 +106,47 @@
         addr = new InetSocketAddress(bindInterface, port);
      }

      File hostKeyStore = new File(gitblit.getBaseFolder(), HOST_KEY_STORE);
      CachingPublicKeyAuthenticator keyAuthenticator =
            getPublicKeyAuthenticator(keyManager, gitblit);

      sshd = SshServer.setUpDefaultServer();
      sshd.setPort(addr.getPort());
      sshd.setHost(addr.getHostName());
      sshd.setKeyPairProvider(new PEMGeneratorHostKeyProvider(new File(
            gitblit.getBaseFolder(), HOST_KEY_STORE).getPath()));
      sshd.setPublickeyAuthenticator(new SshKeyAuthenticator(gitblit));
      sshd.setPasswordAuthenticator(new SshPasswordAuthenticator(gitblit));
      sshd.setSessionFactory(new SshSessionFactory(idGenerator));
      sshd.setKeyPairProvider(new PEMGeneratorHostKeyProvider(hostKeyStore.getPath()));
      sshd.setPublickeyAuthenticator(keyAuthenticator);
      sshd.setPasswordAuthenticator(new UsernamePasswordAuthenticator(gitblit));
      sshd.setSessionFactory(new SshServerSessionFactory());
      sshd.setFileSystemFactory(new DisabledFilesystemFactory());
      sshd.setForwardingFilter(new NonForwardingFilter());
      sshd.setTcpipForwardingFilter(new NonForwardingFilter());
      sshd.setCommandFactory(new SshCommandFactory(gitblit, keyAuthenticator, idGenerator));
      sshd.setShellFactory(new WelcomeShell(settings));

      DispatchCommand gitblitCmd = new DispatchCommand();
      gitblitCmd.registerCommand(CreateRepository.class);
      gitblitCmd.registerCommand(VersionCommand.class);

      DispatchCommand dispatcher = new DispatchCommand();
      dispatcher.registerDispatcher("gitblit", gitblitCmd);

      SshCommandFactory commandFactory = new SshCommandFactory(
            new RepositoryResolver<SshSession>(gitblit),
            new GitblitUploadPackFactory<SshSession>(gitblit),
            new GitblitReceivePackFactory<SshSession>(gitblit),
            new WorkQueue(idGenerator),
            dispatcher);

      sshd.setCommandFactory(commandFactory);
      String version = Constants.getGitBlitVersion() + " (" + sshd.getVersion() + ")";
      sshd.getProperties().put(SshServer.SERVER_IDENTIFICATION, version);

      run = new AtomicBoolean(false);
   }

   private CachingPublicKeyAuthenticator getPublicKeyAuthenticator(
         IKeyManager keyManager, IGitblit gitblit) {
      IStoredSettings settings = gitblit.getSettings();
      String clazz = settings.getString(Keys.git.sshPublicKeyAuthenticator,
            CachingPublicKeyAuthenticator.class.getName());
      if (StringUtils.isEmpty(clazz)) {
         clazz = CachingPublicKeyAuthenticator.class.getName();
      }
      try {
         Class<CachingPublicKeyAuthenticator> authClass =
               (Class<CachingPublicKeyAuthenticator>) Class.forName(clazz);
         return authClass.getConstructor(
               new Class[] { IKeyManager.class,
                     IAuthenticationManager.class }).newInstance(
               keyManager, gitblit);
      } catch (Exception e) {
         log.error("failed to create ssh auth manager " + clazz, e);
      }
      return null;
   }

   public String formatUrl(String gituser, String servername, String repository) {
@@ -149,9 +177,12 @@
      sshd.start();
      run.set(true);

      String sshBackendStr = gitblit.getSettings().getString(Keys.git.sshBackend,
            SshSessionBackend.NIO2.name());

      log.info(MessageFormat.format(
            "SSH Daemon is listening on {0}:{1,number,0}",
            sshd.getHost(), sshd.getPort()));
            "SSH Daemon ({0}) is listening on {1}:{2,number,0}",
            sshBackendStr, sshd.getHost(), sshd.getPort()));
   }

   /** @return true if this daemon is receiving connections. */
@@ -172,4 +203,75 @@
         }
      }
   }

   @SuppressWarnings("unchecked")
   protected IKeyManager getKeyManager() {
      IKeyManager keyManager = null;
      IStoredSettings settings = gitblit.getSettings();
      String clazz = settings.getString(Keys.git.sshKeysManager, FileKeyManager.class.getName());
      if (StringUtils.isEmpty(clazz)) {
         clazz = FileKeyManager.class.getName();
      }
      try {
         Class<? extends IKeyManager> managerClass = (Class<? extends IKeyManager>) Class.forName(clazz);
         keyManager = injector.get(managerClass).start();
         if (keyManager.isReady()) {
            log.info("{} is ready.", keyManager);
         } else {
            log.warn("{} is disabled.", keyManager);
         }
      } catch (Exception e) {
         log.error("failed to create ssh key manager " + clazz, e);
         keyManager = injector.get(NullKeyManager.class).start();
      }
      return keyManager;
   }

   @SuppressWarnings("unchecked")
   protected IKeyManager getKeyAuthenticator() {
      IKeyManager keyManager = null;
      IStoredSettings settings = gitblit.getSettings();
      String clazz = settings.getString(Keys.git.sshKeysManager, FileKeyManager.class.getName());
      if (StringUtils.isEmpty(clazz)) {
         clazz = FileKeyManager.class.getName();
      }
      try {
         Class<? extends IKeyManager> managerClass = (Class<? extends IKeyManager>) Class.forName(clazz);
         keyManager = injector.get(managerClass).start();
         if (keyManager.isReady()) {
            log.info("{} is ready.", keyManager);
         } else {
            log.warn("{} is disabled.", keyManager);
         }
      } catch (Exception e) {
         log.error("failed to create ssh key manager " + clazz, e);
         keyManager = injector.get(NullKeyManager.class).start();
      }
      return keyManager;
   }

   /**
    * A nested Dagger graph is used for constructor dependency injection of
    * complex classes.
    *
    * @author James Moger
    *
    */
   @Module(
         library = true,
         injects = {
               NullKeyManager.class,
               FileKeyManager.class
         }
         )
   class SshModule {

      @Provides @Singleton NullKeyManager provideNullKeyManager() {
         return new NullKeyManager();
      }

      @Provides @Singleton FileKeyManager provideFileKeyManager() {
         return new FileKeyManager(SshDaemon.this.gitblit);
      }
   }
}