Delphi ActiveX 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? Delphi ActiveX

var
success: Integer;
key: TChilkatSshKey;
sftp: TChilkatSFtp;
json: TChilkatJsonObject;

begin
success := 0;

//  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.
key := TChilkatSshKey.Create(Self);
key.Password := 'key_password';

success := key.FromOpenSshPrivateKey(key.LoadText('qa_data/my_private_key_file'));
if (success = 0) then
  begin
    Memo1.Lines.Add(key.LastErrorText);
    Exit;
  end;

sftp := TChilkatSFtp.Create(Self);

success := sftp.Connect('sftp.example.com',22);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

//  Authenticate using both a password and private key.
success := sftp.AuthenticatePwPk('myLogin','myPassword',key.ControlInterface);
if (success = 1) then
  begin
    Memo1.Lines.Add('Authentication is successful!');
    Exit;
  end;

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

json := TChilkatJsonObject.Create(Self);
sftp.GetLastJsonData(json.ControlInterface);

json.EmitCompact := 0;

//  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:
Memo1.Lines.Add('authResult: ' + json.StringOf('authResult'));
Memo1.Lines.Add('authFailReason: ' + json.StringOf('authFailReason'));