Delphi DLL

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 DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, SshKey, JsonObject, SFtp;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
key: HCkSshKey;
sftp: HCkSFtp;
json: HCkJsonObject;

begin
success := False;

// 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 := CkSshKey_Create();
CkSshKey_putPassword(key,'key_password');

success := CkSshKey_FromOpenSshPrivateKey(key,CkSshKey__loadText(key,'qa_data/my_private_key_file'));
if (success = False) then
  begin
    Memo1.Lines.Add(CkSshKey__lastErrorText(key));
    Exit;
  end;

sftp := CkSFtp_Create();

success := CkSFtp_Connect(sftp,'sftp.example.com',22);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

// Authenticate using both a password and private key.
success := CkSFtp_AuthenticatePwPk(sftp,'myLogin','myPassword',key);
if (success = True) 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 := CkJsonObject_Create();
CkSFtp_GetLastJsonData(sftp,json);

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

CkSshKey_Dispose(key);
CkSFtp_Dispose(sftp);
CkJsonObject_Dispose(json);

end;