Connect to an SFTP Server

See more SFTP Examples

Demonstrates the Chilkat SFtp.Connect method, which establishes the SSH connection to an SFTP server. The first argument is the hostname (a DNS name or numeric IPv4/IPv6 address) and the second is the TCP port, usually 22. Connecting is the first of three setup steps.

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.SFtp;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  port: Integer;
  password: string;

begin
  success := False;

  //  Demonstrates the SFtp.Connect method, which establishes the SSH connection to an SFTP server.
  //  The 1st argument is the hostname (a DNS name or numeric IP) and the 2nd is the TCP port.
  //  
  //  Connecting is only the first of three steps.  The full sequence is:
  //    1. Connect
  //    2. AuthenticatePw (or another authentication method)
  //    3. InitializeSftp

  sftp := TSFtp.Create;

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

  success := sftp.AuthenticatePw('mySshLogin',password);
  if (success = False) then
    begin
      WriteLn(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 = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  WriteLn('Connected, authenticated, and SFTP subsystem initialized.');

  sftp.Disconnect();


  sftp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.