Sample code for 30+ languages & platforms
Delphi ActiveX

SFTP Authenticate with a SecureString Password and Private Key

See more SFTP Examples

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 ActiveX Downloads

Delphi ActiveX
var
success: Integer;
sftp: TChilkatSFtp;
port: Integer;
password: WideString;
privKey: TChilkatSshKey;
keyText: WideString;
secureLogin: TChilkatSecureString;
securePassword: TChilkatSecureString;

begin
success := 0;

//  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 := TChilkatSFtp.Create(Self);

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
port := 22;
success := sftp.Connect('sftp.example.com',port);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    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 := TChilkatSshKey.Create(Self);
keyText := privKey.LoadText('qa_data/id_rsa');
if (privKey.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(privKey.LastErrorText);
    Exit;
  end;
success := privKey.FromOpenSshPrivateKey(keyText);
if (success = 0) then
  begin
    Memo1.Lines.Add(privKey.LastErrorText);
    Exit;
  end;

//  Place the login and password into SecureString objects.
secureLogin := TChilkatSecureString.Create(Self);
secureLogin.Append('mySshLogin');
securePassword := TChilkatSecureString.Create(Self);
securePassword.Append(password);

success := sftp.AuthenticateSecPwPk(secureLogin.ControlInterface,securePassword.ControlInterface,privKey.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(sftp.LastErrorText);
    Exit;
  end;

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

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

sftp.Disconnect();