/* ========================================================================
 * 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/
 * ======================================================================*/

namespace Opc.Ua
{
    /// <summary>
    /// A lightweight handle that identifies a secret in an
    /// <see cref="ISecretStore"/>. The identifier itself is non-sensitive
    /// — it carries no plaintext — and is safe to log, persist, or pass
    /// across boundaries.
    /// </summary>
    /// <remarks>
    /// The triple <c>(Name, StoreType, StorePath)</c> is the routing key:
    /// <see cref="ISecretRegistry"/> dispatches to the
    /// <see cref="ISecretStore"/> whose
    /// <see cref="ISecretStore.StoreType"/> matches, and the store uses
    /// <see cref="Name"/> (and optionally <see cref="StorePath"/>) to
    /// locate the actual byte material.
    /// </remarks>
    /// <param name="Name">
    /// Logical name within the store (opaque to the registry — a key,
    /// secret-name, GUID, etc.).
    /// </param>
    /// <param name="StoreType">
    /// Store-type discriminator (e.g. <c>"InMemory"</c>, <c>"DPAPI"</c>,
    /// <c>"AzureKeyVault"</c>, <c>"KubernetesSecret"</c>).
    /// </param>
    /// <param name="StorePath">
    /// Optional store-specific path or sub-scope (e.g. a vault URL, a
    /// Kubernetes namespace, a DPAPI scope identifier).
    /// </param>
    public sealed record SecretIdentifier(
        string Name,
        string StoreType,
        string? StorePath = null);
}