.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaServer.AuditEventModel Class Reference

Inherits UnifiedAutomation.UaServer.BaseEventModel.

Inherited by UnifiedAutomation.UaServer.AuditNodeManagementEventModel, UnifiedAutomation.UaServer.AuditSecurityEventModel, UnifiedAutomation.UaServer.AuditUpdateEventModel, and UnifiedAutomation.UaServer.AuditUpdateMethodEventModel.

Public Member Functions

 AuditEventModel ()
 Initializes a new instance of the AuditEventModel class. More...
 
 AuditEventModel (AuditEventModel template)
 Initializes a new instance of the AuditEventModel class. More...
 
override void UpdateEvent (GenericEvent e)
 Updates the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseEventModel
 BaseEventModel ()
 Initializes a new instance of the BaseEventModel class. More...
 
 BaseEventModel (BaseEventModel template)
 Initializes a new instance of the BaseEventModel class. More...
 
void NewId ()
 Assigns a new EventId, Time and ReceiveTime to the event. More...
 
virtual GenericEvent CreateEvent (FilterManager manager)
 Creates the event. More...
 
virtual GenericEvent CreateEvent (FilterManager manager, bool autoGenerateEventIdAndTime)
 Creates the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 

Properties

DateTime ActionTimeStamp [get, set]
 Identifies the time the user initiated the action that resulted in the AuditEvent being generated. More...
 
string ClientAuditEntryId [get, set]
 Contains the human-readable AuditEntryId. More...
 
string ClientUserId [get, set]
 Identifies the user of the client requesting an action. More...
 
string ServerId [get, set]
 Uniquely identifies the Server generating the Event. More...
 
bool Status [get, set]
 Identifies whether the requested action could be performed. More...
 
- Properties inherited from UnifiedAutomation.UaServer.BaseEventModel
NodeId NodeId [get, set]
 The node identifier for a representation of an event in the Server address space. Used mainly for ConditionIds. More...
 
byte[] EventId [get, set]
 Generated by the server to uniquely identify a particular Event Notification. More...
 
NodeId EventType [get, set]
 Describes the specific type of Event. More...
 
NodeId SourceNode [get, set]
 Identifies the Node that the Event originated from. More...
 
string SourceName [get, set]
 Provides a description of the source of the Event. More...
 
DateTime Time [get, set]
 Provides the time the Event occurred. More...
 
DateTime ReceiveTime [get, set]
 Provides the time the OPC UA Server received the Event from the underlying device of another Server. More...
 
TimeZoneDataType LocalTime [get, set]
 Contains the Offset and the DaylightSavingInOffset flag. More...
 
LocalizedText Message [get, set]
 Provides a human-readable and localizable text description of the Event. More...
 
ushort Severity [get, set]
 An indication of the urgency of the Event. More...
 
INodeAccessInfo NodeAccessInfo [get, set]
 Using a NodeAccessInfo can restrict the access of an event to single scopes. More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 

Detailed Description

OPC UA includes support for security audit trails with traceability between Client and Server audit logs. OPC UA defines audit events for security related client actions, like creating a connection with a server, and also audit events for actions changing the system, like write calls to variables or method calls. If a security-related problem is detected at the Server, the associated Client audit log entry can be located and examined. OPC UA also provides the capability for Servers to generate Event Notifications that report auditable Events to Clients capable of processing and logging them. OPC UA defines security audit parameters that can be included in audit log entries and in audit Event Notifications.

AuditEvents are Events of AuditEventType or subtypes that are generated as a result of an action taken on the Server by a Client of the Server. For example, in response to a Client issuing a write to a Variable, the Server would generate an AuditEvent describing the Variable as the source and the user and Client session as the initiators of the Event.

OPC UA Servers create audit events for an auditable action request. If the action is accepted, then an action AuditEvent is generated and processed by the Server. If the action is not accepted due to security reasons, a security AuditEvent is generated and processed by the Server. The Server may involve the underlying device or system in the process, but it is the Server’s responsibility to provide the Event to any interested Clients. Clients are free to subscribe to Events from the Server and will receive the AuditEvents in response to normal Publish requests.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AuditEventModel.AuditEventModel ( )
inline

Initializes a new instance of the AuditEventModel class.

UnifiedAutomation.UaServer.AuditEventModel.AuditEventModel ( AuditEventModel  template)
inline

Initializes a new instance of the AuditEventModel class.

Parameters
templateThe template.

Member Function Documentation

override void UnifiedAutomation.UaServer.AuditEventModel.UpdateEvent ( GenericEvent  e)
inlinevirtual

Updates the event.

Parameters
eThe event to update.

Reimplemented from UnifiedAutomation.UaServer.BaseEventModel.

Reimplemented in UnifiedAutomation.UaServer.TrustListUpdatedAuditEventModel, UnifiedAutomation.UaServer.RoleMappingRuleChangedAuditEventModel, UnifiedAutomation.UaServer.KeyCredentialUpdatedAuditEventModel, UnifiedAutomation.UaServer.KeyCredentialDeletedAuditEventModel, UnifiedAutomation.UaServer.KeyCredentialAuditEventModel, UnifiedAutomation.UaServer.CertificateUpdatedAuditEventModel, UnifiedAutomation.UaServer.ProgramTransitionAuditEventModel, UnifiedAutomation.UaServer.AuditProgramTransitionEventModel, UnifiedAutomation.UaServer.AuditUpdateStateEventModel, UnifiedAutomation.UaServer.AuditConditionSuppressionEventModel, UnifiedAutomation.UaServer.AuditConditionSilenceEventModel, UnifiedAutomation.UaServer.AuditConditionShelvingEventModel, UnifiedAutomation.UaServer.AuditConditionRespondEventModel, UnifiedAutomation.UaServer.AuditConditionResetEventModel, UnifiedAutomation.UaServer.AuditConditionOutOfServiceEventModel, UnifiedAutomation.UaServer.AuditConditionEnableEventModel, UnifiedAutomation.UaServer.AuditConditionConfirmEventModel, UnifiedAutomation.UaServer.AuditConditionCommentEventModel, UnifiedAutomation.UaServer.AuditConditionAcknowledgeEventModel, UnifiedAutomation.UaServer.AuditConditionEventModel, UnifiedAutomation.UaServer.AuditUpdateMethodEventModel, UnifiedAutomation.UaServer.AuditWriteUpdateEventModel, UnifiedAutomation.UaServer.AuditHistoryValueUpdateEventModel, UnifiedAutomation.UaServer.AuditHistoryEventUpdateEventModel, UnifiedAutomation.UaServer.AuditHistoryRawModifyDeleteEventModel, UnifiedAutomation.UaServer.AuditHistoryEventDeleteEventModel, UnifiedAutomation.UaServer.AuditHistoryAtTimeDeleteEventModel, UnifiedAutomation.UaServer.AuditHistoryDeleteEventModel, UnifiedAutomation.UaServer.AuditHistoryAnnotationUpdateEventModel, UnifiedAutomation.UaServer.AuditHistoryUpdateEventModel, UnifiedAutomation.UaServer.AuditUpdateEventModel, UnifiedAutomation.UaServer.AuditUrlMismatchEventModel, UnifiedAutomation.UaServer.AuditCreateSessionEventModel, UnifiedAutomation.UaServer.AuditCancelEventModel, UnifiedAutomation.UaServer.AuditActivateSessionEventModel, UnifiedAutomation.UaServer.AuditSessionEventModel, UnifiedAutomation.UaServer.AuditOpenSecureChannelEventModel, UnifiedAutomation.UaServer.AuditChannelEventModel, UnifiedAutomation.UaServer.AuditCertificateUntrustedEventModel, UnifiedAutomation.UaServer.AuditCertificateRevokedEventModel, UnifiedAutomation.UaServer.AuditCertificateMismatchEventModel, UnifiedAutomation.UaServer.AuditCertificateInvalidEventModel, UnifiedAutomation.UaServer.AuditCertificateExpiredEventModel, UnifiedAutomation.UaServer.AuditCertificateDataMismatchEventModel, UnifiedAutomation.UaServer.AuditCertificateEventModel, UnifiedAutomation.UaServer.AuditSecurityEventModel, UnifiedAutomation.UaServer.AuditDeleteReferencesEventModel, UnifiedAutomation.UaServer.AuditDeleteNodesEventModel, UnifiedAutomation.UaServer.AuditAddReferencesEventModel, UnifiedAutomation.UaServer.AuditAddNodesEventModel, and UnifiedAutomation.UaServer.AuditNodeManagementEventModel.

Property Documentation

DateTime UnifiedAutomation.UaServer.AuditEventModel.ActionTimeStamp
getset

Identifies the time the user initiated the action that resulted in the AuditEvent being generated.

It differs from the Time Property because this is the time the server generated the AuditEvent documenting the action.

string UnifiedAutomation.UaServer.AuditEventModel.ClientAuditEntryId
getset

Contains the human-readable AuditEntryId.

All action requests include a human readable AuditEntryId. The AuditEntryId is included in the AuditEvent to allow human readers to correlate an Event with the initiating action. The AuditEntryId typically contains who initiated the action and from where it was initiated.

string UnifiedAutomation.UaServer.AuditEventModel.ClientUserId
getset

Identifies the user of the client requesting an action.

The ClientUserId can be obtained from the UserIdentityToken passed in the ActivateSession call. If the UserIdentityToken is a UserNameIdentityToken, then the ClientUserId is the UserName. If the UserIdentityToken is an X509IdentityToken, then the ClientUserId is the X509 Subject Name of the certificate. If the UserIdentityToken is an IssuedIdentityToken, then the ClientUserId should be a string that represents the owner of the token. The best choice for the string depends on the type of IssuedIdentityToken. If an AnonymousIdentityToken was used, the value is null.

string UnifiedAutomation.UaServer.AuditEventModel.ServerId
getset

Uniquely identifies the Server generating the Event.

It identifies the Server uniquely even in a server-controlled transparent redundancy scenario where several Servers may use the same URI.

bool UnifiedAutomation.UaServer.AuditEventModel.Status
getset

Identifies whether the requested action could be performed.

Set Status to TRUE if the requested action could be performed, or to FALSE if not.


The documentation for this class was generated from the following file: