Swift

WebSocket through SSH Tunnel

See more WebSocket Examples

This example shows how to establish a WebSocket connection through an SSH tunnel. The WebSocket protocol communications will be encapsulated within an SSH tunnel. Swift

func chilkatTest() {
    var success: Bool = false

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

    // --------------------------------------------------
    // This example borrows the code from the REST through SSH Tunnel example.
    // We first use the Chilkat Socket object to establish a connection to the WebSocket server through an SSH Tunnel.
    // Next, the Rest object uses the Socket object for its connection.
    // Finally, the WebSocket object uses the Rest object for its connection.  
    // 
    // Hopefully the flexibility of this architecture is easy to see.  All of the HTTP functionality of the Rest object,
    // such as HTTP authentication, custom headers, etc. is available to the WebSocket.  Likewise, all of the advanced functionality
    // of the Socket object is in turn available to the Rest object.  

    // The high-level steps for accomplishing the task of running the WebSocket protocol through an SSH accomplished as follows:
    // 1) Create the SSH tunnel using Chilkat Socket.
    // 2) Open a port-forwarding channel (to the WebSocket server) within the tunnel.
    // 2) Tell Rest to use the Socket object.
    // 3) Tell WebSocket to use the Rest object.

    let tunnel = CkoSocket()!

    var sshHostname: String? = "sftp.example.com"
    var sshPort: Int = 22

    // Connect to an SSH server and establish the SSH tunnel:
    success = tunnel.sshOpenTunnel(sshHostname: sshHostname, sshPort: sshPort)
    if success == false {
        print("\(tunnel.lastErrorText!)")
        return
    }

    // Authenticate with the SSH server via a login/password
    // or with a public key.
    // This example demonstrates SSH password authentication.
    success = tunnel.sshAuthenticatePw(sshLogin: "mySshLogin", sshPassword: "mySshPassword")
    if success == false {
        print("\(tunnel.lastErrorText!)")
        return
    }

    //  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.

    var bTls: Bool = true
    var port: Int = 443
    var maxWaitMs: Int = 5000

    // This returns a socket object that is a single channel within the SSH tunnel.
    // The SSH channel is our logical port-forwarded connection through the SSH tunnel.
    // Note: This example establishes a TLS connection to the target WebSocket server.
    // (The TLS protocol will run on the logical channel within the SSH tunnel.)
    // Your application can just as easily make a non-TLS connection by changing the arguments
    // passed to SshNewChannel.
    let channel = CkoSocket()!
    success = tunnel.sshNewChannel(hostname: "some-websocket-server.com", port: port, ssl: bTls, maxWaitMs: maxWaitMs, channel: channel)
    if success == false {
        print("\(tunnel.lastErrorText!)")
        return
    }

    // Create a REST object and tell it to use the SSH channel.
    // This connection is a TLS running on an SSH channel through an SSH tunnel.
    // In other words, TLS is wrapped within the SSH tunnel.
    let rest = CkoRest()!
    success = rest.useConnection(connection: channel, autoReconnect: false)
    if success == false {
        print("\(rest.lastErrorText!)")
        return
    }

    // Finally, tell our WebSocket object to use the Rest object..
    let ws = CkoWebSocket()!

    // Tell the WebSocket to use this connection.
    success = ws.useConnection(connection: rest)
    if success == false {
        print("\(ws.lastErrorText!)")
        return
    }

    // Add the standard WebSocket open handshake headers that will be needed.
    // (This adds the required HTTP request headers to the rest object.)
    ws.addClientHeaders()

    // Add any additional headers that might be desired.
    // Two common WebSocketSpecific headers are "Sec-WebSocket-Protocol" and "Origin".
    rest.addHeader(name: "Sec-WebSocket-Protocol", value: "x-some-websocket-subprotocol")
    rest.addHeader(name: "Origin", value: "http://some-websocket-server.com")

    // Do the open handshake.
    var responseBody: String? = rest.fullRequestNoBody(httpVerb: "GET", uriPath: "/something")
    if rest.lastMethodSuccess == false {
        print("\(rest.lastErrorText!)")
        return
    }

    // If successful, the HTTP response status code should be 101,
    // and the response body will be empty. (If it failed, we'll have a look
    // at the response body..)
    var statusCode: Int = rest.responseStatusCode.intValue
    print("Response status code: \(statusCode)")

    if statusCode != 101 {
        print("\(responseBody!)")
        print("-- Failed because of unexpected response status code.")
        return
    }

    // We have the expected 101 response, so let's now validate the 
    // contents of the response, such as the value sent by the server in the
    // Sec-WebSocket-Accept header. 
    success = ws.validateServerHandshake()
    if success == false {
        print("\(ws.lastErrorText!)")
        return
    }

    print("WebSocket connection successful.")

    // The application may now begin sending and receiving frames on the WebSocket connection.
    // (At this point, we're done with the rest object...)

}