node-opcua-address-space 2.78.0 → 2.79.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.78.0",
+    "version": "2.79.0",
     "description": "pure nodejs OPCUA SDK - module -address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -16,40 +16,41 @@
         "c": "mocha --version"
     },
     "dependencies": {
-        "@types/lodash": "4.14.184",
+        "@types/lodash": "4.14.185",
+        "@types/semver": "^7.3.12",
         "async": "^3.2.4",
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space-base": "2.78.0",
+        "node-opcua-address-space-base": "2.79.0",
         "node-opcua-assert": "2.77.0",
-        "node-opcua-basic-types": "2.77.0",
+        "node-opcua-basic-types": "2.79.0",
         "node-opcua-binary-stream": "2.77.0",
-        "node-opcua-client-dynamic-extension-object": "2.78.0",
+        "node-opcua-client-dynamic-extension-object": "2.79.0",
         "node-opcua-constants": "2.77.0",
         "node-opcua-crypto": "^1.11.0",
-        "node-opcua-data-access": "2.78.0",
-        "node-opcua-data-model": "2.78.0",
-        "node-opcua-data-value": "2.78.0",
+        "node-opcua-data-access": "2.79.0",
+        "node-opcua-data-model": "2.79.0",
+        "node-opcua-data-value": "2.79.0",
         "node-opcua-date-time": "2.77.0",
         "node-opcua-debug": "2.77.0",
         "node-opcua-enum": "2.77.0",
-        "node-opcua-extension-object": "2.78.0",
-        "node-opcua-factory": "2.78.0",
-        "node-opcua-nodeid": "2.77.0",
-        "node-opcua-nodeset-ua": "2.78.0",
-        "node-opcua-numeric-range": "2.78.0",
+        "node-opcua-extension-object": "2.79.0",
+        "node-opcua-factory": "2.79.0",
+        "node-opcua-nodeid": "2.79.0",
+        "node-opcua-nodeset-ua": "2.79.0",
+        "node-opcua-numeric-range": "2.79.0",
         "node-opcua-object-registry": "2.77.0",
-        "node-opcua-pseudo-session": "2.78.0",
-        "node-opcua-service-browse": "2.78.0",
-        "node-opcua-service-call": "2.78.0",
-        "node-opcua-service-history": "2.78.0",
-        "node-opcua-service-translate-browse-path": "2.78.0",
-        "node-opcua-service-write": "2.78.0",
+        "node-opcua-pseudo-session": "2.79.0",
+        "node-opcua-service-browse": "2.79.0",
+        "node-opcua-service-call": "2.79.0",
+        "node-opcua-service-history": "2.79.0",
+        "node-opcua-service-translate-browse-path": "2.79.0",
+        "node-opcua-service-write": "2.79.0",
         "node-opcua-status-code": "2.77.0",
-        "node-opcua-types": "2.78.0",
+        "node-opcua-types": "2.79.0",
         "node-opcua-utils": "2.77.0",
-        "node-opcua-variant": "2.78.0",
+        "node-opcua-variant": "2.79.0",
         "node-opcua-xml2json": "2.77.0",
         "semver": "^7.3.7",
         "set-prototype-of": "^1.0.0",
@@ -57,14 +58,13 @@
         "xml-writer": "^1.7.0"
     },
     "devDependencies": {
-        "@types/semver": "7.3.12",
         "mocha": "^10.0.0",
         "node-opcua-benchmarker": "2.77.0",
         "node-opcua-leak-detector": "2.77.0",
         "node-opcua-nodesets": "2.77.0",
-        "node-opcua-packet-analyzer": "2.78.0",
-        "node-opcua-service-filter": "2.78.0",
-        "node-opcua-test-fixtures": "2.78.0",
+        "node-opcua-packet-analyzer": "2.79.0",
+        "node-opcua-service-filter": "2.79.0",
+        "node-opcua-test-fixtures": "2.79.0",
         "should": "^13.2.3",
         "sinon": "^14.0.0",
         "source-map-support": "^0.5.21"
@@ -84,5 +84,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "31c6eee3c51f52427584364fff2fdb07bbac65be"
+    "gitHead": "1a6d41827954dccf2c2cdff9344cc11fc99767f3"
 }

package/src/alarms_and_conditions/ua_limit_alarm_impl.ts

@@ -10,7 +10,7 @@ import { make_warningLog } from "node-opcua-debug";
 import { NodeId } from "node-opcua-nodeid";
 import { StatusCodes } from "node-opcua-status-code";
 import { DataType, VariantOptions } from "node-opcua-variant";
-import { UAShelvedStateMachineEx } from "../../source";
+import { UAShelvedStateMachineEx } from "../../source/interfaces/state_machine/ua_shelved_state_machine_ex";
 import { InstantiateLimitAlarmOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_limit_alarm_options";
 import { UALimitAlarmEx } from "../../source/interfaces/alarms_and_conditions/ua_limit_alarm_ex";
 import { NamespacePrivate } from "../namespace_private";

package/src/base_node_impl.ts

@@ -677,6 +677,9 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
         ) {
             return callback(null, StatusCodes.BadAttributeIdInvalid);
         }
+        if (!this.canUserWriteAttribute(context, writeValue.attributeId)) {
+            return callback(null, StatusCodes.BadUserAccessDenied);
+        }
         // by default Node is read-only,
         // this method needs to be overridden to change the behavior
         callback(null, StatusCodes.BadNotWritable);
@@ -1263,6 +1266,23 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
     private _clear_caches() {
         BaseNode_clearCache(this);
     }
+
+    public canUserWriteAttribute(context: ISessionContext | null, attributeId: AttributeIds): boolean {
+        // the Client is allowed to write to Attributes other than the Value,
+        // Historizing or RolePermissions Attribute
+        if (!context) return true;
+        if (attributeId === AttributeIds.Historizing) {
+            return context.checkPermission(this, PermissionType.WriteHistorizing);
+        }
+        if (attributeId === AttributeIds.RolePermissions) {
+            return context.checkPermission(this, PermissionType.WriteRolePermissions);
+        }
+        if (attributeId === AttributeIds.Value) {
+            return context.checkPermission(this, PermissionType.Write);
+        }
+        return context.checkPermission(this, PermissionType.WriteAttribute);
+    }
+
     private _readAccessRestrictions(context: ISessionContext | null): DataValue {
         // https://reference.opcfoundation.org/v104/Core/docs/Part3/8.56/
         if (this.accessRestrictions === undefined) {
@@ -1281,7 +1301,7 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
         // https://reference.opcfoundation.org/v104/Core/docs/Part3/4.8.3/
 
         // to do check that current user can read permission
-        if (context && !context?.checkPermission(this as any, PermissionType.ReadRolePermissions)) {
+        if (context && !context.checkPermission(this, PermissionType.ReadRolePermissions)) {
             return new DataValue({
                 statusCode: StatusCodes.BadSecurityModeInsufficient
             });
@@ -1312,6 +1332,16 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
     }
 
     private _readUserRolePermissions(context: ISessionContext | null): DataValue {
+        const allUserCanSeeTheirOwnRolePermissions = true;
+        if (!allUserCanSeeTheirOwnRolePermissions) {
+            // to do check that current user can read permission
+            if (context && !context.checkPermission(this, PermissionType.ReadRolePermissions)) {
+                return new DataValue({
+                    statusCode: StatusCodes.BadSecurityModeInsufficient
+                });
+            }
+        }
+
         if (this.rolePermissions === undefined) {
             // to do : If not specified, the value of DefaultUserRolePermissions Property from
             // the Namespace Metadata Object associated with the Node is used instead.
@@ -1320,8 +1350,8 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
             });
         }
         const context1: ISessionContext = context === null ? SessionContext.defaultContext : context;
-        // for the time being ...
-        // get user Permission
+
+        // for the time being  get user Permission
         const rolePermissions = this.rolePermissions
             .map(({ roleId, permissions }) => {
                 return new RolePermissionType({
@@ -1330,6 +1360,7 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
                 });
             })
             .filter(({ roleId }) => context1.currentUserHasRole(roleId));
+
         return new DataValue({
             statusCode: StatusCodes.Good,
             value: {

package/src/historical_access/address_space_historical_data_node.ts

@@ -172,7 +172,7 @@ export class VariableHistorian implements IVariableHistorian {
         reverseDataValue: boolean,
         callback: CallbackT<DataValue[]>
     ): void {
-        assert(typeof callback === 'function');
+        assert(typeof callback === "function");
 
         let dataValues = filter_dequeue(this._timeline, historyReadRawModifiedDetails, maxNumberToExtract, isReversed);
 
@@ -322,7 +322,7 @@ function _historyReadRawAsync(
     reverseDataValue: boolean,
     callback: CallbackT<DataValue[]>
 ) {
-    assert(typeof callback === 'function');
+    assert(typeof callback === "function");
     this.varHistorian!.extractDataValues(historyReadRawModifiedDetails, maxNumberToExtract, isReversed, reverseDataValue, callback);
 }
 
@@ -418,9 +418,17 @@ function _historyReadRaw(
     // the Bad_TimestampNotSupported StatusCode.
 
     const session = context.session;
+
+    // istanbul ignore next
     if (!session) {
         throw new Error("Internal Error: context.session not defined");
     }
+
+    // istanbul ignore next
+    if (!session.continuationPointManager) {
+        throw new Error("Internal Error: context.session.continuationPointManager not defined");
+    }
+
     if (continuationData.continuationPoint) {
         const cnt = session.continuationPointManager.getNextHistoryReadRaw(
             historyReadRawModifiedDetails.numValuesPerNode,
@@ -546,7 +554,14 @@ function _historyRead(
     continuationData: ContinuationData,
     callback: CallbackT<HistoryReadResult>
 ) {
-    assert(typeof callback === 'function');
+    if (!this.canUserReadHistory(context)) {
+        const result = new HistoryReadResult({
+            statusCode: StatusCodes.BadUserAccessDenied
+        });
+        callback(null, result);
+    }
+
+    assert(typeof callback === "function");
     if (historyReadDetails instanceof ReadRawModifiedDetails) {
         // note: only ReadRawModifiedDetails supported at this time
         return this._historyReadRawModify(context, historyReadDetails, indexRange, dataEncoding, continuationData, callback);

package/src/nodeset_tools/nodeset_to_xml.ts

@@ -4,7 +4,7 @@
  */
 // produce nodeset xml files
 import { assert } from "node-opcua-assert";
-import { ObjectIds } from "node-opcua-constants";
+import { ObjectIds, VariableIds } from "node-opcua-constants";
 import { make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 import { ExtensionObject } from "node-opcua-extension-object";
 import {
@@ -16,7 +16,7 @@ import {
     makeAccessLevelFlag,
     QualifiedName
 } from "node-opcua-data-model";
-import { NodeId, NodeIdType, resolveNodeId } from "node-opcua-nodeid";
+import { ExpandedNodeId, NodeId, NodeIdType, resolveNodeId } from "node-opcua-nodeid";
 import * as utils from "node-opcua-utils";
 import { Variant, VariantArrayType, DataType } from "node-opcua-variant";
 import {
@@ -99,10 +99,8 @@ function b(xw: XmlWriter, browseName: QualifiedName): string {
 }
 
 function _dumpReverseReferences(xw: XmlWriter, node: BaseNode) {
-    
     const addressSpace = node.addressSpace;
     const hasSubtypeReferenceType = addressSpace.findReferenceType("HasSubtype")!;
-
 }
 function _dumpReferences(xw: XmlWriter, node: BaseNode) {
     xw.startElement("References");
@@ -217,15 +215,29 @@ function _dumpXmlElement(xw: XmlWriter, v: string) {
 </uax:ExtensionObject>
 */
 type XmlNamespaceUri = string;
+type NamespaceUri = string;
 type XmlNs = string;
 interface XmlWriterEx extends XmlWriter {
     map: Record<XmlNamespaceUri, XmlNs>;
     stackMap: Record<XmlNamespaceUri, XmlNs>[];
+    namespaceArray: NamespaceUri[];
 }
-function initXmlWriterEx(xw: XmlWriter, map: Record<XmlNamespaceUri, XmlNs>): void {
+function initXmlWriterEx(xw: XmlWriter, map: Record<XmlNamespaceUri, XmlNs>, namespaceArray: NamespaceUri[]): void {
     const xwe = xw as XmlWriterEx;
     xwe.map = map;
     xwe.stackMap = [];
+    xwe.namespaceArray = namespaceArray;
+}
+function findXsdNamespaceUri(xw: XmlWriter, nodeId: NodeId): string {
+    const xwe = xw as XmlWriterEx;
+    if (!xwe.namespaceArray) {
+        return "";
+    }
+    const namespace = xwe.namespaceArray[nodeId.namespace];
+    if (namespace === "http://opcfoundation.org/UA/") {
+        return "http://opcfoundation.org/UA/2008/02/Types.xsd";
+    }
+    return namespace.replace(/\/$/, "") + "/Types.xsd";
 }
 
 function getPrefix(xw: XmlWriter, namespace: XmlNamespaceUri): XmlNs {
@@ -290,6 +302,9 @@ function _dumpVariantInnerExtensionObject(
     definition: StructureDefinition,
     value: ExtensionObject
 ) {
+    const namespaceUri = findXsdNamespaceUri(xw, definition.defaultEncodingId);
+    const ns = getPrefix(xw, namespaceUri);
+
     for (const field of definition.fields || []) {
         const dataTypeNodeId = field.dataType;
 
@@ -305,8 +320,11 @@ function _dumpVariantInnerExtensionObject(
                 // to do ?? shall we do a extension Object here ?
                 continue; // ns=0;i=0 is reserved
             }
+
             const { name, definition } = definitionMap.findDefinition(dataTypeNodeId);
-            xw.startElement(fieldName);
+
+            startElementEx(xw, ns, fieldName, namespaceUri);
+            //  xw.startElement(fieldName);
 
             let fun: (value: any) => void = (value: any) => {
                 /** */
@@ -339,6 +357,7 @@ function _dumpVariantInnerExtensionObject(
                 console.log(field);
                 // throw err;
             }
+            restoreDefaultNamespace(xw);
             xw.endElement();
         }
     }
@@ -443,10 +462,13 @@ function _dumpVariantExtensionObjectValue_Body(
     value: any
 ) {
     if (value) {
-        xw.startElement(name);
+        const namespaceUri = findXsdNamespaceUri(xw, definition.defaultEncodingId);
+        const ns = getPrefix(xw, namespaceUri);
+        startElementEx(xw, ns, `${name}`, namespaceUri);
         if (value) {
             _dumpVariantInnerExtensionObject(xw, definitionMap, definition, value);
         }
+        restoreDefaultNamespace(xw);
         xw.endElement();
     }
 }
@@ -877,7 +899,7 @@ function _dumpUADataTypeDefinition(xw: XmlWriter, uaDataType: UADataType) {
 
         const dataValue = uaDataType.readAttribute(SessionContext.defaultContext, AttributeIds.DataTypeDefinition);
 
-        if (dataValue.statusCode === StatusCodes.Good) {
+        if (true || dataValue.statusCode === StatusCodes.Good) {
             const definition = uaDataType.getStructureDefinition();
             const baseDefinition = uaDataTypeBase ? uaDataTypeBase.getStructureDefinition() : null;
             xw.startElement("Definition");
@@ -1332,11 +1354,20 @@ UADataTypeImpl.prototype.dumpXML = function (xw: XmlWriter) {
     dumpUADataType(xw, this);
 };
 
+function makeTypeXsd(namespaceUri: string): string {
+    return namespaceUri.replace(/\/$/, "") + "/Type.xsd";
+}
+
 // eslint-disable-next-line max-statements
 NamespaceImpl.prototype.toNodeset2XML = function (this: NamespaceImpl) {
     const dependency = constructNamespaceDependency(this);
     const translationTable = constructNamespaceTranslationTable(dependency);
 
+    const namespaceArrayNode = this.addressSpace.findNode(VariableIds.Server_NamespaceArray);
+    const namespaceArray: string[] = namespaceArrayNode
+        ? namespaceArrayNode.readAttribute(null, AttributeIds.Value).value.value
+        : [];
+
     const xw = new XMLWriter(true);
     xw.translationTable = translationTable;
 
@@ -1346,17 +1377,30 @@ NamespaceImpl.prototype.toNodeset2XML = function (this: NamespaceImpl) {
     xw.writeAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
     xw.writeAttribute("xmlns:uax", "http://opcfoundation.org/UA/2008/02/Types.xsd");
     xw.writeAttribute("xmlns", "http://opcfoundation.org/UA/2011/03/UANodeSet.xsd");
+
+    const namespacesMap: Record<string, string> = {
+        "http://opcfoundation.org/UA/2011/03/UANodeSet.xsd": "",
+        "http://opcfoundation.org/UA/2008/02/Types.xsd": "uax",
+        "http://www.w3.org/2001/XMLSchema-instance": "xsi"
+    };
+
+    for (const namespace of dependency) {
+        if (namespace.index === 0) {
+            continue;
+        }
+        const translatedIndex = translationTable[namespace.index];
+
+        const smallName = `ns${translatedIndex}`;
+        xw.writeAttribute(`xmlns:${smallName}`, makeTypeXsd(namespace.namespaceUri));
+        namespacesMap[namespace.namespaceUri] = smallName;
+    }
     // xx xw.writeAttribute("Version", "1.02");
     // xx xw.writeAttribute("LastModified", (new Date()).toISOString());
 
     // ------------- INamespace Uris
     xw.startElement("NamespaceUris");
 
-    initXmlWriterEx(xw, {
-        "http://opcfoundation.org/UA/2011/03/UANodeSet.xsd": "",
-        "http://opcfoundation.org/UA/2008/02/Types.xsd": "uax",
-        "http://www.w3.org/2001/XMLSchema-instance": "xsi"
-    });
+    initXmlWriterEx(xw, namespacesMap, namespaceArray);
 
     // xx const namespaceArray = namespace.addressSpace.getNamespaceArray();
     for (const depend of dependency) {

package/src/ua_method_impl.ts

@@ -31,7 +31,7 @@ import {
     defaultCloneFilter,
     defaultCloneExtraInfo
 } from "node-opcua-address-space-base";
-import { SessionContext } from "../source";
+import { SessionContext } from "../source/session_context";
 import { _clone } from "./base_node_private";
 import { _handle_hierarchy_parent } from "./namespace_impl";
 import { BaseNodeImpl } from "./base_node_impl";
@@ -85,7 +85,13 @@ export class UAMethodImpl extends BaseNodeImpl implements UAMethod {
         }
         return true;
     }
-
+    public getUserExecutableFlag(context: ISessionContext | null): boolean {
+        if (context && !context.checkPermission(this, PermissionType.Call)) {
+            return false;
+        }
+        if (!this.getExecutableFlag(context)) return false;
+        return true;
+    }
     /**
      *
      * @returns  true if the method is bound
@@ -107,7 +113,7 @@ export class UAMethodImpl extends BaseNodeImpl implements UAMethod {
                 options.statusCode = StatusCodes.Good;
                 break;
             case AttributeIds.UserExecutable:
-                options.value = { dataType: DataType.Boolean, value: this.getExecutableFlag(context) };
+                options.value = { dataType: DataType.Boolean, value: this.getUserExecutableFlag(context) };
                 options.statusCode = StatusCodes.Good;
                 break;
             default:

package/src/ua_variable_impl.ts

@@ -389,6 +389,25 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.Write, AccessLevelFlag.CurrentWrite);
     }
 
+    public canUserReadHistory(context: ISessionContext): boolean {
+        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.ReadHistory, AccessLevelFlag.HistoryRead);
+    }
+    public canUserWriteHistorizingAttribute(context: ISessionContext): boolean {
+        if (context && !context.checkPermission(this, PermissionType.WriteHistorizing)) {
+            return false;
+        }
+        return true;
+    }
+    public canUserInsertHistory(context: ISessionContext): boolean {
+        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.InsertHistory, AccessLevelFlag.HistoryWrite);
+    }
+    public canUserModifyHistory(context: ISessionContext): boolean {
+        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.ModifyHistory, AccessLevelFlag.HistoryWrite);
+    }
+    public canUserDeleteHistory(context: ISessionContext): boolean {
+        return this.checkPermissionAndAccessLevelPrivate(context, PermissionType.DeleteHistory, AccessLevelFlag.HistoryWrite);
+    }
+
     /**
      *
      *
@@ -949,6 +968,10 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         if (!callback) {
             throw new Error("Internal error");
         }
+
+        if (!this.canUserWriteAttribute(context, writeValueOptions.attributeId!)) {
+            return callback(null, StatusCodes.BadUserAccessDenied);
+        }
         const writeValue: WriteValue =
             writeValueOptions instanceof WriteValue ? (writeValueOptions as WriteValue) : new WriteValue(writeValueOptions);
 
@@ -972,18 +995,20 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
                 break;
             case AttributeIds.Historizing:
                 if (writeValue.value!.value.dataType !== DataType.Boolean) {
-                    return callback(null, StatusCodes.BadNotSupported);
+                    return callback(null, StatusCodes.BadTypeMismatch);
+                }
+                if (!this.canUserWriteHistorizingAttribute(context)) {
+                    return callback(null, StatusCodes.BadUserAccessDenied);
                 }
                 // if the variable has no historizing in place reject
-                if (!(this as any)["hA Configuration"]) {
+                if (!this.getChildByName("HA Configuration")) {
                     return callback(null, StatusCodes.BadNotSupported);
                 }
                 // check if user is allowed to do that !
                 // TODO
-
                 this.historizing = !!writeValue.value!.value.value; // yes ! indeed !
-
                 return callback(null, StatusCodes.Good);
+
             default:
                 super.writeAttribute(context, writeValue, callback);
                 break;
@@ -1496,6 +1521,7 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         if (typeof this._historyRead !== "function") {
             return callback!(null, new HistoryReadResult({ statusCode: StatusCodes.BadNotReadable }));
         }
+
         this._historyRead(context, historyReadDetails, indexRange, dataEncoding, continuationData, callback!);
     }
 
@@ -1534,6 +1560,12 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         continuationData: ContinuationData,
         callback: CallbackT<HistoryReadResult>
     ): void {
+        if (!this.canUserReadHistory(context)) {
+            const result = new HistoryReadResult({
+                statusCode: StatusCodes.BadUserAccessDenied
+            });
+            callback(null, result);
+        }
         const result = new HistoryReadResult({
             statusCode: StatusCodes.BadHistoryOperationUnsupported
         });