DataFlex

Connect to an SFTP Server

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.

Background: SFTP runs as a subsystem over SSH, so a session is set up in three fixed steps: Connect establishes the encrypted SSH transport, an Authenticate method logs in, and InitializeSftp opens the SFTP subsystem. File and directory operations are only possible after all three succeed.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    String sTemp1

    Move False To iSuccess

    //  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

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    //  Step 1: Connect the SSH transport.  Port 22 is the usual port.
    Move 22 To iPort
    Get ComConnect Of hoSftp "sftp.example.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSftp "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    //  file or directory operations.
    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Connected, authenticated, and SFTP subsystem initialized."

    Send ComDisconnect To hoSftp


End_Procedure