Merge pull request #1909 from OPCFoundation/master370

Fixed ReportAuditCreateSessionEvent, removed unnecessary calls and added ReportAuditUpdateMethodEvent

Author: mrsuciu

Libraries/Opc.Ua.Server/Diagnostics/CustomNodeManager.cs

@@ -400,22 +400,6 @@ public NodeId CreateNode(
                 instance.Create(contextToUse, null, browseName, null, true);
                 AddPredefinedNode(contextToUse, instance);
 
-                // report audit event
-                if (Server?.EventManager?.ServerAuditing == true)
-                {
-                    // current server supports auditing, prepare the added nodes info
-                    AddNodesItem[] addNodesItems = GetFlattenedNodeTree(context, instance).Select(n => new AddNodesItem() {
-                        BrowseName = n.BrowseName,
-                        NodeClass = n.NodeClass,
-                        RequestedNewNodeId = n.NodeId,
-                        TypeDefinition = n.TypeDefinitionId,
-                        ReferenceTypeId = n.ReferenceTypeId,
-                        ParentNodeId = n.Parent?.NodeId
-                    }).ToArray();
-
-                    ReportAuditAddNodesEvent(context, addNodesItems, "CreateNode", StatusCodes.Good);
-                }
-
                 return instance.NodeId;
             }
         }
@@ -443,18 +427,6 @@ public bool DeleteNode(
 
                 if (PredefinedNodes.TryGetValue(nodeId, out node))
                 {
-                    // report audit event
-                    if (Server?.EventManager?.ServerAuditing == true)
-                    {
-                        // current server supports auditing, prepare the deleted nodes info
-                        DeleteNodesItem[] nodesToDelete = GetFlattenedNodeTree(context, node as BaseInstanceState).Select(n => new DeleteNodesItem() {
-                            NodeId = n.NodeId,
-                            DeleteTargetReferences = true
-                        }).ToArray();
-
-                        ReportAuditDeleteNodesEvent(context, nodesToDelete, "DeleteNode", StatusCodes.Good);
-                    }
-
                     RemovePredefinedNode(contextToUse, node, referencesToRemove);
                     found = true;
                 }
@@ -740,36 +712,6 @@ protected virtual void RemovePredefinedNode(
             }
         }
 
-
-        /// <summary>
-        /// Get the flattened tree of nodes starting from the specified node
-        /// </summary>
-        /// <param name="context">Current server context.</param>
-        /// <param name="rootNode">The root node from where the search begins.</param>
-        /// <returns></returns>
-        protected IList<BaseInstanceState> GetFlattenedNodeTree(ISystemContext context, BaseInstanceState rootNode)
-        {
-            if (rootNode == null) return new List<BaseInstanceState>();
-
-            List<BaseInstanceState> nodes = new List<BaseInstanceState>() { rootNode };
-            List<BaseInstanceState> results = new List<BaseInstanceState> { rootNode };
-            while (nodes.Count > 0)
-            {
-                List<BaseInstanceState> childNodes = new List<BaseInstanceState>();
-                foreach (BaseInstanceState node in nodes)
-                {
-                    IList<BaseInstanceState> children = new List<BaseInstanceState>();
-                    node.GetChildren(context, children);
-
-                    childNodes.AddRange(children);
-                    results.AddRange(children);
-                }
-                nodes = childNodes;
-            }
-
-            return results;
-        }
-
         /// <summary>
         /// Called after a node has been deleted.
         /// </summary>
@@ -5104,6 +5046,62 @@ protected void ReportAuditDeleteNodesEvent(ISystemContext systemContext, DeleteN
                 Utils.LogError(ex, "Error while reporting AuditDeleteNodesEvent event.");
             }
         }
+
+        /// <summary>
+        /// Reports the AuditUpdateMethodEventType
+        /// </summary>
+        /// <param name="systemContext">Server information.</param>
+        /// <param name="objectId">The id of the object where the method is executed.</param>
+        /// <param name="methodId">The NodeId of the object that the method resides in.</param>
+        /// <param name="inputArgs">The InputArguments of the method </param>
+        /// <param name="customMessage">Custom message for delete nodes.</param>
+        /// <param name="statusCode">The resulting status code.</param>
+        protected void ReportAuditUpdateMethodEvent(ISystemContext systemContext,
+            NodeId objectId,
+            NodeId methodId,
+            object[] inputArgs,
+            string customMessage,
+            StatusCode statusCode)
+        {
+            if (Server?.EventManager?.ServerAuditing != true)
+            {
+                // current server does not support auditing
+                return;
+            }
+            try
+            {
+                AuditUpdateMethodEventState e = new AuditUpdateMethodEventState(null);
+
+                TranslationInfo message = new TranslationInfo(
+                           "AuditUpdateMethodEventState",
+                           "en-US",
+                           $"'{customMessage}' returns StatusCode: {statusCode.ToString(null, CultureInfo.InvariantCulture)}.");
+
+                e.Initialize(
+                   systemContext,
+                   null,
+                   EventSeverity.Min,
+                   new LocalizedText(message),
+                   StatusCode.IsGood(statusCode),
+                   DateTime.UtcNow);  // initializes Status, ActionTimeStamp, ServerId, ClientAuditEntryId, ClientUserId
+
+                e.SetChildValue(systemContext, BrowseNames.SourceNode, objectId, false);
+                e.SetChildValue(systemContext, BrowseNames.SourceName, "Attribute/Call", false);
+                e.SetChildValue(systemContext, BrowseNames.LocalTime, Utils.GetTimeZoneInfo(), false);
+
+                e.SetChildValue(systemContext, BrowseNames.ClientUserId, systemContext?.UserIdentity?.DisplayName, false);
+                e.SetChildValue(systemContext, BrowseNames.ClientAuditEntryId, systemContext?.AuditEntryId, false);
+
+                e.SetChildValue(systemContext, BrowseNames.MethodId, methodId, false);
+                e.SetChildValue(systemContext, BrowseNames.InputArguments, inputArgs, false);
+
+                Server.ReportEvent(systemContext, e);
+            }
+            catch (Exception ex)
+            {
+                Utils.LogError(ex, "Error while reporting AuditDeleteNodesEvent event.");
+            }
+        }
         #endregion Report Audit Events
 
         #region ComponentCache Functions

Libraries/Opc.Ua.Server/Server/ServerInternalData.cs

@@ -837,6 +837,7 @@ public void ReportAuditCreateSessionEvent(string auditEntryId, Session session,
 
                 InitializeAuditSessionEvent(systemContext, e, message, exception == null, session, auditEntryId);
 
+                e.SetChildValue(systemContext, BrowseNames.ClientUserId, "System/CreateSession", false);
                 e.SetChildValue(systemContext, BrowseNames.SourceName, "Session/CreateSession", false);
 
                 // set AuditCreateSessionEventState fields