Fix webscoket close and fix test cases.
This commit is contained in:
parent
0feac12a67
commit
51d834a0a1
|
@ -35,7 +35,7 @@ jobs:
|
||||||
- target:
|
- target:
|
||||||
os: windows
|
os: windows
|
||||||
builder: windows-2019
|
builder: windows-2019
|
||||||
name: '${{ matrix.target.os }}-${{ matrix.target.cpu }} (${{ matrix.branch }})'
|
name: "${{ matrix.target.os }}-${{ matrix.target.cpu }} (${{ matrix.branch }})"
|
||||||
runs-on: ${{ matrix.builder }}
|
runs-on: ${{ matrix.builder }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout nim-ws
|
- name: Checkout nim-ws
|
||||||
|
|
|
@ -1,8 +1,7 @@
|
||||||
import pkg/[chronos,
|
import pkg/[chronos,
|
||||||
chronos/apps/http/httpserver,
|
chronos/apps/http/httpserver,
|
||||||
chronicles,
|
chronicles,
|
||||||
httputils,
|
httputils]
|
||||||
stew/byteutils]
|
|
||||||
|
|
||||||
import ../ws/ws
|
import ../ws/ws
|
||||||
|
|
||||||
|
@ -13,22 +12,18 @@ proc process(r: RequestFence): Future[HttpResponseRef] {.async.} =
|
||||||
if request.uri.path == "/ws":
|
if request.uri.path == "/ws":
|
||||||
debug "Initiating web socket connection."
|
debug "Initiating web socket connection."
|
||||||
try:
|
try:
|
||||||
var ws = await createServer(request,"")
|
let ws = await createServer(request, "")
|
||||||
if ws.readyState != Open:
|
if ws.readyState != Open:
|
||||||
error "Failed to open websocket connection."
|
error "Failed to open websocket connection."
|
||||||
return
|
return
|
||||||
debug "Websocket handshake completed."
|
debug "Websocket handshake completed."
|
||||||
while ws.readyState != ReadyState.Closed:
|
while true:
|
||||||
# Only reads header for data frame.
|
let recvData = await ws.recv()
|
||||||
var recvData = await ws.recv()
|
if ws.readyState == ReadyState.Closed:
|
||||||
if recvData.len <= 0:
|
debug "Websocket closed."
|
||||||
debug "Empty messages"
|
|
||||||
break
|
break
|
||||||
|
|
||||||
# debug "Client Response: ", data = string.fromBytes(recvData), size = recvData.len
|
|
||||||
debug "Client Response: ", size = recvData.len
|
debug "Client Response: ", size = recvData.len
|
||||||
await ws.send(recvData)
|
await ws.send(recvData)
|
||||||
# await ws.close()
|
|
||||||
|
|
||||||
except WebSocketError as exc:
|
except WebSocketError as exc:
|
||||||
error "WebSocket error:", exception = exc.msg
|
error "WebSocket error:", exception = exc.msg
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
import unittest
|
import unittest
|
||||||
|
|
||||||
include ../ws/ws
|
include ../ws/ws
|
||||||
include ../ws/random
|
include ../ws/utils
|
||||||
|
|
||||||
# TODO: Fix Test.
|
# TODO: Fix Test.
|
||||||
|
|
||||||
|
|
|
@ -2,22 +2,32 @@ import std/strutils, httputils
|
||||||
|
|
||||||
import pkg/[asynctest,
|
import pkg/[asynctest,
|
||||||
chronos,
|
chronos,
|
||||||
|
chronicles,
|
||||||
chronos/apps/http/shttpserver,
|
chronos/apps/http/shttpserver,
|
||||||
stew/byteutils]
|
stew/byteutils]
|
||||||
|
|
||||||
import ../ws/[ws, stream],
|
import ../ws/[ws, stream],
|
||||||
../examples/tlsserver
|
../examples/tlsserver
|
||||||
|
|
||||||
import ./keys
|
import ./keys
|
||||||
|
|
||||||
var server: SecureHttpServerRef
|
proc waitForClose(ws: WebSocket) {.async.} =
|
||||||
let address = initTAddress("127.0.0.1:8888")
|
try:
|
||||||
let serverFlags = {HttpServerFlags.Secure, HttpServerFlags.NotifyDisconnect}
|
while ws.readystate != ReadyState.Closed:
|
||||||
let socketFlags = {ServerFlags.TcpNoDelay, ServerFlags.ReuseAddr}
|
discard await ws.recv()
|
||||||
let clientFlags = {NoVerifyHost, NoVerifyServerName}
|
except CatchableError:
|
||||||
|
debug "Closing websocket"
|
||||||
|
|
||||||
|
var server: SecureHttpServerRef
|
||||||
|
|
||||||
|
let
|
||||||
|
address = initTAddress("127.0.0.1:8888")
|
||||||
|
serverFlags = {HttpServerFlags.Secure, HttpServerFlags.NotifyDisconnect}
|
||||||
|
socketFlags = {ServerFlags.TcpNoDelay, ServerFlags.ReuseAddr}
|
||||||
|
clientFlags = {NoVerifyHost, NoVerifyServerName}
|
||||||
|
secureKey = TLSPrivateKey.init(SecureKey)
|
||||||
|
secureCert = TLSCertificate.init(SecureCert)
|
||||||
|
|
||||||
let secureKey = TLSPrivateKey.init(SecureKey)
|
|
||||||
let secureCert = TLSCertificate.init(SecureCert)
|
|
||||||
|
|
||||||
suite "Test websocket TLS handshake":
|
suite "Test websocket TLS handshake":
|
||||||
teardown:
|
teardown:
|
||||||
|
@ -31,10 +41,7 @@ suite "Test websocket TLS handshake":
|
||||||
let request = r.get()
|
let request = r.get()
|
||||||
check request.uri.path == "/wss"
|
check request.uri.path == "/wss"
|
||||||
expect WSProtoMismatchError:
|
expect WSProtoMismatchError:
|
||||||
var ws = await createServer(request, "proto")
|
discard await createServer(request, "proto")
|
||||||
check ws.readyState == ReadyState.Closed
|
|
||||||
|
|
||||||
return await request.respond(Http200, "Connection established")
|
|
||||||
|
|
||||||
let res = SecureHttpServerRef.new(
|
let res = SecureHttpServerRef.new(
|
||||||
address, cb,
|
address, cb,
|
||||||
|
@ -62,10 +69,7 @@ suite "Test websocket TLS handshake":
|
||||||
let request = r.get()
|
let request = r.get()
|
||||||
check request.uri.path == "/wss"
|
check request.uri.path == "/wss"
|
||||||
expect WSVersionError:
|
expect WSVersionError:
|
||||||
var ws = await createServer(request, "proto")
|
discard await createServer(request, "proto")
|
||||||
check ws.readyState == ReadyState.Closed
|
|
||||||
|
|
||||||
return await request.respond(Http200, "Connection established")
|
|
||||||
|
|
||||||
let res = SecureHttpServerRef.new(
|
let res = SecureHttpServerRef.new(
|
||||||
address, cb,
|
address, cb,
|
||||||
|
@ -91,14 +95,17 @@ suite "Test websocket TLS handshake":
|
||||||
check r.isOk()
|
check r.isOk()
|
||||||
let request = r.get()
|
let request = r.get()
|
||||||
check request.uri.path == "/wss"
|
check request.uri.path == "/wss"
|
||||||
check request.headers.getString("Connection").toUpperAscii() == "Upgrade".toUpperAscii()
|
check request.headers.getString("Connection").toUpperAscii() ==
|
||||||
check request.headers.getString("Upgrade").toUpperAscii() == "websocket".toUpperAscii()
|
"Upgrade".toUpperAscii()
|
||||||
check request.headers.getString("Cache-Control").toUpperAscii() == "no-cache".toUpperAscii()
|
check request.headers.getString("Upgrade").toUpperAscii() ==
|
||||||
|
"websocket".toUpperAscii()
|
||||||
|
check request.headers.getString("Cache-Control").toUpperAscii() ==
|
||||||
|
"no-cache".toUpperAscii()
|
||||||
check request.headers.getString("Sec-WebSocket-Version") == $WSDefaultVersion
|
check request.headers.getString("Sec-WebSocket-Version") == $WSDefaultVersion
|
||||||
|
|
||||||
check request.headers.contains("Sec-WebSocket-Key")
|
check request.headers.contains("Sec-WebSocket-Key")
|
||||||
|
|
||||||
discard await request.respond( Http200,"Connection established")
|
discard await request.respond(Http200, "Connection established")
|
||||||
|
|
||||||
let res = SecureHttpServerRef.new(
|
let res = SecureHttpServerRef.new(
|
||||||
address, cb,
|
address, cb,
|
||||||
|
@ -133,7 +140,7 @@ suite "Test websocket TLS transmission":
|
||||||
let ws = await createServer(request, "proto")
|
let ws = await createServer(request, "proto")
|
||||||
let servRes = await ws.recv()
|
let servRes = await ws.recv()
|
||||||
check string.fromBytes(servRes) == testString
|
check string.fromBytes(servRes) == testString
|
||||||
await ws.close()
|
await waitForClose(ws)
|
||||||
return dumbResponse()
|
return dumbResponse()
|
||||||
|
|
||||||
let res = SecureHttpServerRef.new(
|
let res = SecureHttpServerRef.new(
|
||||||
|
@ -158,41 +165,7 @@ suite "Test websocket TLS transmission":
|
||||||
|
|
||||||
test "Client - test reading simple frame":
|
test "Client - test reading simple frame":
|
||||||
let testString = "Hello!"
|
let testString = "Hello!"
|
||||||
proc cb(r: RequestFence): Future[HttpResponseRef] {.async.} =
|
proc cb(r: RequestFence): Future[HttpResponseRef] {.async.} =
|
||||||
if r.isErr():
|
|
||||||
return dumbResponse()
|
|
||||||
|
|
||||||
let request = r.get()
|
|
||||||
check request.uri.path == "/wss"
|
|
||||||
let ws = await createServer(request, "proto")
|
|
||||||
let servRes = await ws.recv()
|
|
||||||
check string.fromBytes(servRes) == testString
|
|
||||||
await ws.close()
|
|
||||||
return dumbResponse()
|
|
||||||
|
|
||||||
let res = SecureHttpServerRef.new(
|
|
||||||
address, cb,
|
|
||||||
serverFlags = serverFlags,
|
|
||||||
socketFlags = socketFlags,
|
|
||||||
tlsPrivateKey = secureKey,
|
|
||||||
tlsCertificate = secureCert)
|
|
||||||
|
|
||||||
server = res.get()
|
|
||||||
server.start()
|
|
||||||
|
|
||||||
let wsClient = await WebSocket.tlsConnect(
|
|
||||||
"127.0.0.1",
|
|
||||||
Port(8888),
|
|
||||||
path = "/wss",
|
|
||||||
protocols = @["proto"],
|
|
||||||
clientFlags)
|
|
||||||
|
|
||||||
await wsClient.send(testString)
|
|
||||||
await wsClient.close()
|
|
||||||
|
|
||||||
test "Client - test reading simple frame":
|
|
||||||
let testString = "Hello!"
|
|
||||||
proc cb(r: RequestFence): Future[HttpResponseRef] {.async.} =
|
|
||||||
if r.isErr():
|
if r.isErr():
|
||||||
return dumbResponse()
|
return dumbResponse()
|
||||||
|
|
||||||
|
@ -222,4 +195,4 @@ suite "Test websocket TLS transmission":
|
||||||
|
|
||||||
var clientRes = await wsClient.recv()
|
var clientRes = await wsClient.recv()
|
||||||
check string.fromBytes(clientRes) == testString
|
check string.fromBytes(clientRes) == testString
|
||||||
await wsClient.close()
|
await waitForClose(wsClient)
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,4 +1,4 @@
|
||||||
import pkg/[chronos,
|
import pkg/[chronos,
|
||||||
chronos/apps/http/httpserver,
|
chronos/apps/http/httpserver,
|
||||||
chronos/timer,
|
chronos/timer,
|
||||||
chronicles,
|
chronicles,
|
||||||
|
@ -8,7 +8,7 @@ import strutils
|
||||||
const
|
const
|
||||||
HeaderSep = @[byte('\c'), byte('\L'), byte('\c'), byte('\L')]
|
HeaderSep = @[byte('\c'), byte('\L'), byte('\c'), byte('\L')]
|
||||||
HttpHeadersTimeout = timer.seconds(120) # timeout for receiving headers (120 sec)
|
HttpHeadersTimeout = timer.seconds(120) # timeout for receiving headers (120 sec)
|
||||||
MaxHttpHeadersSize = 8192 # maximum size of HTTP headers in octets
|
MaxHttpHeadersSize = 8192 # maximum size of HTTP headers in octets
|
||||||
|
|
||||||
proc readHeaders*(rstream: AsyncStreamReader): Future[seq[byte]] {.async.} =
|
proc readHeaders*(rstream: AsyncStreamReader): Future[seq[byte]] {.async.} =
|
||||||
var buffer = newSeq[byte](MaxHttpHeadersSize)
|
var buffer = newSeq[byte](MaxHttpHeadersSize)
|
||||||
|
@ -45,7 +45,11 @@ proc readHeaders*(rstream: AsyncStreamReader): Future[seq[byte]] {.async.} =
|
||||||
|
|
||||||
return buffer
|
return buffer
|
||||||
|
|
||||||
proc closeWait*(wsStream : AsyncStream) {.async.} =
|
proc closeWait*(wsStream: AsyncStream) {.async.} =
|
||||||
|
|
||||||
|
await allFutures(
|
||||||
|
wsStream.writer.closeWait(),
|
||||||
|
wsStream.reader.closeWait())
|
||||||
await allFutures(
|
await allFutures(
|
||||||
wsStream.writer.tsource.closeWait(),
|
wsStream.writer.tsource.closeWait(),
|
||||||
wsStream.reader.tsource.closeWait())
|
wsStream.reader.tsource.closeWait())
|
||||||
|
|
309
ws/ws.nim
309
ws/ws.nim
|
@ -18,7 +18,7 @@ import pkg/[chronos,
|
||||||
stew/base10,
|
stew/base10,
|
||||||
nimcrypto/sha]
|
nimcrypto/sha]
|
||||||
|
|
||||||
import ./random, ./stream
|
import ./utils, ./stream
|
||||||
|
|
||||||
#[
|
#[
|
||||||
+---------------------------------------------------------------+
|
+---------------------------------------------------------------+
|
||||||
|
@ -47,7 +47,7 @@ const
|
||||||
WSHeaderSize* = 12
|
WSHeaderSize* = 12
|
||||||
WSDefaultVersion* = 13
|
WSDefaultVersion* = 13
|
||||||
WSDefaultFrameSize* = 1 shl 20 # 1mb
|
WSDefaultFrameSize* = 1 shl 20 # 1mb
|
||||||
WSMaxMessageSize* = 20 shl 20 # 20mb
|
WSMaxMessageSize* = 20 shl 20 # 20mb
|
||||||
WSGuid* = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
|
WSGuid* = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
|
||||||
CRLF* = "\r\n"
|
CRLF* = "\r\n"
|
||||||
|
|
||||||
|
@ -71,7 +71,13 @@ type
|
||||||
WSMaxMessageSizeError* = object of WebSocketError
|
WSMaxMessageSizeError* = object of WebSocketError
|
||||||
WSClosedError* = object of WebSocketError
|
WSClosedError* = object of WebSocketError
|
||||||
WSSendError* = object of WebSocketError
|
WSSendError* = object of WebSocketError
|
||||||
WSPayloadTooLarge = object of WebSocketError
|
WSPayloadTooLarge* = object of WebSocketError
|
||||||
|
WSReserverdOpcodeError* = object of WebSocketError
|
||||||
|
WSFragmentedControlFrameError* = object of WebSocketError
|
||||||
|
WSInvalidCloseCodeError* = object of WebSocketError
|
||||||
|
WSPayloadLengthError* = object of WebSocketError
|
||||||
|
WSInvalidOpcodeError* = object of WebSocketError
|
||||||
|
|
||||||
|
|
||||||
Base16Error* = object of CatchableError
|
Base16Error* = object of CatchableError
|
||||||
## Base16 specific exception type
|
## Base16 specific exception type
|
||||||
|
@ -111,21 +117,21 @@ type
|
||||||
TooLarge = 1009
|
TooLarge = 1009
|
||||||
NoExtensions = 1010
|
NoExtensions = 1010
|
||||||
UnexpectedError = 1011
|
UnexpectedError = 1011
|
||||||
TlsError # use by clients
|
ReservedCode = 3999 # use by clients
|
||||||
# 3000-3999 reserved for libs
|
# 3000-3999 reserved for libs
|
||||||
# 4000-4999 reserved for applications
|
# 4000-4999 reserved for applications
|
||||||
|
|
||||||
Frame = ref object
|
Frame = ref object
|
||||||
fin: bool ## Indicates that this is the final fragment in a message.
|
fin: bool ## Indicates that this is the final fragment in a message.
|
||||||
rsv1: bool ## MUST be 0 unless negotiated that defines meanings
|
rsv1: bool ## MUST be 0 unless negotiated that defines meanings
|
||||||
rsv2: bool ## MUST be 0
|
rsv2: bool ## MUST be 0
|
||||||
rsv3: bool ## MUST be 0
|
rsv3: bool ## MUST be 0
|
||||||
opcode: Opcode ## Defines the interpretation of the "Payload data".
|
opcode: Opcode ## Defines the interpretation of the "Payload data".
|
||||||
mask: bool ## Defines whether the "Payload data" is masked.
|
mask: bool ## Defines whether the "Payload data" is masked.
|
||||||
data: seq[byte] ## Payload data
|
data: seq[byte] ## Payload data
|
||||||
maskKey: array[4, char] ## Masking key
|
maskKey: array[4, char] ## Masking key
|
||||||
length: uint64 ## Message size.
|
length: uint64 ## Message size.
|
||||||
consumed: uint64 ## how much has been consumed from the frame
|
consumed: uint64 ## how much has been consumed from the frame
|
||||||
|
|
||||||
ControlCb* = proc() {.gcsafe, raises: [Defect].}
|
ControlCb* = proc() {.gcsafe, raises: [Defect].}
|
||||||
|
|
||||||
|
@ -156,11 +162,11 @@ template remainder*(frame: Frame): uint64 =
|
||||||
proc `$`(ht: HttpTables): string =
|
proc `$`(ht: HttpTables): string =
|
||||||
## Returns string representation of HttpTable/Ref.
|
## Returns string representation of HttpTable/Ref.
|
||||||
var res = ""
|
var res = ""
|
||||||
for key,value in ht.stringItems(true):
|
for key, value in ht.stringItems(true):
|
||||||
res.add(key.normalizeHeaderName())
|
res.add(key.normalizeHeaderName())
|
||||||
res.add(": ")
|
res.add(": ")
|
||||||
res.add(value)
|
res.add(value)
|
||||||
res.add(CRLF)
|
res.add(CRLF)
|
||||||
|
|
||||||
## add for end of header mark
|
## add for end of header mark
|
||||||
res.add(CRLF)
|
res.add(CRLF)
|
||||||
|
@ -209,10 +215,11 @@ proc handshake*(
|
||||||
wantProtocol & ")")
|
wantProtocol & ")")
|
||||||
|
|
||||||
let cKey = ws.key & WSGuid
|
let cKey = ws.key & WSGuid
|
||||||
let acceptKey = Base64Pad.encode(sha1.digest(cKey.toOpenArray(0, cKey.high)).data)
|
let acceptKey = Base64Pad.encode(sha1.digest(cKey.toOpenArray(0,
|
||||||
|
cKey.high)).data)
|
||||||
var headerData = [
|
var headerData = [
|
||||||
("Connection", "Upgrade"),
|
("Connection", "Upgrade"),
|
||||||
("Upgrade", "webSocket" ),
|
("Upgrade", "webSocket"),
|
||||||
("Sec-WebSocket-Accept", acceptKey)]
|
("Sec-WebSocket-Accept", acceptKey)]
|
||||||
|
|
||||||
var headers = HttpTable.init(headerData)
|
var headers = HttpTable.init(headerData)
|
||||||
|
@ -222,7 +229,8 @@ proc handshake*(
|
||||||
try:
|
try:
|
||||||
discard await request.respond(httputils.Http101, "", headers)
|
discard await request.respond(httputils.Http101, "", headers)
|
||||||
except CatchableError as exc:
|
except CatchableError as exc:
|
||||||
raise newException(WSHandshakeError, "Failed to sent handshake response. Error: " & exc.msg)
|
raise newException(WSHandshakeError,
|
||||||
|
"Failed to sent handshake response. Error: " & exc.msg)
|
||||||
ws.readyState = ReadyState.Open
|
ws.readyState = ReadyState.Open
|
||||||
|
|
||||||
proc createServer*(
|
proc createServer*(
|
||||||
|
@ -330,39 +338,47 @@ proc send*(
|
||||||
maskKey = genMaskKey(ws.rng)
|
maskKey = genMaskKey(ws.rng)
|
||||||
|
|
||||||
if opcode notin {Opcode.Text, Opcode.Cont, Opcode.Binary}:
|
if opcode notin {Opcode.Text, Opcode.Cont, Opcode.Binary}:
|
||||||
|
if ws.readyState in {ReadyState.Closing} and opcode notin {Opcode.Close}:
|
||||||
|
return
|
||||||
await ws.stream.writer.write(encodeFrame(Frame(
|
await ws.stream.writer.write(encodeFrame(Frame(
|
||||||
fin: true,
|
fin: true,
|
||||||
rsv1: false,
|
rsv1: false,
|
||||||
rsv2: false,
|
rsv2: false,
|
||||||
rsv3: false,
|
rsv3: false,
|
||||||
opcode: opcode,
|
opcode: opcode,
|
||||||
mask: ws.masked,
|
mask: ws.masked,
|
||||||
data: data, # allow sending data with close messages
|
data: data, # allow sending data with close messages
|
||||||
maskKey: maskKey)))
|
maskKey: maskKey)))
|
||||||
|
|
||||||
return
|
return
|
||||||
|
|
||||||
let maxSize = ws.frameSize
|
let maxSize = ws.frameSize
|
||||||
var i = 0
|
var i = 0
|
||||||
while i < data.len:
|
while ws.readyState notin {ReadyState.Closing}:
|
||||||
let len = min(data.len, (maxSize + i))
|
let len = min(data.len, (maxSize + i))
|
||||||
let inFrame = Frame(
|
let encFrame = encodeFrame(Frame(
|
||||||
fin: if (i + len >= data.len): true else: false,
|
fin: if (i + len >= data.len): true else: false,
|
||||||
rsv1: false,
|
rsv1: false,
|
||||||
rsv2: false,
|
rsv2: false,
|
||||||
rsv3: false,
|
rsv3: false,
|
||||||
opcode: if i > 0: Opcode.Cont else: opcode, # fragments have to be `Continuation` frames
|
opcode: if i > 0: Opcode.Cont else: opcode, # fragments have to be `Continuation` frames
|
||||||
mask: ws.masked,
|
mask: ws.masked,
|
||||||
data: data[i ..< len],
|
data: data[i ..< len],
|
||||||
maskKey: maskKey)
|
maskKey: maskKey))
|
||||||
|
|
||||||
await ws.stream.writer.write(encodeFrame(inFrame))
|
await ws.stream.writer.write(encFrame)
|
||||||
i += len
|
i += len
|
||||||
|
|
||||||
|
if i >= data.len:
|
||||||
|
break
|
||||||
|
|
||||||
proc send*(ws: WebSocket, data: string): Future[void] =
|
proc send*(ws: WebSocket, data: string): Future[void] =
|
||||||
send(ws, toBytes(data), Opcode.Text)
|
send(ws, toBytes(data), Opcode.Text)
|
||||||
|
|
||||||
proc handleClose*(ws: WebSocket, frame: Frame) {.async.} =
|
proc handleClose*(ws: WebSocket, frame: Frame, payLoad: seq[byte] = @[]) {.async.} =
|
||||||
|
|
||||||
|
if ws.readyState notin {ReadyState.Open}:
|
||||||
|
return
|
||||||
logScope:
|
logScope:
|
||||||
fin = frame.fin
|
fin = frame.fin
|
||||||
masked = frame.mask
|
masked = frame.mask
|
||||||
|
@ -370,46 +386,46 @@ proc handleClose*(ws: WebSocket, frame: Frame) {.async.} =
|
||||||
serverState = ws.readyState
|
serverState = ws.readyState
|
||||||
|
|
||||||
debug "Handling close sequence"
|
debug "Handling close sequence"
|
||||||
if ws.readyState == ReadyState.Open or ws.readyState == ReadyState.Closing:
|
var
|
||||||
# Read control frame payload.
|
code = Status.Fulfilled
|
||||||
var data = newSeq[byte](frame.length)
|
reason = ""
|
||||||
if frame.length > 0:
|
|
||||||
# Read the data.
|
|
||||||
await ws.stream.reader.readExactly(addr data[0], int frame.length)
|
|
||||||
unmask(data.toOpenArray(0, data.high), frame.maskKey)
|
|
||||||
|
|
||||||
var code: Status
|
if payLoad.len == 1:
|
||||||
if data.len > 0:
|
raise newException(WSPayloadLengthError, "Invalid close frame with payload length 1!")
|
||||||
let ccode = uint16.fromBytesBE(data[0..<2]) # first two bytes are the status
|
elif payLoad.len > 1:
|
||||||
doAssert(ccode > 999, "No valid code in close message!")
|
# first two bytes are the status
|
||||||
|
let ccode = uint16.fromBytesBE(payLoad[0..<2])
|
||||||
|
if ccode <= 999 or ccode > 1015:
|
||||||
|
raise newException(WSInvalidCloseCodeError, "Invalid code in close message!")
|
||||||
|
try:
|
||||||
code = Status(ccode)
|
code = Status(ccode)
|
||||||
data = data[2..data.high]
|
except RangeError:
|
||||||
|
code = Status.Fulfilled
|
||||||
|
# remining payload bytes are reason for closing
|
||||||
|
reason = string.fromBytes(payLoad[2..payLoad.high])
|
||||||
|
|
||||||
var rcode = Status.Fulfilled
|
var rcode: Status
|
||||||
var reason = ""
|
if code in {Status.Fulfilled}:
|
||||||
if not isNil(ws.onClose):
|
rcode = Status.Fulfilled
|
||||||
try:
|
|
||||||
(rcode, reason) = ws.onClose(code, string.fromBytes(data))
|
|
||||||
except CatchableError as exc:
|
|
||||||
debug "Exception in Close callback, this is most likely a bug", exc = exc.msg
|
|
||||||
|
|
||||||
# don't respond to a terminated connection
|
if not isNil(ws.onClose):
|
||||||
if ws.readyState != ReadyState.Closing:
|
try:
|
||||||
await ws.send(prepareCloseBody(rcode, reason), Opcode.Close)
|
(rcode, reason) = ws.onClose(code, reason)
|
||||||
|
except CatchableError as exc:
|
||||||
|
debug "Exception in Close callback, this is most likely a bug", exc = exc.msg
|
||||||
|
|
||||||
|
# don't respond to a terminated connection
|
||||||
|
if ws.readyState != ReadyState.Closing:
|
||||||
|
ws.readyState = ReadyState.Closing
|
||||||
|
await ws.send(prepareCloseBody(rcode, reason), Opcode.Close)
|
||||||
|
|
||||||
await ws.stream.closeWait()
|
|
||||||
ws.readyState = ReadyState.Closed
|
ws.readyState = ReadyState.Closed
|
||||||
else:
|
await ws.stream.closeWait()
|
||||||
raiseAssert("Invalid state during close!")
|
|
||||||
|
|
||||||
proc handleControl*(ws: WebSocket, frame: Frame) {.async.} =
|
proc handleControl*(ws: WebSocket, frame: Frame, payLoad: seq[byte] = @[]) {.async.} =
|
||||||
## handle control frames
|
## handle control frames
|
||||||
##
|
##
|
||||||
|
|
||||||
if frame.length > 125:
|
|
||||||
raise newException(WSPayloadTooLarge,
|
|
||||||
"Control message payload is greater than 125 bytes!")
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Process control frame payload.
|
# Process control frame payload.
|
||||||
case frame.opcode:
|
case frame.opcode:
|
||||||
|
@ -421,7 +437,7 @@ proc handleControl*(ws: WebSocket, frame: Frame) {.async.} =
|
||||||
debug "Exception in Ping callback, this is most likelly a bug", exc = exc.msg
|
debug "Exception in Ping callback, this is most likelly a bug", exc = exc.msg
|
||||||
|
|
||||||
# send pong to remote
|
# send pong to remote
|
||||||
await ws.send(@[], Opcode.Pong)
|
await ws.send(payLoad, Opcode.Pong)
|
||||||
of Opcode.Pong:
|
of Opcode.Pong:
|
||||||
if not isNil(ws.onPong):
|
if not isNil(ws.onPong):
|
||||||
try:
|
try:
|
||||||
|
@ -429,9 +445,12 @@ proc handleControl*(ws: WebSocket, frame: Frame) {.async.} =
|
||||||
except CatchableError as exc:
|
except CatchableError as exc:
|
||||||
debug "Exception in Pong callback, this is most likelly a bug", exc = exc.msg
|
debug "Exception in Pong callback, this is most likelly a bug", exc = exc.msg
|
||||||
of Opcode.Close:
|
of Opcode.Close:
|
||||||
await ws.handleClose(frame)
|
await ws.handleClose(frame, payLoad)
|
||||||
else:
|
else:
|
||||||
raiseAssert("Invalid control opcode")
|
raise newException(WSInvalidOpcodeError, "Invalid control opcode!")
|
||||||
|
except WebSocketError as exc:
|
||||||
|
debug "Handled websocket exception", exc = exc.msg
|
||||||
|
raise exc
|
||||||
except CatchableError as exc:
|
except CatchableError as exc:
|
||||||
trace "Exception handling control messages", exc = exc.msg
|
trace "Exception handling control messages", exc = exc.msg
|
||||||
ws.readyState = ReadyState.Closed
|
ws.readyState = ReadyState.Closed
|
||||||
|
@ -467,8 +486,12 @@ proc readFrame*(ws: WebSocket): Future[Frame] {.async.} =
|
||||||
if opcode > ord(Opcode.high):
|
if opcode > ord(Opcode.high):
|
||||||
raise newException(WSOpcodeMismatchError, "Wrong opcode!")
|
raise newException(WSOpcodeMismatchError, "Wrong opcode!")
|
||||||
|
|
||||||
frame.opcode = (opcode).Opcode
|
let frameOpcode = (opcode).Opcode
|
||||||
|
if frameOpcode notin {Opcode.Text, Opcode.Cont, Opcode.Binary,
|
||||||
|
Opcode.Ping, Opcode.Pong, Opcode.Close}:
|
||||||
|
raise newException(WSReserverdOpcodeError, "Unknown opcode received!")
|
||||||
|
|
||||||
|
frame.opcode = frameOpcode
|
||||||
# If any of the rsv are set close the socket.
|
# If any of the rsv are set close the socket.
|
||||||
if frame.rsv1 or frame.rsv2 or frame.rsv3:
|
if frame.rsv1 or frame.rsv2 or frame.rsv3:
|
||||||
raise newException(WSRsvMismatchError, "WebSocket rsv mismatch")
|
raise newException(WSRsvMismatchError, "WebSocket rsv mismatch")
|
||||||
|
@ -508,12 +531,33 @@ proc readFrame*(ws: WebSocket): Future[Frame] {.async.} =
|
||||||
|
|
||||||
# return the current frame if it's not one of the control frames
|
# return the current frame if it's not one of the control frames
|
||||||
if frame.opcode notin {Opcode.Text, Opcode.Cont, Opcode.Binary}:
|
if frame.opcode notin {Opcode.Text, Opcode.Cont, Opcode.Binary}:
|
||||||
asyncSpawn ws.handleControl(frame) # process control frames
|
if not frame.fin:
|
||||||
|
raise newException(WSFragmentedControlFrameError, "Control frame cannot be fragmented!")
|
||||||
|
if frame.length > 125:
|
||||||
|
raise newException(WSPayloadTooLarge,
|
||||||
|
"Control message payload is greater than 125 bytes!")
|
||||||
|
var payLoad = newSeq[byte](frame.length)
|
||||||
|
if frame.length > 0:
|
||||||
|
# Read control frame payload.
|
||||||
|
await ws.stream.reader.readExactly(addr payLoad[0], frame.length.int)
|
||||||
|
unmask(payLoad.toOpenArray(0, payLoad.high), frame.maskKey)
|
||||||
|
await ws.handleControl(frame, payLoad) # process control frames# process control frames
|
||||||
continue
|
continue
|
||||||
|
|
||||||
debug "Decoded new frame", opcode = frame.opcode, len = frame.length, mask = frame.mask
|
debug "Decoded new frame", opcode = frame.opcode, len = frame.length,
|
||||||
|
mask = frame.mask
|
||||||
|
|
||||||
return frame
|
return frame
|
||||||
|
|
||||||
|
except WSReserverdOpcodeError as exc:
|
||||||
|
trace "Handled websocket opcode exception", exc = exc.msg
|
||||||
|
raise exc
|
||||||
|
except WSPayloadTooLarge as exc:
|
||||||
|
debug "Handled payload too large exception", exc = exc.msg
|
||||||
|
raise exc
|
||||||
|
except WebSocketError as exc:
|
||||||
|
debug "Handled websocket exception", exc = exc.msg
|
||||||
|
raise exc
|
||||||
except CatchableError as exc:
|
except CatchableError as exc:
|
||||||
debug "Exception reading frame, dropping socket", exc = exc.msg
|
debug "Exception reading frame, dropping socket", exc = exc.msg
|
||||||
ws.readyState = ReadyState.Closed
|
ws.readyState = ReadyState.Closed
|
||||||
|
@ -543,17 +587,32 @@ proc recv*(
|
||||||
while consumed < size:
|
while consumed < size:
|
||||||
# we might have to read more than
|
# we might have to read more than
|
||||||
# one frame to fill the buffer
|
# one frame to fill the buffer
|
||||||
if isNil(ws.frame):
|
|
||||||
ws.frame = await ws.readFrame()
|
|
||||||
|
|
||||||
# all has been consumed from the frame
|
# all has been consumed from the frame
|
||||||
# read the next frame
|
# read the next frame
|
||||||
if ws.frame.remainder() <= 0:
|
if isNil(ws.frame):
|
||||||
ws.frame = await ws.readFrame()
|
ws.frame = await ws.readFrame()
|
||||||
|
# This could happen if the connection is closed.
|
||||||
|
if isNil(ws.frame):
|
||||||
|
return consumed.int
|
||||||
|
if ws.frame.opcode == Opcode.Cont:
|
||||||
|
raise newException(WSOpcodeMismatchError, "First frame cannot be continue frame")
|
||||||
|
|
||||||
|
elif (not ws.frame.fin and ws.frame.remainder() <= 0):
|
||||||
|
ws.frame = await ws.readFrame()
|
||||||
|
# This could happen if the connection is closed.
|
||||||
|
if isNil(ws.frame):
|
||||||
|
return consumed.int
|
||||||
|
|
||||||
|
if ws.frame.opcode != Opcode.Cont:
|
||||||
|
raise newException(WSOpcodeMismatchError, "expected continue frame")
|
||||||
|
if ws.frame.fin and ws.frame.remainder().int <= 0:
|
||||||
|
ws.frame = nil
|
||||||
|
break
|
||||||
|
|
||||||
let len = min(ws.frame.remainder().int, size - consumed)
|
let len = min(ws.frame.remainder().int, size - consumed)
|
||||||
|
if len == 0:
|
||||||
|
continue
|
||||||
let read = await ws.stream.reader.readOnce(addr pbuffer[consumed], len)
|
let read = await ws.stream.reader.readOnce(addr pbuffer[consumed], len)
|
||||||
|
|
||||||
if read <= 0:
|
if read <= 0:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
@ -562,14 +621,18 @@ proc recv*(
|
||||||
unmask(
|
unmask(
|
||||||
pbuffer.toOpenArray(consumed, (consumed + read) - 1),
|
pbuffer.toOpenArray(consumed, (consumed + read) - 1),
|
||||||
ws.frame.maskKey,
|
ws.frame.maskKey,
|
||||||
consumed)
|
ws.frame.consumed.int)
|
||||||
|
|
||||||
consumed += read
|
consumed += read
|
||||||
ws.frame.consumed += read.uint64
|
ws.frame.consumed += read.uint64
|
||||||
if ws.frame.fin and ws.frame.remainder().int <= 0:
|
|
||||||
break
|
|
||||||
|
|
||||||
return consumed.int
|
return consumed.int
|
||||||
|
|
||||||
|
except WebSocketError as exc:
|
||||||
|
debug "Websocket error", exc = exc.msg
|
||||||
|
ws.readyState = ReadyState.Closed
|
||||||
|
await ws.stream.closeWait()
|
||||||
|
raise exc
|
||||||
except CancelledError as exc:
|
except CancelledError as exc:
|
||||||
debug "Cancelling reading", exc = exc.msg
|
debug "Cancelling reading", exc = exc.msg
|
||||||
raise exc
|
raise exc
|
||||||
|
@ -611,7 +674,8 @@ proc recv*(
|
||||||
# read the entire message, exit
|
# read the entire message, exit
|
||||||
if ws.frame.fin and ws.frame.remainder().int <= 0:
|
if ws.frame.fin and ws.frame.remainder().int <= 0:
|
||||||
break
|
break
|
||||||
except WSMaxMessageSizeError as exc:
|
except WebSocketError as exc:
|
||||||
|
debug "Websocket error", exc = exc.msg
|
||||||
raise exc
|
raise exc
|
||||||
except CancelledError as exc:
|
except CancelledError as exc:
|
||||||
debug "Cancelling reading", exc = exc.msg
|
debug "Cancelling reading", exc = exc.msg
|
||||||
|
@ -659,41 +723,48 @@ proc initiateHandshake(
|
||||||
TransportError,
|
TransportError,
|
||||||
"Cannot connect to " & $transp.remoteAddress() & " Error: " & exc.msg)
|
"Cannot connect to " & $transp.remoteAddress() & " Error: " & exc.msg)
|
||||||
|
|
||||||
let requestHeader = "GET " & uri.path & " HTTP/1.1" & CRLF & $headers
|
let
|
||||||
let reader = newAsyncStreamReader(transp)
|
requestHeader = "GET " & uri.path & " HTTP/1.1" & CRLF & $headers
|
||||||
let writer = newAsyncStreamWriter(transp)
|
reader = newAsyncStreamReader(transp)
|
||||||
|
writer = newAsyncStreamWriter(transp)
|
||||||
|
|
||||||
var stream: AsyncStream
|
var stream: AsyncStream
|
||||||
|
|
||||||
var res: seq[byte]
|
try:
|
||||||
if uri.scheme == "https":
|
var res: seq[byte]
|
||||||
let tlsstream = newTLSClientAsyncStream(reader, writer, "", flags = flags)
|
if uri.scheme == "https":
|
||||||
stream = AsyncStream(
|
let tlsstream = newTLSClientAsyncStream(reader, writer, "", flags = flags)
|
||||||
reader: tlsstream.reader,
|
stream = AsyncStream(
|
||||||
writer: tlsstream.writer)
|
reader: tlsstream.reader,
|
||||||
|
writer: tlsstream.writer)
|
||||||
|
|
||||||
await tlsstream.writer.write(requestHeader)
|
await tlsstream.writer.write(requestHeader)
|
||||||
res = await tlsstream.reader.readHeaders()
|
res = await tlsstream.reader.readHeaders()
|
||||||
else:
|
else:
|
||||||
stream = AsyncStream(
|
stream = AsyncStream(
|
||||||
reader: reader,
|
reader: reader,
|
||||||
writer: writer)
|
writer: writer)
|
||||||
await stream.writer.write(requestHeader)
|
await stream.writer.write(requestHeader)
|
||||||
res = await stream.reader.readHeaders()
|
res = await stream.reader.readHeaders()
|
||||||
|
|
||||||
if res.len == 0:
|
if res.len == 0:
|
||||||
raise newException(ValueError, "Empty response from server")
|
raise newException(ValueError, "Empty response from server")
|
||||||
|
|
||||||
let resHeader = res.parseResponse()
|
let resHeader = res.parseResponse()
|
||||||
if resHeader.failed():
|
if resHeader.failed():
|
||||||
# Header could not be parsed
|
# Header could not be parsed
|
||||||
raise newException(WSMalformedHeaderError, "Malformed header received.")
|
raise newException(WSMalformedHeaderError, "Malformed header received.")
|
||||||
|
|
||||||
if resHeader.code != ord(Http101):
|
if resHeader.code != ord(Http101):
|
||||||
raise newException(WSFailedUpgradeError,
|
raise newException(WSFailedUpgradeError,
|
||||||
"Server did not reply with a websocket upgrade:" &
|
"Server did not reply with a websocket upgrade:" &
|
||||||
" Header code: " & $resHeader.code &
|
" Header code: " & $resHeader.code &
|
||||||
" Header reason: " & resHeader.reason() &
|
" Header reason: " & resHeader.reason() &
|
||||||
" Address: " & $transp.remoteAddress())
|
" Address: " & $transp.remoteAddress())
|
||||||
|
except CatchableError as exc:
|
||||||
|
debug "Websocket failed during handshake", exc = exc.msg
|
||||||
|
await stream.closeWait()
|
||||||
|
raise exc
|
||||||
|
|
||||||
return stream
|
return stream
|
||||||
|
|
||||||
|
@ -738,7 +809,7 @@ proc connect*(
|
||||||
# Client data should be masked.
|
# Client data should be masked.
|
||||||
return WebSocket(
|
return WebSocket(
|
||||||
stream: stream,
|
stream: stream,
|
||||||
readyState: Open,
|
readyState: ReadyState.Open,
|
||||||
masked: true,
|
masked: true,
|
||||||
rng: newRng(),
|
rng: newRng(),
|
||||||
frameSize: frameSize,
|
frameSize: frameSize,
|
||||||
|
|
Loading…
Reference in New Issue