PureBasic

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

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSecureString.pb"
IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  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.

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Step 1: Connect the SSH transport.  Port 22 is the usual port.
    port.i = 22
    success = CkSFtp::ckConnect(sftp,"sftp.example.com",port)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ;  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.s = "mySshPassword"

    ;  Place the login and password into SecureString objects.
    secureLogin.i = CkSecureString::ckCreate()
    If secureLogin.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkSecureString::ckAppend(secureLogin,"mySshLogin")
    securePassword.i = CkSecureString::ckCreate()
    If securePassword.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkSecureString::ckAppend(securePassword,password)

    success = CkSFtp::ckAuthenticateSecPw(sftp,secureLogin,securePassword)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        CkSecureString::ckDispose(secureLogin)
        CkSecureString::ckDispose(securePassword)
        ProcedureReturn
    EndIf

    ;  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    ;  file or directory operations.
    success = CkSFtp::ckInitializeSftp(sftp)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        CkSecureString::ckDispose(secureLogin)
        CkSecureString::ckDispose(securePassword)
        ProcedureReturn
    EndIf

    Debug "Authenticated with secure strings."

    CkSFtp::ckDisconnect(sftp)


    CkSFtp::ckDispose(sftp)
    CkSecureString::ckDispose(secureLogin)
    CkSecureString::ckDispose(securePassword)


    ProcedureReturn
EndProcedure