Merge ae9833ffaa into e6f5142fc3

Feature/secrets manager

PepperDashEssentials/ControlSystem.cs

@@ -36,6 +36,7 @@ namespace PepperDash.Essentials
             Thread.MaxNumberOfUserThreads = 400;
             Global.ControlSystem = this;
             DeviceManager.Initialize(this);
+            SecretsManager.Initialize();
             SystemMonitor.ProgramInitialization.ProgramInitializationUnderUserControl = true;
         }
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Comm and IR/GenericComm.cs

@@ -25,6 +25,7 @@ namespace PepperDash.Essentials.Core
         public GenericComm(DeviceConfig config)
             : base(config)
         {
+
             PropertiesConfig = CommFactory.GetControlPropertiesConfig(config);
 
             var commPort = CommFactory.CreateCommForDevice(config);

essentials-framework/Essentials Core/PepperDashEssentialsBase/Config/DeviceConfig.cs

@@ -31,6 +31,18 @@ namespace PepperDash.Essentials.Core.Config
         [JsonProperty("properties")]
         [JsonConverter(typeof(DevicePropertiesConverter))]
         public JToken Properties { get; set; }
+
+        public DeviceConfig(DeviceConfig dc)
+        {
+            Key = dc.Key;
+            Uid = dc.Uid;
+            Name = dc.Name;
+            Group = dc.Group;
+            Type = dc.Type;
+            Properties = JToken.FromObject(dc.Properties);
+        }
+
+        public DeviceConfig() {}
     }
 
     /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Extensions/JsonExtensions.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace PepperDash.Essentials.Core
+{
+    public static class JsonExtensions
+    {
+        public static List<JToken> FindTokens(this JToken containerToken, string name)
+        {
+            List<JToken> matches = new List<JToken>();
+            FindTokens(containerToken, name, matches);
+            return matches;
+        }
+
+        private static void FindTokens(JToken containerToken, string name, List<JToken> matches)
+        {
+            if (containerToken.Type == JTokenType.Object)
+            {
+                foreach (JProperty child in containerToken.Children<JProperty>())
+                {
+                    if (child.Name == name)
+                    {
+                        matches.Add(child.Value);
+                    }
+                    FindTokens(child.Value, name, matches);
+                }
+            }
+            else if (containerToken.Type == JTokenType.Array)
+            {
+                foreach (JToken child in containerToken.Children())
+                {
+                    FindTokens(child, name, matches);
+                }
+            }
+        }
+    }
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Factory/DeviceFactory.cs

@@ -7,6 +7,8 @@ using Crestron.SimplSharpPro;
 using Crestron.SimplSharpPro.GeneralIO;
 using Crestron.SimplSharp.Reflection;
 using PepperDash.Core;
+using Newtonsoft.Json.Linq;
+using Newtonsoft.Json;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Config;
 using PepperDash.Essentials.Core.CrestronIO;
@@ -85,29 +87,77 @@ namespace PepperDash.Essentials.Core
             DeviceFactory.FactoryMethods.Add(typeName, wrapper);
         }
 
-		/// <summary>
+        private static void CheckForSecrets(IEnumerable<JProperty> obj)
-		/// The factory method for Core "things". Also iterates the Factory methods that have
+        {
-		/// been loaded from plugins
+            foreach (var prop in obj.Where(prop => prop.Value as JObject != null))
-		/// </summary>
+            {
-		/// <param name="dc"></param>
+                if (prop.Name.ToLower() == "secret")
-		/// <returns></returns>
+                {
+                    var secret = GetSecret(prop.Children().First().ToObject<SecretsPropertiesConfig>());
+                    //var secret = GetSecret(JsonConvert.DeserializeObject<SecretsPropertiesConfig>(prop.Children().First().ToString()));
+                    prop.Parent.Replace(secret);
+                }
+                var recurseProp = prop.Value as JObject;
+                if (recurseProp == null) return;
+                CheckForSecrets(recurseProp.Properties());
+            }
+        }
+
+        private static string GetSecret(SecretsPropertiesConfig data)
+        {
+            var secretProvider = SecretsManager.GetSecretProviderByKey(data.Provider);
+            if (secretProvider == null) return null;
+            var secret = secretProvider.GetSecret(data.Key);
+            if (secret != null) return (string) secret.Value;
+            Debug.Console(1,
+                "Unable to retrieve secret {0}{1} - Make sure you've added it to the secrets provider",
+                data.Provider, data.Key);
+            return String.Empty;
+        }
+
+
+        /// <summary>
+        /// The factory method for Core "things". Also iterates the Factory methods that have
+        /// been loaded from plugins
+        /// </summary>
+        /// <param name="dc"></param>
+        /// <returns></returns>
         public static IKeyed GetDevice(DeviceConfig dc)
         {
-            var key = dc.Key;
+            try
-            var name = dc.Name;
-            var type = dc.Type;
-            var properties = dc.Properties;	
-
-            var typeName = dc.Type.ToLower();
-
-            // Check for types that have been added by plugin dlls. 
-            if (FactoryMethods.ContainsKey(typeName))
             {
                 Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading '{0}' from Essentials Core", dc.Type);
-                return FactoryMethods[typeName].FactoryMethod(dc);
-            }
 
-            return null;
+                var localDc = new DeviceConfig(dc);
+
+                var key = localDc.Key;
+                var name = localDc.Name;
+                var type = localDc.Type;
+                var properties = localDc.Properties;
+                //var propRecurse = properties;
+
+                var typeName = localDc.Type.ToLower();
+
+
+                var jObject = properties as JObject;
+                if (jObject != null)
+                {
+                    var jProp = jObject.Properties();
+
+                    CheckForSecrets(jProp);
+                }
+
+                Debug.Console(2, "typeName = {0}", typeName);
+                // Check for types that have been added by plugin dlls. 
+                return !FactoryMethods.ContainsKey(typeName) ? null : FactoryMethods[typeName].FactoryMethod(localDc);
+            }
+            catch (Exception ex)
+            {
+                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;
+            }
         }
 
         /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj

@@ -209,6 +209,7 @@
     <Compile Include="DeviceTypeInterfaces\IHasFarEndContentStatus.cs" />
     <Compile Include="DeviceTypeInterfaces\IHasPhoneDialing.cs" />
     <Compile Include="DeviceTypeInterfaces\IMobileControl.cs" />
+    <Compile Include="Extensions\JsonExtensions.cs" />
     <Compile Include="Factory\DeviceFactory.cs" />
     <Compile Include="Factory\IDeviceFactory.cs" />
     <Compile Include="Factory\ReadyEventArgs.cs" />
@@ -320,6 +321,10 @@
     <Compile Include="Feedbacks\BoolFeedbackPulseExtender.cs" />
     <Compile Include="Routing\RoutingPortNames.cs" />
     <Compile Include="Routing\TieLineConfig.cs" />
+    <Compile Include="Secrets\CrestronSecretsProvider.cs" />
+    <Compile Include="Secrets\Interfaces.cs" />
+    <Compile Include="Secrets\SecretsManager.cs" />
+    <Compile Include="Secrets\SecretsPropertiesConfig.cs" />
     <Compile Include="Shades\Shade Interfaces.cs" />
     <Compile Include="Shades\ShadeBase.cs" />
     <Compile Include="Shades\ShadeController.cs" />

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

@@ -0,0 +1,97 @@
+using System;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronDataStore;
+using PepperDash.Core;
+
+
+namespace PepperDash.Essentials.Core
+{
+    public class CrestronSecretsProvider : ISecretProvider
+    {
+        public string Key { get; set; }
+        //Added for reference
+        private static readonly bool SecureSupported;
+        public CrestronSecretsProvider(string key)
+        {
+            Key = key;
+        }
+
+        static CrestronSecretsProvider()
+        {
+            //Added for future encrypted reference
+            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;
+            if (String.IsNullOrEmpty(secret))
+            {
+                Debug.Console(2, this, "Unable to set secret for {0}:{1} - value is empty.", Key, key);
+                return false;
+            }
+            var setErrorCode = CrestronDataStoreStatic.SetLocalStringValue(key, secret);
+            switch (setErrorCode)
+            {
+                case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
+                    Debug.Console(1, this,"Secret Successfully Set for {0}:{1}", Key, key);
+                    return true;
+                default:
+                    Debug.Console(2, this, Debug.ErrorLogLevel.Notice, "Unable to set secret for {0}:{1} - {2}", Key, key, setErrorCode.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>
+    /// 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;
+        }
+
+    }
+}

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

@@ -0,0 +1,24 @@
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// All ISecrecretProvider classes must implement this interface.
+    /// </summary>
+    public interface ISecretProvider : IKeyed
+    {
+        bool SetSecret(string key, object value);
+
+        ISecret GetSecret(string key);
+    }
+
+    /// <summary>
+    /// interface for delivering secrets in Essentials.
+    /// </summary>
+    public interface ISecret
+    {
+        ISecretProvider Provider { get; }
+        string Key { get; }
+        object Value { get; }
+    }
+}

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

@@ -0,0 +1,281 @@
+using System;
+using System.Collections.Generic;
+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 CrestronSecretsProvider("default"));
+
+            CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret",
+                "Adds secrets to secret provider",
+                ConsoleAccessLevelEnum.AccessOperator);
+
+            CrestronConsole.AddNewConsoleCommand(UpdateSecretProcess, "updatesecret",
+                "Updates secrets in secret provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+
+            CrestronConsole.AddNewConsoleCommand(DeleteSecretProcess, "deletesecret",
+                "Deletes secrets in secret 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;
+        }
+
+        /// <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)
+        {
+            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];
+
+            if (provider.GetSecret(key) == null)
+            {
+
+                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);                    
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+            response =
+                String.Format(
+                    "Unable to set secret for {0}:{1} - Please use the 'UpdateSecret' command to modify it");
+            CrestronConsole.ConsoleCommandResponse(response);
+        }
+
+        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];
+
+            if (provider.GetSecret(key) != null)
+            {
+                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);
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            response =
+                String.Format(
+                    "Unable to update secret for {0}:{1} - Please use the 'SetSecret' command to create a new secret");
+            CrestronConsole.ConsoleCommandResponse(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;
+
+
+        }
+    }
+
+
+}

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

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using 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; }
+    }
+}