Files
Marc Schier 0612a43fe4 Pluggable cryptography and hardware-held private keys (#4192)
Makes the stack's cryptographic operations replaceable - by another library, an offboard service, or hardware (TPM 2.0 / HSM / PKCS#11 token / cloud KMS) - with no performance cost in the default configuration, and extends this to certificates so a private key need never exist in process memory.

Also fixes three pre-existing defects found while validating: STACKGEN001 erroring for every compilation the stack generator was merely loaded into, certificates failing to load from paths past MAX_PATH on Windows, and the MonitoredNode2 tests starving the thread pool.

Fixes #4190
2026-08-09 12:40:26 +02:00

72 lines
2.8 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2025 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.Collections.Generic;
using Microsoft.CodeAnalysis.Diagnostics;
namespace Opc.Ua.SourceGeneration
{
/// <summary>
/// Model compiler options
/// </summary>
internal sealed record class StackGenerationOptions
{
/// <summary>
/// -exclude [id;id;id]
/// </summary>
public IReadOnlyList<string> Exclude { get; set; }
/// <summary>
/// Which part of the stack the compilation opts in to generating.
/// </summary>
/// <remarks>
/// Empty when the project did not opt in, which is the case for every
/// compilation the generator is merely loaded into - a
/// BenchmarkDotNet host project, for instance. Those must compile
/// without the generator contributing anything, so the absence of the
/// property is not an error.
/// </remarks>
public string Mode { get; set; }
/// <summary>
/// Get options from options provider
/// </summary>
/// <param name="provider"></param>
/// <returns></returns>
public static StackGenerationOptions FromProvider(AnalyzerConfigOptionsProvider provider)
{
return new StackGenerationOptions
{
Exclude = provider.GlobalOptions.GetStrings(nameof(Exclude)),
Mode = provider.GlobalOptions.GetString(nameof(Mode))
};
}
}
}