pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-15 20:54:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Resoves #688

Browse Source 
Added some QoL improvements to SecretsManager meant to protect the integrity of the providers dictionary from accidental manipulation

Debug statement improvements

Improvements to verbosity of console command returns for the SecretsManager
This commit is contained in:
Trevor Payne
2021-04-16 12:29:41 -05:00
parent 452d0a5a39
commit 3c9ca1e527
4 changed files with 97 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
essentials-framework/Essentials Core/PepperDashEssentialsBase/Factory/DeviceFactory.cs
View File

@@ -93,7 +93,8 @@ namespace PepperDash.Essentials.Core
{ {
if (prop.Name.ToLower() == "secret") if (prop.Name.ToLower() == "secret")
{ {
var secret = GetSecret(JsonConvert.DeserializeObject<SecretsPropertiesConfig>(prop.Children().First().ToString())); var secret = GetSecret(prop.Children().First().ToObject<SecretsPropertiesConfig>());
//var secret = GetSecret(JsonConvert.DeserializeObject<SecretsPropertiesConfig>(prop.Children().First().ToString()));
prop.Parent.Replace(secret); prop.Parent.Replace(secret);
} }
var recurseProp = prop.Value as JObject; var recurseProp = prop.Value as JObject;
@@ -152,7 +153,9 @@ namespace PepperDash.Essentials.Core
} }
catch (Exception ex) catch (Exception ex)
{ {
Debug.Console(2, "Issue with getting device - {0}", ex.Message); Debug.Console(0, Debug.ErrorLogLevel.Error, "Exception occurred while creating device {0}: {1}", dc.Key, ex.Message);
Debug.Console(2, "{0}", ex.StackTrace);
return null; return null;
} }
} }

29
essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/CrestronSecretsProvider.cs
View File

@@ -10,19 +10,22 @@ namespace PepperDash.Essentials.Core
{ {
public string Key { get; set; } public string Key { get; set; }
//Added for reference //Added for reference
//private readonly bool _secureSupported; private static readonly bool SecureSupported;
public CrestronSecretsProvider(string key) public CrestronSecretsProvider(string key)
{ {
Key = key; Key = key;
}
static CrestronSecretsProvider()
{
//Added for future encrypted reference //Added for future encrypted reference
//_secureSupported = CrestronSecureStorage.Supported; SecureSupported = CrestronSecureStorage.Supported;
//if (_secureSupported)
//{
// return;
//}
CrestronDataStoreStatic.InitCrestronDataStore(); CrestronDataStoreStatic.InitCrestronDataStore();
if (SecureSupported)
{
//doThingsFuture
}
} }
/// <summary> /// <summary>
@@ -30,23 +33,23 @@ namespace PepperDash.Essentials.Core
/// </summary> /// </summary>
/// <param name="key">Secret Key</param> /// <param name="key">Secret Key</param>
/// <param name="value">Secret Value</param> /// <param name="value">Secret Value</param>
public void SetSecret(string key, object value) public bool SetSecret(string key, object value)
{ {
var secret = value as string; var secret = value as string;
if (String.IsNullOrEmpty(secret)) if (String.IsNullOrEmpty(secret))
{ {
Debug.Console(2, this, "Unable to set secret for {0}:{1} - value is empty.", Key, key); Debug.Console(2, this, "Unable to set secret for {0}:{1} - value is empty.", Key, key);
return; return false;
} }
var setErrorCode = CrestronDataStoreStatic.SetLocalStringValue(key, secret); var setErrorCode = CrestronDataStoreStatic.SetLocalStringValue(key, secret);
switch (setErrorCode) switch (setErrorCode)
{ {
case CrestronDataStore.CDS_ERROR.CDS_SUCCESS: case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
Debug.Console(2, this,"Secret Successfully Set for {0}:{1}", Key, key); Debug.Console(1, this,"Secret Successfully Set for {0}:{1}", Key, key);
break; return true;
default: default:
Debug.Console(2, this, Debug.ErrorLogLevel.Notice, "Unable to set secret for {0}:{1} - {2}", Key, key, setErrorCode.ToString()); Debug.Console(2, this, Debug.ErrorLogLevel.Notice, "Unable to set secret for {0}:{1} - {2}", Key, key, setErrorCode.ToString());
break; return false;
} }
} }
@@ -68,7 +71,7 @@ namespace PepperDash.Essentials.Core
default: default:
Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "Unable to retrieve secret for {0}:{1} - {2}", Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "Unable to retrieve secret for {0}:{1} - {2}",
Key, key, getErrorCode.ToString()); Key, key, getErrorCode.ToString());
return new CrestronSecret(key, String.Empty, this); return null;
} }
} }
} }

2
essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/Interfaces.cs
View File

@@ -7,7 +7,7 @@ namespace PepperDash.Essentials.Core
/// </summary> /// </summary>
public interface ISecretProvider : IKeyed public interface ISecretProvider : IKeyed
{ {
void SetSecret(string key, object value); bool SetSecret(string key, object value);
ISecret GetSecret(string key); ISecret GetSecret(string key);
} }

93
essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/SecretsManager.cs
View File

@@ -1,6 +1,5 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using Crestron.SimplSharp; using Crestron.SimplSharp;
using PepperDash.Core; using PepperDash.Core;
@@ -9,14 +8,15 @@ namespace PepperDash.Essentials.Core
{ {
public static class SecretsManager public static class SecretsManager
{ {
public static List<ISecretProvider> Secrets { get; set; } public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
/// <summary> /// <summary>
/// Initialize the SecretsManager /// Initialize the SecretsManager
/// </summary> /// </summary>
public static void Initialize() public static void Initialize()
{ {
Secrets = new List<ISecretProvider> {new CrestronSecretsProvider("default")};
AddSecretProvider("default", new CrestronSecretsProvider("default"));
CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret", CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret",
"Adds secrets to secret provider", "Adds secrets to secret provider",
@@ -29,18 +29,24 @@ namespace PepperDash.Essentials.Core
CrestronConsole.AddNewConsoleCommand(DeleteSecretProcess, "deletesecret", CrestronConsole.AddNewConsoleCommand(DeleteSecretProcess, "deletesecret",
"Deletes secrets in secret provider", "Deletes secrets in secret provider",
ConsoleAccessLevelEnum.AccessAdministrator); ConsoleAccessLevelEnum.AccessAdministrator);
}
static SecretsManager()
{
Secrets = new Dictionary<string, ISecretProvider>();
} }
/// <summary> /// <summary>
/// Method to return a ISecretProvider to Set, Get, and Delete Secrets /// Get Secret Provider from dictionary by key
/// </summary> /// </summary>
/// <param name="key">Secret Provider Key</param> /// <param name="key">Dictionary Key for provider</param>
/// <returns></returns> /// <returns>ISecretProvider</returns>
public static ISecretProvider GetSecretProviderByKey(string key) public static ISecretProvider GetSecretProviderByKey(string key)
{ {
var secret = Secrets.FirstOrDefault(o => o.Key == key); ISecretProvider secret;
Secrets.TryGetValue(key, out secret);
if (secret == null) if (secret == null)
{ {
Debug.Console(1, "SecretsManager unable to retrieve SecretProvider with the key '{0}'", key); Debug.Console(1, "SecretsManager unable to retrieve SecretProvider with the key '{0}'", key);
@@ -48,6 +54,44 @@ namespace PepperDash.Essentials.Core
return secret; return secret;
} }
/// <summary>
/// Add secret provider to secrets dictionary
/// </summary>
/// <param name="key">Key of new entry</param>
/// <param name="provider">New Provider Entry</param>
public static void AddSecretProvider(string key, ISecretProvider provider)
{
if (!Secrets.ContainsKey(key))
{
Secrets.Add(key, provider);
Debug.Console(1, "Secrets provider '{0}' added to SecretsManager", key);
}
Debug.Console(0, Debug.ErrorLogLevel.Notice, "Unable to add Provider '{0}' to Secrets. Provider with that key already exists", key );
}
/// <summary>
/// Add secret provider to secrets dictionary, with optional overwrite parameter
/// </summary>
/// <param name="key">Key of new entry</param>
/// <param name="provider">New provider entry</param>
/// <param name="overwrite">true to overwrite any existing providers in the dictionary</param>
public static void AddSecretProvider(string key, ISecretProvider provider, bool overwrite)
{
if (!Secrets.ContainsKey(key))
{
Secrets.Add(key, provider);
Debug.Console(1, "Secrets provider '{0}' added to SecretsManager", key);
}
if (overwrite)
{
Secrets.Add(key, provider);
Debug.Console(1, Debug.ErrorLogLevel.Notice, "Provider with the key '{0}' already exists in secrets. Overwriting with new secrets provider.", key);
}
Debug.Console(0, Debug.ErrorLogLevel.Notice, "Unable to add Provider '{0}' to Secrets. Provider with that key already exists", key);
}
private static void SetSecretProcess(string cmd) private static void SetSecretProcess(string cmd)
{ {
string response; string response;
@@ -76,7 +120,7 @@ namespace PepperDash.Essentials.Core
} }
var provider = Secrets.FirstOrDefault(o => o.Key == args[0]); var provider = GetSecretProviderByKey(args[0]);
if (provider == null) if (provider == null)
{ {
@@ -92,10 +136,13 @@ namespace PepperDash.Essentials.Core
if (provider.GetSecret(key) == null) if (provider.GetSecret(key) == null)
{ {
provider.SetSecret(key, secret);
response = response = provider.SetSecret(key, secret)
String.Format( ? String.Format(
"Secret successfully set for {0}:{1}", "Secret successfully set for {0}:{1}",
provider.Key, key)
: String.Format(
"Unable to set secret for {0}:{1}",
provider.Key, key); provider.Key, key);
CrestronConsole.ConsoleCommandResponse(response); CrestronConsole.ConsoleCommandResponse(response);
return; return;
@@ -137,7 +184,7 @@ namespace PepperDash.Essentials.Core
} }
var provider = Secrets.FirstOrDefault(o => o.Key == args[0]); var provider = GetSecretProviderByKey(args[0]);
if (provider == null) if (provider == null)
{ {
@@ -153,10 +200,12 @@ namespace PepperDash.Essentials.Core
if (provider.GetSecret(key) != null) if (provider.GetSecret(key) != null)
{ {
provider.SetSecret(key, secret); response = provider.SetSecret(key, secret)
response = ? String.Format(
String.Format( "Secret successfully set for {0}:{1}",
"Secret successfully updated for {0}:{1}", provider.Key, key)
: String.Format(
"Unable to set secret for {0}:{1}",
provider.Key, key); provider.Key, key);
CrestronConsole.ConsoleCommandResponse(response); CrestronConsole.ConsoleCommandResponse(response);
return; return;
@@ -199,7 +248,7 @@ namespace PepperDash.Essentials.Core
} }
var provider = Secrets.FirstOrDefault(o => o.Key == args[0]); var provider = GetSecretProviderByKey(args[0]);
if (provider == null) if (provider == null)
{ {
@@ -214,11 +263,15 @@ namespace PepperDash.Essentials.Core
provider.SetSecret(key, ""); provider.SetSecret(key, "");
response = response = provider.SetSecret(key, "")
String.Format( ? String.Format(
"Secret successfully deleted for {0}:{1}", "Secret successfully deleted for {0}:{1}",
provider.Key, key)
: String.Format(
"Unable to delete secret for {0}:{1}",
provider.Key, key); provider.Key, key);
CrestronConsole.ConsoleCommandResponse(response); CrestronConsole.ConsoleCommandResponse(response);
return;
} }