@signalk/streams 6.1.0 → 6.2.0

package/dist/mdns-ws.d.ts

@@ -16,6 +16,7 @@ interface MdnsWsOptions {
     type?: string;
     subscription?: string;
     selfHandling?: string;
+    token?: string;
     remoteSelf?: string;
     ignoreServers?: string[];
     selfsignedcert?: boolean;
@@ -31,6 +32,8 @@ export default class MdnsWs extends Transform {
     private signalkClient?;
     private fetchedMetaPaths;
     constructor(options: MdnsWsOptions);
+    private verifyRemoteToken;
+    private setProviderStatus;
     private connectClient;
     private fetchMetaIfNeeded;
     _transform(chunk: unknown, encoding: BufferEncoding, done: TransformCallback): void;

package/dist/mdns-ws.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mdns-ws.d.ts","sourceRoot":"","sources":["../src/mdns-ws.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAGrD,OAAO,EAAE,WAAW,EAAe,MAAM,SAAS,CAAA;AAElD,UAAU,aAAa;IACrB,GAAG,EAAE;QACH,MAAM,EAAE;YACN,mBAAmB,IAAI,MAAM,CAAA;YAC7B,eAAe,IAAI,MAAM,CAAA;SAC1B,CAAA;QACD,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;QAChD,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KAChD,CAAA;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAOD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,SAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAC3D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,aAAa,CAAC,CAAQ;IAC9B,OAAO,CAAC,gBAAgB,CAAoB;gBAEhC,OAAO,EAAE,aAAa;IAuDlC,OAAO,CAAC,aAAa;IA6FrB,OAAO,CAAC,iBAAiB;IA0BzB,UAAU,CACR,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,cAAc,EACxB,IAAI,EAAE,iBAAiB,GACtB,IAAI;CAGR"}
+{"version":3,"file":"mdns-ws.d.ts","sourceRoot":"","sources":["../src/mdns-ws.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAKrD,OAAO,EAAE,WAAW,EAAe,MAAM,SAAS,CAAA;AAElD,UAAU,aAAa;IACrB,GAAG,EAAE;QACH,MAAM,EAAE;YACN,mBAAmB,IAAI,MAAM,CAAA;YAC7B,eAAe,IAAI,MAAM,CAAA;SAC1B,CAAA;QACD,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;QAChD,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KAChD,CAAA;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAOD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,SAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAC3D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,aAAa,CAAC,CAAQ;IAC9B,OAAO,CAAC,gBAAgB,CAAoB;gBAEhC,OAAO,EAAE,aAAa;IAuDlC,OAAO,CAAC,iBAAiB;IAyBzB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,aAAa;IAmIrB,OAAO,CAAC,iBAAiB;IA0BzB,UAAU,CACR,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,cAAc,EACxB,IAAI,EAAE,iBAAiB,GACtB,IAAI;CAGR"}

package/dist/mdns-ws.js

@@ -14,8 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const stream_1 = require("stream");
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
 const client_1 = require("@signalk/client");
 const signalk_schema_1 = require("@signalk/signalk-schema");
 class MdnsWs extends stream_1.Transform {
@@ -76,6 +81,38 @@ class MdnsWs extends stream_1.Transform {
             this.options.app.setProviderError(this.options.providerId, 'This connection is deprecated and must be deleted');
         }
     }
+    verifyRemoteToken() {
+        const protocol = this.options.type === 'wss' ? https_1.default : http_1.default;
+        return new Promise((resolve, reject) => {
+            const reqOptions = {
+                hostname: this.options.host,
+                port: this.options.port,
+                path: '/signalk/v1/api/self',
+                method: 'GET',
+                headers: {
+                    Authorization: `JWT ${this.options.token}`
+                },
+                rejectUnauthorized: !(this.options.selfsignedcert === true)
+            };
+            const req = protocol.request(reqOptions, (response) => {
+                response.resume();
+                resolve(response.statusCode === 200);
+            });
+            req.on('error', (err) => reject(err));
+            req.setTimeout(10000, () => {
+                req.destroy(new Error('Token verification timed out'));
+            });
+            req.end();
+        });
+    }
+    setProviderStatus(message, isError) {
+        if (!isError) {
+            this.options.app.setProviderStatus(this.options.providerId, message);
+        }
+        else {
+            this.options.app.setProviderError(this.options.providerId, message);
+        }
+    }
     connectClient(client) {
         this.fetchedMetaPaths.clear();
         client
@@ -83,7 +120,25 @@ class MdnsWs extends stream_1.Transform {
             .then(() => {
             this.options.app.setProviderStatus(this.options.providerId, `ws connection connected to ${client.options.hostname}:${client.options.port}`);
             console.log(`ws connection connected to ${client.options.hostname}:${client.options.port}`);
-            if (this.options.selfHandling === 'useRemoteSelf') {
+            if (this.options.token) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const conn = client.connection;
+                conn.send(JSON.stringify({ token: this.options.token }));
+                conn.setAuthenticated(this.options.token, 'JWT');
+                this.debug('Sent authentication token to remote server');
+                this.verifyRemoteToken()
+                    .then((isValid) => {
+                    if (!isValid) {
+                        this.setProviderStatus(`Authentication failed for ${client.options.hostname}:${client.options.port} — token may be invalid or revoked`, true);
+                        conn.disconnect();
+                    }
+                })
+                    .catch((err) => {
+                    this.debug('Token verification error: ' + err.message);
+                });
+            }
+            if (this.options.selfHandling !== 'manualSelf' &&
+                this.options.selfHandling !== 'noSelf') {
                 client
                     .API()
                     .then((api) => api.get('/self'))
@@ -152,6 +207,15 @@ class MdnsWs extends stream_1.Transform {
                 }
             }
         });
+        client.on('disconnect', () => {
+            const hint = this.options.token
+                ? ' — check that the token is valid on the remote server'
+                : ' — the remote server may require authentication';
+            this.setProviderStatus(`Disconnected from ${client.options.hostname}:${client.options.port}${hint}`, true);
+        });
+        client.on('error', (err) => {
+            this.setProviderStatus(`Connection error: ${err.message}`, true);
+        });
     }
     fetchMetaIfNeeded(client, context, path) {
         if ((0, signalk_schema_1.getMetadata)('vessels.self.' + path)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/streams",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Utilities for handling streams of Signal K data",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",