mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-11 19:44:52 +00:00
refactor: updated method by which the Factories assess secret objects refactor: updated 'SecretsManager' console responses feat: added 'secretproviderlist' console command feat: added 'secretproviderinfo' console command feat: added 'CrestronGlobalSecretsProvider' feat: Added 'Description' property to 'ISecretProvider' feat: added 'TestSecret' method to 'ISecretProvider' docs: added xml comments to 'ISecretProvider' docs: added xml comments to 'ISecret' refactor: cleaned up crestron default secrets provider classes refactor: moved 'CrestronSecret' to its own class file refactor: overhauled all secrets-related console commands resolves #968
102 lines
3.5 KiB
C#
102 lines
3.5 KiB
C#
using System;
|
|
using Crestron.SimplSharp;
|
|
using Crestron.SimplSharp.CrestronDataStore;
|
|
using PepperDash.Core;
|
|
|
|
|
|
namespace PepperDash.Essentials.Core
|
|
{
|
|
public class CrestronGlobalSecretsProvider : ISecretProvider
|
|
{
|
|
public string Key { get; set; }
|
|
//Added for reference
|
|
public string Description { get; private set; }
|
|
|
|
public CrestronGlobalSecretsProvider(string key)
|
|
{
|
|
Key = key;
|
|
Description = String.Format("Default secret provider serving all local applications");
|
|
|
|
}
|
|
|
|
static CrestronGlobalSecretsProvider()
|
|
{
|
|
//Added for future encrypted reference
|
|
var secureSupported = CrestronSecureStorage.Supported;
|
|
|
|
CrestronDataStoreStatic.InitCrestronDataStore();
|
|
if (secureSupported)
|
|
{
|
|
//doThingsFuture
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Set secret for item in the CrestronSecretsProvider
|
|
/// </summary>
|
|
/// <param name="key">Secret Key</param>
|
|
/// <param name="value">Secret Value</param>
|
|
public bool SetSecret(string key, object value)
|
|
{
|
|
var secret = value as string;
|
|
CrestronDataStore.CDS_ERROR returnCode;
|
|
|
|
if (String.IsNullOrEmpty(secret))
|
|
{
|
|
returnCode = CrestronDataStoreStatic.clearGlobal(key);
|
|
if (returnCode == CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
|
|
{
|
|
Debug.Console(0, this, "Successfully removed secret \"{0}\"", secret);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
else
|
|
{
|
|
returnCode = CrestronDataStoreStatic.SetGlobalStringValue(key, secret);
|
|
if (returnCode == CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
|
|
{
|
|
Debug.Console(0, this, "Successfully set secret \"{0}\"", secret);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "Unable to set secret for {0}:{1} - {2}", Key, key, returnCode.ToString());
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieve secret for item in the CrestronSecretsProvider
|
|
/// </summary>
|
|
/// <param name="key">Secret Key</param>
|
|
/// <returns>ISecret Object containing key, provider, and value</returns>
|
|
public ISecret GetSecret(string key)
|
|
{
|
|
string mySecret;
|
|
var getErrorCode = CrestronDataStoreStatic.GetGlobalStringValue(key, out mySecret);
|
|
|
|
switch (getErrorCode)
|
|
{
|
|
case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
|
|
Debug.Console(2, this, "Secret Successfully retrieved for {0}:{1}", Key, key);
|
|
return new CrestronSecret(key, mySecret, this);
|
|
default:
|
|
Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "Unable to retrieve secret for {0}:{1} - {2}",
|
|
Key, key, getErrorCode.ToString());
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determine if a secret is present within the provider without retrieving it
|
|
/// </summary>
|
|
/// <param name="key">Secret Key</param>
|
|
/// <returns>bool if present</returns>
|
|
public bool TestSecret(string key)
|
|
{
|
|
string mySecret;
|
|
return CrestronDataStoreStatic.GetGlobalStringValue(key, out mySecret) == CrestronDataStore.CDS_ERROR.CDS_SUCCESS;
|
|
}
|
|
}
|
|
|
|
} |