Elevate the public key manager to a top-level manager

James Moger

2014-03-17 245836904ba5cecdc31773cf7c9616396c8ad8c0

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

@@ -21,39 +21,21 @@
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.IoServiceFactory;
import org.apache.sshd.common.io.IoServiceFactoryFactory;
import org.apache.sshd.common.io.mina.MinaServiceFactory;
import org.apache.sshd.common.io.mina.MinaServiceFactoryFactory;
import org.apache.sshd.common.io.nio2.Nio2ServiceFactory;
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.IGitblit;
import com.gitblit.transport.ssh.commands.CreateRepository;
import com.gitblit.transport.ssh.commands.DispatchCommand;
import com.gitblit.transport.ssh.commands.Receive;
import com.gitblit.transport.ssh.commands.SetAccountCommand;
import com.gitblit.transport.ssh.commands.Upload;
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
@@ -69,7 +51,7 @@
   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
@@ -84,7 +66,6 @@

   private final IGitblit gitblit;
   private final SshServer sshd;
   private final ObjectGraph injector;

   /**
    * Construct the Gitblit SSH daemon.
@@ -93,14 +74,11 @@
    */
   public SshDaemon(IGitblit gitblit, IdGenerator idGenerator) {
      this.gitblit = gitblit;
      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());
@@ -109,7 +87,7 @@
          backend == SshSessionBackend.MINA
             ? MinaServiceFactoryFactory.class.getName()
             : Nio2ServiceFactoryFactory.class.getName());
		

      InetSocketAddress addr;
      if (StringUtils.isEmpty(bindInterface)) {
         addr = new InetSocketAddress(port);
@@ -117,42 +95,24 @@
         addr = new InetSocketAddress(bindInterface, port);
      }

      SshKeyAuthenticator publickeyAuthenticator = new SshKeyAuthenticator(
            keyManager, gitblit);
      File hostKeyStore = new File(gitblit.getBaseFolder(), HOST_KEY_STORE);
      CachingPublicKeyAuthenticator keyAuthenticator =
            new CachingPublicKeyAuthenticator(gitblit.getPublicKeyManager(), 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(publickeyAuthenticator);
      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.setTcpipForwardingFilter(new NonForwardingFilter());
      sshd.setCommandFactory(new SshCommandFactory(gitblit, idGenerator));
      sshd.setShellFactory(new WelcomeShell(settings));

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

      DispatchCommand gitCmd = new DispatchCommand();
      gitCmd.registerCommand(Upload.class);
      gitCmd.registerCommand(Receive.class);

      DispatchCommand root = new DispatchCommand();
      root.registerDispatcher("gitblit", gitblitCmd);
      root.registerDispatcher("git", gitCmd);

      root.setRepositoryResolver(new RepositoryResolver<SshSession>(gitblit));
      root.setUploadPackFactory(new GitblitUploadPackFactory<SshSession>(gitblit));
      root.setReceivePackFactory(new GitblitReceivePackFactory<SshSession>(gitblit));
      root.setAuthenticator(publickeyAuthenticator);

      SshCommandFactory commandFactory = new SshCommandFactory(
            new WorkQueue(idGenerator),
            root);

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

      run = new AtomicBoolean(false);
   }
@@ -185,9 +145,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. */
@@ -206,53 +169,6 @@
         } catch (InterruptedException e) {
            log.error("SSH Daemon stop interrupted", e);
         }
      }
   }
	
   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;
   }
	
   /**
    * 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);
      }
   }
}