/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: IHCVaultClient.cs
*
* IHCVaultClient.cs is part of VNLib.Plugins.Extensions.Loading which is
* part of the larger VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Net.Http;
using System.Threading.Tasks;
namespace VNLib.Plugins.Extensions.Loading
{
///
/// A Hashicorp Vault client for reading secrets from a vault server
///
public interface IHCVaultClient
{
///
/// Reads a single KeyValue secret from the vault server asyncrhonously and returns the result
/// or null if the secret does not exist
///
/// The path to the item within the store
/// The vault mount points
/// The name of the secret within the property array to retrieve
/// The secret wrapper if found, null otherwise
///
///
///
///
Task ReadSecretAsync(string path, string mountPoint, string secretName);
///
/// Reads a single KeyValue secret from the vault server syncrhonously and returns the result
/// or null if the secret does not exist
///
/// The path to the item within the store
/// The vault mount points
/// The name of the secret within the property array to retrieve
/// The secret wrapper if found, null otherwise
///
///
///
///
ISecretResult? ReadSecret(string path, string mountPoint, string secretName);
}
}