DataFlex

SFTP Authenticate with a SecureString Password

Demonstrates the Chilkat SFtp.AuthenticateSecPw method, which authenticates using SecureString login and password objects. The first argument is the login and the second is the password.

Background: A SecureString keeps the credential encrypted in memory, reducing the chance of a plaintext password lingering in the process. The behavior otherwise matches AuthenticatePw; only the credential handling is more protective. Populate the SecureString from a value obtained at runtime, not a hard-coded literal.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    Variant vSecureLogin
    Handle hoSecureLogin
    Variant vSecurePassword
    Handle hoSecurePassword
    String sTemp1

    Move False To iSuccess

    //  Demonstrates the SFtp.AuthenticateSecPw method, which authenticates using SecureString login
    //  and password objects.  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

    //  Place the login and password into SecureString objects.
    Get Create (RefClass(cComChilkatSecureString)) To hoSecureLogin
    If (Not(IsComObjectCreated(hoSecureLogin))) Begin
        Send CreateComObject of hoSecureLogin
    End
    Get ComAppend Of hoSecureLogin "mySshLogin" To iSuccess
    Get Create (RefClass(cComChilkatSecureString)) To hoSecurePassword
    If (Not(IsComObjectCreated(hoSecurePassword))) Begin
        Send CreateComObject of hoSecurePassword
    End
    Get ComAppend Of hoSecurePassword sPassword To iSuccess

    Get pvComObject of hoSecureLogin to vSecureLogin
    Get pvComObject of hoSecurePassword to vSecurePassword
    Get ComAuthenticateSecPw Of hoSftp vSecureLogin vSecurePassword 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 secure strings."

    Send ComDisconnect To hoSftp


End_Procedure