PowerBuilder

SFTP Authentication using X.509 Certificates

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using an certificate's private key.

Note: See X.509v3 Certificates for SSH Authentication for more information.

PowerBuilder

integer li_rc
long li_Success
oleobject loo_Sftp
string ls_Hostname
long li_Port
oleobject loo_Cert
string ls_PrivKeyPem
oleobject loo_Key

li_Success = 0

//  This example assumes the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

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

ls_Hostname = "sftp.example.com"
li_Port = 22
li_Success = loo_Sftp.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Load the cert + private key from a .pfx.
//  Note: Chilkat provides methods for loading certs and private keys from many sources, including smart cards and USB tokens (HSM's)
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Cert.LoadPfxFile("qa_data/pfx/example.pfx","pfx_password")
if li_Success <> 1 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Sftp
    destroy loo_Cert
    return
end if

//  Get the cert's private key (as PEM) to be used for SSH authentication.
//  (The public key is installed on the server.)
ls_PrivKeyPem = loo_Cert.GetPrivateKeyPem()
if loo_Cert.LastMethodSuccess = 0 then
    Write-Debug loo_Cert.LastErrorText
    destroy loo_Sftp
    destroy loo_Cert
    return
end if

loo_Key = create oleobject
li_rc = loo_Key.ConnectToNewObject("Chilkat.SshKey")

//  Load a private key from a PEM string:
li_Success = loo_Key.FromOpenSshPrivateKey(ls_PrivKeyPem)
if li_Success <> 1 then
    Write-Debug loo_Key.LastErrorText
    destroy loo_Sftp
    destroy loo_Cert
    destroy loo_Key
    return
end if

//  Authenticate with the SSH server.
li_Success = loo_Sftp.AuthenticatePk("myLogin",loo_Key)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_Cert
    destroy loo_Key
    return
end if

Write-Debug "Public-Key Authentication Successful!"


destroy loo_Sftp
destroy loo_Cert
destroy loo_Key