refactor: rearrange and add solution for 4-series

src/PepperDash.Essentials.Core/Secrets/CrestronGlobalSecretsProvider.cs

@@ -0,0 +1,102 @@
+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;
+        }
+    }
+
+}

src/PepperDash.Essentials.Core/Secrets/CrestronLocalSecretsProvider.cs

@@ -0,0 +1,103 @@
+using System;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronDataStore;
+using PepperDash.Core;
+using Crestron.SimplSharpPro;
+
+
+namespace PepperDash.Essentials.Core
+{
+    public class CrestronLocalSecretsProvider : ISecretProvider
+    {
+        public string Key { get; set; }
+        //Added for reference
+        public string Description { get; private set; }
+
+
+        public CrestronLocalSecretsProvider(string key)
+        {
+            Key = key;
+            Description = String.Format("Default secret provider serving Essentials Application {0}", InitialParametersClass.ApplicationNumber);
+        }
+
+        static CrestronLocalSecretsProvider()
+        {
+            //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.clearLocal(key);
+                if (returnCode == CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
+                {
+                    Debug.Console(0, this, "Successfully removed secret \"{0}\"", secret);
+                    return true;
+                }
+            }
+
+            else  
+            {
+                returnCode = CrestronDataStoreStatic.SetLocalStringValue(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.GetLocalStringValue(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.GetLocalStringValue(key, out mySecret) == CrestronDataStore.CDS_ERROR.CDS_SUCCESS;
+        }
+    }
+
+}

src/PepperDash.Essentials.Core/Secrets/CrestronSecret.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Special container class for CrestronSecret provider
+    /// </summary>
+    public class CrestronSecret : ISecret
+    {
+        public ISecretProvider Provider { get; private set; }
+        public string Key { get; private set; }
+
+        public object Value { get; private set; }
+
+        public CrestronSecret(string key, string value, ISecretProvider provider)
+        {
+            Key = key;
+            Value = value;
+            Provider = provider;
+        }
+
+    }
+
+}

src/PepperDash.Essentials.Core/Secrets/Interfaces.cs

@@ -0,0 +1,58 @@
+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; }
+    }
+}

src/PepperDash.Essentials.Core/Secrets/SecretsManager.cs

@@ -0,0 +1,375 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    public static class SecretsManager
+    {
+        public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
+
+        /// <summary>
+        /// Initialize the SecretsManager
+        /// </summary>
+        public static void Initialize()
+        {
+
+            AddSecretProvider("default", new CrestronLocalSecretsProvider("default"));
+
+            AddSecretProvider("CrestronGlobalSecrets", new CrestronGlobalSecretsProvider("CrestronGlobalSecrets"));
+
+            CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret",
+                "Adds secret to secrets provider",
+                ConsoleAccessLevelEnum.AccessOperator);
+
+            CrestronConsole.AddNewConsoleCommand(UpdateSecretProcess, "updatesecret",
+                "Updates secret in secrets provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+
+            CrestronConsole.AddNewConsoleCommand(DeleteSecretProcess, "deletesecret",
+                "Deletes secret from secrest provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+
+            CrestronConsole.AddNewConsoleCommand(ListProviders, "secretproviderlist",
+                "Return list of all valid secrets providers",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+
+            CrestronConsole.AddNewConsoleCommand(GetProviderInfo, "secretproviderinfo",
+                "Return data about secrets provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+        }
+
+        static SecretsManager()
+        {
+            Secrets = new Dictionary<string, ISecretProvider>();
+        }
+
+        /// <summary>
+        /// Get Secret Provider from dictionary by key
+        /// </summary>
+        /// <param name="key">Dictionary Key for provider</param>
+        /// <returns>ISecretProvider</returns>
+        public static ISecretProvider GetSecretProviderByKey(string key)
+        {
+            ISecretProvider secret;
+
+            Secrets.TryGetValue(key, out secret);
+
+            if (secret == null)
+            {
+                Debug.Console(1, "SecretsManager unable to retrieve SecretProvider with the key '{0}'", key);
+            }
+            return secret;
+        }
+
+        public static void GetProviderInfo(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (cmd.Length == 0 || (args.Length == 1 && args[0] == "?"))
+            {
+                response = "Returns data about secrets provider.  Format 'secretproviderinfo <provider>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            if (args.Length == 1)
+            {
+                var provider = GetSecretProviderByKey(args[0]);
+
+                if (provider == null)
+                {
+                    response = "Invalid secrets provider key";
+                    CrestronConsole.ConsoleCommandResponse(response);
+                    return;
+                }
+
+                response = String.Format("{0} : {1}", provider.Key, provider.Description);
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            response = "Improper number of arguments";
+            CrestronConsole.ConsoleCommandResponse(response);
+
+        }
+
+
+        /// <summary>
+        /// Console Command that returns all valid secrets in the essentials program.
+        /// </summary>
+        /// <param name="cmd"></param>
+        public static void ListProviders(string cmd)
+        {
+            var response = String.Empty;
+            var args = cmd.Split(' ');
+
+            if (cmd.Length == 0)
+            {
+                if (Secrets != null && Secrets.Count > 0)
+                {
+                    response = Secrets.Aggregate(response,
+                        (current, secretProvider) => current + (secretProvider.Key + "\n\r"));
+                }
+                else
+                {
+                    response = "No Secrets Providers Available";
+                }
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Reports all valid and preset Secret providers";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+
+            response = "Improper number of arguments";
+            CrestronConsole.ConsoleCommandResponse(response);
+
+        }
+
+        /// <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);
+                return;
+            }
+            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);
+                return;
+            }
+            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);
+                return;
+            }
+            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)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Adds secrets to secret provider. Format 'setsecret <provider> <secretKey> <secret>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Adds secrets to secret provider. Format 'setsecret <provider> <secretKey> <secret>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            if (args.Length < 3)
+            {
+                response =  "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response =  "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+            var secret = args[2];
+
+            CrestronConsole.ConsoleCommandResponse(SetSecret(provider, key, secret));
+        }
+
+        private static void UpdateSecretProcess(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Updates secrets in secret provider. Format 'updatesecret <provider> <secretKey> <secret>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Updates secrets in secret provider. Format 'updatesecret <provider> <secretKey> <secret>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+
+            if (args.Length < 3)
+            {
+                //someFail
+                response = "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response = "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+            var secret = args[2];
+
+            CrestronConsole.ConsoleCommandResponse(UpdateSecret(provider, key, secret));
+
+        }
+
+        private static string UpdateSecret(ISecretProvider provider, string key, string secret)
+        {
+            var secretPresent = provider.TestSecret(key);
+
+            Debug.Console(2, provider, "SecretsProvider {0} {1} contain a secret entry for {2}", provider.Key, secretPresent ? "does" : "does not", key);
+
+            if (!secretPresent)
+                return
+                    String.Format(
+                        "Unable to update secret for {0}:{1} - Please use the 'SetSecret' command to modify it");
+            var response = provider.SetSecret(key, secret)
+                ? String.Format(
+                    "Secret successfully set for {0}:{1}",
+                    provider.Key, key)
+                : String.Format(
+                    "Unable to set secret for {0}:{1}",
+                    provider.Key, key);
+            return response;
+        }
+
+        private static string SetSecret(ISecretProvider provider, string key, string secret)
+        {
+            var secretPresent = provider.TestSecret(key);
+
+            Debug.Console(2, provider, "SecretsProvider {0} {1} contain a secret entry for {2}", provider.Key, secretPresent ? "does" : "does not", key);
+
+            if (secretPresent)
+                return
+                    String.Format(
+                        "Unable to set secret for {0}:{1} - Please use the 'UpdateSecret' command to modify it");
+            var response = provider.SetSecret(key, secret)
+                ? String.Format(
+                    "Secret successfully set for {0}:{1}",
+                    provider.Key, key)
+                : String.Format(
+                    "Unable to set secret for {0}:{1}",
+                    provider.Key, key);
+            return response;
+
+        }
+
+        private static void DeleteSecretProcess(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Deletes secrets in secret provider. Format 'deletesecret <provider> <secretKey>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Deletes secrets in secret provider. Format 'deletesecret <provider> <secretKey>'";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+
+
+            if (args.Length < 2)
+            {
+                //someFail
+                response =  "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response =  "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+
+
+            provider.SetSecret(key, "");
+            response = provider.SetSecret(key, "")
+                ? String.Format(
+                    "Secret successfully deleted for {0}:{1}",
+                    provider.Key, key)
+                : String.Format(
+                    "Unable to delete secret for {0}:{1}",
+                    provider.Key, key);
+            CrestronConsole.ConsoleCommandResponse(response);
+            return;
+
+
+        }
+    }
+
+
+}

src/PepperDash.Essentials.Core/Secrets/SecretsPropertiesConfig.cs

@@ -0,0 +1,22 @@
+extern alias Full;
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Full.Newtonsoft.Json;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Provide a way to easily deserialize into a secret object from config
+    /// </summary>
+    public class SecretsPropertiesConfig
+    {
+        [JsonProperty("provider")]
+        public string Provider { get; set; }
+        [JsonProperty("key")]
+        public string Key { get; set; }
+    }
+}