/Starscream

Websockets in swift for iOS and OSX

Primary LanguageSwiftApache License 2.0Apache-2.0

starscream

Starscream is a conforming WebSocket (RFC 6455) client library in Swift.

Its Objective-C counterpart can be found here: Jetfire

Features

  • Conforms to all of the base Autobahn test suite.
  • Nonblocking. Everything happens in the background, thanks to GCD.
  • TLS/WSS support.
  • Compression Extensions support (RFC 7692)
  • Simple concise codebase at just a few hundred LOC.

Example

First thing is to import the framework. See the Installation instructions on how to add the framework to your project.

import Starscream

Once imported, you can open a connection to your WebSocket server. Note that socket is probably best as a property, so it doesn't get deallocated right after being setup.

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
socket.delegate = self
socket.connect()

After you are connected, there are some delegate methods that we need to implement.

websocketDidConnect

websocketDidConnect is called as soon as the client connects to the server.

func websocketDidConnect(socket: WebSocketClient) {
    print("websocket is connected")
}

websocketDidDisconnect

websocketDidDisconnect is called as soon as the client is disconnected from the server.

func websocketDidDisconnect(socket: WebSocketClient, error: Error?) {
	print("websocket is disconnected: \(error?.localizedDescription)")
}

websocketDidReceiveMessage

websocketDidReceiveMessage is called when the client gets a text frame from the connection.

func websocketDidReceiveMessage(socket: WebSocketClient, text: String) {
	print("got some text: \(text)")
}

websocketDidReceiveData

websocketDidReceiveData is called when the client gets a binary frame from the connection.

func websocketDidReceiveData(socket: WebSocketClient, data: Data) {
	print("got some data: \(data.count)")
}

Optional: websocketDidReceivePong (required protocol: WebSocketPongDelegate)

websocketDidReceivePong is called when the client gets a pong response from the connection. You need to implement the WebSocketPongDelegate protocol and set an additional delegate, eg: socket.pongDelegate = self

func websocketDidReceivePong(socket: WebSocketClient, data: Data?) {
	print("Got pong! Maybe some data: \(data?.count)")
}

Or you can use closures.

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
//websocketDidConnect
socket.onConnect = {
    print("websocket is connected")
}
//websocketDidDisconnect
socket.onDisconnect = { (error: Error?) in
    print("websocket is disconnected: \(error?.localizedDescription)")
}
//websocketDidReceiveMessage
socket.onText = { (text: String) in
    print("got some text: \(text)")
}
//websocketDidReceiveData
socket.onData = { (data: Data) in
    print("got some data: \(data.count)")
}
//you could do onPong as well.
socket.connect()

One more: you can listen to socket connection and disconnection via notifications. Starscream posts WebsocketDidConnectNotification and WebsocketDidDisconnectNotification. You can find an Error that caused the disconection by accessing WebsocketDisconnectionErrorKeyName on notification userInfo.

The delegate methods give you a simple way to handle data from the server, but how do you send data?

write a binary frame

The writeData method gives you a simple way to send Data (binary) data to the server.

socket.write(data: data) //write some Data over the socket!

write a string frame

The writeString method is the same as writeData, but sends text/string.

socket.write(string: "Hi Server!") //example on how to write text over the socket!

write a ping frame

The writePing method is the same as write, but sends a ping control frame.

socket.write(ping: Data()) //example on how to write a ping control frame over the socket!

write a pong frame

the writePong method is the same as writePing, but sends a pong control frame.

socket.write(pong: Data()) //example on how to write a pong control frame over the socket!

Starscream will automatically respond to incoming ping control frames so you do not need to manually send pongs.

However if for some reason you need to control this process you can turn off the automatic ping response by disabling respondToPingWithPong.

socket.respondToPingWithPong = false //Do not automaticaly respond to incoming pings with pongs.

In most cases you will not need to do this.

disconnect

The disconnect method does what you would expect and closes the socket.

socket.disconnect()

The socket can be forcefully closed, by specifying a timeout (in milliseconds). A timeout of zero will also close the socket immediately without waiting on the server.

socket.disconnect(forceTimeout: 10, closeCode: CloseCode.normal.rawValue)

isConnected

Returns if the socket is connected or not.

if socket.isConnected {
  // do cool stuff.
}

Custom Headers

You can also override the default websocket headers with your own custom ones like so:

var request = URLRequest(url: URL(string: "ws://localhost:8080/")!)
request.timeoutInterval = 5
request.setValue("someother protocols", forHTTPHeaderField: "Sec-WebSocket-Protocol")
request.setValue("14", forHTTPHeaderField: "Sec-WebSocket-Version")
request.setValue("Everything is Awesome!", forHTTPHeaderField: "My-Awesome-Header")
let socket = WebSocket(request: request)

Custom HTTP Method

Your server may use a different HTTP method when connecting to the websocket:

var request = URLRequest(url: URL(string: "ws://localhost:8080/")!)
request.httpMethod = "POST"
request.timeoutInterval = 5
let socket = WebSocket(request: request)

Protocols

If you need to specify a protocol, simple add it to the init:

//chat and superchat are the example protocols here
socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
socket.delegate = self
socket.connect()

Self Signed SSL

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])

//set this if you want to ignore SSL cert validation, so a self signed SSL certificate can be used.
socket.disableSSLCertValidation = true

SSL Pinning

SSL Pinning is also supported in Starscream.

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
let data = ... //load your certificate from disk
socket.security = SSLSecurity(certs: [SSLCert(data: data)], usePublicKeys: true)
//socket.security = SSLSecurity() //uses the .cer files in your app's bundle

You load either a Data blob of your certificate or you can use a SecKeyRef if you have a public key you want to use. The usePublicKeys bool is whether to use the certificates for validation or the public keys. The public keys will be extracted from the certificates automatically if usePublicKeys is choosen.

SSL Cipher Suites

To use an SSL encrypted connection, you need to tell Starscream about the cipher suites your server supports.

socket = WebSocket(url: URL(string: "wss://localhost:8080/")!, protocols: ["chat","superchat"])

// Set enabled cipher suites to AES 256 and AES 128
socket.enabledSSLCipherSuites = [TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]

If you don't know which cipher suites are supported by your server, you can try pointing SSL Labs at it and checking the results.

Compression Extensions

Compression Extensions (RFC 7692) is supported in Starscream. Compression is enabled by default, however compression will only be used if it is supported by the server as well. You may enable or disable compression via the .enableCompression property:

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
socket.enableCompression = false

Compression should be disabled if your application is transmitting already-compressed, random, or other uncompressable data.

Custom Queue

A custom queue can be specified when delegate methods are called. By default DispatchQueue.main is used, thus making all delegate methods calls run on the main thread. It is important to note that all WebSocket processing is done on a background thread, only the delegate method calls are changed when modifying the queue. The actual processing is always on a background thread and will not pause your app.

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
//create a custom queue
socket.callbackQueue = DispatchQueue(label: "com.vluxe.starscream.myapp")

Example Project

Check out the SimpleTest project in the examples directory to see how to setup a simple connection to a WebSocket server.

Requirements

Starscream works with iOS 7/OSX 10.9 or above. It is recommended to use iOS 8/10.10 or above for CocoaPods/framework support. To use Starscream with a project targeting iOS 7, you must include all Swift files directly in your project.

Installation

CocoaPods

Check out Get Started tab on cocoapods.org.

To use Starscream in your project add the following 'Podfile' to your project

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

pod 'Starscream', '~> 3.0.2'

Then run:

pod install

Carthage

Check out the Carthage docs on how to add a install. The Starscream framework is already setup with shared schemes.

Carthage Install

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Starscream into your Xcode project using Carthage, specify it in your Cartfile:

github "daltoniam/Starscream" >= 3.0.2

Rogue

First see the installation docs for how to install Rogue.

To install Starscream run the command below in the directory you created the rogue file.

rogue add https://github.com/daltoniam/Starscream

Next open the libs folder and add the Starscream.xcodeproj to your Xcode project. Once that is complete, in your "Build Phases" add the Starscream.framework to your "Link Binary with Libraries" phase. Make sure to add the libs folder to your .gitignore file.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding Starscream as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .Package(url: "https://github.com/daltoniam/Starscream.git", majorVersion: 3)
]

Other

Simply grab the framework (either via git submodule or another package manager).

Add the Starscream.xcodeproj to your Xcode project. Once that is complete, in your "Build Phases" add the Starscream.framework to your "Link Binary with Libraries" phase.

Add Copy Frameworks Phase

If you are running this in an OSX app or on a physical iOS device you will need to make sure you add the Starscream.framework to be included in your app bundle. To do this, in Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar. In the tab bar at the top of that window, open the "Build Phases" panel. Expand the "Link Binary with Libraries" group, and add Starscream.framework. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add Starscream.framework respectively.

WebSocketAdvancedDelegate

The advanced delegate acts just like the simpler delegate but provides some additional information on the connection and incoming frames.

socket.advancedDelegate = self

In most cases you do not need the extra info and should use the normal delegate.

websocketDidReceiveMessage

func websocketDidReceiveMessage(socket: WebSocketClient, text: String, response: WebSocket.WSResponse) {
	print("got some text: \(text)")
	print("First frame for this message arrived on \(response.firstFrame)")
}

websocketDidReceiveData

func websocketDidReceiveData(socket: WebSocketClient, data: Date, response: WebSocket.WSResponse) {
	print("got some data it long: \(data.count)")
	print("A total of \(response.frameCount) frames were used to send this data")
}

websocketHttpUpgrade

These methods are called when the HTTP upgrade request is sent and when the response returns.

func  websocketHttpUpgrade(socket: WebSocketClient, request: CFHTTPMessage) {
	print("the http request was sent we can check the raw http if we need to")
}
func  websocketHttpUpgrade(socket: WebSocketClient, response: CFHTTPMessage) {
	print("the http response has returned.")
}

KNOWN ISSUES

  • WatchOS does not have the the CFNetwork String constants to modify the stream's SSL behavior. It will be the default Foundation SSL behavior. This means watchOS CANNOT use SSLCiphers, disableSSLCertValidation, or SSL pinning. All these values set on watchOS will do nothing.
  • Linux does not have the security framework, so it CANNOT use SSL pinning or SSLCiphers either.

TODOs

  • Add Unit Tests - Local WebSocket server that runs against Autobahn

License

Starscream is licensed under the Apache v2 License.

Contact

Dalton Cherry

Austin Cherry