SFTP Authenticate with a SecureString Password and Private Key

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

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

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
    ;  and password objects together with a private key.  The 1st argument is the username, the 2nd
    ;  is the password, and the 3rd is an SshKey private key.

    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"

    ;  Load the SSH private key.  LoadText reads the file's text, which is then imported.
    privKey.i = CkSshKey::ckCreate()
    If privKey.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    keyText.s = CkSshKey::ckLoadText(privKey,"qa_data/id_rsa")
    If CkSshKey::ckLastMethodSuccess(privKey) = 0
        Debug CkSshKey::ckLastErrorText(privKey)
        CkSFtp::ckDispose(sftp)
        CkSshKey::ckDispose(privKey)
        ProcedureReturn
    EndIf

    success = CkSshKey::ckFromOpenSshPrivateKey(privKey,keyText)
    If success = 0
        Debug CkSshKey::ckLastErrorText(privKey)
        CkSFtp::ckDispose(sftp)
        CkSshKey::ckDispose(privKey)
        ProcedureReturn
    EndIf

    ;  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::ckAuthenticateSecPwPk(sftp,secureLogin,securePassword,privKey)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        CkSshKey::ckDispose(privKey)
        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)
        CkSshKey::ckDispose(privKey)
        CkSecureString::ckDispose(secureLogin)
        CkSecureString::ckDispose(securePassword)
        ProcedureReturn
    EndIf

    Debug "Authenticated."

    CkSFtp::ckDisconnect(sftp)


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


    ProcedureReturn
EndProcedure