bare-ws 1.1.0 → 1.2.1

package/README.md

@@ -6,6 +6,24 @@ WebSocket library for JavaScript.
 npm i bare-ws
 ```
 
+## Usage
+
+```js
+const ws = require('bare-ws')
+
+const server = new ws.Server({ port: 8080 }, (socket) => {
+  socket.on('data', (data) => {
+    console.log(data.toString())
+  })
+})
+
+server.on('listening', () => {
+  const socket = new ws.Socket({ port: 8080 })
+
+  socket.write('Hello WebSocket')
+})
+```
+
 ## License
 
 Apache-2.0

package/lib/errors.js

@@ -23,6 +23,18 @@ module.exports = class WebSocketError extends Error {
     return new WebSocketError(msg, 'UNEXPECTED_MASK', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_MASK)
   }
 
+  static EXPECTED_CONTINUATION (msg = 'Expected a continuation frame') {
+    return new WebSocketError(msg, 'EXPECTED_CONTINUATION', status.PROTOCOL_ERROR, WebSocketError.EXPECTED_CONTINUATION)
+  }
+
+  static UNEXPECTED_CONTINUATION (msg = 'Unexpected continuation frame') {
+    return new WebSocketError(msg, 'UNEXPECTED_CONTINUATION', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_CONTINUATION)
+  }
+
+  static UNEXPECTED_CONTROL (msg = 'Unexpected control frame') {
+    return new WebSocketError(msg, 'UNEXPECTED_CONTROL', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_CONTROL)
+  }
+
   static INVALID_ENCODING (msg = 'Invalid encoding') {
     return new WebSocketError(msg, 'INVALID_ENCODING', status.PROTOCOL_ERROR, WebSocketError.INVALID_ENCODING)
   }
@@ -43,6 +55,10 @@ module.exports = class WebSocketError extends Error {
     return new WebSocketError(msg, 'INVALID_ACCEPT_HEADER', status.PROTOCOL_ERROR, WebSocketError.INVALID_ACCEPT_HEADER)
   }
 
+  static INVALID_OPCODE (msg = 'Invalid opcode') {
+    return new WebSocketError(msg, 'INVALID_OPCODE', status.PROTOCOL_ERROR, WebSocketError.INVALID_OPCODE)
+  }
+
   static INVALID_PAYLOAD_LENGTH (msg = 'Invalid payload length') {
     return new WebSocketError(msg, 'INVALID_PAYLOAD_LENGTH', status.MESSAGE_TOO_LARGE, WebSocketError.INVALID_PAYLOAD_LENGTH)
   }

package/lib/socket.js

@@ -85,7 +85,7 @@ module.exports = exports = class WebSocket extends Duplex {
     while (this._buffer !== null) {
       const state = { start: 0, end: this._buffer.length, buffer: this._buffer }
 
-      const frame = Frame.decode(state, { isServer: this._isServer })
+      const frame = Frame.decode(state)
 
       if (frame === null) return
 
@@ -97,24 +97,47 @@ module.exports = exports = class WebSocket extends Duplex {
 
   _onframe (frame) {
     if (frame.payload.length > 0 && !frame.mask === this._isServer) {
-      throw this._isServer ? errors.EXPECTED_MASK() : errors.UNEXPECTED_MASK()
+      return this.destroy(this._isServer ? errors.EXPECTED_MASK() : errors.UNEXPECTED_MASK())
     }
 
-    if (frame.fin === 0) {
-      this._fragments.push(frame)
+    if (frame.fin === false) {
+      if (this._fragments.push(frame) === 1) { // First frame
+        if (frame.opcode === opcode.CONTINUATION) return this.destroy(errors.UNEXPECTED_CONTINUATION())
+
+        if (frame.opcode >= opcode.CLOSE) return this.destroy(errors.UNEXPECTED_CONTROL())
+
+        return
+      }
+
+      if (frame.opcode !== opcode.CONTINUATION) return this.destroy(errors.EXPECTED_CONTINUATION())
+
       return
     }
 
-    if (this._fragments.length > 0) {
-      frame.opcode = this._fragments[0].opcode
+    switch (frame.opcode) {
+      case opcode.CLOSE:
+        this.push(null)
+        this.end()
+        return
+
+      case opcode.CONTINUATION: {
+        if (this._fragments.length === 0) return this.destroy(errors.UNEXPECTED_CONTINUATION())
+
+        frame.opcode = this._fragments[0].opcode
+
+        const payloads = this._fragments.map(frame => frame.payload)
+
+        payloads.push(frame.payload)
 
-      const payloads = this._fragments.map(frame => frame.payload)
+        frame.payload = Buffer.concat(payloads)
 
-      payloads.push(frame.payload)
+        this._fragments = []
 
-      frame.payload = Buffer.concat(payloads)
+        break
+      }
 
-      this._fragments = []
+      default:
+        if (this._fragments.length > 0) return this.destroy(errors.EXPECTED_CONTINUATION())
     }
 
     switch (frame.opcode) {
@@ -123,9 +146,8 @@ module.exports = exports = class WebSocket extends Duplex {
         this.push(frame.payload)
         break
 
-      case opcode.CLOSE:
-        this.push(null)
-        this.end()
+      default:
+        this.destroy(errors.INVALID_OPCODE())
     }
   }
 
@@ -200,10 +222,10 @@ const handshake = exports.handshake = function handshake (req, cb) {
 function defaultPort (url) {
   switch (url.protocol) {
     case 'ftp:': return 21
-    case 'http':
-    case 'ws': return 80
-    case 'https':
-    case 'wss': return 443
+    case 'http:':
+    case 'ws:': return 80
+    case 'https:':
+    case 'wss:': return 443
   }
 
   return null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ws",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "WebSocket library for JavaScript",
   "exports": {
     ".": "./index.js",