UA-.NETStandard/Stack/Opc.Ua.Bindings.Pcap/Audit/PcapAuditEvent.cs

/* ========================================================================
 * Copyright (c) 2005-2026 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Collections.Generic;

namespace Opc.Ua.Bindings.Pcap.Audit
{
    /// <summary>
    /// Describes one security-sensitive Pcap binding operation. The kind
    /// identifies the operation; the timestamp is the UTC event time; the
    /// optional session id correlates manager and MCP tool events; the
    /// optional resource path names the pcap, keylog, or session folder; the
    /// optional remote endpoint records a peer, listener, or replay target;
    /// and properties hold additional non-secret structured metadata.
    /// </summary>
    public sealed record class PcapAuditEvent
    {
        /// <summary>
        /// Constructs a Pcap audit event.
        /// </summary>
        public PcapAuditEvent(
            PcapAuditEventKind kind,
            DateTimeOffset timestamp,
            string? sessionId,
            string? resourcePath,
            string? remoteEndpoint,
            IReadOnlyDictionary<string, string>? properties)
        {
            if (!Enum.IsDefined(kind))
            {
                throw new ArgumentOutOfRangeException(nameof(kind), kind, "Audit event kind must be defined.");
            }

            if (timestamp == default)
            {
                throw new ArgumentException("Audit event timestamp must be set.", nameof(timestamp));
            }

            Kind = kind;
            Timestamp = timestamp;
            SessionId = sessionId;
            ResourcePath = resourcePath;
            RemoteEndpoint = remoteEndpoint;
            Properties = properties;
        }

        /// <summary>
        /// Gets the security-sensitive operation category.
        /// </summary>
        public PcapAuditEventKind Kind { get; init; }

        /// <summary>
        /// Gets the UTC time when the event occurred.
        /// </summary>
        public DateTimeOffset Timestamp { get; init; }

        /// <summary>
        /// Gets the capture or replay session id, when one exists.
        /// </summary>
        public string? SessionId { get; init; }

        /// <summary>
        /// Gets the pcap, keylog, or session-folder path involved in the operation.
        /// </summary>
        public string? ResourcePath { get; init; }

        /// <summary>
        /// Gets the peer, listener, or replay target endpoint involved in the operation.
        /// </summary>
        public string? RemoteEndpoint { get; init; }

        /// <summary>
        /// Gets non-secret structured metadata for the operation.
        /// </summary>
        public IReadOnlyDictionary<string, string>? Properties { get; init; }
    }
}