├── .gitignore ├── LICENSE ├── Package.swift ├── README.md ├── Sources └── PerfectWebSockets │ └── WebSocketHandler.swift └── Tests ├── LinuxMain.swift └── PerfectWebSocketsTests └── PerfectWebSocketsTests.swift /.gitignore: -------------------------------------------------------------------------------- 1 | # Xcode 2 | # 3 | # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore 4 | 5 | ## Build generated 6 | build/ 7 | DerivedData/ 8 | 9 | ## Various settings 10 | *.pbxuser 11 | !default.pbxuser 12 | *.mode1v3 13 | !default.mode1v3 14 | *.mode2v3 15 | !default.mode2v3 16 | *.perspectivev3 17 | !default.perspectivev3 18 | xcuserdata/ 19 | 20 | ## Other 21 | *.moved-aside 22 | *.xcuserstate 23 | 24 | ## Obj-C/Swift specific 25 | *.hmap 26 | *.ipa 27 | *.dSYM.zip 28 | *.dSYM 29 | 30 | ## Playgrounds 31 | timeline.xctimeline 32 | playground.xcworkspace 33 | 34 | # Swift Package Manager 35 | # 36 | # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies. 37 | # Packages/ 38 | .build/ 39 | 40 | # CocoaPods 41 | # 42 | # We recommend against adding the Pods directory to your .gitignore. However 43 | # you should judge for yourself, the pros and cons are mentioned at: 44 | # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control 45 | # 46 | # Pods/ 47 | 48 | # Carthage 49 | # 50 | # Add this line if you want to avoid checking in source code from Carthage dependencies. 51 | # Carthage/Checkouts 52 | 53 | Carthage/Build 54 | 55 | # fastlane 56 | # 57 | # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the 58 | # screenshots whenever they are needed. 59 | # For more information about the recommended setup visit: 60 | # https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md 61 | 62 | fastlane/report.xml 63 | fastlane/Preview.html 64 | fastlane/screenshots 65 | fastlane/test_output 66 | 67 | Packages/ 68 | PerfectWebSockets.xcodeproj/ 69 | .DS_Store 70 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:4.0 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | // Generated automatically by Perfect Assistant Application 5 | // Date: 2017-09-20 18:45:32 +0000 6 | import PackageDescription 7 | let package = Package( 8 | name: "PerfectWebSockets", 9 | products: [ 10 | .library(name: "PerfectWebSockets", targets: ["PerfectWebSockets"]) 11 | ], 12 | dependencies: [ 13 | .package(url: "https://github.com/PerfectlySoft/Perfect-HTTP.git", from: "3.0.0"), 14 | ], 15 | targets: [ 16 | .target(name: "PerfectWebSockets", dependencies: ["PerfectHTTP"]) 17 | ] 18 | ) 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Perfect-WebSockets 2 | 3 |

4 | 5 | Get Involed with Perfect! 6 | 7 |

8 | 9 |

10 | 11 | Star Perfect On Github 12 | 13 | 14 | Stack Overflow 15 | 16 | 17 | Follow Perfect on Twitter 18 | 19 | 20 | Join the Perfect Slack 21 | 22 |

23 | 24 |

25 | 26 | Swift 4.0 27 | 28 | 29 | Platforms OS X | Linux 30 | 31 | 32 | License Apache 33 | 34 | 35 | PerfectlySoft Twitter 36 | 37 | 38 | Slack Status 39 | 40 |

41 | 42 | WebSockets support for Perfect 43 | 44 | Building 45 | -------- 46 | 47 | Add this project as a dependency in your Package.swift file. 48 | 49 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 50 | .Package(url:"https://github.com/PerfectlySoft/Perfect-WebSockets.git", majorVersion: 3) 51 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 52 | 53 | Example Usage 54 | -------- 55 | 56 | [PerfectExample-WebSocketsServer](https://github.com/PerfectExamples/Perfect-WebSocketsServer) 57 | 58 | 59 | 60 | ## Further Information 61 | For more information on the Perfect project, please visit [perfect.org](http://perfect.org). 62 | -------------------------------------------------------------------------------- /Sources/PerfectWebSockets/WebSocketHandler.swift: -------------------------------------------------------------------------------- 1 | // 2 | // WebSocketHandler.swift 3 | // PerfectLib 4 | // 5 | // Created by Kyle Jessup on 2016-01-06. 6 | // Copyright © 2016 PerfectlySoft. All rights reserved. 7 | // 8 | //===----------------------------------------------------------------------===// 9 | // 10 | // This source file is part of the Perfect.org open source project 11 | // 12 | // Copyright (c) 2015 - 2016 PerfectlySoft Inc. and the Perfect project authors 13 | // Licensed under Apache License v2.0 14 | // 15 | // See http://perfect.org/licensing.html for license information 16 | // 17 | //===----------------------------------------------------------------------===// 18 | // 19 | 20 | import PerfectNet 21 | import PerfectLib 22 | import PerfectHTTP 23 | 24 | #if os(Linux) 25 | import SwiftGlibc 26 | import LinuxBridge 27 | private let UINT16_MAX = UInt(0xFFFF) 28 | #else 29 | import Darwin 30 | #endif 31 | 32 | import COpenSSL 33 | 34 | private let smallPayloadSize = 126 35 | 36 | /// This class represents the communications channel for a WebSocket session. 37 | public class WebSocket: Equatable { 38 | 39 | /// The various types of WebSocket messages. 40 | public enum OpcodeType: UInt8 { 41 | /// Continuation op code 42 | case continuation = 0x0, 43 | /// Text data indicator 44 | text = 0x1, 45 | /// Binary data indicator 46 | binary = 0x2, 47 | /// Close indicator 48 | close = 0x8, 49 | /// Ping message 50 | ping = 0x9, 51 | /// Ping response message 52 | pong = 0xA, 53 | /// Invalid op code 54 | invalid 55 | } 56 | 57 | private struct Frame { 58 | let fin: Bool 59 | let rsv1: Bool 60 | let rsv2: Bool 61 | let rsv3: Bool 62 | let opCode: OpcodeType 63 | let bytesPayload: [UInt8] 64 | 65 | var stringPayload: String? { 66 | return UTF8Encoding.encode(bytes: self.bytesPayload) 67 | } 68 | } 69 | 70 | /// The read timeout, in seconds. By default this is -1, which means no timeout. 71 | public var readTimeoutSeconds: Double = NetEvent.noTimeout 72 | 73 | /// Indicates if the socket is still likely connected or if it has been closed. 74 | public var isConnected: Bool { return self.socket.isValid } 75 | private let socket: NetTCP 76 | private var nextIsContinuation = false 77 | private let readBuffer = Bytes() 78 | 79 | init(socket: NetTCP) { 80 | self.socket = socket 81 | } 82 | 83 | /// Close the connection. 84 | public func close() { 85 | if self.socket.isValid { 86 | self.sendMessage(opcode: .close, bytes: [UInt8](), final: true) { 87 | self.socket.close() 88 | } 89 | } 90 | } 91 | 92 | private func clearFrame() { 93 | let position = self.readBuffer.position 94 | self.readBuffer.data.removeFirst(position) 95 | self.readBuffer.position = 0 96 | } 97 | 98 | private func fillFrame() -> Frame? { 99 | guard self.readBuffer.availableExportBytes >= 2 else { 100 | return nil 101 | } 102 | // we know we potentially have a valid frame here 103 | // for to be resetting the position if we don't have a valid frame yet 104 | let oldPosition = self.readBuffer.position 105 | 106 | let byte1 = self.readBuffer.export8Bits() 107 | let byte2 = self.readBuffer.export8Bits() 108 | 109 | let fin = (byte1 & 0x80) != 0 110 | let rsv1 = (byte1 & 0x40) != 0 111 | let rsv2 = (byte1 & 0x20) != 0 112 | let rsv3 = (byte1 & 0x10) != 0 113 | let opcode = OpcodeType(rawValue: byte1 & 0xF) ?? .invalid 114 | let maskBit = (byte2 & 0x80) != 0 115 | 116 | guard maskBit else { 117 | self.close() 118 | return nil 119 | } 120 | 121 | var unmaskedLength = Int(byte2 ^ 0x80) 122 | if unmaskedLength == smallPayloadSize { 123 | if self.readBuffer.availableExportBytes >= 2 { 124 | unmaskedLength = Int(self.readBuffer.export16Bits().netToHost) 125 | } 126 | } else if unmaskedLength > smallPayloadSize { 127 | if self.readBuffer.availableExportBytes >= 8 { 128 | unmaskedLength = Int(self.readBuffer.export64Bits().netToHost) 129 | } 130 | } // else small payload 131 | if self.readBuffer.availableExportBytes >= 4 { 132 | let maskingKey = self.readBuffer.exportBytes(count: 4) 133 | if self.readBuffer.availableExportBytes >= unmaskedLength { 134 | var exported = self.readBuffer.exportBytes(count: unmaskedLength) 135 | for i in 0.. ()) { 147 | self.socket.readBytesFully(count: demnd, timeoutSeconds: self.readTimeoutSeconds) { 148 | [weak self] (b:[UInt8]?) -> () in 149 | if let b = b { 150 | self?.readBuffer.data.append(contentsOf: b) 151 | } 152 | completion(b != nil) 153 | } 154 | } 155 | 156 | func fillBufferSome(suggestion suggest: Int, completion: @escaping () -> ()) { 157 | self.socket.readSomeBytes(count: suggest) { 158 | [weak self] (b:[UInt8]?) -> () in 159 | if let b = b { 160 | self?.readBuffer.data.append(contentsOf: b) 161 | } 162 | completion() 163 | } 164 | } 165 | 166 | private func readFrame(completion comp: @escaping (Frame?) -> ()) { 167 | if let frame = self.fillFrame() { 168 | switch frame.opCode { 169 | // check for and handle ping/pong 170 | case .ping: 171 | self.sendMessage(opcode: .pong, bytes: frame.bytesPayload, final: true) { 172 | self.readFrame(completion: comp) 173 | } 174 | // check for and handle close 175 | case .close: 176 | self.close() 177 | comp(nil) 178 | default: 179 | comp(frame) 180 | } 181 | } else { 182 | self.fillBuffer(demand: 1) { 183 | b in 184 | guard b != false else { 185 | return comp(nil) 186 | } 187 | self.fillBufferSome(suggestion: 1024 * 32) { // some arbitrary read-ahead amount 188 | self.readFrame(completion: comp) 189 | } 190 | } 191 | } 192 | } 193 | 194 | /// Read string data from the client. 195 | public func readStringMessage(continuation: @escaping (String?, _ opcode: OpcodeType, _ final: Bool) -> ()) { 196 | self.readFrame { 197 | frame in 198 | continuation(frame?.stringPayload, frame?.opCode ?? .invalid, frame?.fin ?? true) 199 | } 200 | } 201 | 202 | /// Read binary data from the client. 203 | public func readBytesMessage(continuation: @escaping ([UInt8]?, _ opcode: OpcodeType, _ final: Bool) -> ()) { 204 | self.readFrame { 205 | frame in 206 | continuation(frame?.bytesPayload, frame?.opCode ?? .invalid, frame?.fin ?? true) 207 | } 208 | } 209 | 210 | /// Send binary data to thew client. 211 | public func sendBinaryMessage(bytes: [UInt8], final: Bool, completion: @escaping () -> ()) { 212 | self.sendMessage(opcode: .binary, bytes: bytes, final: final, completion: completion) 213 | } 214 | 215 | /// Send string data to the client. 216 | public func sendStringMessage(string: String, final: Bool, completion: @escaping () -> ()) { 217 | self.sendMessage(opcode: .text, bytes: UTF8Encoding.decode(string: string), final: final, completion: completion) 218 | } 219 | 220 | /// Send a "pong" message to the client. 221 | public func sendPong(completion: @escaping () -> ()) { 222 | self.sendMessage(opcode: .pong, bytes: [UInt8](), final: true, completion: completion) 223 | } 224 | 225 | /// Send a "ping" message to the client. 226 | /// Expect a "pong" message to follow. 227 | public func sendPing(completion: @escaping () -> ()) { 228 | self.sendMessage(opcode: .ping, bytes: [UInt8](), final: true, completion: completion) 229 | } 230 | 231 | private func sendMessage(opcode op: OpcodeType, bytes: [UInt8], final: Bool, completion: @escaping () -> ()) { 232 | let sendBuffer = Bytes() 233 | 234 | let byte1 = UInt8(final ? 0x80 : 0x0) | (self.nextIsContinuation ? 0 : op.rawValue) 235 | 236 | self.nextIsContinuation = !final 237 | 238 | let _ = sendBuffer.import8Bits(from: byte1) 239 | 240 | let payloadSize = bytes.count 241 | if payloadSize < smallPayloadSize { 242 | 243 | let byte2 = UInt8(payloadSize) 244 | 245 | let _ = sendBuffer.import8Bits(from: byte2) 246 | 247 | } else if payloadSize <= Int(UINT16_MAX) { 248 | 249 | let _ = sendBuffer.import8Bits(from: UInt8(smallPayloadSize)) 250 | .import16Bits(from: UInt16(payloadSize).hostToNet) 251 | 252 | } else { 253 | 254 | let _ = sendBuffer.import8Bits(from: UInt8(1+smallPayloadSize)) 255 | .import64Bits(from: UInt64(payloadSize).hostToNet) 256 | 257 | } 258 | let _ = sendBuffer.importBytes(from: bytes) 259 | self.socket.write(bytes: sendBuffer.data) { 260 | _ in 261 | completion() 262 | } 263 | } 264 | 265 | /// implement Equatable protocol 266 | public static func == (lhs: WebSocket, rhs: WebSocket) -> Bool { 267 | return lhs.socket == rhs.socket 268 | } 269 | } 270 | 271 | /// The protocol that all WebSocket handlers must implement. 272 | public protocol WebSocketSessionHandler { 273 | 274 | /// Optionally indicate the name of the protocol the handler implements. 275 | /// If this has a valid, the protocol name will be validated against what the client is requesting. 276 | var socketProtocol: String? { get } 277 | /// This function is called once the WebSocket session has been initiated. 278 | func handleSession(request req: HTTPRequest, socket: WebSocket) 279 | 280 | } 281 | 282 | private let acceptableProtocolVersions = [13] 283 | private let webSocketGUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" 284 | 285 | /// This request handler accepts WebSocket requests from client. 286 | /// It will initialize the session and then deliver it to the `WebSocketSessionHandler`. 287 | public struct WebSocketHandler { 288 | 289 | /// Function which produces a WebSocketSessionHandler 290 | public typealias HandlerProducer = (_ request: HTTPRequest, _ protocols: [String]) -> WebSocketSessionHandler? 291 | 292 | private let handlerProducer: HandlerProducer 293 | 294 | /// Initialize WebSocketHandler with a handler producer function 295 | public init(handlerProducer: @escaping HandlerProducer) { 296 | self.handlerProducer = handlerProducer 297 | } 298 | 299 | /// Handle the request and negotiate the WebSocket session 300 | public func handleRequest(request: HTTPRequest, response: HTTPResponse) { 301 | 302 | guard let upgrade = request.header(.upgrade), 303 | let connection = request.header(.connection), 304 | let secWebSocketKey = request.header(.custom(name: "sec-websocket-key")), 305 | let secWebSocketVersion = request.header(.custom(name: "sec-websocket-version")) 306 | , upgrade.lowercased() == "websocket" && connection.lowercased().contains(string: "upgrade") else { 307 | 308 | response.status = .badRequest 309 | return response.completed() 310 | } 311 | 312 | guard acceptableProtocolVersions.contains(Int(secWebSocketVersion) ?? 0) else { 313 | response.status = .badRequest 314 | response.addHeader(.custom(name: "Sec-WebSocket-Version"), value: "\(acceptableProtocolVersions[0])") 315 | response.appendBody(string: "WebSocket protocol version \(secWebSocketVersion) not supported. Supported protocol versions are: \(acceptableProtocolVersions)") 316 | return response.completed() 317 | } 318 | 319 | let secWebSocketProtocol = request.header(.custom(name: "sec-websocket-protocol")) ?? "" 320 | let protocolList = secWebSocketProtocol.split(separator: ",").compactMap { 321 | i -> String? in 322 | var s = String(i) 323 | while s.count > 0 && s[s.startIndex] == " " { 324 | s.remove(at: s.startIndex) 325 | } 326 | return s.count > 0 ? s : nil 327 | } 328 | 329 | guard let handler = self.handlerProducer(request, protocolList) else { 330 | response.status = .badRequest 331 | response.appendBody(string: "WebSocket protocols not supported.") 332 | response.completed() 333 | return 334 | } 335 | request.scratchPad["no-compression"] = true 336 | response.status = .switchingProtocols 337 | response.addHeader(.upgrade, value: "websocket") 338 | response.addHeader(.connection, value: "Upgrade") 339 | response.addHeader(.custom(name: "Sec-WebSocket-Accept"), value: self.base64((secWebSocketKey + webSocketGUID).utf8.sha1)) 340 | 341 | if let chosenProtocol = handler.socketProtocol { 342 | response.addHeader(.custom(name: "Sec-WebSocket-Protocol"), value: chosenProtocol) 343 | } 344 | 345 | response.push { 346 | ok in 347 | guard ok else { 348 | request.connection.close() 349 | return 350 | } 351 | handler.handleSession(request: request, socket: WebSocket(socket: request.connection)) 352 | } 353 | } 354 | 355 | private func base64(_ a: [UInt8]) -> String { 356 | let bio = BIO_push(BIO_new(BIO_f_base64()), BIO_new(BIO_s_mem())) 357 | 358 | BIO_set_flags(bio, BIO_FLAGS_BASE64_NO_NL) 359 | BIO_write(bio, a, Int32(a.count)) 360 | BIO_ctrl(bio, BIO_CTRL_FLUSH, 0, nil) 361 | 362 | var mem = UnsafeMutablePointer(nil as OpaquePointer?) 363 | BIO_ctrl(bio, BIO_C_GET_BUF_MEM_PTR, 0, &mem) 364 | BIO_ctrl(bio, BIO_CTRL_SET_CLOSE, Int(BIO_NOCLOSE), nil) 365 | BIO_free_all(bio) 366 | 367 | guard let amem = mem else { 368 | return "" 369 | } 370 | guard let txt = UnsafeMutableRawPointer(amem.pointee.data)?.assumingMemoryBound(to: UInt8.self) else { 371 | return "" 372 | } 373 | let ret = UTF8Encoding.encode(generator: GenerateFromPointer(from: txt, count: amem.pointee.length)) 374 | free(amem.pointee.data) 375 | return ret 376 | } 377 | } 378 | 379 | extension String.UTF8View { 380 | var sha1: [UInt8] { 381 | let bytes = UnsafeMutablePointer.allocate(capacity: Int(SHA_DIGEST_LENGTH)) 382 | defer { bytes.deallocate() } 383 | 384 | SHA1(Array(self), (self.count), bytes) 385 | 386 | var r = [UInt8]() 387 | for idx in 0.. () throws -> Void)] { 10 | return [ 11 | ("testExample", testExample), 12 | ] 13 | } 14 | } 15 | --------------------------------------------------------------------------------