node-opcua-server 2.51.0

package/dist/register_server_manager_mdns_only.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module node-opcua-server
+ */
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { IRegisterServerManager } from "./i_register_server_manager";
+/**
+ * a RegisterServerManager that declare the server the OPCUA Bonjour service
+ * available on the current computer
+ */
+export declare class RegisterServerManagerMDNSONLY extends EventEmitter implements IRegisterServerManager {
+    discoveryServerEndpointUrl: string;
+    private server?;
+    private bonjour;
+    constructor(options: any);
+    stop(callback: () => void): void;
+    start(callback: () => void): void;
+    dispose(): void;
+}

package/dist/register_server_manager_mdns_only.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * @module node-opcua-server
+ */
+// RegisterServerManagerMDNSONLY
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterServerManagerMDNSONLY = void 0;
+const events_1 = require("events");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_service_discovery_1 = require("node-opcua-service-discovery");
+const base_server_1 = require("./base_server");
+/**
+ * a RegisterServerManager that declare the server the OPCUA Bonjour service
+ * available on the current computer
+ */
+class RegisterServerManagerMDNSONLY extends events_1.EventEmitter {
+    constructor(options) {
+        super();
+        this.discoveryServerEndpointUrl = "";
+        this.server = options.server;
+        (0, node_opcua_assert_1.assert)(this.server);
+        (0, node_opcua_assert_1.assert)(this.server instanceof base_server_1.OPCUABaseServer);
+        this.bonjour = new node_opcua_service_discovery_1.BonjourHolder();
+    }
+    stop(callback) {
+        if (this.bonjour) {
+            this.bonjour._stop_announcedOnMulticastSubnet();
+        }
+        setImmediate(() => {
+            this.emit("serverUnregistered");
+            setImmediate(callback);
+        });
+    }
+    start(callback) {
+        // istanbul ignore next
+        if (!this.server) {
+            throw new Error("internal error");
+        }
+        (0, node_opcua_assert_1.assert)(this.server instanceof base_server_1.OPCUABaseServer);
+        this.bonjour._announcedOnMulticastSubnet({
+            capabilities: this.server.capabilitiesForMDNS,
+            name: this.server.serverInfo.applicationUri,
+            path: "/",
+            port: this.server.endpoints[0].port,
+        });
+        setImmediate(() => {
+            this.emit("serverRegistered");
+            setImmediate(callback);
+        });
+    }
+    dispose() {
+        (0, node_opcua_assert_1.assert)(!this.bonjour.isStarted());
+        (0, node_opcua_assert_1.assert)(this.server);
+        this.server = undefined;
+    }
+}
+exports.RegisterServerManagerMDNSONLY = RegisterServerManagerMDNSONLY;
+//# sourceMappingURL=register_server_manager_mdns_only.js.map

package/dist/register_server_manager_mdns_only.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register_server_manager_mdns_only.js","sourceRoot":"","sources":["../source/register_server_manager_mdns_only.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,gCAAgC;;;AAEhC,mCAAsC;AACtC,yDAA2C;AAC3C,+EAEsC;AACtC,+CAAgD;AAGhD;;;GAGG;AACH,MAAa,6BACX,SAAQ,qBAAY;IAQlB,YAAY,OAAY;QACpB,KAAK,EAAE,CAAC;QANL,+BAA0B,GAAW,EAAE,CAAC;QAO3C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,YAAY,6BAAe,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,4CAAa,EAAE,CAAC;IACvC,CAAC;IAEM,IAAI,CAAC,QAAoB;QAC5B,IAAI,IAAI,CAAC,OAAO,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC;SACnD;QACD,YAAY,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAChC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,QAAoB;QAC7B,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;SACrC;QACD,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,YAAY,6BAAe,CAAC,CAAC;QAE/C,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC;YACrC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,mBAAmB;YAC7C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,cAAe;YAC5C,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;SACtC,CAAC,CAAC;QACH,YAAY,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC9B,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,OAAO;QACV,IAAA,0BAAM,EAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QAClC,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC5B,CAAC;CACJ;AAnDD,sEAmDC"}

package/dist/server_capabilities.d.ts

@@ -0,0 +1,61 @@
+import { SignedSoftwareCertificate } from "node-opcua-types";
+/**
+ */
+export interface OperationLimitsOptions {
+    maxNodesPerRead?: number;
+    maxNodesPerBrowse?: number;
+    maxNodesPerWrite?: number;
+    maxNodesPerMethodCall?: number;
+    maxNodesPerRegisterNodes?: number;
+    maxNodesPerNodeManagement?: number;
+    maxMonitoredItemsPerCall?: number;
+    maxNodesPerHistoryReadData?: number;
+    maxNodesPerHistoryReadEvents?: number;
+    maxNodesPerHistoryUpdateData?: number;
+    maxNodesPerHistoryUpdateEvents?: number;
+    maxNodesPerTranslateBrowsePathsToNodeIds?: number;
+}
+export declare class OperationLimits {
+    maxNodesPerRead: number;
+    maxNodesPerBrowse: number;
+    maxNodesPerWrite: number;
+    maxNodesPerMethodCall: number;
+    maxNodesPerRegisterNodes: number;
+    maxNodesPerNodeManagement: number;
+    maxMonitoredItemsPerCall: number;
+    maxNodesPerHistoryReadData: number;
+    maxNodesPerHistoryReadEvents: number;
+    maxNodesPerHistoryUpdateData: number;
+    maxNodesPerHistoryUpdateEvents: number;
+    maxNodesPerTranslateBrowsePathsToNodeIds: number;
+    constructor(options: OperationLimitsOptions);
+}
+export interface ServerCapabilitiesOptions {
+    maxBrowseContinuationPoints?: number;
+    maxHistoryContinuationPoints?: number;
+    maxStringLength?: number;
+    maxArrayLength?: number;
+    maxByteStringLength?: number;
+    maxQueryContinuationPoints?: number;
+    minSupportedSampleRate?: number;
+    operationLimits?: OperationLimitsOptions;
+    serverProfileArray?: string[];
+    localeIdArray?: string[];
+    softwareCertificates?: SignedSoftwareCertificate[];
+}
+/**
+ */
+export declare class ServerCapabilities {
+    maxBrowseContinuationPoints: number;
+    maxHistoryContinuationPoints: number;
+    maxStringLength: number;
+    maxArrayLength: number;
+    maxByteStringLength: number;
+    maxQueryContinuationPoints: number;
+    minSupportedSampleRate: number;
+    operationLimits: OperationLimits;
+    serverProfileArray: string[];
+    localeIdArray: string[];
+    softwareCertificates: SignedSoftwareCertificate[];
+    constructor(options: ServerCapabilitiesOptions);
+}

package/dist/server_capabilities.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerCapabilities = exports.OperationLimits = void 0;
+class OperationLimits {
+    constructor(options) {
+        /**
+         * @property maxNodesPerRead
+         * @default 0
+         */
+        this.maxNodesPerRead = options.maxNodesPerRead || 0;
+        /**
+         * @property maxNodesPerWrite
+         * @default 0
+         */
+        this.maxNodesPerWrite = options.maxNodesPerWrite || 0;
+        /**
+         * @property maxNodesPerMethodCall
+         * @default 0
+         */
+        this.maxNodesPerMethodCall = options.maxNodesPerMethodCall || 0;
+        /**
+         * @property maxNodesPerBrowse
+         * @default 0
+         */
+        this.maxNodesPerBrowse = options.maxNodesPerBrowse || 0;
+        /**
+         * @property maxNodesPerRegisterNodes
+         * @default 0
+         */
+        this.maxNodesPerRegisterNodes = options.maxNodesPerRegisterNodes || 0;
+        /**
+         * @property maxNodesPerNodeManagement
+         * @default 0
+         */
+        this.maxNodesPerNodeManagement = options.maxNodesPerNodeManagement || 0;
+        /**
+         * @property maxMonitoredItemsPerCall
+         * @default 0
+         */
+        this.maxMonitoredItemsPerCall = options.maxMonitoredItemsPerCall || 0;
+        /**
+         * @property maxNodesPerHistoryReadData
+         */
+        this.maxNodesPerHistoryReadData = options.maxNodesPerHistoryReadData || 0;
+        /**
+         * @property maxNodesPerHistoryReadEvents
+         * @default 0
+         */
+        this.maxNodesPerHistoryReadEvents = options.maxNodesPerHistoryReadEvents || 0;
+        /**
+         * @property maxNodesPerHistoryUpdateData
+         * @default 0
+         */
+        this.maxNodesPerHistoryUpdateData = options.maxNodesPerHistoryUpdateData || 0;
+        /**
+         * @property maxNodesPerHistoryUpdateEvents
+         * @default 0
+         */
+        this.maxNodesPerHistoryUpdateEvents = options.maxNodesPerHistoryUpdateEvents || 0;
+        /**
+         * @property maxNodesPerTranslateBrowsePathsToNodeIds
+         * @default 0
+         */
+        this.maxNodesPerTranslateBrowsePathsToNodeIds = options.maxNodesPerTranslateBrowsePathsToNodeIds || 0;
+    }
+}
+exports.OperationLimits = OperationLimits;
+/**
+ */
+class ServerCapabilities {
+    constructor(options) {
+        options = options || {};
+        options.operationLimits = options.operationLimits || {};
+        this.serverProfileArray = options.serverProfileArray || [];
+        this.localeIdArray = options.localeIdArray || [];
+        this.softwareCertificates = options.softwareCertificates || [];
+        /**
+         * @property maxArrayLength
+         */
+        this.maxArrayLength = options.maxArrayLength || 0;
+        /**
+         * @property maxStringLength
+         */
+        this.maxStringLength = options.maxStringLength || 0;
+        /**
+         * @property maxByteStringLength
+         */
+        this.maxByteStringLength = options.maxByteStringLength || 0;
+        /**
+         * @property maxBrowseContinuationPoints
+         */
+        this.maxBrowseContinuationPoints = options.maxBrowseContinuationPoints || 0;
+        /**
+         * @property maxQueryContinuationPoints
+         */
+        this.maxQueryContinuationPoints = options.maxQueryContinuationPoints || 0;
+        /**
+         * @property maxHistoryContinuationPoints
+         */
+        this.maxHistoryContinuationPoints = options.maxHistoryContinuationPoints || 0;
+        /**
+         * @property operationLimits
+         */
+        this.operationLimits = new OperationLimits(options.operationLimits);
+        this.minSupportedSampleRate = 100; // to do adjust me
+    }
+}
+exports.ServerCapabilities = ServerCapabilities;
+//# sourceMappingURL=server_capabilities.js.map

package/dist/server_capabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server_capabilities.js","sourceRoot":"","sources":["../source/server_capabilities.ts"],"names":[],"mappings":";;;AAwBA,MAAa,eAAe;IAexB,YAAY,OAA+B;QAEvC;;;WAGG;QACH,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD;;;WAGG;QACH,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAC;QACtD;;;WAGG;QACH,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,IAAI,CAAC,CAAC;QAChE;;;WAGG;QACH,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,IAAI,CAAC,CAAC;QACxD;;;WAGG;QACH,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,IAAI,CAAC,CAAC;QACtE;;;WAGG;QACH,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,IAAI,CAAC,CAAC;QACxE;;;WAGG;QACH,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,IAAI,CAAC,CAAC;QACtE;;WAEG;QACH,IAAI,CAAC,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,IAAI,CAAC,CAAC;QAC1E;;;WAGG;QACH,IAAI,CAAC,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,IAAI,CAAC,CAAC;QAC9E;;;WAGG;QACH,IAAI,CAAC,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,IAAI,CAAC,CAAC;QAC9E;;;WAGG;QACH,IAAI,CAAC,8BAA8B,GAAG,OAAO,CAAC,8BAA8B,IAAI,CAAC,CAAC;QAClF;;;WAGG;QACH,IAAI,CAAC,wCAAwC,GAAG,OAAO,CAAC,wCAAwC,IAAI,CAAC,CAAC;IAE1G,CAAC;CACJ;AA9ED,0CA8EC;AAiBD;GACG;AACH,MAAa,kBAAkB;IAe3B,YAAY,OAAkC;QAE1C,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,EAAE,CAAC;QAExD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,IAAI,EAAE,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC;QAC/D;;WAEG;QACH,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,CAAC,CAAC;QAClD;;WAEG;QACH,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD;;WAEG;QACH,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC;QAC5D;;WAEG;QACH,IAAI,CAAC,2BAA2B,GAAG,OAAO,CAAC,2BAA2B,IAAI,CAAC,CAAC;QAC5E;;WAEG;QACH,IAAI,CAAC,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,IAAI,CAAC,CAAC;QAC1E;;WAEG;QACH,IAAI,CAAC,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,IAAI,CAAC,CAAC;QAE9E;;WAEG;QACH,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEpE,IAAI,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC,kBAAkB;IACzD,CAAC;CACJ;AAvDD,gDAuDC"}

package/dist/server_end_point.d.ts

@@ -0,0 +1,180 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { OPCUACertificateManager } from "node-opcua-certificate-manager";
+import { Certificate, PrivateKeyPEM } from "node-opcua-crypto";
+import { MessageSecurityMode, SecurityPolicy, ServerSecureChannelLayer, ServerSecureChannelParent } from "node-opcua-secure-channel";
+import { EndpointDescription } from "node-opcua-service-endpoints";
+import { ApplicationDescription } from "node-opcua-service-endpoints";
+export interface OPCUAServerEndPointOptions {
+    /**
+     * the tcp port
+     */
+    port: number;
+    /**
+     * the DER certificate chain
+     */
+    certificateChain: Certificate;
+    /**
+     * privateKey
+     */
+    privateKey: PrivateKeyPEM;
+    certificateManager: OPCUACertificateManager;
+    /**
+     *  the default secureToken lifetime @default=60000
+     */
+    defaultSecureTokenLifetime?: number;
+    /**
+     * the maximum number of connection allowed on the TCP server socket
+     * @default 20
+     */
+    maxConnections?: number;
+    /**
+     *  the  timeout for the TCP HEL/ACK transaction (in ms)
+     *  @default 30000
+     */
+    timeout?: number;
+    serverInfo: ApplicationDescription;
+    objectFactory?: any;
+}
+export interface EndpointDescriptionParams {
+    allowAnonymous?: boolean;
+    restricted?: boolean;
+    allowUnsecurePassword?: boolean;
+    resourcePath?: string;
+    alternateHostname?: string[];
+    hostname: string;
+    securityPolicies: SecurityPolicy[];
+}
+export interface AddStandardEndpointDescriptionsParam {
+    securityModes?: MessageSecurityMode[];
+    securityPolicies?: SecurityPolicy[];
+    disableDiscovery?: boolean;
+    allowAnonymous?: boolean;
+    restricted?: boolean;
+    hostname?: string;
+    alternateHostname?: string[];
+    allowUnsecurePassword?: boolean;
+    resourcePath?: string;
+}
+/**
+ * OPCUAServerEndPoint a Server EndPoint.
+ * A sever end point is listening to one port
+ * note:
+ *   see OPCUA Release 1.03 part 4 page 108 7.1 ApplicationDescription
+ */
+export declare class OPCUAServerEndPoint extends EventEmitter implements ServerSecureChannelParent {
+    /**
+     * the tcp port
+     */
+    port: number;
+    certificateManager: OPCUACertificateManager;
+    defaultSecureTokenLifetime: number;
+    maxConnections: number;
+    timeout: number;
+    bytesWrittenInOldChannels: number;
+    bytesReadInOldChannels: number;
+    transactionsCountOldChannels: number;
+    securityTokenCountOldChannels: number;
+    serverInfo: ApplicationDescription;
+    objectFactory: any;
+    _on_new_channel?: (channel: ServerSecureChannelLayer) => void;
+    _on_close_channel?: (channel: ServerSecureChannelLayer) => void;
+    _on_connectionRefused?: (socketData: any) => void;
+    _on_openSecureChannelFailure?: (socketData: any, channelData: any) => void;
+    private _certificateChain;
+    private _privateKey;
+    private _channels;
+    private _server?;
+    private _endpoints;
+    private _listen_callback;
+    private _started;
+    private _counter;
+    private _policy_deduplicator;
+    constructor(options: OPCUAServerEndPointOptions);
+    dispose(): void;
+    toString(): string;
+    getChannels(): ServerSecureChannelLayer[];
+    /**
+     * Returns the X509 DER form of the server certificate
+     */
+    getCertificate(): Certificate;
+    /**
+     * Returns the X509 DER form of the server certificate
+     */
+    getCertificateChain(): Certificate;
+    /**
+     * the private key
+     */
+    getPrivateKey(): PrivateKeyPEM;
+    /**
+     * The number of active channel on this end point.
+     */
+    get currentChannelCount(): number;
+    /**
+     * @method getEndpointDescription
+     * @param securityMode
+     * @param securityPolicy
+     * @return endpoint_description {EndpointDescription|null}
+     */
+    getEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, endpointUrl: string | null): EndpointDescription | null;
+    addEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, options?: EndpointDescriptionParams): void;
+    addRestrictedEndpointDescription(options: EndpointDescriptionParams): void;
+    addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void;
+    /**
+     * returns the list of end point descriptions.
+     */
+    endpointDescriptions(): EndpointDescription[];
+    /**
+     * @method listen
+     * @async
+     */
+    listen(callback: (err?: Error) => void): void;
+    killClientSockets(callback: (err?: Error) => void): void;
+    suspendConnection(callback: (err?: Error) => void): void;
+    restoreConnection(callback: (err?: Error) => void): void;
+    abruptlyInterruptChannels(): void;
+    /**
+     * @method shutdown
+     * @async
+     */
+    shutdown(callback: (err?: Error) => void): void;
+    /**
+     * @method start
+     * @async
+     * @param callback
+     */
+    start(callback: (err?: Error) => void): void;
+    get bytesWritten(): number;
+    get bytesRead(): number;
+    get transactionsCount(): number;
+    get securityTokenCount(): number;
+    get activeChannelCount(): number;
+    private _dump_statistics;
+    private _setup_server;
+    private _on_client_connection;
+    private _preregisterChannel;
+    private _un_pre_registerChannel;
+    /**
+     * @method _registerChannel
+     * @param channel
+     * @private
+     */
+    private _registerChannel;
+    /**
+     * @method _unregisterChannel
+     * @param channel
+     * @private
+     */
+    private _unregisterChannel;
+    private _end_listen;
+    /**
+     *  shutdown_channel
+     * @param channel
+     * @param inner_callback
+     */
+    private shutdown_channel;
+    /**
+     * @private
+     */
+    private _prevent_DDOS_Attack;
+}