node-opcua-packet-analyzer 2.51.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2021 Etienne Rossignon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/source/index.d.ts

@@ -0,0 +1 @@
+export { analyzePacket, analyseExtensionObject, analyze_object_binary_encoding } from "./packet_analyzer/packet_analyzer";

package/dist/source/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyze_object_binary_encoding = exports.analyseExtensionObject = exports.analyzePacket = void 0;
+var packet_analyzer_1 = require("./packet_analyzer/packet_analyzer");
+Object.defineProperty(exports, "analyzePacket", { enumerable: true, get: function () { return packet_analyzer_1.analyzePacket; } });
+Object.defineProperty(exports, "analyseExtensionObject", { enumerable: true, get: function () { return packet_analyzer_1.analyseExtensionObject; } });
+Object.defineProperty(exports, "analyze_object_binary_encoding", { enumerable: true, get: function () { return packet_analyzer_1.analyze_object_binary_encoding; } });
+//# sourceMappingURL=index.js.map

package/dist/source/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/index.ts"],"names":[],"mappings":";;;AAAA,qEAI2C;AAHvC,gHAAA,aAAa,OAAA;AACb,yHAAA,sBAAsB,OAAA;AACtB,iIAAA,8BAA8B,OAAA"}

package/dist/source/packet_analyzer/packet_analyzer.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { BaseUAObject } from "node-opcua-factory";
+interface AnalyzePacketOptions {
+}
+export declare function analyzePacket(buffer: Buffer, objMessage: any, padding: number, offset?: number, customOptions?: AnalyzePacketOptions): void;
+export declare function analyseExtensionObject(buffer: Buffer, padding: number, offset: number, customOptions?: AnalyzePacketOptions): void;
+export declare function analyze_object_binary_encoding(obj: BaseUAObject): void;
+export {};

package/dist/source/packet_analyzer/packet_analyzer.js

@@ -0,0 +1,192 @@
+"use strict";
+// tslint:disable:no-bitwise
+// tslint:disable:no-console
+// tslint:disable:max-line-length
+// tslint:disable:no-empty-interface
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyze_object_binary_encoding = exports.analyseExtensionObject = exports.analyzePacket = void 0;
+const chalk = require("chalk");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const util_1 = require("util");
+const node_opcua_basic_types_1 = require("node-opcua-basic-types");
+const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_factory_1 = require("node-opcua-factory");
+const node_opcua_utils_1 = require("node-opcua-utils");
+const spaces = "                                                                                                                                                                             ";
+function f(n, width) {
+    const s = n.toString();
+    return (s + "      ").substr(0, Math.max(s.length, width));
+}
+function display_encoding_mask(padding, encodingMask, encodingInfo) {
+    for (const v in encodingInfo) {
+        if (!encodingInfo.hasOwnProperty(v)) {
+            continue;
+        }
+        const enumKey = encodingInfo[v];
+        if (typeof enumKey === "number") {
+            continue;
+        }
+        const mask = encodingInfo[enumKey];
+        const bit = Math.log(mask) / Math.log(2);
+        const bits = [".", ".", ".", ".", ".", ".", ".", ".", "."];
+        bits[bit] = (encodingMask & mask) === mask ? "Y" : "n";
+        console.log(padding + " ", bits.join(""), " <- has " + enumKey + " 0x" + mask.toString(16));
+    }
+    // DataValueEncodingByte
+}
+function hex_block(start, end, buffer) {
+    const n = end - start;
+    const strBuf = (0, node_opcua_utils_1.buffer_ellipsis)(buffer);
+    return (chalk.cyan("s:") + f(start, 4) + chalk.cyan(" e:") + f(end, 4) + chalk.cyan(" n:") + f(n, 4) + " " + chalk.yellow(strBuf));
+}
+function make_tracer(buffer, padding, offset) {
+    padding = !padding ? 0 : padding;
+    offset = offset || 0;
+    const pad = () => "                                                       ".substr(0, padding);
+    function _display(str, hexInfo) {
+        hexInfo = hexInfo || "";
+        // account for ESC codes for colors
+        const nbColorAttributes = [...str.split("")].filter((c) => c === "\u001b").length;
+        const extra = nbColorAttributes * 5;
+        console.log((pad() + str + spaces).substr(0, 132 + extra) + "|" + hexInfo);
+    }
+    function display(str, hexInfo) {
+        const lines = str.split("\n");
+        for (const line of lines) {
+            _display(line, hexInfo);
+        }
+    }
+    function display_encodeable(value, buffer1, start, end) {
+        const bufferExtract = buffer1.slice(start, end);
+        const stream = new node_opcua_binary_stream_1.BinaryStream(bufferExtract);
+        const nodeId = (0, node_opcua_basic_types_1.decodeNodeId)(stream);
+        const encodingMask = (0, node_opcua_basic_types_1.decodeByte)(stream); // 1 bin 2: xml
+        const length = (0, node_opcua_basic_types_1.decodeUInt32)(stream);
+        display(chalk.green("     ExpandedNodId =") + " " + nodeId);
+        display(chalk.green("     encoding mask =") + " " + encodingMask);
+        display(chalk.green("            length =") + " " + length);
+        analyzePacket(bufferExtract.slice(stream.length), value.encodingDefaultBinary, padding + 2, start + stream.length);
+    }
+    return {
+        tracer: {
+            dump: (title, value) => display(title + "  " + chalk.green(value.toString())),
+            encoding_byte: (encodingMask, valueEnum, start, end) => {
+                (0, node_opcua_assert_1.assert)(valueEnum);
+                const b = buffer.slice(start, end);
+                display("  012345678", hex_block(start, end, b));
+                display_encoding_mask(pad(), encodingMask, valueEnum);
+            },
+            trace: (operation, name, value, start, end, fieldType) => {
+                const b = buffer.slice(start, end);
+                let _hexDump = "";
+                switch (operation) {
+                    case "start":
+                        padding += 2;
+                        display(name.toString());
+                        break;
+                    case "end":
+                        padding -= 2;
+                        break;
+                    case "start_array":
+                        display("." + name + " (length = " + value + ") " + "[", hex_block(start, end, b));
+                        padding += 2;
+                        break;
+                    case "end_array":
+                        padding -= 2;
+                        display("] // " + name);
+                        break;
+                    case "start_element":
+                        display(" #" + value + " {");
+                        padding += 2;
+                        break;
+                    case "end_element":
+                        padding -= 2;
+                        display(" } // # " + value);
+                        break;
+                    case "member":
+                        display("." + name + " : " + fieldType);
+                        _hexDump = "";
+                        if (value instanceof Buffer) {
+                            _hexDump = (0, node_opcua_debug_1.hexDump)(value);
+                            console.log(_hexDump);
+                            value = "<BUFFER>";
+                        }
+                        if (value && value.encode) {
+                            if (fieldType === "ExtensionObject") {
+                                display_encodeable(value, buffer, start, end);
+                            }
+                            else {
+                                const str = value.toString() || "<empty>";
+                                display(str);
+                            }
+                        }
+                        else {
+                            display(" " + value, hex_block(start, end, b));
+                        }
+                        break;
+                }
+            }
+        }
+    };
+}
+function analyzePacket(buffer, objMessage, padding, offset, customOptions) {
+    const stream = new node_opcua_binary_stream_1.BinaryStream(buffer);
+    _internalAnalyzePacket(buffer, stream, objMessage, padding, customOptions, offset);
+}
+exports.analyzePacket = analyzePacket;
+function analyseExtensionObject(buffer, padding, offset, customOptions) {
+    const stream = new node_opcua_binary_stream_1.BinaryStream(buffer);
+    let id;
+    let objMessage;
+    try {
+        id = (0, node_opcua_basic_types_1.decodeExpandedNodeId)(stream);
+        objMessage = (0, node_opcua_factory_1.constructObject)(id);
+    }
+    catch (err) {
+        console.log(id);
+        console.log(err);
+        console.log("Cannot read decodeExpandedNodeId  on stream " + stream.buffer.toString("hex"));
+    }
+    _internalAnalyzePacket(buffer, stream, objMessage, padding, customOptions, offset);
+}
+exports.analyseExtensionObject = analyseExtensionObject;
+function _internalAnalyzePacket(buffer, stream, objMessage, padding, customOptions, offset) {
+    let options = make_tracer(buffer, padding, offset);
+    options.name = "message";
+    if (customOptions)
+        options = Object.assign(Object.assign({}, options), customOptions);
+    try {
+        if (objMessage) {
+            objMessage.decodeDebug(stream, options);
+        }
+        else {
+            console.log(" Invalid object", objMessage);
+        }
+    }
+    catch (err) {
+        console.log(" Error in ", err);
+        if (err instanceof Error) {
+            console.log(" Error in ", err.stack);
+        }
+        console.log(" objMessage ", (0, util_1.inspect)(objMessage, { colors: true }));
+    }
+}
+function analyze_object_binary_encoding(obj) {
+    (0, node_opcua_assert_1.assert)(obj);
+    const size = obj.binaryStoreSize();
+    console.log("-------------------------------------------------");
+    console.log(" size = ", size);
+    const stream = new node_opcua_binary_stream_1.BinaryStream(size);
+    obj.encode(stream);
+    stream.rewind();
+    console.log("-------------------------------------------------");
+    if (stream.buffer.length < 256) {
+        console.log((0, node_opcua_debug_1.hexDump)(stream.buffer));
+        console.log("-------------------------------------------------");
+    }
+    const reloadedObject = new obj.constructor();
+    analyzePacket(stream.buffer, reloadedObject, 0);
+}
+exports.analyze_object_binary_encoding = analyze_object_binary_encoding;
+//# sourceMappingURL=packet_analyzer.js.map

package/dist/source/packet_analyzer/packet_analyzer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packet_analyzer.js","sourceRoot":"","sources":["../../../source/packet_analyzer/packet_analyzer.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,4BAA4B;AAC5B,iCAAiC;AACjC,oCAAoC;;;AAEpC,+BAA+B;AAC/B,yDAA2C;AAC3C,+BAA+B;AAE/B,mEAAsG;AACtG,uEAAwD;AACxD,uDAA2C;AAC3C,2DAAmE;AACnE,uDAAmD;AAEnD,MAAM,MAAM,GACR,+KAA+K,CAAC;AAEpL,SAAS,CAAC,CAAC,CAAS,EAAE,KAAa;IAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;IACvB,OAAO,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe,EAAE,YAAiB,EAAE,YAAiB;IAChF,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE;QAC1B,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;YACjC,SAAS;SACZ;QACD,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC7B,SAAS;SACZ;QAED,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAEzC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC3D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAEvD,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;KAC/F;IACD,wBAAwB;AAC5B,CAAC;AAED,SAAS,SAAS,CAAC,KAAa,EAAE,GAAW,EAAE,MAAc;IACzD,MAAM,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;IACtB,MAAM,MAAM,GAAG,IAAA,kCAAe,EAAC,MAAM,CAAC,CAAC;IACvC,OAAO,CACH,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAC5H,CAAC;AACN,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,OAAe,EAAE,MAAe;IACjE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACjC,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC;IAErB,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,yDAAyD,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAE/F,SAAS,QAAQ,CAAC,GAAW,EAAE,OAAgB;QAC3C,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,mCAAmC;QACnC,MAAM,iBAAiB,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,MAAM,CAAC;QAClF,MAAM,KAAK,GAAG,iBAAiB,GAAG,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC,CAAC;IAC/E,CAAC;IACD,SAAS,OAAO,CAAC,GAAW,EAAE,OAAgB;QAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC3B;IACL,CAAC;IAED,SAAS,kBAAkB,CAAC,KAAU,EAAE,OAAe,EAAE,KAAa,EAAE,GAAW;QAC/E,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAA,qCAAY,EAAC,MAAM,CAAC,CAAC;QACpC,MAAM,YAAY,GAAG,IAAA,mCAAU,EAAC,MAAM,CAAC,CAAC,CAAC,eAAe;QACxD,MAAM,MAAM,GAAG,IAAA,qCAAY,EAAC,MAAM,CAAC,CAAC;QAEpC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;QAC5D,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAG,GAAG,GAAG,YAAY,CAAC,CAAC;QAClE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;QAC5D,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,qBAAqB,EAAE,OAAO,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACvH,CAAC;IAED,OAAO;QACH,MAAM,EAAE;YACJ,IAAI,EAAE,CAAC,KAAa,EAAE,KAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE1F,aAAa,EAAE,CAAC,YAAiB,EAAE,SAAc,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;gBAC7E,IAAA,0BAAM,EAAC,SAAS,CAAC,CAAC;gBAClB,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACnC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACjD,qBAAqB,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;YAC1D,CAAC;YAED,KAAK,EAAE,CAAC,SAAc,EAAE,IAAS,EAAE,KAAU,EAAE,KAAa,EAAE,GAAW,EAAE,SAAiB,EAAE,EAAE;gBAC5F,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACnC,IAAI,QAAQ,GAAG,EAAE,CAAC;gBAElB,QAAQ,SAAS,EAAE;oBACf,KAAK,OAAO;wBACR,OAAO,IAAI,CAAC,CAAC;wBACb,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACzB,MAAM;oBAEV,KAAK,KAAK;wBACN,OAAO,IAAI,CAAC,CAAC;wBACb,MAAM;oBAEV,KAAK,aAAa;wBACd,OAAO,CAAC,GAAG,GAAG,IAAI,GAAG,aAAa,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;wBACnF,OAAO,IAAI,CAAC,CAAC;wBACb,MAAM;oBAEV,KAAK,WAAW;wBACZ,OAAO,IAAI,CAAC,CAAC;wBACb,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;wBACxB,MAAM;oBAEV,KAAK,eAAe;wBAChB,OAAO,CAAC,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC;wBAC7B,OAAO,IAAI,CAAC,CAAC;wBACb,MAAM;oBAEV,KAAK,aAAa;wBACd,OAAO,IAAI,CAAC,CAAC;wBACb,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,CAAC;wBAC5B,MAAM;oBAEV,KAAK,QAAQ;wBACT,OAAO,CAAC,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,SAAS,CAAC,CAAC;wBAExC,QAAQ,GAAG,EAAE,CAAC;wBACd,IAAI,KAAK,YAAY,MAAM,EAAE;4BACzB,QAAQ,GAAG,IAAA,0BAAO,EAAC,KAAK,CAAC,CAAC;4BAC1B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;4BACtB,KAAK,GAAG,UAAU,CAAC;yBACtB;wBAED,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE;4BACvB,IAAI,SAAS,KAAK,iBAAiB,EAAE;gCACjC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;6BACjD;iCAAM;gCACH,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,SAAS,CAAC;gCAC1C,OAAO,CAAC,GAAG,CAAC,CAAC;6BAChB;yBACJ;6BAAM;4BACH,OAAO,CAAC,GAAG,GAAG,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;yBAClD;wBACD,MAAM;iBACb;YACL,CAAC;SACJ;KACJ,CAAC;AACN,CAAC;AAID,SAAgB,aAAa,CACzB,MAAc,EACd,UAAe,EACf,OAAe,EACf,MAAe,EACf,aAAoC;IAEpC,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,MAAM,CAAC,CAAC;IACxC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AACvF,CAAC;AATD,sCASC;AAED,SAAgB,sBAAsB,CAAC,MAAc,EAAE,OAAe,EAAE,MAAc,EAAE,aAAoC;IACxH,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,EAAE,CAAC;IACP,IAAI,UAAU,CAAC;IACf,IAAI;QACA,EAAE,GAAG,IAAA,6CAAoB,EAAC,MAAM,CAAC,CAAC;QAClC,UAAU,GAAG,IAAA,oCAAe,EAAC,EAAE,CAAC,CAAC;KACpC;IAAC,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,CAAC,GAAG,CAAC,8CAA8C,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;KAC/F;IACD,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AACvF,CAAC;AAbD,wDAaC;AAED,SAAS,sBAAsB,CAC3B,MAAc,EACd,MAAoB,EACpB,UAAe,EACf,OAAe,EACf,aAAoC,EACpC,MAAe;IAEf,IAAI,OAAO,GAAQ,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACxD,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IACzB,IAAI,aAAa;QAAE,OAAO,mCAAQ,OAAO,GAAK,aAAa,CAAE,CAAC;IAC9D,IAAI;QACA,IAAI,UAAU,EAAE;YACZ,UAAU,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SAC3C;aAAM;YACH,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;SAC9C;KACJ;IAAC,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAC/B,IAAI,GAAG,YAAY,KAAK,EAAE;YACtB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;SACxC;QACD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAA,cAAO,EAAC,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;KACtE;AACL,CAAC;AAED,SAAgB,8BAA8B,CAAC,GAAiB;IAC5D,IAAA,0BAAM,EAAC,GAAG,CAAC,CAAC;IAEZ,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,EAAE,CAAC;IACnC,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;IACjE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,IAAI,CAAC,CAAC;IACtC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEnB,MAAM,CAAC,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;IACjE,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;QAC5B,OAAO,CAAC,GAAG,CAAC,IAAA,0BAAO,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;KACpE;IAED,MAAM,cAAc,GAAG,IAAK,GAAG,CAAC,WAAmB,EAAE,CAAC;IACtD,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAlBD,wEAkBC"}

package/dist/test_helpers/compare_obj_by_encoding.d.ts

@@ -0,0 +1,2 @@
+import { BaseUAObject } from "node-opcua-factory";
+export declare function compare_obj_by_encoding(obj1: BaseUAObject, obj2: BaseUAObject): boolean;

package/dist/test_helpers/compare_obj_by_encoding.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compare_obj_by_encoding = void 0;
+const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
+const should = require("should");
+const persist = should;
+function compare_obj_by_encoding(obj1, obj2) {
+    function encoded(obj) {
+        const stream = new node_opcua_binary_stream_1.BinaryStream(obj.binaryStoreSize());
+        obj.encode(stream);
+        return stream.buffer.toString("hex");
+    }
+    encoded(obj1).should.eql(encoded(obj2));
+    return true;
+}
+exports.compare_obj_by_encoding = compare_obj_by_encoding;
+//# sourceMappingURL=compare_obj_by_encoding.js.map

package/dist/test_helpers/compare_obj_by_encoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare_obj_by_encoding.js","sourceRoot":"","sources":["../../test_helpers/compare_obj_by_encoding.ts"],"names":[],"mappings":";;;AAAA,uEAAwD;AAExD,iCAAiC;AACjC,MAAM,OAAO,GAAG,MAAM,CAAC;AAEvB,SAAgB,uBAAuB,CAAC,IAAkB,EAAE,IAAkB;IAE1E,SAAS,OAAO,CAAC,GAAiB;QAC9B,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC;QACvD,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC;AAChB,CAAC;AATD,0DASC"}

package/dist/test_helpers/encode_decode_round_trip_test.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+declare type encode_decode_round_trip_testCallback = (buffer: Buffer, encoding: any, options: any) => void;
+/**
+ * @method encode_decode_round_trip_test
+ * @param obj  : object to test ( the object must provide a binaryStoreSize,encode,decode method
+ * @param [options]
+ * @param callback_buffer
+ * @return {*}
+ */
+export declare function encode_decode_round_trip_test(obj: any, options?: any, callback_buffer?: encode_decode_round_trip_testCallback): any;
+export declare function json_encode_decode_round_trip_test(obj: any, options: any, callbackBuffer?: any): any;
+export {};

package/dist/test_helpers/encode_decode_round_trip_test.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.json_encode_decode_round_trip_test = exports.encode_decode_round_trip_test = void 0;
+// @ts-check
+const chalk = require("chalk");
+const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_factory_1 = require("node-opcua-factory");
+const node_opcua_test_helpers_1 = require("node-opcua-test-helpers");
+const should = require("should");
+const source_1 = require("../source");
+// tslint:disable:no-console
+function dump_block_in_debug_mode(buffer, id, options) {
+    if (process.env.DEBUG) {
+        console.log((0, node_opcua_debug_1.hexDump)(buffer));
+        (0, source_1.analyzePacket)(buffer, id, 0, 0, options);
+    }
+}
+function isTypedArray(v) {
+    if (v && v.buffer && v.buffer instanceof ArrayBuffer) {
+        return true;
+    }
+    return false;
+}
+function isArrayOrTypedArray(v) {
+    return isTypedArray(v) || v instanceof Array;
+}
+function compare(objReloaded, obj) {
+    function displayError(p, expected, actual) {
+        console.log(chalk.yellow(" ---------------------------------- error in encode_decode_round_trip_test"));
+        console.log(chalk.red(" key "), p);
+        console.log(chalk.red(" expected "), JSON.stringify(expected));
+        console.log(chalk.cyan(" actual   "), JSON.stringify(actual));
+    }
+    Object.keys(objReloaded).forEach((p) => {
+        try {
+            if (isArrayOrTypedArray(obj[p])) {
+                (0, node_opcua_test_helpers_1.assert_arrays_are_equal)(objReloaded[p], obj[p]);
+            }
+            else {
+                if (objReloaded[p] === undefined || obj[p] === undefined) {
+                    return;
+                }
+                JSON.stringify(objReloaded[p]).should.eql(JSON.stringify(obj[p]));
+            }
+        }
+        catch (err) {
+            displayError(p, obj[p], objReloaded[p]);
+            console.log(obj.toString());
+            console.log(objReloaded.toString());
+            // re throw exception
+            throw err;
+        }
+    });
+}
+function redirectToNull(functor) {
+    const old = console.log;
+    if (!process.env.DEBUG) {
+        // tslint:disable:no-empty
+        console.log = (...args) => { };
+    }
+    try {
+        functor();
+    }
+    catch (err) {
+        throw err;
+    }
+    finally {
+        console.log = old;
+    }
+}
+/**
+ * @method encode_decode_round_trip_test
+ * @param obj  : object to test ( the object must provide a binaryStoreSize,encode,decode method
+ * @param [options]
+ * @param callback_buffer
+ * @return {*}
+ */
+function encode_decode_round_trip_test(obj, options, callback_buffer) {
+    if (!callback_buffer && typeof options === "function") {
+        callback_buffer = options;
+        options = {};
+    }
+    callback_buffer = callback_buffer || dump_block_in_debug_mode;
+    should.exist(obj);
+    const size = obj.binaryStoreSize(options);
+    const stream = new node_opcua_binary_stream_1.BinaryStream(Buffer.alloc(size));
+    obj.encode(stream, options);
+    callback_buffer(stream.buffer, obj.encodingDefaultBinary, options);
+    stream.rewind();
+    // reconstruct a object ( some object may not have a default Binary and should be recreated
+    const expandedNodeId = obj.encodingDefaultBinary;
+    const objReloaded = expandedNodeId ? (0, node_opcua_factory_1.constructObject)(expandedNodeId) : new obj.constructor();
+    objReloaded.decode(stream, options);
+    redirectToNull(() => (0, source_1.analyze_object_binary_encoding)(obj));
+    compare(objReloaded, obj);
+    return objReloaded;
+}
+exports.encode_decode_round_trip_test = encode_decode_round_trip_test;
+function json_encode_decode_round_trip_test(obj, options, callbackBuffer) {
+    if (!callbackBuffer && typeof options === "function") {
+        callbackBuffer = options;
+        options = {};
+    }
+    callbackBuffer = callbackBuffer || dump_block_in_debug_mode;
+    should.exist(obj);
+    const json = JSON.stringify(obj);
+    const objReloaded = JSON.parse(json);
+    compare(objReloaded, obj);
+    return objReloaded;
+}
+exports.json_encode_decode_round_trip_test = json_encode_decode_round_trip_test;
+//# sourceMappingURL=encode_decode_round_trip_test.js.map

package/dist/test_helpers/encode_decode_round_trip_test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode_decode_round_trip_test.js","sourceRoot":"","sources":["../../test_helpers/encode_decode_round_trip_test.ts"],"names":[],"mappings":";;;AAAA,YAAY;AACZ,+BAA+B;AAC/B,uEAAwD;AACxD,uDAA2C;AAC3C,2DAAmE;AACnE,qEAAkE;AAClE,iCAAiC;AAEjC,sCAA0E;AAC1E,4BAA4B;AAE5B,SAAS,wBAAwB,CAAC,MAAc,EAAE,EAAO,EAAE,OAAY;IACnE,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE;QACnB,OAAO,CAAC,GAAG,CAAC,IAAA,0BAAO,EAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,IAAA,sBAAa,EAAC,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;KAC5C;AACL,CAAC;AAED,SAAS,YAAY,CAAC,CAAM;IACxB,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,YAAY,WAAW,EAAE;QAClD,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAM;IAC/B,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC;AACjD,CAAC;AAED,SAAS,OAAO,CAAC,WAAgB,EAAE,GAAQ;IACvC,SAAS,YAAY,CAAC,CAAS,EAAE,QAAa,EAAE,MAAW;QACvD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,4EAA4E,CAAC,CAAC,CAAC;QACxG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAM,EAAE,EAAE;QACxC,IAAI;YACA,IAAI,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC7B,IAAA,iDAAuB,EAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;iBAAM;gBACH,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;oBACtD,OAAO;iBACV;gBACA,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAS,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC9E;SACJ;QAAC,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YACpC,qBAAqB;YACrB,MAAM,GAAG,CAAC;SACb;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,cAAc,CAAC,OAAmB;IACvC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE;QACpB,0BAA0B;QAC1B,OAAO,CAAC,GAAG,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,GAAE,CAAC,CAAC;KACxC;IAED,IAAI;QACA,OAAO,EAAE,CAAC;KACb;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,CAAC;KACb;YAAS;QACN,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;KACrB;AACL,CAAC;AAID;;;;;;GAMG;AACH,SAAgB,6BAA6B,CACzC,GAAQ,EACR,OAAa,EACb,eAAuD;IAEvD,IAAI,CAAC,eAAe,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QACnD,eAAe,GAAG,OAAO,CAAC;QAC1B,OAAO,GAAG,EAAE,CAAC;KAChB;IAED,eAAe,GAAG,eAAe,IAAI,wBAAwB,CAAC;IAE9D,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElB,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAE1C,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpD,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5B,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAEnE,MAAM,CAAC,MAAM,EAAE,CAAC;IAEhB,2FAA2F;IAC3F,MAAM,cAAc,GAAG,GAAG,CAAC,qBAAqB,CAAC;IACjD,MAAM,WAAW,GAAG,cAAc,CAAC,CAAC,CAAC,IAAA,oCAAe,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;IAE7F,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC,cAAc,CAAC,GAAG,EAAE,CAAC,IAAA,uCAA8B,EAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAC1B,OAAO,WAAW,CAAC;AACvB,CAAC;AAjCD,sEAiCC;AAED,SAAgB,kCAAkC,CAAC,GAAQ,EAAE,OAAY,EAAE,cAAoB;IAC3F,IAAI,CAAC,cAAc,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QAClD,cAAc,GAAG,OAAO,CAAC;QACzB,OAAO,GAAG,EAAE,CAAC;KAChB;IACD,cAAc,GAAG,cAAc,IAAI,wBAAwB,CAAC;IAE5D,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAEjC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAErC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAE1B,OAAO,WAAW,CAAC;AACvB,CAAC;AAhBD,gFAgBC"}

package/dist/test_helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./compare_obj_by_encoding";
+export * from "./encode_decode_round_trip_test";

package/dist/test_helpers/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./compare_obj_by_encoding"), exports);
+__exportStar(require("./encode_decode_round_trip_test"), exports);
+//# sourceMappingURL=index.js.map

package/dist/test_helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../test_helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAA0C;AAC1C,kEAAgD"}

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "node-opcua-packet-analyzer",
+    "version": "2.51.0",
+    "description": "pure nodejs OPCUA SDK - module -packet-analyzer",
+    "main": "./dist/source/index.js",
+    "types": "./dist/source/index.d.ts",
+    "scripts": {
+        "build": "tsc -b",
+        "clean": "node -e \"require('rimraf').sync('dist');\"",
+        "test": "echo no test"
+    },
+    "author": "Etienne Rossignon",
+    "license": "MIT",
+    "dependencies": {
+        "chalk": "4.1.2",
+        "node-opcua-assert": "2.51.0",
+        "node-opcua-basic-types": "2.51.0",
+        "node-opcua-binary-stream": "2.51.0",
+        "node-opcua-debug": "2.51.0",
+        "node-opcua-factory": "2.51.0",
+        "node-opcua-utils": "2.51.0"
+    },
+    "devDependencies": {
+        "node-opcua-test-helpers": "2.42.0",
+        "should": "^13.2.3"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/node-opcua/node-opcua.git"
+    },
+    "keywords": [
+        "OPCUA",
+        "opcua",
+        "m2m",
+        "iot",
+        "opc ua",
+        "internet of things"
+    ],
+    "homepage": "http://node-opcua.github.io/",
+    "gitHead": "75feb111daf7ec65fa0111e4fa5beb8987fd4945"
+}

package/source/index.ts

@@ -0,0 +1,5 @@
+export {
+    analyzePacket,
+    analyseExtensionObject,
+    analyze_object_binary_encoding
+} from "./packet_analyzer/packet_analyzer";

package/source/packet_analyzer/packet_analyzer.ts

@@ -0,0 +1,230 @@
+// tslint:disable:no-bitwise
+// tslint:disable:no-console
+// tslint:disable:max-line-length
+// tslint:disable:no-empty-interface
+
+import * as chalk from "chalk";
+import { assert } from "node-opcua-assert";
+import { inspect } from "util";
+
+import { decodeByte, decodeExpandedNodeId, decodeNodeId, decodeUInt32 } from "node-opcua-basic-types";
+import { BinaryStream } from "node-opcua-binary-stream";
+import { hexDump } from "node-opcua-debug";
+import { BaseUAObject, constructObject } from "node-opcua-factory";
+import { buffer_ellipsis } from "node-opcua-utils";
+
+const spaces =
+    "                                                                                                                                                                             ";
+
+function f(n: number, width: number): string {
+    const s = n.toString();
+    return (s + "      ").substr(0, Math.max(s.length, width));
+}
+
+function display_encoding_mask(padding: string, encodingMask: any, encodingInfo: any) {
+    for (const v in encodingInfo) {
+        if (!encodingInfo.hasOwnProperty(v)) {
+            continue;
+        }
+        const enumKey = encodingInfo[v];
+        if (typeof enumKey === "number") {
+            continue;
+        }
+
+        const mask = encodingInfo[enumKey];
+        const bit = Math.log(mask) / Math.log(2);
+
+        const bits = [".", ".", ".", ".", ".", ".", ".", ".", "."];
+        bits[bit] = (encodingMask & mask) === mask ? "Y" : "n";
+
+        console.log(padding + " ", bits.join(""), " <- has " + enumKey + " 0x" + mask.toString(16));
+    }
+    // DataValueEncodingByte
+}
+
+function hex_block(start: number, end: number, buffer: Buffer) {
+    const n = end - start;
+    const strBuf = buffer_ellipsis(buffer);
+    return (
+        chalk.cyan("s:") + f(start, 4) + chalk.cyan(" e:") + f(end, 4) + chalk.cyan(" n:") + f(n, 4) + " " + chalk.yellow(strBuf)
+    );
+}
+
+function make_tracer(buffer: Buffer, padding: number, offset?: number) {
+    padding = !padding ? 0 : padding;
+    offset = offset || 0;
+
+    const pad = () => "                                                       ".substr(0, padding);
+
+    function _display(str: string, hexInfo?: string) {
+        hexInfo = hexInfo || "";
+        // account for ESC codes for colors
+        const nbColorAttributes = [...str.split("")].filter((c) => c === "\u001b").length;
+        const extra = nbColorAttributes * 5;
+        console.log((pad() + str + spaces).substr(0, 132 + extra) + "|" + hexInfo);
+    }
+    function display(str: string, hexInfo?: string) {
+        const lines = str.split("\n");
+        for (const line of lines) {
+            _display(line, hexInfo);
+        }
+    }
+
+    function display_encodeable(value: any, buffer1: Buffer, start: number, end: number) {
+        const bufferExtract = buffer1.slice(start, end);
+        const stream = new BinaryStream(bufferExtract);
+        const nodeId = decodeNodeId(stream);
+        const encodingMask = decodeByte(stream); // 1 bin 2: xml
+        const length = decodeUInt32(stream);
+
+        display(chalk.green("     ExpandedNodId =") + " " + nodeId);
+        display(chalk.green("     encoding mask =") + " " + encodingMask);
+        display(chalk.green("            length =") + " " + length);
+        analyzePacket(bufferExtract.slice(stream.length), value.encodingDefaultBinary, padding + 2, start + stream.length);
+    }
+
+    return {
+        tracer: {
+            dump: (title: string, value: any) => display(title + "  " + chalk.green(value.toString())),
+
+            encoding_byte: (encodingMask: any, valueEnum: any, start: number, end: number) => {
+                assert(valueEnum);
+                const b = buffer.slice(start, end);
+                display("  012345678", hex_block(start, end, b));
+                display_encoding_mask(pad(), encodingMask, valueEnum);
+            },
+
+            trace: (operation: any, name: any, value: any, start: number, end: number, fieldType: string) => {
+                const b = buffer.slice(start, end);
+                let _hexDump = "";
+
+                switch (operation) {
+                    case "start":
+                        padding += 2;
+                        display(name.toString());
+                        break;
+
+                    case "end":
+                        padding -= 2;
+                        break;
+
+                    case "start_array":
+                        display("." + name + " (length = " + value + ") " + "[", hex_block(start, end, b));
+                        padding += 2;
+                        break;
+
+                    case "end_array":
+                        padding -= 2;
+                        display("] // " + name);
+                        break;
+
+                    case "start_element":
+                        display(" #" + value + " {");
+                        padding += 2;
+                        break;
+
+                    case "end_element":
+                        padding -= 2;
+                        display(" } // # " + value);
+                        break;
+
+                    case "member":
+                        display("." + name + " : " + fieldType);
+
+                        _hexDump = "";
+                        if (value instanceof Buffer) {
+                            _hexDump = hexDump(value);
+                            console.log(_hexDump);
+                            value = "<BUFFER>";
+                        }
+
+                        if (value && value.encode) {
+                            if (fieldType === "ExtensionObject") {
+                                display_encodeable(value, buffer, start, end);
+                            } else {
+                                const str = value.toString() || "<empty>";
+                                display(str);
+                            }
+                        } else {
+                            display(" " + value, hex_block(start, end, b));
+                        }
+                        break;
+                }
+            }
+        }
+    };
+}
+
+interface AnalyzePacketOptions {}
+
+export function analyzePacket(
+    buffer: Buffer,
+    objMessage: any,
+    padding: number,
+    offset?: number,
+    customOptions?: AnalyzePacketOptions
+) {
+    const stream = new BinaryStream(buffer);
+    _internalAnalyzePacket(buffer, stream, objMessage, padding, customOptions, offset);
+}
+
+export function analyseExtensionObject(buffer: Buffer, padding: number, offset: number, customOptions?: AnalyzePacketOptions) {
+    const stream = new BinaryStream(buffer);
+    let id;
+    let objMessage;
+    try {
+        id = decodeExpandedNodeId(stream);
+        objMessage = constructObject(id);
+    } catch (err) {
+        console.log(id);
+        console.log(err);
+        console.log("Cannot read decodeExpandedNodeId  on stream " + stream.buffer.toString("hex"));
+    }
+    _internalAnalyzePacket(buffer, stream, objMessage, padding, customOptions, offset);
+}
+
+function _internalAnalyzePacket(
+    buffer: Buffer,
+    stream: BinaryStream,
+    objMessage: any,
+    padding: number,
+    customOptions?: AnalyzePacketOptions,
+    offset?: number
+) {
+    let options: any = make_tracer(buffer, padding, offset);
+    options.name = "message";
+    if (customOptions) options = { ...options, ...customOptions };
+    try {
+        if (objMessage) {
+            objMessage.decodeDebug(stream, options);
+        } else {
+            console.log(" Invalid object", objMessage);
+        }
+    } catch (err) {
+        console.log(" Error in ", err);
+        if (err instanceof Error) {
+            console.log(" Error in ", err.stack);
+        }
+        console.log(" objMessage ", inspect(objMessage, { colors: true }));
+    }
+}
+
+export function analyze_object_binary_encoding(obj: BaseUAObject) {
+    assert(obj);
+
+    const size = obj.binaryStoreSize();
+    console.log("-------------------------------------------------");
+    console.log(" size = ", size);
+    const stream = new BinaryStream(size);
+    obj.encode(stream);
+
+    stream.rewind();
+    console.log("-------------------------------------------------");
+    if (stream.buffer.length < 256) {
+        console.log(hexDump(stream.buffer));
+        console.log("-------------------------------------------------");
+    }
+
+    const reloadedObject = new (obj.constructor as any)();
+    analyzePacket(stream.buffer, reloadedObject, 0);
+}

package/test_helpers/compare_obj_by_encoding.ts

@@ -0,0 +1,15 @@
+import { BinaryStream } from "node-opcua-binary-stream";
+import { BaseUAObject } from "node-opcua-factory";
+import * as should from "should";
+const persist = should;
+
+export function compare_obj_by_encoding(obj1: BaseUAObject, obj2: BaseUAObject): boolean {
+
+    function encoded(obj: BaseUAObject) {
+        const stream = new BinaryStream(obj.binaryStoreSize());
+        obj.encode(stream);
+        return stream.buffer.toString("hex");
+    }
+    encoded(obj1).should.eql(encoded(obj2));
+    return true;
+}

package/test_helpers/encode_decode_round_trip_test.ts

@@ -0,0 +1,135 @@
+// @ts-check
+import * as chalk from "chalk";
+import { BinaryStream } from "node-opcua-binary-stream";
+import { hexDump } from "node-opcua-debug";
+import { BaseUAObject, constructObject } from "node-opcua-factory";
+import { assert_arrays_are_equal } from "node-opcua-test-helpers";
+import * as should from "should";
+
+import { analyze_object_binary_encoding, analyzePacket } from "../source";
+// tslint:disable:no-console
+
+function dump_block_in_debug_mode(buffer: Buffer, id: any, options: any) {
+    if (process.env.DEBUG) {
+        console.log(hexDump(buffer));
+        analyzePacket(buffer, id, 0, 0, options);
+    }
+}
+
+function isTypedArray(v: any): boolean {
+    if (v && v.buffer && v.buffer instanceof ArrayBuffer) {
+        return true;
+    }
+    return false;
+}
+
+function isArrayOrTypedArray(v: any): boolean {
+    return isTypedArray(v) || v instanceof Array;
+}
+
+function compare(objReloaded: any, obj: any) {
+    function displayError(p: string, expected: any, actual: any) {
+        console.log(chalk.yellow(" ---------------------------------- error in encode_decode_round_trip_test"));
+        console.log(chalk.red(" key "), p);
+        console.log(chalk.red(" expected "), JSON.stringify(expected));
+        console.log(chalk.cyan(" actual   "), JSON.stringify(actual));
+    }
+
+    Object.keys(objReloaded).forEach((p: any) => {
+        try {
+            if (isArrayOrTypedArray(obj[p])) {
+                assert_arrays_are_equal(objReloaded[p], obj[p]);
+            } else {
+                if (objReloaded[p] === undefined || obj[p] === undefined) {
+                    return;
+                }
+                (JSON.stringify(objReloaded[p]) as any).should.eql(JSON.stringify(obj[p]));
+            }
+        } catch (err) {
+            displayError(p, obj[p], objReloaded[p]);
+            console.log(obj.toString());
+            console.log(objReloaded.toString());
+            // re throw exception
+            throw err;
+        }
+    });
+}
+
+function redirectToNull(functor: () => void) {
+    const old = console.log;
+
+    if (!process.env.DEBUG) {
+        // tslint:disable:no-empty
+        console.log = (...args: any[]) => {};
+    }
+
+    try {
+        functor();
+    } catch (err) {
+        throw err;
+    } finally {
+        console.log = old;
+    }
+}
+
+type encode_decode_round_trip_testCallback = (buffer: Buffer, encoding: any, options: any) => void;
+
+/**
+ * @method encode_decode_round_trip_test
+ * @param obj  : object to test ( the object must provide a binaryStoreSize,encode,decode method
+ * @param [options]
+ * @param callback_buffer
+ * @return {*}
+ */
+export function encode_decode_round_trip_test(
+    obj: any,
+    options?: any,
+    callback_buffer?: encode_decode_round_trip_testCallback
+): any {
+    if (!callback_buffer && typeof options === "function") {
+        callback_buffer = options;
+        options = {};
+    }
+
+    callback_buffer = callback_buffer || dump_block_in_debug_mode;
+
+    should.exist(obj);
+
+    const size = obj.binaryStoreSize(options);
+
+    const stream = new BinaryStream(Buffer.alloc(size));
+
+    obj.encode(stream, options);
+
+    callback_buffer(stream.buffer, obj.encodingDefaultBinary, options);
+
+    stream.rewind();
+
+    // reconstruct a object ( some object may not have a default Binary and should be recreated
+    const expandedNodeId = obj.encodingDefaultBinary;
+    const objReloaded = expandedNodeId ? constructObject(expandedNodeId) : new obj.constructor();
+
+    objReloaded.decode(stream, options);
+
+    redirectToNull(() => analyze_object_binary_encoding(obj));
+    compare(objReloaded, obj);
+    return objReloaded;
+}
+
+export function json_encode_decode_round_trip_test(obj: any, options: any, callbackBuffer?: any) {
+    if (!callbackBuffer && typeof options === "function") {
+        callbackBuffer = options;
+        options = {};
+    }
+    callbackBuffer = callbackBuffer || dump_block_in_debug_mode;
+
+    should.exist(obj);
+
+    const json = JSON.stringify(obj);
+
+    const objReloaded = JSON.parse(json);
+
+    compare(objReloaded, obj);
+
+    return objReloaded;
+}

package/test_helpers/index.ts

@@ -0,0 +1,2 @@
+export * from "./compare_obj_by_encoding";
+export * from "./encode_decode_round_trip_test";