pusher 5.0.0 → 5.0.1

package/.github/stale.yml

@@ -1,7 +1,7 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 
 # Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 365
+daysUntilStale: 90
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
 # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
@@ -23,4 +23,4 @@ markComment: >
   This issue has been automatically marked as stale because it has not had
   recent activity. It will be closed if no further activity occurs. If you'd
   like this issue to stay open please leave a comment indicating how this issue
-  is affecting you. Thankyou.
+  is affecting you. Thank you.

package/CHANGELOG.md

@@ -1,6 +1,12 @@
+## 5.0.1 (2022-01-24)
+
+[FIXED] Incorrect `require` on `version.js` was causing a compilation error in Webpack
+[FIXED] Inconsistent encoding for shared secret between other SDKs
+
 ## 5.0.0 (2021-02-18)
 
 [BREAKING CHANGE] `trigger` now accepts a `params` _object_ instead of a `socket_id` as the third parameter.
+
 [ADDED] Support for requesting channel attributes as part of a `trigger` and `triggerBatch` request via an `info` parameter.
 
 ## 4.0.2 (2020-11-30)
@@ -51,6 +57,7 @@ const pusher = new Pusher.forURL(process.env.PUSHER_URL, {
 [UPGRADED] development dependencies
 
 [ADDED] encryptionMasterKeyBase64 constructor parameter to make it easier to use the full range of 32 byte binary values in encryption key
+
 [DEPRECATED] encryptionMasterKey constructor parameter - use encryptionMasterKeyBase64
 
 ## 3.0.0 (2019-09-26)

package/README.md

@@ -7,9 +7,9 @@ In order to use this library, you need to have an account on <https://pusher.com
 
 ## Supported platforms
 
-This SDK supports **Node.js** version 8+.
+This SDK supports **Node.js** version 10+.
 
-We test the library against a selection of Node.js versions which we update over time. Please refer to [travis.yml](https://github.com/pusher/pusher-http-node/blob/master/.travis.yml) for the set of versions that are currently tested with CI.
+We test the library against a selection of Node.js versions which we update over time. Please refer to [test.yml](https://github.com/pusher/pusher-http-node/blob/master/.github/workflows/test.yml) for the set of versions that are currently tested with CI.
 
 If you find any compatibility issues, please [raise an issue](https://github.com/pusher/pusher-http-node/issues/new) in the repository or contact support at [support@pusher.com](support@pusher.com). We will happily investigate reported problems ❤️.
 
@@ -237,7 +237,7 @@ pusher
   })
 ```
 
-### End-to-end encryption [BETA]
+### End-to-end encryption
 
 This library supports end-to-end encryption of your private channels. This means that only you and your connected clients will be able to read your messages. Pusher cannot decrypt them. You can enable this feature by following these steps:
 

package/examples/typescript/main.ts

@@ -4,8 +4,7 @@ import * as Pusher from "pusher"
 
 const pusher = Pusher.forURL(process.env.PUSHER_URL, {
   encryptionMasterKeyBase64: Buffer.from(
-    "01234567890123456789012345678901",
-    "binary"
+    "01234567890123456789012345678901"
   ).toString("base64"),
   agent: new Agent({ keepAlive: true }),
 })

package/lib/config.js

@@ -49,7 +49,7 @@ function Config(options) {
       )
     }
 
-    this.encryptionMasterKey = options.encryptionMasterKey
+    this.encryptionMasterKey = Buffer.from(options.encryptionMasterKey)
   }
 
   // Handle base64 encoded 32 byte key to encourage use of the full range of byte values
@@ -61,10 +61,7 @@ function Config(options) {
       throw new Error("encryptionMasterKeyBase64 must be valid base64")
     }
 
-    const decodedKey = Buffer.from(
-      options.encryptionMasterKeyBase64,
-      "base64"
-    ).toString("binary")
+    const decodedKey = Buffer.from(options.encryptionMasterKeyBase64, "base64")
     if (decodedKey.length !== 32) {
       throw new Error(
         "encryptionMasterKeyBase64 must decode to 32 bytes, but the string " +

package/lib/pusher.js

@@ -234,7 +234,9 @@ Pusher.prototype.createSignedQueryString = function (options) {
 Pusher.prototype.channelSharedSecret = function (channel) {
   return crypto
     .createHash("sha256")
-    .update(channel + this.config.encryptionMasterKey)
+    .update(
+      Buffer.concat([Buffer.from(channel), this.config.encryptionMasterKey])
+    )
     .digest()
 }
 

package/lib/version.js

@@ -1 +1 @@
-module.exports = require("../package").version
+module.exports = require("../package.json").version

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pusher",
   "description": "Node.js client to interact with the Pusher Channels REST API",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "author": "Pusher <support@pusher.com>",
   "contributors": [
     {

package/tests/integration/pusher/authenticate.js

@@ -149,14 +149,14 @@ describe("Pusher", function () {
 describe("Pusher with encryptionMasterKey", function () {
   let pusher
 
-  const testMasterKey = "01234567890123456789012345678901"
+  const testMasterKeyBase64 = "zyrm8pvV2C9fJcBfhyXzvxbJVN/H7QLmbe0xJi1GhPU="
 
   beforeEach(function () {
     pusher = new Pusher({
       appId: 1234,
       key: "f00d",
       secret: "tofu",
-      encryptionMasterKey: testMasterKey,
+      encryptionMasterKeyBase64: testMasterKeyBase64,
     })
   })
 
@@ -168,7 +168,7 @@ describe("Pusher with encryptionMasterKey", function () {
         auth:
           "f00d:962c48b78bf93d98ff4c92ee7dff04865821455b7b401e9d60a9e0a90af2c105",
         channel_data: '"foo"',
-        shared_secret: "BYBsePpRCQkGPvbWu/5j8x+MmUF5sgPH5DmNBwkTzYs=",
+        shared_secret: "nlr49ISQHz91yS3cy/yWmW8wFMNeTnNL5tNHnbPJcLQ=",
       })
     })
     it("should not return a shared_secret for non-encrypted channels", function () {

package/tests/integration/pusher/constructor.js

@@ -102,7 +102,7 @@ describe("Pusher", function () {
     it("should support `encryptionMasterKey` of 32 bytes", function () {
       const key = "01234567890123456789012345678901"
       const pusher = new Pusher({ encryptionMasterKey: key })
-      expect(pusher.config.encryptionMasterKey).to.equal(key)
+      expect(pusher.config.encryptionMasterKey.toString()).to.equal(key)
     })
 
     it("should reject `encryptionMasterKey` of 31 bytes", function () {
@@ -121,14 +121,14 @@ describe("Pusher", function () {
 
     it("should support `encryptionMasterKeyBase64` which decodes to 32 bytes", function () {
       const key = "01234567890123456789012345678901"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       const pusher = new Pusher({ encryptionMasterKeyBase64: keyBase64 })
-      expect(pusher.config.encryptionMasterKey).to.equal(key)
+      expect(pusher.config.encryptionMasterKey.toString()).to.equal(key)
     })
 
     it("should reject `encryptionMasterKeyBase64` which decodes to 31 bytes", function () {
       const key = "0123456789012345678901234567890"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       expect(function () {
         new Pusher({ encryptionMasterKeyBase64: keyBase64 })
       }).to.throwException(/31 bytes/)
@@ -136,7 +136,7 @@ describe("Pusher", function () {
 
     it("should reject `encryptionMasterKeyBase64` which decodes to 33 bytes", function () {
       const key = "012345678901234567890123456789012"
-      const keyBase64 = Buffer.from(key, "binary").toString("base64")
+      const keyBase64 = Buffer.from(key).toString("base64")
       expect(function () {
         new Pusher({ encryptionMasterKeyBase64: keyBase64 })
       }).to.throwException(/33 bytes/)

package/tests/integration/pusher/trigger.js

@@ -447,8 +447,7 @@ describe("Pusher with encryptionMasterKey", function () {
   let pusher
 
   const testMasterKey = Buffer.from(
-    "01234567890123456789012345678901",
-    "binary"
+    "01234567890123456789012345678901"
   ).toString("base64")
 
   beforeEach(function () {