com.github.mlk.junit.rules.SftpRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of assortmentofjunitrules Show documentation

Useful assortment of JUnit rules for integration testing

There is a newer version: 1.5.39

Show newest version

package com.github.mlk.junit.rules;

import static com.github.mlk.junit.rules.Helper.findRandomOpenPortOnAllLocalInterfaces;

import java.io.File;
import java.io.IOException;
import java.security.PublicKey;
import java.util.Collections;
import java.util.function.Supplier;
import org.apache.sshd.common.file.virtualfs.VirtualFileSystemFactory;
import org.apache.sshd.common.keyprovider.ClassLoadableResourceKeyPairProvider;
import org.apache.sshd.server.SshServer;
import org.apache.sshd.server.auth.hostbased.StaticHostBasedAuthenticator;
import org.apache.sshd.server.auth.pubkey.AcceptAllPublickeyAuthenticator;
import org.apache.sshd.server.auth.pubkey.UserAuthPublicKeyFactory;
import org.apache.sshd.server.scp.ScpCommandFactory;
import org.apache.sshd.server.subsystem.sftp.SftpSubsystemFactory;
import org.junit.rules.ExternalResource;

/**
 * Create an SFTP server running on a random port. This server runs in a promiscuous mode, accepting
 * any connection with a private key.
 * TODO:
 * - Allow both public key or username/password auth.
 * - Allow for custom server key
 */
public class SftpRule extends ExternalResource {

  private final Supplier currentFolder;

  private SshServer sshd;

  /**
   * SFTP Server
   *
   * @param currentFolder The user home folder for the SFTP server.
   */
  public SftpRule(Supplier currentFolder) {
    this.currentFolder = currentFolder;
  }

  @Override
  protected void before() throws Throwable {
    sshd = SshServer.setUpDefaultServer();
    sshd.setPort(findRandomOpenPortOnAllLocalInterfaces());
    sshd.setKeyPairProvider(
        new ClassLoadableResourceKeyPairProvider(getClass().getClassLoader(), "server_key"));
    sshd.setCommandFactory(new ScpCommandFactory());
    sshd.setSubsystemFactories(Collections.singletonList(new SftpSubsystemFactory()));
    sshd.setUserAuthFactories(Collections.singletonList(new UserAuthPublicKeyFactory()));
    sshd.setHost("localhost");
    sshd.setPublickeyAuthenticator(AcceptAllPublickeyAuthenticator.INSTANCE);
    sshd.setHostBasedAuthenticator(new StaticHostBasedAuthenticator(true));

    VirtualFileSystemFactory fileSystemFactory = new VirtualFileSystemFactory();
    fileSystemFactory.setDefaultHomeDir(currentFolder.get().toPath());

    sshd.setFileSystemFactory(fileSystemFactory);
    sshd.start();
  }

  @Override
  protected void after() {
    try {
      sshd.stop();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  /**
   * The port the server is running on.
   *
   * @return The port the server is running on.
   */
  public int getPort() {
    return sshd.getPort();
  }

  /**
   * The servers public key
   *
   * @return The servers public key
   * @deprecated Badly named, use getHostsPublicKey
   */
  @Deprecated
  public PublicKey getPublicKey() {
    return getHostsPublicKey();
  }

  public PublicKey getHostsPublicKey() {
    return sshd.getKeyPairProvider().loadKeys().iterator().next().getPublic();
  }
}