DataFlex

SFTP Authenticate with a Password

Demonstrates the Chilkat SFtp.AuthenticatePw method, which authenticates the connected session with a login name and password. The first argument is the login and the second is the password. Call Connect first and InitializeSftp afterward.

Background: Password authentication is the simplest SFTP method, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for automated jobs. Note the fixed ordering: authentication happens between Connect and InitializeSftp.

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.AuthenticatePw method, which authenticates the connected session with a
    //  login name and password.  The 1st argument is the login and the 2nd is the password.

    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 "Authenticated with a password."

    Send ComDisconnect To hoSftp


End_Procedure