Java

SFTP Authenticate with a SecureString Password

Demonstrates the Chilkat SFtp.AuthenticateSecPw method, which authenticates using SecureString login and password objects. The first argument is the login and the second is the password.

Background: A SecureString keeps the credential encrypted in memory, reducing the chance of a plaintext password lingering in the process. The behavior otherwise matches AuthenticatePw; only the credential handling is more protective. Populate the SecureString from a value obtained at runtime, not a hard-coded literal.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.SFtp;
import com.chilkatsoft.chilkat2.SecureString;

public class ChilkatExample {

    public static void main(String[] args) {
        // Demonstrates the SFtp.AuthenticateSecPw method, which authenticates using SecureString login
        // and password objects.  The 1st argument is the login and the 2nd is the password.

        SFtp sftp = new SFtp();

        // Step 1: Connect the SSH transport.  Port 22 is the usual port.
        int port = 22;
        try {
            sftp.connect("sftp.example.com", port);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Normally you would not hard-code the password in source.  You should instead obtain it
        // from an interactive prompt, environment variable, or a secrets vault.
        String password = "mySshPassword";

        // Place the login and password into SecureString objects.
        SecureString secureLogin = new SecureString();
        secureLogin.append("mySshLogin");
        SecureString securePassword = new SecureString();
        securePassword.append(password);

        try {
            sftp.authenticateSecPw(secureLogin, securePassword);

            // Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
            // file or directory operations.
            sftp.initializeSftp();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Authenticated with secure strings.");

        sftp.disconnect();
    }
}