node-opcua-server 2.116.0 → 2.118.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-server",
-    "version": "2.116.0",
+    "version": "2.118.0",
     "description": "pure nodejs OPCUA SDK - module server",
     "scripts": {
         "build": "tsc -b",
@@ -13,60 +13,60 @@
     "types": "./dist/index.d.ts",
     "dependencies": {
         "@ster5/global-mutex": "^2.0.0",
-        "async": "^3.2.4",
+        "async": "^3.2.5",
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space": "2.116.0",
-        "node-opcua-address-space-base": "2.114.0",
+        "node-opcua-address-space": "2.118.0",
+        "node-opcua-address-space-base": "2.118.0",
         "node-opcua-assert": "2.105.0",
-        "node-opcua-basic-types": "2.114.0",
-        "node-opcua-binary-stream": "2.114.0",
-        "node-opcua-certificate-manager": "2.114.0",
-        "node-opcua-client": "2.116.0",
-        "node-opcua-client-dynamic-extension-object": "2.116.0",
-        "node-opcua-common": "2.114.0",
+        "node-opcua-basic-types": "2.118.0",
+        "node-opcua-binary-stream": "2.117.0",
+        "node-opcua-certificate-manager": "2.118.0",
+        "node-opcua-client": "2.118.0",
+        "node-opcua-client-dynamic-extension-object": "2.118.0",
+        "node-opcua-common": "2.118.0",
         "node-opcua-constants": "2.114.0",
-        "node-opcua-crypto": "4.5.0",
-        "node-opcua-data-model": "2.114.0",
-        "node-opcua-data-value": "2.114.0",
-        "node-opcua-date-time": "2.114.0",
-        "node-opcua-debug": "2.114.0",
-        "node-opcua-extension-object": "2.114.0",
-        "node-opcua-factory": "2.114.0",
-        "node-opcua-hostname": "2.105.0",
-        "node-opcua-nodeid": "2.114.0",
-        "node-opcua-nodesets": "2.110.0",
-        "node-opcua-numeric-range": "2.114.0",
-        "node-opcua-object-registry": "2.114.0",
-        "node-opcua-secure-channel": "2.114.0",
-        "node-opcua-service-browse": "2.114.0",
-        "node-opcua-service-call": "2.114.0",
-        "node-opcua-service-discovery": "2.114.0",
-        "node-opcua-service-endpoints": "2.114.0",
-        "node-opcua-service-filter": "2.114.0",
-        "node-opcua-service-history": "2.114.0",
-        "node-opcua-service-node-management": "2.114.0",
-        "node-opcua-service-query": "2.114.0",
-        "node-opcua-service-read": "2.114.0",
-        "node-opcua-service-register-node": "2.114.0",
-        "node-opcua-service-secure-channel": "2.114.0",
-        "node-opcua-service-session": "2.114.0",
-        "node-opcua-service-subscription": "2.114.0",
-        "node-opcua-service-translate-browse-path": "2.114.0",
-        "node-opcua-service-write": "2.114.0",
-        "node-opcua-status-code": "2.114.0",
-        "node-opcua-types": "2.114.0",
-        "node-opcua-utils": "2.114.0",
-        "node-opcua-variant": "2.114.0",
+        "node-opcua-crypto": "4.6.2",
+        "node-opcua-data-model": "2.118.0",
+        "node-opcua-data-value": "2.118.0",
+        "node-opcua-date-time": "2.118.0",
+        "node-opcua-debug": "2.118.0",
+        "node-opcua-extension-object": "2.118.0",
+        "node-opcua-factory": "2.118.0",
+        "node-opcua-hostname": "2.118.0",
+        "node-opcua-nodeid": "2.118.0",
+        "node-opcua-nodesets": "2.118.0",
+        "node-opcua-numeric-range": "2.118.0",
+        "node-opcua-object-registry": "2.118.0",
+        "node-opcua-secure-channel": "2.118.0",
+        "node-opcua-service-browse": "2.118.0",
+        "node-opcua-service-call": "2.118.0",
+        "node-opcua-service-discovery": "2.118.0",
+        "node-opcua-service-endpoints": "2.118.0",
+        "node-opcua-service-filter": "2.118.0",
+        "node-opcua-service-history": "2.118.0",
+        "node-opcua-service-node-management": "2.118.0",
+        "node-opcua-service-query": "2.118.0",
+        "node-opcua-service-read": "2.118.0",
+        "node-opcua-service-register-node": "2.118.0",
+        "node-opcua-service-secure-channel": "2.118.0",
+        "node-opcua-service-session": "2.118.0",
+        "node-opcua-service-subscription": "2.118.0",
+        "node-opcua-service-translate-browse-path": "2.118.0",
+        "node-opcua-service-write": "2.118.0",
+        "node-opcua-status-code": "2.117.0",
+        "node-opcua-types": "2.118.0",
+        "node-opcua-utils": "2.117.0",
+        "node-opcua-variant": "2.118.0",
         "thenify": "^3.3.1"
     },
     "devDependencies": {
-        "node-opcua-data-access": "2.114.0",
-        "node-opcua-leak-detector": "2.114.0",
+        "node-opcua-data-access": "2.118.0",
+        "node-opcua-leak-detector": "2.118.0",
         "node-opcua-test-helpers": "2.113.0",
         "should": "^13.2.3",
-        "sinon": "^16.0.0",
+        "sinon": "^17.0.1",
         "underscore": "^1.13.6"
     },
     "author": "Etienne Rossignon",
@@ -84,7 +84,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "713ad387571a323c8d886ad1c907f50ad96a5e76",
+    "gitHead": "6210aaa97b43554e3982113041963b2720e50a95",
     "files": [
         "dist",
         "source"

package/source/base_server.ts

@@ -2,11 +2,11 @@
  * @module node-opcua-server
  */
 // tslint:disable:no-console
-import * as fs from "fs";
-import * as path from "path";
-import * as os from "os";
+import fs from "fs";
+import path from "path";
+import os from "os";
 import { types } from "util";
-import * as async from "async";
+import async from "async";
 import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { withLock } from "@ster5/global-mutex";

package/source/helper.ts

@@ -1,4 +1,4 @@
-import * as util from "util";
+import util from "util";
 import { OPCUAServer } from "./opcua_server";
 import { ServerEngine } from "./server_engine";
 import { ServerSession } from "./server_session";

package/source/opcua_server.ts

@@ -10,13 +10,13 @@ import { randomBytes } from "crypto";
 import { EventEmitter } from "events";
 import { callbackify, types } from "util";
 
-import * as async from "async";
+import async from "async";
 import chalk from "chalk";
 
 import { extractFullyQualifiedDomainName, getFullyQualifiedDomainName } from "node-opcua-hostname";
 
 import { assert } from "node-opcua-assert";
-import * as utils from "node-opcua-utils";
+import { isNullOrUndefined } from "node-opcua-utils";
 
 import {
     AddressSpace,
@@ -752,7 +752,11 @@ export interface OPCUAServerEndpointOptions {
 }
 
 export interface OPCUAServerOptions extends OPCUABaseServerOptions, OPCUAServerEndpointOptions {
+    /**
+     * @deprecated
+     */
     alternateEndpoints?: OPCUAServerEndpointOptions[];
+    endpoints?: OPCUAServerEndpointOptions[];
 
     /**
      * the server certificate full path filename
@@ -1139,7 +1143,9 @@ export class OPCUAServer extends OPCUABaseServer {
         this.discoveryServerEndpointUrl = options.discoveryServerEndpointUrl || "opc.tcp://%FQDN%:4840";
         assert(typeof this.discoveryServerEndpointUrl === "string");
 
-        this.serverInfo.applicationType = ApplicationType.Server;
+        this.serverInfo.applicationType =
+            options.serverInfo?.applicationType === undefined ? ApplicationType.Server : options.serverInfo.applicationType;
+
         this.capabilitiesForMDNS = options.capabilitiesForMDNS || ["NA"];
         this.registerServerMethod = options.registerServerMethod || RegisterServerMethod.HIDDEN;
         _installRegisterServerManager(this);
@@ -1164,23 +1170,46 @@ export class OPCUAServer extends OPCUABaseServer {
                 applicationUri: () => this.serverInfo.applicationUri!,
                 buildInfo,
                 isAuditing: options.isAuditing,
-                serverCapabilities: options.serverCapabilities
+                serverCapabilities: options.serverCapabilities,
+
+                serverConfiguration: {
+                    serverCapabilities: () => {
+                        return this.capabilitiesForMDNS || ["NA"];
+                    },
+                    supportedPrivateKeyFormat: ["PEM"],
+                    applicationType: () => this.serverInfo.applicationType,
+                    applicationUri: () => this.serverInfo.applicationUri || "",
+                    productUri: () => this.serverInfo.productUri || "",
+                    // hasSecureElement: () => false,
+                    multicastDnsEnabled: () => this.registerServerMethod === RegisterServerMethod.MDNS
+                }
             });
+
             this.objectFactory = new Factory(this.engine);
 
-            const endpointDefinitions: OPCUAServerEndpointOptions[] = options.alternateEndpoints || [];
+            const endpointDefinitions: OPCUAServerEndpointOptions[] = [
+                ...(options.endpoints || []),
+                ...(options.alternateEndpoints || [])
+            ];
+
             const hostname = getFullyQualifiedDomainName();
+            endpointDefinitions.forEach((endpointDefinition) => {
+                endpointDefinition.port = endpointDefinition.port === undefined ? 26543 : endpointDefinition.port;
+                endpointDefinition.hostname = endpointDefinition.hostname || hostname;
+            });
 
-            endpointDefinitions.push({
-                port: options.port === undefined ? 26543 : options.port,
+            if (!options.endpoints) {
+                endpointDefinitions.push({
+                    port: options.port === undefined ? 26543 : options.port,
+                    hostname: options.hostname || hostname,
 
-                allowAnonymous: options.allowAnonymous,
-                alternateHostname: options.alternateHostname,
-                disableDiscovery: options.disableDiscovery,
-                hostname: options.hostname || hostname,
-                securityModes: options.securityModes,
-                securityPolicies: options.securityPolicies
-            });
+                    allowAnonymous: options.allowAnonymous,
+                    alternateHostname: options.alternateHostname,
+                    disableDiscovery: options.disableDiscovery,
+                    securityModes: options.securityModes,
+                    securityPolicies: options.securityPolicies
+                });
+            }
             // todo  should self.serverInfo.productUri  match self.engine.buildInfo.productUri ?
             for (const endpointOptions of endpointDefinitions) {
                 const endPoint = this.createEndpointDescriptions(options!, endpointOptions);
@@ -1807,7 +1836,7 @@ export class OPCUAServer extends OPCUABaseServer {
         // unique for the instance of the Client.
         // If this parameter is not specified the Server shall assign a value.
 
-        if (utils.isNullOrUndefined(request.sessionName)) {
+        if (isNullOrUndefined(request.sessionName)) {
             // see also #198
             // let's the server assign a sessionName for this lazy client.
 
@@ -3547,7 +3576,9 @@ export class OPCUAServer extends OPCUABaseServer {
             !isFinite(endpointOptions.port!) ||
             typeof endpointOptions.port !== "number"
         ) {
-            throw new Error("expecting a valid port (number)");
+            throw new Error(
+                "expecting a valid port (number) when specified. alternatively you can specify port:0 and node-opcua will choose the first available port"
+            );
         }
 
         const port = Number(endpointOptions.port || 0);
@@ -3573,6 +3604,10 @@ export class OPCUAServer extends OPCUABaseServer {
             disableDiscovery: !!endpointOptions.disableDiscovery,
             // xx                hostname,
             resourcePath: serverOption.resourcePath || ""
+
+            // TODO  userTokenTypes: endpointOptions.userTokenTypes || undefined,
+
+            // TODO allowUnsecurePassword: endpointOptions.allowUnsecurePassword || false
         });
         return endPoint;
     }

package/source/register_server_manager.ts

@@ -3,7 +3,7 @@
  */
 // tslint:disable:no-console
 import { EventEmitter } from "events";
-import * as async from "async";
+import async from "async";
 import chalk from "chalk";
 
 import { assert } from "node-opcua-assert";

package/source/server_end_point.ts

@@ -1,12 +1,13 @@
+/* eslint-disable max-statements */
 /**
  * @module node-opcua-server
  */
 // tslint:disable:no-console
 import { EventEmitter } from "events";
-import * as net from "net";
+import net from "net";
 import { Server, Socket } from "net";
 import chalk from "chalk";
-import * as async from "async";
+import async from "async";
 
 import { assert } from "node-opcua-assert";
 import { OPCUACertificateManager } from "node-opcua-certificate-manager";
@@ -294,9 +295,8 @@ export class OPCUAServerEndPoint extends EventEmitter implements ServerSecureCha
     }
 
     public toString(): string {
+        const privateKeyThumpPrint = makePrivateKeyThumbPrint(this.getPrivateKey());
 
-        const privateKeyThumpPrint = makePrivateKeyThumbPrint(this.getPrivateKey())
-        
         const txt =
             " end point" +
             this._counter +
@@ -1111,22 +1111,42 @@ function _makeEndpointDescription(options: MakeEndpointDescriptionOptions, paren
             //  when channel session security is not "None",
             //  userIdentityTokens can be left to null.
             //  in this case this mean that secure policy will be the same as connection security policy
-            registerIdentity({
-                policyId: u("usernamePassword"),
-                tokenType: UserTokenType.UserName,
-                issuedTokenType: null,
-                issuerEndpointUrl: null,
-                securityPolicyUri: null
-            });
+            // istanbul ignore next
+            if (process.env.NODEOPCUA_SERVER_EMULATE_SIEMENS) {
+                // However, for some reason SIEMENS plc requires that password get encrypted even though
+                // the secure channel is also encrypted ....
+                // you can set the NODEOPCUA_SERVER_EMULATE_SIEMENS env variable to simulate this behavior
+                const registerIdentity3 = (tokenType: UserTokenType, securityPolicy: SecurityPolicy, name: string) => {
+                    const identity = {
+                        policyId: u(name),
+                        tokenType,
+                        issuedTokenType: null,
+                        issuerEndpointUrl: null,
+                        securityPolicyUri: securityPolicy
+                    };
+                    userIdentityTokens.push(identity);
+                };
+                registerIdentity3(UserTokenType.UserName, SecurityPolicy.Basic256, "username_basic256");
+                registerIdentity3(UserTokenType.UserName, SecurityPolicy.Basic128Rsa15, "username_basic128Rsa15");
+                registerIdentity3(UserTokenType.UserName, SecurityPolicy.Basic256Sha256, "username_basic256Sha256");
+            } else {
+                registerIdentity({
+                    policyId: u("usernamePassword"),
+                    tokenType: UserTokenType.UserName,
+                    issuedTokenType: null,
+                    issuerEndpointUrl: null,
+                    securityPolicyUri: null
+                });
 
-            registerIdentity({
-                policyId: u("certificateX509"),
-                tokenType: UserTokenType.Certificate,
+                registerIdentity({
+                    policyId: u("certificateX509"),
+                    tokenType: UserTokenType.Certificate,
 
-                issuedTokenType: null,
-                issuerEndpointUrl: null,
-                securityPolicyUri: null
-            });
+                    issuedTokenType: null,
+                    issuerEndpointUrl: null,
+                    securityPolicyUri: null
+                });
+            }
         }
 
         registerIdentity({
@@ -1155,7 +1175,7 @@ function _makeEndpointDescription(options: MakeEndpointDescriptionOptions, paren
     endpoint._parent = parent;
 
     // endpointUrl is dynamic as port number may be adjusted
-    // when the tcp socker start listening
+    // when the tcp socket start listening
     (endpoint as any).__defineGetter__("endpointUrl", () => {
         const port = endpoint._parent.port;
         const resourcePath = options.resourcePath || "";

package/source/server_engine.ts

@@ -3,7 +3,7 @@
  */
 import { EventEmitter } from "events";
 import { types } from "util";
-import * as async from "async";
+import async from "async";
 import chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { BinaryStream } from "node-opcua-binary-stream";
@@ -65,7 +65,8 @@ import {
     CallMethodResultOptions,
     ReadRequestOptions,
     BrowseDescriptionOptions,
-    CallMethodRequest
+    CallMethodRequest,
+    ApplicationType
 } from "node-opcua-types";
 import { DataType, isValidVariant, Variant, VariantArrayType } from "node-opcua-variant";
 
@@ -287,7 +288,39 @@ function _get_next_subscriptionId() {
 }
 
 export type StringGetter = () => string;
+export type StringArrayGetter = () => string[];
+export type ApplicationTypeGetter = () => ApplicationType;
+export type BooleanGetter = () => boolean;
 
+export interface ServerConfigurationOptions {
+    applicationUri?: string | StringGetter;
+    applicationType?: ApplicationType | ApplicationTypeGetter; // default "Server"
+
+    hasSecureElement?: boolean | BooleanGetter; // default true
+
+    multicastDnsEnabled?: boolean | BooleanGetter; // default true
+
+    productUri?: string | StringGetter;
+
+    // /** @restricted only in professional version */
+    // resetToServerDefaults: () => Promise<void>;
+    // /** @restricted only in professional version */
+    // setAdminPassword?: (password: string) => Promise<void>;
+
+    /**
+     * The SupportedPrivateKeyFormats specifies the PrivateKey formats supported by the Server.
+     * Possible values include “PEM” (see RFC 5958) or “PFX” (see PKCS #12).
+     * @default ["PEM"]
+     */
+    supportedPrivateKeyFormat: string[] | StringArrayGetter;
+
+    /**
+     * The ServerCapabilities Property specifies the capabilities from Annex D
+     * ( see https://reference.opcfoundation.org/GDS/v104/docs/D)  which the Server supports. The value is
+     * the same as the value reported to the LocalDiscoveryServer when the Server calls the RegisterServer2 Service.
+     */
+    serverCapabilities?: string[] | StringArrayGetter; // default|"N/A"]
+}
 export interface ServerEngineOptions {
     applicationUri: string | StringGetter;
 
@@ -299,6 +332,7 @@ export interface ServerEngineOptions {
     serverDiagnosticsEnabled?: boolean;
     serverCapabilities?: ServerCapabilitiesOptions;
     historyServerCapabilities?: HistoryServerCapabilitiesOptions;
+    serverConfiguration?: ServerConfigurationOptions;
 }
 
 export interface CreateSessionOption {
@@ -322,6 +356,7 @@ export class ServerEngine extends EventEmitter implements IAddressSpaceAccessor
     public serverDiagnosticsEnabled: boolean;
     public serverCapabilities: ServerCapabilities;
     public historyServerCapabilities: HistoryServerCapabilities;
+    public serverConfiguration: ServerConfigurationOptions;
     public clientDescription?: ApplicationDescription;
 
     public addressSpace: AddressSpace | null;
@@ -367,6 +402,10 @@ export class ServerEngine extends EventEmitter implements IAddressSpaceAccessor
         // --------------------------------------------------- ServerCapabilities
         options.serverCapabilities = options.serverCapabilities || {};
 
+        options.serverConfiguration = options.serverConfiguration || {
+            supportedPrivateKeyFormat: ["PEM"]
+        };
+
         // https://profiles.opcfoundation.org/profile
         options.serverCapabilities.serverProfileArray = options.serverCapabilities.serverProfileArray || [
             "http://opcfoundation.org/UA-Profile/Server/Standard", // Standard UA Server Profile",
@@ -405,6 +444,8 @@ export class ServerEngine extends EventEmitter implements IAddressSpaceAccessor
             return MonitoredItem.minimumSamplingInterval;
         });
 
+        this.serverConfiguration = options.serverConfiguration;
+
         this.historyServerCapabilities = new HistoryServerCapabilities(options.historyServerCapabilities);
 
         // --------------------------------------------------- serverDiagnosticsSummary extension Object
@@ -1133,12 +1174,49 @@ export class ServerEngine extends EventEmitter implements IAddressSpaceAccessor
                 });
             };
 
+            type Getter<T> = () => T;
+            function r<T>(a: undefined | T | Getter<T>, defaultValue: T): T {
+                if (a === undefined) return defaultValue;
+                if (typeof a === "function") {
+                    return (a as any)();
+                }
+                return a;
+            }
+            const bindServerConfigurationBasic = () => {
+                bindStandardArray(VariableIds.ServerConfiguration_ServerCapabilities, DataType.String, DataType.String, () =>
+                    r(this.serverConfiguration.serverCapabilities, ["NA"])
+                );
+                bindStandardScalar(VariableIds.ServerConfiguration_ApplicationType, DataType.Int32, () =>
+                    r(this.serverConfiguration.applicationType, ApplicationType.Server)
+                );
+                bindStandardScalar(VariableIds.ServerConfiguration_ApplicationUri, DataType.String, () =>
+                    r(this.serverConfiguration.applicationUri, "")
+                );
+                bindStandardScalar(VariableIds.ServerConfiguration_ProductUri, DataType.String, () =>
+                    r(this.serverConfiguration.productUri, "")
+                );
+                bindStandardScalar(VariableIds.ServerConfiguration_HasSecureElement, DataType.Boolean, () =>
+                    r(this.serverConfiguration.hasSecureElement, false)
+                );
+                bindStandardScalar(VariableIds.ServerConfiguration_MulticastDnsEnabled, DataType.Boolean, () =>
+                    r(this.serverConfiguration.multicastDnsEnabled, false)
+                );
+                bindStandardArray(
+                    VariableIds.ServerConfiguration_SupportedPrivateKeyFormats,
+                    DataType.String,
+                    DataType.String,
+                    () => r(this.serverConfiguration.supportedPrivateKeyFormat, ["PEM"])
+                );
+            };
+
             bindServerDiagnostics();
 
             bindServerStatus();
 
             bindServerCapabilities();
 
+            bindServerConfigurationBasic();
+
             bindHistoryServerCapabilities();
 
             const bindExtraStuff = () => {