node-opcua-client 2.103.0 → 2.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-client",
-    "version": "2.103.0",
+    "version": "2.104.0",
     "description": "pure nodejs OPCUA SDK - module client",
     "scripts": {
         "clean": "npx rimraf node_modules dist *.tsbuildinfo certificates",
@@ -13,61 +13,61 @@
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "dependencies": {
-        "@ster5/global-mutex": "^1.2.0",
-        "@types/async": "^3.2.18",
+        "@ster5/global-mutex": "^2.0.0",
+        "@types/async": "^3.2.20",
         "async": "^3.2.4",
         "chalk": "4.1.2",
-        "node-opcua-assert": "2.98.1",
-        "node-opcua-basic-types": "2.99.0",
-        "node-opcua-buffer-utils": "2.98.1",
-        "node-opcua-certificate-manager": "2.99.0",
-        "node-opcua-client-dynamic-extension-object": "2.103.0",
-        "node-opcua-common": "2.103.0",
+        "node-opcua-assert": "2.104.0",
+        "node-opcua-basic-types": "2.104.0",
+        "node-opcua-buffer-utils": "2.104.0",
+        "node-opcua-certificate-manager": "2.104.0",
+        "node-opcua-client-dynamic-extension-object": "2.104.0",
+        "node-opcua-common": "2.104.0",
         "node-opcua-constants": "2.98.1",
-        "node-opcua-crypto": "^2.1.2",
-        "node-opcua-data-model": "2.102.0",
-        "node-opcua-data-value": "2.102.0",
-        "node-opcua-date-time": "2.99.0",
-        "node-opcua-debug": "2.99.0",
-        "node-opcua-extension-object": "2.99.0",
-        "node-opcua-hostname": "2.98.1",
-        "node-opcua-nodeid": "2.99.0",
-        "node-opcua-object-registry": "2.99.0",
-        "node-opcua-pki": "^3.0.2",
-        "node-opcua-pseudo-session": "2.103.0",
-        "node-opcua-schemas": "2.103.0",
-        "node-opcua-secure-channel": "2.103.0",
-        "node-opcua-service-browse": "2.103.0",
-        "node-opcua-service-call": "2.103.0",
-        "node-opcua-service-discovery": "2.103.0",
-        "node-opcua-service-endpoints": "2.103.0",
-        "node-opcua-service-filter": "2.103.0",
-        "node-opcua-service-history": "2.103.0",
-        "node-opcua-service-query": "2.103.0",
-        "node-opcua-service-read": "2.103.0",
-        "node-opcua-service-register-node": "2.103.0",
-        "node-opcua-service-secure-channel": "2.103.0",
-        "node-opcua-service-session": "2.103.0",
-        "node-opcua-service-subscription": "2.103.0",
-        "node-opcua-service-translate-browse-path": "2.103.0",
-        "node-opcua-service-write": "2.103.0",
-        "node-opcua-status-code": "2.98.1",
-        "node-opcua-types": "2.103.0",
-        "node-opcua-utils": "2.98.1",
-        "node-opcua-variant": "2.102.0",
+        "node-opcua-crypto": "3.0.5",
+        "node-opcua-data-model": "2.104.0",
+        "node-opcua-data-value": "2.104.0",
+        "node-opcua-date-time": "2.104.0",
+        "node-opcua-debug": "2.104.0",
+        "node-opcua-extension-object": "2.104.0",
+        "node-opcua-hostname": "2.104.0",
+        "node-opcua-nodeid": "2.104.0",
+        "node-opcua-object-registry": "2.104.0",
+        "node-opcua-pki": "4.2.0",
+        "node-opcua-pseudo-session": "2.104.0",
+        "node-opcua-schemas": "2.104.0",
+        "node-opcua-secure-channel": "2.104.0",
+        "node-opcua-service-browse": "2.104.0",
+        "node-opcua-service-call": "2.104.0",
+        "node-opcua-service-discovery": "2.104.0",
+        "node-opcua-service-endpoints": "2.104.0",
+        "node-opcua-service-filter": "2.104.0",
+        "node-opcua-service-history": "2.104.0",
+        "node-opcua-service-query": "2.104.0",
+        "node-opcua-service-read": "2.104.0",
+        "node-opcua-service-register-node": "2.104.0",
+        "node-opcua-service-secure-channel": "2.104.0",
+        "node-opcua-service-session": "2.104.0",
+        "node-opcua-service-subscription": "2.104.0",
+        "node-opcua-service-translate-browse-path": "2.104.0",
+        "node-opcua-service-write": "2.104.0",
+        "node-opcua-status-code": "2.104.0",
+        "node-opcua-types": "2.104.0",
+        "node-opcua-utils": "2.104.0",
+        "node-opcua-variant": "2.104.0",
         "thenify": "^3.3.1"
     },
     "devDependencies": {
-        "@types/underscore": "^1.11.4",
+        "@types/underscore": "^1.11.5",
         "dequeue": "^1.0.5",
         "mocha": "^10.2.0",
-        "node-opcua-address-space": "2.103.0",
-        "node-opcua-binary-stream": "2.98.1",
-        "node-opcua-factory": "2.99.0",
-        "node-opcua-leak-detector": "2.99.0",
+        "node-opcua-address-space": "2.104.0",
+        "node-opcua-binary-stream": "2.104.0",
+        "node-opcua-factory": "2.104.0",
+        "node-opcua-leak-detector": "2.104.0",
         "node-opcua-nodesets": "2.103.0",
         "should": "^13.2.3",
-        "sinon": "^15.0.3",
+        "sinon": "^15.1.0",
         "underscore": "^1.13.6"
     },
     "eslintConfig": {
@@ -90,7 +90,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "e206cac2daf39bd07e5ac6cbd744f966bb54759e",
+    "gitHead": "3cd6d355e8b3c66822d08a3ca682659ea5d1a55d",
     "files": [
         "dist",
         "source"

package/source/alarms_and_conditions/client_alarm_tools_dump_event.ts

@@ -1,4 +1,4 @@
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { AttributeIds } from "node-opcua-data-model";
 import { NodeId } from "node-opcua-nodeid";
 import { IBasicSession } from "node-opcua-pseudo-session";

package/source/client_monitored_item_toolbox.ts

@@ -1,7 +1,7 @@
 /**
  * @module node-opcua-client
  */
-import * as chalk from "chalk";
+import chalk from "chalk";
 
 import { assert } from "node-opcua-assert";
 import { TimestampsToReturn } from "node-opcua-data-value";

package/source/client_session_keepalive_manager.ts

@@ -2,7 +2,7 @@
  * @module node-opcua-client
  */
 import { EventEmitter } from "events";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { ServerState } from "node-opcua-common";
 import { VariableIds } from "node-opcua-constants";

package/source/private/client_base_impl.ts

@@ -5,12 +5,11 @@
 import * as fs from "fs";
 import * as path from "path";
 import * as async from "async";
-import * as chalk from "chalk";
-
+import chalk from "chalk";
 import { withLock } from "@ster5/global-mutex";
 import { assert } from "node-opcua-assert";
 import { IOPCUASecureObjectOptions, OPCUASecureObject } from "node-opcua-common";
-import { Certificate, makeSHA1Thumbprint, Nonce } from "node-opcua-crypto";
+import { Certificate, makeSHA1Thumbprint, Nonce, split_der } from "node-opcua-crypto";
 import { installPeriodicClockAdjustment, periodicClockAdjustment, uninstallPeriodicClockAdjustment } from "node-opcua-date-time";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 
@@ -750,11 +749,14 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         if ((this as any)._inCreateDefaultCertificate) {
             errorLog("Internal error : re-entrancy in createDefaultCertificate!");
         }
-
         (this as any)._inCreateDefaultCertificate = true;
         if (!fs.existsSync(this.certificateFile)) {
-            const lockfile = path.join(this.certificateFile + ".lock");
-            await withLock({ lockfile: lockfile, maxStaleDuration: 60 * 1000, retryInterval: 100 }, async () => {
+            await withLock({ fileToLock: this.certificateFile + ".mutex" }, async () => {
+                if (fs.existsSync(this.certificateFile)) {
+                    // the file may have been created in between    
+                    return;
+                }
+                console.log("Creating default certificate ... please wait");
                 if (this.disconnecting) return;
 
                 await ClientBaseImpl.createCertificate(
@@ -797,13 +799,10 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         if (!fs.existsSync(this.privateKeyFile)) {
             throw new Error(" cannot locate private key file " + this.privateKeyFile);
         }
-
         if (this.disconnecting) return;
 
-        const lockfile = path.join(this.certificateFile + ".lock");
-        await withLock({ lockfile: lockfile, maxStaleDuration: 60 * 1000, retryInterval: 100 }, async () => {
-            if (this.disconnecting) return;
-            await performCertificateSanityCheck.call(this, "client", this.clientCertificateManager, this._getBuiltApplicationUri());
+        await this.clientCertificateManager.withLock2(async () => {
+            await performCertificateSanityCheck(this, "client", this.clientCertificateManager, this._getBuiltApplicationUri());
         });
     }
 
@@ -938,6 +937,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                     /* */
                     this._handleDisconnectionWhileConnecting(err, callback);
                 } else {
+                    console.log("REMOVE ME", err.stack);
                     err = new Error("The connection may have been rejected by server,\n" + "Err = (" + err.message + ")");
                     this._handleUnrecoverableConnectionFailure(err, callback);
                 }
@@ -1289,12 +1289,12 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 tmpChannel = null;
                 this._destroy_secure_channel();
                 this._setInternalState("disconnected");
-                setImmediate(callback);
+                callback();
             });
         } else {
             this._setInternalState("disconnected");
-        //    this.emit("close", null);
-            setImmediate(callback);
+            //    this.emit("close", null);
+            callback();
         }
     }
 
@@ -1416,14 +1416,28 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             _verify_serverCertificate(this.clientCertificateManager, endpoint.serverCertificate, (err1?: Error) => {
                 if (err1) {
                     warningLog("[NODE-OPCUA-W25] client's server certificate verification has failed ", err1.message);
-                    warningLog("                 ", this.clientCertificateManager.rootDir);
-                    warningLog(
-                        "                 ",
-                        endpoint.serverCertificate.toString("base64").replace(/(.{80})/g, "$1\n                 ")
-                    );
-                    warningLog(
-                        "                 verify that server certificate is trusted or that server certificate issuer's certificate is present in the issuer folder"
-                    );
+                    warningLog("                 clientCertificateManager.rootDir = ", this.clientCertificateManager.rootDir);
+
+                    const f = (b: Buffer) =>
+                        "                 " + b.toString("base64").replace(/(.{80})/g, "$1\n                 ");
+
+                    const chain = split_der(endpoint.serverCertificate);
+                    warningLog(`                  server certificate contains ${chain.length} elements`);
+                    for (let i = 0; i < chain.length; i++) {
+                        const c = chain[i];
+                        warningLog("certificate", i, "\n" + f(c));
+                    }
+                    if (chain.length > 1) {
+                        warningLog(
+                            "                 verify also that the issuer certificate is trusted and the issuer's certificate is present in the issuer.cert folder\n" +
+                                "                 of the client certificate manager located in ",
+                            this.clientCertificateManager.rootDir
+                        );
+                    } else {
+                        warningLog(
+                            "                 verify that the server certificate is trusted or that server certificate issuer's certificate is present in the issuer folder"
+                        );
+                    }
                     return callback(err1);
                 }
                 this.serverCertificate = endpoint.serverCertificate;

package/source/private/client_publish_engine.ts

@@ -3,7 +3,7 @@
  */
 import { types } from "util";
 import * as async from "async";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { checkDebugFlag, make_debugLog, make_warningLog } from "node-opcua-debug";
 import { PublishRequest, PublishResponse, RepublishRequest, RepublishResponse } from "node-opcua-service-subscription";

package/source/private/client_session_impl.ts

@@ -3,7 +3,7 @@
  */
 import { EventEmitter } from "events";
 import { callbackify } from "util";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { AggregateFunction } from "node-opcua-constants";
 import { DateTime } from "node-opcua-basic-types";

package/source/private/client_subscription_impl.ts

@@ -4,7 +4,7 @@
 // tslint:disable:unified-signatures
 import { EventEmitter } from "events";
 import * as async from "async";
-import * as chalk from "chalk";
+import chalk from "chalk";
 
 import { assert } from "node-opcua-assert";
 import { AttributeIds } from "node-opcua-data-model";

package/source/private/opcua_client_impl.ts

@@ -9,7 +9,7 @@ import * as crypto from "crypto";
 import { createPublicKey } from "crypto";
 import { callbackify } from "util";
 import * as async from "async";
-import * as chalk from "chalk";
+import chalk from "chalk";
 
 import { assert } from "node-opcua-assert";
 import { createFastUninitializedBuffer } from "node-opcua-buffer-utils";
@@ -19,7 +19,6 @@ import {
     extractPublicKeyFromCertificateSync,
     Nonce,
     PrivateKey,
-    PrivateKeyPEM,
     toPem
 } from "node-opcua-crypto";
 

package/source/reconnection.ts

@@ -4,7 +4,7 @@
 
 // tslint:disable:only-arrow-functions
 import * as async from "async";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 import { TransferSubscriptionsRequest, TransferSubscriptionsResponse } from "node-opcua-service-subscription";

package/source/tools/read_history_server_capabilities.ts

@@ -55,18 +55,24 @@ export function readHistoryServerCapabilities(
         const properties = [
             "AccessHistoryDataCapability",
             "AccessHistoryEventsCapability",
+          
             "DeleteAtTimeCapability",
             "DeleteRawCapability",
             "DeleteEventCapability",
+          
             "InsertAnnotationCapability",
             "InsertDataCapability",
             "InsertEventCapability",
+          
             "ReplaceDataCapability",
             "ReplaceEventCapability",
+          
             "UpdateDataCapability",
             "UpdateEventCapability",
+          
             "MaxReturnDataValues",
             "MaxReturnEventValues",
+          
             "AggregateFunctions/AnnotationCount",
             "AggregateFunctions/Average",
             "AggregateFunctions/Count",

package/source/verify.ts

@@ -86,6 +86,7 @@ export function verifyIsOPCUAValidCertificate(
                     `see https://reference.opcfoundation.org/v104/Core/docs/Part6/6.2.2/\n` +
                     `certificateFile = ${certificateFile}`
             );
+            warningLog(`keyUsage = ${JSON.stringify(keyUsage, null, " ")}`);
         }
     }
     const extKeyUsage = certificateInfo.tbsCertificate.extensions?.extKeyUsage;
@@ -120,21 +121,21 @@ export function verifyIsOPCUAValidCertificate(
 }
 
 export async function performCertificateSanityCheck(
-    this: OPCUASecureObject,
+    secureObject: OPCUASecureObject,
     serverOrClient: "server" | "client",
     certificateManager: OPCUACertificateManager,
     applicationUri: string
 ): Promise<void> {
-    // verify that certificate is matching private key, and inform the developper if not
-    const certificate = this.getCertificate();
-    const privateKey = this.getPrivateKey();
+    // verify that certificate is matching private key, and inform the developer if not
+    const certificate = secureObject.getCertificate();
+    const privateKey = secureObject.getPrivateKey();
     //
     if (!publicKeyAndPrivateKeyMatches(certificate, privateKey)) {
         errorLog("[NODE-OPCUA-E01] Configuration error : the certificate and the private key do not match !");
         errorLog("                  please check the configuration of the OPCUA Server");
-        errorLog("                    privateKey= ", this.privateKeyFile);
+        errorLog("                    privateKey= ", secureObject.privateKeyFile);
         errorLog(" certificateManager.privateKey= ", certificateManager.privateKey);
-        errorLog("               certificateFile= ", this.certificateFile);
+        errorLog("               certificateFile= ", secureObject.certificateFile);
         throw new Error(
             "[NODE-OPCUA-E01] Configuration error : the certificate and the private key do not match ! please fix your configuration"
         );
@@ -154,8 +155,8 @@ export async function performCertificateSanityCheck(
     const status = await certificateManager.verifyCertificateAsync(certificate);
 
     if (status !== "Good") {
-        warningLog("[NODE-OPCUA-W04] Warning: the certificate status is = ", status, " file = ", this.certificateFile);
+        warningLog("[NODE-OPCUA-W04] Warning: the certificate status is = ", status, " file = ", secureObject.certificateFile);
     }
 
-    verifyIsOPCUAValidCertificate(certificate, this.certificateFile, serverOrClient, applicationUri);
+    verifyIsOPCUAValidCertificate(certificate, secureObject.certificateFile, serverOrClient, applicationUri);
 }