PureBasic

SFTP Authenticate with Password and Private Key

Demonstrates the Chilkat SFtp.AuthenticatePwPk method, which authenticates with a server that requires both a password and a private key. The arguments are the username, the password, and an 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.

Background: Most servers require either a password or a public key, not both — but some high-security deployments mandate two-factor SSH, combining something you know (the password) with something you have (the key). This method satisfies that policy in one call. As always, the password should come from a secure source rather than a literal in code.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the SFtp.AuthenticatePwPk method, which authenticates with a server that requires
    ;  BOTH a password and 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

    success = CkSFtp::ckAuthenticatePwPk(sftp,"mySshLogin",password,privKey)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        CkSshKey::ckDispose(privKey)
        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)
        ProcedureReturn
    EndIf

    Debug "Authenticated with a password and a private key."

    CkSFtp::ckDisconnect(sftp)


    CkSFtp::ckDispose(sftp)
    CkSshKey::ckDispose(privKey)


    ProcedureReturn
EndProcedure