(VB.NET UWP/WinRT) Xero API through an SSH Tunnel

This example demonstrates connecting through an SSH Tunnel w/ 2-legged OAuth for a Xero private application.

This example requires Chilkat v9.5.0.64 or later

Chilkat Universal Windows Platform (UWP) / WinRT Downloads Chilkat for the Universal Windows Platform (UWP)

' This example requires Chilkat v9.5.0.64 or later

Dim tunnel As New Chilkat.Socket

Dim sshHostname As String = "www.my-ssh-server.com"
Dim sshPort As Integer = 22

' Connect to an SSH server and establish the SSH tunnel:
Dim success As Boolean = Await tunnel.SshOpenTunnelAsync(sshHostname,sshPort)
If (success <> True) Then
    Debug.WriteLine(tunnel.LastErrorText)
    Exit Sub
End If


' Authenticate with the SSH server via a login/password
' or with a public key.
' This example demonstrates SSH password authentication.
success = Await tunnel.SshAuthenticatePwAsync("mySshLogin","mySshPassword")
If (success <> True) Then
    Debug.WriteLine(tunnel.LastErrorText)
    Exit Sub
End If


'  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
'  (Any number of channels may be created from the same SSH tunnel.
'  Multiple channels may coexist at the same time.)


' This sample code would typically be placed in a subroutine or function
' where the rest object is passed by reference.
' It does the OAuth1 setup and makes the initial connection.
Dim rest As New Chilkat.Rest
Dim channel As Chilkat.Socket

Dim bTls As Boolean = True
Dim port As Integer = 443
Dim maxWaitMs As Integer = 7000

' This returns a socket object that is a single channel within the SSH tunnel.
channel = Await tunnel.SshOpenChannelAsync("api.xero.com",port,bTls,maxWaitMs)
If (tunnel.LastMethodSuccess <> True) Then
    Debug.WriteLine(tunnel.LastErrorText)
    Exit Sub
End If


' Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
' In other words, TLS is wrapped within the SSH tunnel.)
success = rest.UseConnection(channel,True)
If (success <> True) Then
    Debug.WriteLine(rest.LastErrorText)

    Exit Sub
End If



' OK, we're connected.  
' -----------------------------------------------------------------
' Now setup the OAuth1 authenticator..

Dim consumerKey As String = "XERO_PRIVATE_APP_KEY"
Dim consumerSecret As String = "XERO_PRIVATE_APP_SECRET"

' Let's get our private key from our PFX (password protected), or the PEM (unprotected).
' You can decide which to use.  Either is OK, although I would recommend keeping your
' private keys in a PFX and not in an unprotected PEM.
Dim pfx As New Chilkat.Pfx
success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD")
If (success <> True) Then
    Debug.WriteLine(pfx.LastErrorText)
    Exit Sub
End If

Dim privKeyFromPfx As Chilkat.PrivateKey = pfx.GetPrivateKey(0)
If (pfx.LastMethodSuccess <> True) Then
    Debug.WriteLine(pfx.LastErrorText)
    Exit Sub
End If


' Or we can load from a PEM..
Dim privKeyFromPem As New Chilkat.PrivateKey
success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem")
If (success <> True) Then
    Debug.WriteLine(privKeyFromPem.LastErrorText)
    Exit Sub
End If


' Note: There are many other means for loading a private key, including
' from other formats and directly from memory (i.e. not file-based).

Dim oauth1 As New Chilkat.OAuth1
oauth1.ConsumerKey = consumerKey
oauth1.ConsumerSecret = consumerSecret
oauth1.Token = consumerKey
oauth1.TokenSecret = consumerSecret
oauth1.SignatureMethod = "RSA-SHA1"
oauth1.SetRsaKey(privKeyFromPfx)


' Install the OAuth1 authenticator.
rest.SetAuthOAuth1(oauth1,False)

Debug.WriteLine("OK, the Xero OAuth1 is initialized and the REST object is ready to make REST API calls..")

' -----------------------------------------------------------------
' Make a call to verify that OAuth1 through an HTTP proxy works..

' Get the full list of contacts.
Dim sbXml As New Chilkat.StringBuilder
success = Await rest.FullRequestNoBodySbAsync("GET","/api.xro/2.0/Contacts",sbXml)
If (success <> True) Then
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


' A 200 response is expected for actual success.
If (rest.ResponseStatusCode <> 200) Then
    Debug.WriteLine(sbXml.GetAsString())
    Exit Sub
End If


' Iterate over the contacts..
Dim bAutoTrim As Boolean = False
Dim xml As New Chilkat.Xml
xml.LoadSb(sbXml,bAutoTrim)
xml.SaveXml("qa_cache/xero_contacts.xml")

' How many records exist?
Dim recordCount As Integer = xml.NumChildrenAt("Contacts")
Debug.WriteLine("numRecords = " & recordCount)

Dim i As Integer = 0
While i < recordCount
    xml.I = i
    Debug.WriteLine("ContactID: " & xml.GetChildContent("Contacts|Contact[i]|ContactID"))
    i = i + 1
End While