Essentials/essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/Interfaces.cs

using PepperDash.Core;

namespace PepperDash.Essentials.Core
{
    /// <summary>
    /// All ISecrecretProvider classes must implement this interface.
    /// </summary>
    public interface ISecretProvider : IKeyed
    {
        /// <summary>
        /// Set secret value for provider by key
        /// </summary>
        /// <param name="key">key of secret to set</param>
        /// <param name="value">value to set secret to</param>
        /// <returns></returns>
        bool SetSecret(string key, object value);

        /// <summary>
        /// Return object containing secret from provider
        /// </summary>
        /// <param name="key">key of secret to retrieve</param>
        /// <returns></returns>
        ISecret GetSecret(string key);

        /// <summary>
        /// Verifies presence of secret
        /// </summary>
        /// <param name="key">key of secret to chek</param>
        /// <returns></returns>
        bool TestSecret(string key);

        /// <summary>
        /// Description of the secrets provider
        /// </summary>
        string Description { get; }
    }

    /// <summary>
    /// interface for delivering secrets in Essentials.
    /// </summary>
    public interface ISecret
    {
        /// <summary>
        /// Instance of ISecretProvider that the secret belongs to
        /// </summary>
        ISecretProvider Provider { get; }

        /// <summary>
        /// Key of the secret in the provider
        /// </summary>
        string Key { get; }

        /// <summary>
        /// Value of the secret
        /// </summary>
        object Value { get; }
    }
}