(Java) SFTP Auth Failure Reason (AuthenticatePwPk)

This example demonstrates how to determine the failure reason for the case where both a password and private key are required for authentication. If authentication fails, was it because of an invalid private key, or an invalid password?

Note: This example requires a feature introduced in Chilkat v9.5.0.79

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.

    // Load a private key to be used for SSH authentication.
    CkSshKey key = new CkSshKey();
    key.put_Password("key_password");

    boolean success = key.FromOpenSshPrivateKey(key.loadText("qa_data/my_private_key_file"));
    if (success != true) {
        System.out.println(key.lastErrorText());
        return;
        }

    CkSFtp sftp = new CkSFtp();

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

    // Authenticate using both a password and private key.
    success = sftp.AuthenticatePwPk("myLogin","myPassword",key);
    if (success == true) {
        System.out.println("Authentication is successful!");
        return;
        }

    // If we get here, it means the authentication failed.
    // To find out why, get the LastJsonData
    // This is a feature added in Chilkat v9.5.0.79

    CkJsonObject json = sftp.LastJsonData();
    json.put_EmitCompact(false);

    // This is the JSON if the key is correct, but the password is incorrect:

    // {
    //   "public_key_type": "rsa",
    //   "partialAuthResult": "publickey success. continue to authenticate with password...",
    //   "authResult": "failed",
    //   "authFailReason": "Password is incorrect"
    // }

    // This is the JSON if the key is incorrect.  We won't know if the password is also incorrect until
    // the key is made correct so that authentication proceeds to check the password.

    // {
    //   "public_key_type": "rsa",
    //   "authResult": "failed",
    //   "authFailReason": "Key is incorrect"
    // }

    // To get the authResult anbd authFailReason:
    System.out.println("authResult: " + json.stringOf("authResult"));
    System.out.println("authFailReason: " + json.stringOf("authFailReason"));
  }
}