From 9e94ed1cea0d741eae564dcdb38de523636cbe46 Mon Sep 17 00:00:00 2001 From: Erik Date: Tue, 28 Mar 2017 05:10:46 -0400 Subject: [PATCH 1/3] Bump websocket version, fix some warnings --- Source/SocketAnyEvent.swift | 2 +- Source/WebSocket.swift | 168 ++++++++++++++++++------------------ 2 files changed, 87 insertions(+), 83 deletions(-) diff --git a/Source/SocketAnyEvent.swift b/Source/SocketAnyEvent.swift index b3f2833..3647e96 100644 --- a/Source/SocketAnyEvent.swift +++ b/Source/SocketAnyEvent.swift @@ -28,7 +28,7 @@ public final class SocketAnyEvent : NSObject { public let event: String public let items: [Any]? override public var description: String { - return "SocketAnyEvent: Event: \(event) items: \(items ?? nil)" + return "SocketAnyEvent: Event: \(event) items: \(String(describing: items))" } init(event: String, items: [Any]?) { diff --git a/Source/WebSocket.swift b/Source/WebSocket.swift index ccdf290..00e636e 100644 --- a/Source/WebSocket.swift +++ b/Source/WebSocket.swift @@ -38,7 +38,7 @@ public protocol WebSocketPongDelegate: class { } open class WebSocket : NSObject, StreamDelegate { - + enum OpCode : UInt8 { case continueFrame = 0x0 case textFrame = 0x1 @@ -49,7 +49,7 @@ open class WebSocket : NSObject, StreamDelegate { case pong = 0xA // B-F reserved. } - + public enum CloseCode : UInt16 { case normal = 1000 case goingAway = 1001 @@ -62,19 +62,19 @@ open class WebSocket : NSObject, StreamDelegate { case policyViolated = 1008 case messageTooBig = 1009 } - + public static let ErrorDomain = "WebSocket" - + enum InternalErrorCode: UInt16 { // 0-999 WebSocket status codes not used case outputStreamWriteError = 1 } - + // Where the callback is executed. It defaults to the main UI thread queue. public var callbackQueue = DispatchQueue.main - + var optionalProtocols: [String]? - + // MARK: - Constants let headerWSUpgradeName = "Upgrade" let headerWSUpgradeValue = "websocket" @@ -96,7 +96,7 @@ open class WebSocket : NSObject, StreamDelegate { let MaxFrameSize: Int = 32 let httpSwitchProtocolCode = 101 let supportedSSLSchemes = ["wss", "https"] - + class WSResponse { var isFin = false var code: OpCode = .continueFrame @@ -104,23 +104,23 @@ open class WebSocket : NSObject, StreamDelegate { var frameCount = 0 var buffer: NSMutableData? } - + // MARK: - Delegates /// Responds to callback about new messages coming in over the WebSocket /// and also connection/disconnect messages. public weak var delegate: WebSocketDelegate? - + /// Receives a callback for each pong message recived. public weak var pongDelegate: WebSocketPongDelegate? - - + + // MARK: - Block based API. public var onConnect: ((Void) -> Void)? public var onDisconnect: ((NSError?) -> Void)? public var onText: ((String) -> Void)? public var onData: ((Data) -> Void)? public var onPong: ((Data?) -> Void)? - + public var headers = [String: String]() public var voipEnabled = false public var disableSSLCertValidation = false @@ -131,9 +131,9 @@ open class WebSocket : NSObject, StreamDelegate { public var isConnected: Bool { return connected } - + public var currentURL: URL { return url } - + // MARK: - Private private var url: URL private var inputStream: InputStream? @@ -157,7 +157,7 @@ open class WebSocket : NSObject, StreamDelegate { } /// The shared processing queue used for all WebSocket. private static let sharedWorkQueue = DispatchQueue(label: "com.vluxe.starscream.websocket", attributes: []) - + /// Used for setting protocols. public init(url: URL, protocols: [String]? = nil) { self.url = url @@ -170,13 +170,13 @@ open class WebSocket : NSObject, StreamDelegate { writeQueue.maxConcurrentOperationCount = 1 optionalProtocols = protocols } - + // Used for specifically setting the QOS for the write queue. public convenience init(url: URL, writeQueueQOS: QualityOfService, protocols: [String]? = nil) { self.init(url: url, protocols: protocols) writeQueue.qualityOfService = writeQueueQOS } - + /** Connect to the WebSocket server on a background thread. */ @@ -186,14 +186,14 @@ open class WebSocket : NSObject, StreamDelegate { isConnecting = true createHTTPRequest() } - + /** Disconnect from the server. I send a Close control frame to the server, then expect the server to respond with a Close control frame and close the socket from its end. I notify my delegate once the socket has been closed. If you supply a non-nil `forceTimeout`, I wait at most that long (in seconds) for the server to close the socket. After the timeout expires, I close the socket and notify my delegate. If you supply a zero (or negative) `forceTimeout`, I immediately close the socket (without sending a Close control frame) and notify my delegate. - Parameter forceTimeout: Maximum time to wait for the server to close the socket. - Parameter closeCode: The code to send on disconnect. The default is the normal close code for cleanly disconnecting a webSocket. - */ + */ open func disconnect(forceTimeout: TimeInterval? = nil, closeCode: UInt16 = CloseCode.normal.rawValue) { guard isConnected else { return } switch forceTimeout { @@ -210,7 +210,7 @@ open class WebSocket : NSObject, StreamDelegate { break } } - + /** Write a string to the websocket. This sends it as a text frame. If you supply a non-nil completion block, I will perform it when the write completes. @@ -221,7 +221,7 @@ open class WebSocket : NSObject, StreamDelegate { guard isConnected else { return } dequeueWrite(string.data(using: String.Encoding.utf8)!, code: .textFrame, writeCompletion: completion) } - + /** Write binary data to the websocket. This sends it as a binary frame. If you supply a non-nil completion block, I will perform it when the write completes. @@ -232,7 +232,7 @@ open class WebSocket : NSObject, StreamDelegate { guard isConnected else { return } dequeueWrite(data, code: .binaryFrame, writeCompletion: completion) } - + /** Write a ping to the websocket. This sends it as a control frame. Yodel a sound to the planet. This sends it as an astroid. http://youtu.be/Eu5ZJELRiJ8?t=42s @@ -241,15 +241,14 @@ open class WebSocket : NSObject, StreamDelegate { guard isConnected else { return } dequeueWrite(ping, code: .ping, writeCompletion: completion) } - + /** Private method that starts the connection. */ private func createHTTPRequest() { - let urlRequest = CFHTTPMessageCreateRequest(kCFAllocatorDefault, "GET" as CFString, url as CFURL, kCFHTTPVersion1_1).takeRetainedValue() - + var port = url.port if port == nil { if supportedSSLSchemes.contains(url.scheme!) { @@ -277,14 +276,14 @@ open class WebSocket : NSObject, StreamDelegate { initStreamsWithData(serializedRequest as Data, Int(port!)) } } - + /** Add a header to the CFHTTPMessage by using the NSString bridges to CFString */ private func addHeader(_ urlRequest: CFHTTPMessage, key: String, val: String) { CFHTTPMessageSetHeaderFieldValue(urlRequest, key as CFString, val as CFString) } - + /** Generate a WebSocket key as needed in RFC. */ @@ -299,7 +298,7 @@ open class WebSocket : NSObject, StreamDelegate { let baseKey = data?.base64EncodedString(options: NSData.Base64EncodingOptions(rawValue: 0)) return baseKey! } - + /** Start the stream connection and write the data to the output stream. */ @@ -308,7 +307,7 @@ open class WebSocket : NSObject, StreamDelegate { //NSStream.getStreamsToHostWithName(url.host, port: url.port.integerValue, inputStream: &inputStream, outputStream: &outputStream) // Disconnect and clean up any existing streams before setting up a new pair disconnectStream(nil, runDelegate: false) - + var readStream: Unmanaged? var writeStream: Unmanaged? let h = url.host! as NSString @@ -350,16 +349,16 @@ open class WebSocket : NSObject, StreamDelegate { inStream.setProperty(StreamNetworkServiceTypeValue.voIP as AnyObject, forKey: Stream.PropertyKey.networkServiceType) outStream.setProperty(StreamNetworkServiceTypeValue.voIP as AnyObject, forKey: Stream.PropertyKey.networkServiceType) } - + CFReadStreamSetDispatchQueue(inStream, WebSocket.sharedWorkQueue) CFWriteStreamSetDispatchQueue(outStream, WebSocket.sharedWorkQueue) inStream.open() outStream.open() - + self.mutex.lock() self.readyToWrite = true self.mutex.unlock() - + let bytes = UnsafeRawPointer((data as NSData).bytes).assumingMemoryBound(to: UInt8.self) var out = timeout * 1_000_000 // wait 5 seconds before giving up let operation = BlockOperation() @@ -370,34 +369,38 @@ open class WebSocket : NSObject, StreamDelegate { guard !sOperation.isCancelled else { return } out -= 100 if out < 0 { - self?.cleanupStream() + WebSocket.sharedWorkQueue.async { + self?.cleanupStream() + } self?.doDisconnect(self?.errorWithDetail("write wait timed out", code: 2)) return } else if outStream.streamError != nil { return // disconnectStream will be called. } } - guard !sOperation.isCancelled else { return } + guard !sOperation.isCancelled, let s = self else { return } + // Do the pinning now if needed + if let sec = s.security, !s.certValidated { + let trust = outStream.property(forKey: kCFStreamPropertySSLPeerTrust as Stream.PropertyKey) as! SecTrust + let domain = outStream.property(forKey: kCFStreamSSLPeerName as Stream.PropertyKey) as? String + s.certValidated = sec.isValid(trust, domain: domain) + if !s.certValidated { + WebSocket.sharedWorkQueue.async { + let error = s.errorWithDetail("Invalid SSL certificate", code: 1) + s.disconnectStream(error) + } + return + } + } outStream.write(bytes, maxLength: data.count) } writeQueue.addOperation(operation) } - + /** Delegate for the stream methods. Processes incoming bytes */ open func stream(_ aStream: Stream, handle eventCode: Stream.Event) { - if let sec = security, !certValidated && [.hasBytesAvailable, .hasSpaceAvailable].contains(eventCode) { - let trust = aStream.property(forKey: kCFStreamPropertySSLPeerTrust as Stream.PropertyKey) as! SecTrust - let domain = aStream.property(forKey: kCFStreamSSLPeerName as Stream.PropertyKey) as? String - if sec.isValid(trust, domain: domain) { - certValidated = true - } else { - let error = errorWithDetail("Invalid SSL certificate", code: 1) - disconnectStream(error) - return - } - } if eventCode == .hasBytesAvailable { if aStream == inputStream { processInputStream() @@ -408,7 +411,7 @@ open class WebSocket : NSObject, StreamDelegate { disconnectStream(nil) } } - + /** Disconnect the stream object and notifies the delegate. */ @@ -424,7 +427,7 @@ open class WebSocket : NSObject, StreamDelegate { doDisconnect(error) } } - + /** cleanup the streams. */ @@ -443,7 +446,7 @@ open class WebSocket : NSObject, StreamDelegate { inputStream = nil fragBuffer = nil } - + /** Handles the incoming bytes and sending them to the proper processing method. */ @@ -461,7 +464,7 @@ open class WebSocket : NSObject, StreamDelegate { dequeueInput() } } - + /** Dequeue the incoming input so it is processed in order. */ @@ -487,7 +490,7 @@ open class WebSocket : NSObject, StreamDelegate { } } } - + /** Handle checking the inital connection status */ @@ -498,12 +501,12 @@ open class WebSocket : NSObject, StreamDelegate { break case -1: fragBuffer = Data(bytes: buffer, count: bufferLen) - break // do nothing, we are going to collect more data + break // do nothing, we are going to collect more data default: doDisconnect(errorWithDetail("Invalid HTTP upgrade", code: UInt16(code))) } } - + /** Finds the HTTP Packet in the TCP stream, by looking for the CRLF. */ @@ -547,7 +550,7 @@ open class WebSocket : NSObject, StreamDelegate { } return -1 // Was unable to find the full TCP header. } - + /** Validates the HTTP is a 101 as per the RFC spec. */ @@ -568,14 +571,14 @@ open class WebSocket : NSObject, StreamDelegate { } return -1 } - + /** Read a 16 bit big endian value from a buffer */ private static func readUint16(_ buffer: UnsafePointer, offset: Int) -> UInt16 { return (UInt16(buffer[offset + 0]) << 8) | UInt16(buffer[offset + 1]) } - + /** Read a 64 bit big endian value from a buffer */ @@ -586,7 +589,7 @@ open class WebSocket : NSObject, StreamDelegate { } return value } - + /** Write a 16-bit big endian value to a buffer. */ @@ -594,7 +597,7 @@ open class WebSocket : NSObject, StreamDelegate { buffer[offset + 0] = UInt8(value >> 8) buffer[offset + 1] = UInt8(value & 0xff) } - + /** Write a 64-bit big endian value to a buffer. */ @@ -603,7 +606,7 @@ open class WebSocket : NSObject, StreamDelegate { buffer[offset + i] = UInt8((value >> (8*UInt64(7 - i))) & 0xff) } } - + /** Process one message at the start of `buffer`. Return another buffer (sharing storage) that contains the leftover contents of `buffer` that I didn't process. */ @@ -641,10 +644,10 @@ open class WebSocket : NSObject, StreamDelegate { let isControlFrame = (receivedOpcode == .connectionClose || receivedOpcode == .ping) if !isControlFrame && (receivedOpcode != .binaryFrame && receivedOpcode != .continueFrame && receivedOpcode != .textFrame && receivedOpcode != .pong) { - let errCode = CloseCode.protocolError.rawValue - doDisconnect(errorWithDetail("unknown opcode: \(receivedOpcode)", code: errCode)) - writeError(errCode) - return emptyBuffer + let errCode = CloseCode.protocolError.rawValue + doDisconnect(errorWithDetail("unknown opcode: \(String(describing: receivedOpcode))", code: errCode)) + writeError(errCode) + return emptyBuffer } if isControlFrame && isFin == 0 { let errCode = CloseCode.protocolError.rawValue @@ -736,7 +739,7 @@ open class WebSocket : NSObject, StreamDelegate { if receivedOpcode == .continueFrame { let errCode = CloseCode.protocolError.rawValue doDisconnect(errorWithDetail("first frame can't be a continue frame", - code: errCode)) + code: errCode)) writeError(errCode) return emptyBuffer } @@ -751,7 +754,7 @@ open class WebSocket : NSObject, StreamDelegate { } else { let errCode = CloseCode.protocolError.rawValue doDisconnect(errorWithDetail("second and beyond of fragment message must be a continue frame", - code: errCode)) + code: errCode)) writeError(errCode) return emptyBuffer } @@ -766,12 +769,12 @@ open class WebSocket : NSObject, StreamDelegate { } _ = processResponse(response) } - + let step = Int(offset + numericCast(len)) return buffer.fromOffset(step) } } - + /** Process all messages in the buffer if possible. */ @@ -784,7 +787,7 @@ open class WebSocket : NSObject, StreamDelegate { fragBuffer = Data(buffer: buffer) } } - + /** Process the finished response of a buffer. */ @@ -821,7 +824,7 @@ open class WebSocket : NSObject, StreamDelegate { } return false } - + /** Create an error */ @@ -830,7 +833,7 @@ open class WebSocket : NSObject, StreamDelegate { details[NSLocalizedDescriptionKey] = detail return NSError(domain: WebSocket.ErrorDomain, code: Int(code), userInfo: details) } - + /** Write an error to the socket */ @@ -840,7 +843,7 @@ open class WebSocket : NSObject, StreamDelegate { WebSocket.writeUint16(buffer, offset: 0, value: code) dequeueWrite(Data(bytes: buffer, count: MemoryLayout.size), code: .connectionClose) } - + /** Used to write things to the stream */ @@ -870,7 +873,7 @@ open class WebSocket : NSObject, StreamDelegate { let maskKey = UnsafeMutablePointer(buffer + offset) _ = SecRandomCopyBytes(kSecRandomDefault, Int(MemoryLayout.size), maskKey) offset += MemoryLayout.size - + for i in 0...size] offset += 1 @@ -899,14 +902,14 @@ open class WebSocket : NSObject, StreamDelegate { callback() } } - + break } } } writeQueue.addOperation(operation) } - + /** Used to preform the disconnect delegate */ @@ -924,31 +927,32 @@ open class WebSocket : NSObject, StreamDelegate { s.notificationCenter.post(name: NSNotification.Name(WebsocketDidDisconnectNotification), object: self, userInfo: userInfo) } } - + // MARK: - Deinit deinit { mutex.lock() readyToWrite = false mutex.unlock() cleanupStream() + writeQueue.cancelAllOperations() } - + } private extension Data { - + init(buffer: UnsafeBufferPointer) { self.init(bytes: buffer.baseAddress!, count: buffer.count) } - + } private extension UnsafeBufferPointer { - + func fromOffset(_ offset: Int) -> UnsafeBufferPointer { return UnsafeBufferPointer(start: baseAddress?.advanced(by: offset), count: count - offset) } - + } -private let emptyBuffer = UnsafeBufferPointer(start: nil, count: 0) \ No newline at end of file +private let emptyBuffer = UnsafeBufferPointer(start: nil, count: 0) From 1f8c8b8f61926b9ba2320a77fa8945457c364952 Mon Sep 17 00:00:00 2001 From: Erik Date: Tue, 28 Mar 2017 05:14:25 -0400 Subject: [PATCH 2/3] note that swift2.3 is a tag now --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6358712..e485afe 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{ ##Installation Requires Swift 3/Xcode 8.x -If you need swift 2.3 use the swift2.3 branch (Pre-Swift 3 support is no longer maintained) +If you need swift 2.3 use the swift2.3 tag (Pre-Swift 3 support is no longer maintained) If you need swift 2.2 use 7.x (Pre-Swift 3 support is no longer maintained) From 373c1a3447cf6e066f0251fe60be0fb4265f748b Mon Sep 17 00:00:00 2001 From: Erik Date: Wed, 29 Mar 2017 12:20:28 -0400 Subject: [PATCH 3/3] bump websocket --- Source/WebSocket.swift | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/Source/WebSocket.swift b/Source/WebSocket.swift index 00e636e..34152af 100644 --- a/Source/WebSocket.swift +++ b/Source/WebSocket.swift @@ -318,6 +318,7 @@ open class WebSocket : NSObject, StreamDelegate { inStream.delegate = self outStream.delegate = self if supportedSSLSchemes.contains(url.scheme!) { + certValidated = false inStream.setProperty(StreamSocketSecurityLevel.negotiatedSSL as AnyObject, forKey: Stream.PropertyKey.socketSecurityLevelKey) outStream.setProperty(StreamSocketSecurityLevel.negotiatedSSL as AnyObject, forKey: Stream.PropertyKey.socketSecurityLevelKey) if disableSSLCertValidation { @@ -631,7 +632,8 @@ open class WebSocket : NSObject, StreamDelegate { return buffer.fromOffset(bufferLen - extra) } else { let isFin = (FinMask & baseAddress[0]) - let receivedOpcode = OpCode(rawValue: (OpCodeMask & baseAddress[0])) + let receivedOpcodeRawValue = (OpCodeMask & baseAddress[0]) + let receivedOpcode = OpCode(rawValue: receivedOpcodeRawValue) let isMasked = (MaskMask & baseAddress[1]) let payloadLen = (PayloadLenMask & baseAddress[1]) var offset = 2 @@ -645,7 +647,7 @@ open class WebSocket : NSObject, StreamDelegate { if !isControlFrame && (receivedOpcode != .binaryFrame && receivedOpcode != .continueFrame && receivedOpcode != .textFrame && receivedOpcode != .pong) { let errCode = CloseCode.protocolError.rawValue - doDisconnect(errorWithDetail("unknown opcode: \(String(describing: receivedOpcode))", code: errCode)) + doDisconnect(errorWithDetail("unknown opcode: \(receivedOpcodeRawValue)", code: errCode)) writeError(errCode) return emptyBuffer } @@ -690,18 +692,13 @@ open class WebSocket : NSObject, StreamDelegate { if dataLength > UInt64(bufferLen) { len = UInt64(bufferLen-offset) } - let data: Data - if len < 0 { - len = 0 - data = Data() - } else { - if receivedOpcode == .connectionClose && len > 0 { - let size = MemoryLayout.size - offset += size - len -= UInt64(size) - } - data = Data(bytes: baseAddress+offset, count: Int(len)) + if receivedOpcode == .connectionClose && len > 0 { + let size = MemoryLayout.size + offset += size + len -= UInt64(size) } + let data = Data(bytes: baseAddress+offset, count: Int(len)) + if receivedOpcode == .connectionClose { var closeReason = "connection closed by server" if let customCloseReason = String(data: data, encoding: .utf8) {