bl 4.0.1 → 4.1.0

package/.travis.yml

@@ -1,15 +1,16 @@
 sudo: false
+arch:
+ - amd64
+ - ppc64le
 language: node_js
 node_js:
   - '6'
   - '8'
   - '10'
   - '12'
+  - '14'
+  - '15'
   - lts/*
-  - current
-branches:
-  only:
-    - master
 notifications:
   email:
     - rod@vagg.org

package/BufferList.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { Buffer } = require('buffer')
 const symbol = Symbol.for('BufferList')
 
 function BufferList (buf) {
@@ -133,12 +134,13 @@ BufferList.prototype.copy = function copy (dst, dstStart, srcStart, srcEnd) {
 
     if (bytes > l) {
       this._bufs[i].copy(dst, bufoff, start)
+      bufoff += l
     } else {
       this._bufs[i].copy(dst, bufoff, start, start + bytes)
+      bufoff += l
       break
     }
 
-    bufoff += l
     bytes -= l
 
     if (start) {
@@ -146,6 +148,9 @@ BufferList.prototype.copy = function copy (dst, dstStart, srcStart, srcEnd) {
     }
   }
 
+  // safeguard so that we don't return uninitialized memory
+  if (dst.length > bufoff) return dst.slice(0, bufoff)
+
   return dst
 }
 
@@ -187,6 +192,11 @@ BufferList.prototype.toString = function toString (encoding, start, end) {
 }
 
 BufferList.prototype.consume = function consume (bytes) {
+  // first, normalize the argument, in accordance with how Buffer does it
+  bytes = Math.trunc(bytes)
+  // do nothing if not a positive number
+  if (Number.isNaN(bytes) || bytes <= 0) return this
+
   while (this._bufs.length) {
     if (bytes >= this._bufs[0].length) {
       bytes -= this._bufs[0].length
@@ -363,7 +373,7 @@ BufferList.prototype._match = function (offset, search) {
           return this.slice(offset, offset + byteLength)[m](0, byteLength)
         }
       } else {
-        BufferList.prototype[m] = function (offset) {
+        BufferList.prototype[m] = function (offset = 0) {
           return this.slice(offset, offset + methods[m])[m](0)
         }
       }

package/bl.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const DuplexStream = require('readable-stream').Duplex
-const util = require('util')
+const inherits = require('inherits')
 const BufferList = require('./BufferList')
 
 function BufferListStream (callback) {
@@ -33,7 +33,7 @@ function BufferListStream (callback) {
   DuplexStream.call(this)
 }
 
-util.inherits(BufferListStream, DuplexStream)
+inherits(BufferListStream, DuplexStream)
 Object.assign(BufferListStream.prototype, BufferList.prototype)
 
 BufferListStream.prototype._new = function _new (callback) {

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "bl",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!",
+  "license": "MIT",
   "main": "bl.js",
   "scripts": {
     "lint": "standard *.js test/*.js",
@@ -23,8 +24,9 @@
     "stream",
     "awesomesauce"
   ],
-  "license": "MIT",
   "dependencies": {
+    "buffer": "^5.5.0",
+    "inherits": "^2.0.4",
     "readable-stream": "^3.4.0"
   },
   "devDependencies": {

package/test/convert.js

@@ -2,7 +2,7 @@
 
 const tape = require('tape')
 const { BufferList, BufferListStream } = require('../')
-const { Buffer } = require('safe-buffer')
+const { Buffer } = require('buffer')
 
 tape('convert from BufferList to BufferListStream', (t) => {
   const data = Buffer.from(`TEST-${Date.now()}`)

package/test/indexOf.js

@@ -2,7 +2,7 @@
 
 const tape = require('tape')
 const BufferList = require('../')
-const Buffer = require('safe-buffer').Buffer
+const { Buffer } = require('buffer')
 
 tape('indexOf single byte needle', (t) => {
   const bl = new BufferList(['abcdefg', 'abcdefg', '12345'])

package/test/isBufferList.js

@@ -2,7 +2,7 @@
 
 const tape = require('tape')
 const { BufferList, BufferListStream } = require('../')
-const { Buffer } = require('safe-buffer')
+const { Buffer } = require('buffer')
 
 tape('isBufferList positives', (t) => {
   t.ok(BufferList.isBufferList(new BufferList()))

package/test/test.js

@@ -5,7 +5,7 @@ const crypto = require('crypto')
 const fs = require('fs')
 const path = require('path')
 const BufferList = require('../')
-const Buffer = require('safe-buffer').Buffer
+const { Buffer } = require('buffer')
 
 const encodings =
       ('hex utf8 utf-8 ascii binary base64' +
@@ -265,6 +265,7 @@ tape('test readUInt8 / readInt8', function (t) {
   const buf3 = Buffer.alloc(3)
   const bl = new BufferList()
 
+  buf1[0] = 0x1
   buf2[1] = 0x3
   buf2[2] = 0x4
   buf3[0] = 0x23
@@ -274,6 +275,7 @@ tape('test readUInt8 / readInt8', function (t) {
   bl.append(buf2)
   bl.append(buf3)
 
+  t.equal(bl.readUInt8(), 0x1)
   t.equal(bl.readUInt8(2), 0x3)
   t.equal(bl.readInt8(2), 0x3)
   t.equal(bl.readUInt8(3), 0x4)
@@ -292,6 +294,7 @@ tape('test readUInt16LE / readUInt16BE / readInt16LE / readInt16BE', function (t
   const buf3 = Buffer.alloc(3)
   const bl = new BufferList()
 
+  buf1[0] = 0x1
   buf2[1] = 0x3
   buf2[2] = 0x4
   buf3[0] = 0x23
@@ -301,6 +304,8 @@ tape('test readUInt16LE / readUInt16BE / readInt16LE / readInt16BE', function (t
   bl.append(buf2)
   bl.append(buf3)
 
+  t.equal(bl.readUInt16BE(), 0x0100)
+  t.equal(bl.readUInt16LE(), 0x0001)
   t.equal(bl.readUInt16BE(2), 0x0304)
   t.equal(bl.readUInt16LE(2), 0x0403)
   t.equal(bl.readInt16BE(2), 0x0304)
@@ -323,6 +328,7 @@ tape('test readUInt32LE / readUInt32BE / readInt32LE / readInt32BE', function (t
   const buf3 = Buffer.alloc(3)
   const bl = new BufferList()
 
+  buf1[0] = 0x1
   buf2[1] = 0x3
   buf2[2] = 0x4
   buf3[0] = 0x23
@@ -332,6 +338,8 @@ tape('test readUInt32LE / readUInt32BE / readInt32LE / readInt32BE', function (t
   bl.append(buf2)
   bl.append(buf3)
 
+  t.equal(bl.readUInt32BE(), 0x01000304)
+  t.equal(bl.readUInt32LE(), 0x04030001)
   t.equal(bl.readUInt32BE(2), 0x03042342)
   t.equal(bl.readUInt32LE(2), 0x42230403)
   t.equal(bl.readInt32BE(2), 0x03042342)
@@ -391,6 +399,7 @@ tape('test readFloatLE / readFloatBE', function (t) {
   const buf3 = Buffer.alloc(3)
   const bl = new BufferList()
 
+  buf1[0] = 0x01
   buf2[1] = 0x00
   buf2[2] = 0x00
   buf3[0] = 0x80
@@ -400,7 +409,11 @@ tape('test readFloatLE / readFloatBE', function (t) {
   bl.append(buf2)
   bl.append(buf3)
 
-  t.equal(bl.readFloatLE(2), 0x01)
+  const canonical = Buffer.concat([buf1, buf2, buf3])
+  t.equal(bl.readFloatLE(), canonical.readFloatLE())
+  t.equal(bl.readFloatBE(), canonical.readFloatBE())
+  t.equal(bl.readFloatLE(2), canonical.readFloatLE(2))
+  t.equal(bl.readFloatBE(2), canonical.readFloatBE(2))
 
   t.end()
 })
@@ -411,6 +424,7 @@ tape('test readDoubleLE / readDoubleBE', function (t) {
   const buf3 = Buffer.alloc(10)
   const bl = new BufferList()
 
+  buf1[0] = 0x01
   buf2[1] = 0x55
   buf2[2] = 0x55
   buf3[0] = 0x55
@@ -424,7 +438,11 @@ tape('test readDoubleLE / readDoubleBE', function (t) {
   bl.append(buf2)
   bl.append(buf3)
 
-  t.equal(bl.readDoubleLE(2), 0.3333333333333333)
+  const canonical = Buffer.concat([buf1, buf2, buf3])
+  t.equal(bl.readDoubleBE(), canonical.readDoubleBE())
+  t.equal(bl.readDoubleLE(), canonical.readDoubleLE())
+  t.equal(bl.readDoubleBE(2), canonical.readDoubleBE(2))
+  t.equal(bl.readDoubleLE(2), canonical.readDoubleLE(2))
 
   t.end()
 })
@@ -463,6 +481,22 @@ tape('test toString encoding', function (t) {
   t.end()
 })
 
+tape('uninitialized memory', function (t) {
+  const secret = crypto.randomBytes(256)
+  for (let i = 0; i < 1e6; i++) {
+    const clone = Buffer.from(secret)
+    const bl = new BufferList()
+    bl.append(Buffer.from('a'))
+    bl.consume(-1024)
+    const buf = bl.slice(1)
+    if (buf.indexOf(clone) !== -1) {
+      t.fail(`Match (at ${i})`)
+      break
+    }
+  }
+  t.end()
+})
+
 !process.browser && tape('test stream', function (t) {
   const random = crypto.randomBytes(65534)