Delphi DLL

SFTP Authenticate with a SecureString Password and Private Key

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: This is the SecureString form of two-factor SFTP authentication: the password is held encrypted in memory and combined with a private key for servers that require both. It is the most protective option when a deployment mandates two-factor SSH and you also want to minimize plaintext credential exposure in the process.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
sftp: HCkSFtp;
port: Integer;
password: PWideChar;
privKey: HCkSshKey;
keyText: PWideChar;
secureLogin: HCkSecureString;
securePassword: HCkSecureString;

begin
success := False;

//  Demonstrates the SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
//  and password objects together with a private key.  The 1st argument is the username, the 2nd
//  is the password, and the 3rd is an SshKey private key.

sftp := CkSFtp_Create();

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
port := 22;
success := CkSFtp_Connect(sftp,'sftp.example.com',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    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';

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
privKey := CkSshKey_Create();
keyText := CkSshKey__loadText(privKey,'qa_data/id_rsa');
if (CkSshKey_getLastMethodSuccess(privKey) = False) then
  begin
    Memo1.Lines.Add(CkSshKey__lastErrorText(privKey));
    Exit;
  end;
success := CkSshKey_FromOpenSshPrivateKey(privKey,keyText);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSshKey__lastErrorText(privKey));
    Exit;
  end;

//  Place the login and password into SecureString objects.
secureLogin := CkSecureString_Create();
CkSecureString_Append(secureLogin,'mySshLogin');
securePassword := CkSecureString_Create();
CkSecureString_Append(securePassword,password);

success := CkSFtp_AuthenticateSecPwPk(sftp,secureLogin,securePassword,privKey);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success := CkSFtp_InitializeSftp(sftp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSFtp__lastErrorText(sftp));
    Exit;
  end;

Memo1.Lines.Add('Authenticated.');

CkSFtp_Disconnect(sftp);

CkSFtp_Dispose(sftp);
CkSshKey_Dispose(privKey);
CkSecureString_Dispose(secureLogin);
CkSecureString_Dispose(securePassword);