(Java) SFTP Authentication using X.509 Certificates

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using an certificate's private key.

Note: See X.509v3 Certificates for SSH Authentication for more information.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkSFtp sftp = new CkSFtp();

    String hostname = "sftp.example.com";
    int port = 22;
    boolean success = sftp.Connect(hostname,port);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Load the cert + private key from a .pfx.
    // Note: Chilkat provides methods for loading certs and private keys from many sources, including smart cards and USB tokens (HSM's)
    CkCert cert = new CkCert();
    success = cert.LoadPfxFile("qa_data/pfx/example.pfx","pfx_password");
    if (success != true) {
        System.out.println(cert.lastErrorText());
        return;
        }

    // Get the cert's private key (as PEM) to be used for SSH authentication.
    // (The public key is installed on the server.)
    String privKeyPem = cert.getPrivateKeyPem();
    if (cert.get_LastMethodSuccess() == false) {
        System.out.println(cert.lastErrorText());
        return;
        }

    CkSshKey key = new CkSshKey();

    // Load a private key from a PEM string:
    success = key.FromOpenSshPrivateKey(privKeyPem);
    if (success != true) {
        System.out.println(key.lastErrorText());
        return;
        }

    // Authenticate with the SSH server.
    success = sftp.AuthenticatePk("myLogin",key);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("Public-Key Authentication Successful!");
  }
}