/* ========================================================================
* 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.IO;
using System.Threading;
using System.Threading.Tasks;
namespace Opc.Ua.Bindings.Pcap.KeyLog
{
///
/// Default key escrow provider that writes encrypted key-log
/// artifacts into the capture session folder.
///
internal sealed class DiskKeyEscrowProvider : IKeyEscrowProvider
{
internal const string KeyLogJsonFileName = "keys.uakeys.json";
internal const string KeyLogTextFileName = "keys.uakeys.txt";
///
public ValueTask BeginSessionAsync(
string sessionId,
string sessionFolder,
CancellationToken cancellationToken)
{
ArgumentException.ThrowIfNullOrWhiteSpace(sessionId);
ArgumentException.ThrowIfNullOrWhiteSpace(sessionFolder);
cancellationToken.ThrowIfCancellationRequested();
Directory.CreateDirectory(sessionFolder);
string jsonPath = Path.Combine(sessionFolder, KeyLogJsonFileName);
string textPath = Path.Combine(sessionFolder, KeyLogTextFileName);
// CA2000: ownership of the DiskKeyEscrowSession transfers to the caller via
// the returned ValueTask; the caller is responsible for DisposeAsync.
#pragma warning disable CA2000
return new ValueTask(new DiskKeyEscrowSession(jsonPath, textPath));
#pragma warning restore CA2000
}
///
public ValueTask DisposeAsync()
{
return ValueTask.CompletedTask;
}
}
///
/// Per-session disk escrow handle.
///
internal sealed class DiskKeyEscrowSession : IKeyEscrowSession
{
private readonly string m_jsonPath;
private readonly string m_textPath;
private UaKeyLogJsonWriter? m_jsonWriter;
private UaKeyLogTextWriter? m_textWriter;
public DiskKeyEscrowSession(string jsonPath, string textPath)
{
ArgumentException.ThrowIfNullOrWhiteSpace(jsonPath);
ArgumentException.ThrowIfNullOrWhiteSpace(textPath);
m_jsonPath = jsonPath;
m_textPath = textPath;
}
///
public async ValueTask EscrowAsync(ChannelKeyMaterial material, CancellationToken ct)
{
ArgumentNullException.ThrowIfNull(material);
EnsureWriters();
await m_jsonWriter!.AppendAsync(material, ct).ConfigureAwait(false);
await m_textWriter!.AppendAsync(material, ct).ConfigureAwait(false);
}
///
public async ValueTask FlushAsync(CancellationToken ct)
{
if (m_jsonWriter is not null)
{
await m_jsonWriter.FlushAsync(ct).ConfigureAwait(false);
}
if (m_textWriter is not null)
{
await m_textWriter.FlushAsync(ct).ConfigureAwait(false);
}
}
///
public async ValueTask DisposeAsync()
{
if (m_jsonWriter is not null)
{
await m_jsonWriter.DisposeAsync().ConfigureAwait(false);
m_jsonWriter = null;
}
if (m_textWriter is not null)
{
await m_textWriter.DisposeAsync().ConfigureAwait(false);
m_textWriter = null;
}
}
private void EnsureWriters()
{
if (m_jsonWriter is not null && m_textWriter is not null)
{
return;
}
byte[] sessionKey = SessionKeyManager.CreateAndPersistKey(m_jsonPath);
m_jsonWriter = new UaKeyLogJsonWriter(m_jsonPath, sessionKey);
m_textWriter = new UaKeyLogTextWriter(m_textPath, sessionKey);
}
}
}