Delphi DLL

SSH Auth Failure Reason (AuthenticatePwPk)

Demonstrates how to determine why authentication failed when a server requires both a password and a private key. If AuthenticatePwPk fails, GetLastJsonData returns diagnostic JSON whose authResult and authFailReason members reveal which factor was at fault.

Background: With multi-factor SSH, a plain failure is ambiguous — the key could be wrong, the password could be wrong, or both. The diagnostic JSON resolves that: it reports Key is incorrect when the key fails, or a partialAuthResult showing the key succeeded before Password is incorrect. Note the ordering consequence: if the key is rejected, authentication never reaches the password check, so you cannot yet know whether the password is also wrong. Passwords and passphrases are never included in this JSON, so it is safe to log.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
key: HCkSshKey;
privKeyText: PWideChar;
ssh: HCkSsh;
port: Integer;
password: PWideChar;
json: HCkJsonObject;

begin
success := False;

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Demonstrates how to determine why authentication failed when a server requires BOTH a
//  password and a private key.  Was the private key wrong, or the password?

//  Load the private key used for authentication.
key := CkSshKey_Create();

//  The key password is not hard-coded in a real application; obtain it from a secure source.
CkSshKey_putPassword(key,'myKeyPassword');

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

success := CkSshKey_FromOpenSshPrivateKey(key,privKeyText);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSshKey__lastErrorText(key));
    Exit;
  end;

ssh := CkSsh_Create();
port := 22;
success := CkSsh_Connect(ssh,'ssh.example.com',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  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.
password := 'mySshPassword';

//  Authenticate using both a password and a private key.
success := CkSsh_AuthenticatePwPk(ssh,'mySshLogin',password,key);
if (success) then
  begin
    Memo1.Lines.Add('Authentication is successful!');
    Exit;
  end;

//  Authentication failed.  The diagnostic JSON explains which factor was at fault.
json := CkJsonObject_Create();
CkSsh_GetLastJsonData(ssh,json);
CkJsonObject_putEmitCompact(json,False);

//  If the key is correct but the password is wrong:
//  {
//    "public_key_type": "rsa",
//    "partialAuthResult": "publickey success. continue to authenticate with password...",
//    "authResult": "failed",
//    "authFailReason": "Password is incorrect"
//  }
//  
//  If the key is incorrect.  Whether the password is also wrong is unknown, because
//  authentication never got far enough to check it:
//  {
//    "public_key_type": "rsa",
//    "authResult": "failed",
//    "authFailReason": "Key is incorrect"
//  }

Memo1.Lines.Add('authResult: ' + CkJsonObject__stringOf(json,'authResult'));
Memo1.Lines.Add('authFailReason: ' + CkJsonObject__stringOf(json,'authFailReason'));

CkSshKey_Dispose(key);
CkSsh_Dispose(ssh);
CkJsonObject_Dispose(json);