PowerBuilder

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

Download Chilkat for PowerBuilder

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Sftp
integer li_Port
string ls_Password
oleobject loo_PrivKey
string ls_KeyText

li_Success = 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.

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
li_Port = 22
li_Success = loo_Sftp.Connect("sftp.example.com",li_Port)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  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.
ls_Password = "mySshPassword"

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
loo_PrivKey = create oleobject
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.SshKey")

ls_KeyText = loo_PrivKey.LoadText("qa_data/id_rsa")
if loo_PrivKey.LastMethodSuccess = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

li_Success = loo_PrivKey.FromOpenSshPrivateKey(ls_KeyText)
if li_Success = 0 then
    Write-Debug loo_PrivKey.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

li_Success = loo_Sftp.AuthenticatePwPk("mySshLogin",ls_Password,loo_PrivKey)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
li_Success = loo_Sftp.InitializeSftp()
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_PrivKey
    return
end if

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

loo_Sftp.Disconnect()


destroy loo_Sftp
destroy loo_PrivKey