Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL oPrivKey
LOCAL cKeyText

nSuccess := 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.

oSftp := CreateObject("Chilkat.SFtp")

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
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.
cPassword := "mySshPassword"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
oPrivKey := CreateObject("Chilkat.SshKey")
cKeyText := oPrivKey:LoadText("qa_data/id_rsa")
IF (oPrivKey:LastMethodSuccess == 0)
    ? oPrivKey:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

nSuccess := oPrivKey:FromOpenSshPrivateKey(cKeyText)
IF (nSuccess == 0)
    ? oPrivKey:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

nSuccess := oSftp:AuthenticatePwPk("mySshLogin", cPassword, oPrivKey)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

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

oSftp:Disconnect()

oSftp:destroy()
oPrivKey:destroy()