PowerBuilder

SFTP Authenticate with a Private Key

Demonstrates the Chilkat SFtp.AuthenticatePk method, which authenticates the connected session using public-key authentication. The first argument is the username and the second is an SshKey private key. The matching public key must already be authorized for the account on the server.

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

Background: Public-key authentication is the standard for unattended SFTP transfers: the private key stays on the client, the server trusts the corresponding public key, and no reusable password crosses the wire. The SshKey object imports keys in several formats — this example loads an OpenSSH private key. For an encrypted key, set its Password property before importing.

Chilkat PowerBuilder Downloads

Download Chilkat for PowerBuilder

PowerBuilder

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

li_Success = 0

//  Demonstrates the SFtp.AuthenticatePk method, which authenticates the connected session using
//  public-key authentication.  The 1st argument is the username and the 2nd is an SshKey private
//  key.  The matching public key must already be authorized for the account on the server.

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

//  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.AuthenticatePk("mySshLogin",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 private key."

loo_Sftp.Disconnect()


destroy loo_Sftp
destroy loo_PrivKey