React Native Requires Chilkat v11.0.0+

SFTP Auth Failure Reason (AuthenticatePwPk)

See more SFTP Examples

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? React Native

import { JsonObject, SFtp, SshKey } from '@chilkat/react-native'

async function chilkatExample() {
  // 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.
  const key = new SshKey();
  key.password = 'key_password';

  try {
    key.fromOpenSshPrivateKey(key.loadText('qa_data/my_private_key_file'));
  } catch {
    console.log(key.lastErrorText);
    return;
  }

  const sftp = new SFtp();

  try {
    await sftp.connectAsync('sftp.example.com', 22);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Authenticate using both a password and private key.
  try {
    await sftp.authenticatePwPkAsync('myLogin', 'myPassword', key);
    console.log('Authentication is successful!');
    return;
  } catch {
    // sftp.authenticatePwPk() failed; continue anyway.
  }

  // If we get here, it means the authentication failed.
  // Examine the last JSON data..

  const json = new JsonObject();
  sftp.getLastJsonData(json);

  json.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:
  console.log(`authResult: ${json.stringOf('authResult')}`);
  console.log(`authFailReason: ${json.stringOf('authFailReason')}`);
}