Merge pull request #693 from PepperDash/hotfix/console-response-crlf-fixes

Hotfix/console response crlf fixes

PepperDashEssentials/ControlSystem.cs

@@ -72,7 +72,7 @@ namespace PepperDash.Essentials
             CrestronConsole.AddNewConsoleCommand(s =>
             {
                 foreach (var tl in TieLineCollection.Default)
-                    CrestronConsole.ConsoleCommandResponse("  {0}\r", tl);
+                    CrestronConsole.ConsoleCommandResponse("  {0}\r\n", tl);
             },
             "listtielines", "Prints out all tie lines", ConsoleAccessLevelEnum.AccessOperator);
 
@@ -86,8 +86,8 @@ namespace PepperDash.Essentials
 
             CrestronConsole.AddNewConsoleCommand(s =>
             {
-                CrestronConsole.ConsoleCommandResponse("This system can be found at the following URLs:\r" +
-                    "System URL:   {0}\r" +
+                CrestronConsole.ConsoleCommandResponse("This system can be found at the following URLs:\r\n" +
+                    "System URL:   {0}\r\n" +
                     "Template URL: {1}", ConfigReader.ConfigObject.SystemUrl, ConfigReader.ConfigObject.TemplateUrl);
             }, "portalinfo", "Shows portal URLS from configuration", ConsoleAccessLevelEnum.AccessOperator);
 

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

@@ -85,96 +85,81 @@ namespace PepperDash.Essentials.Core
 
             var wrapper = new DeviceFactoryWrapper() { CType = cType, Description = description, FactoryMethod = method };
             DeviceFactory.FactoryMethods.Add(typeName, wrapper);
-        }
-
-		/// <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>
+        }
+
+        private static void CheckForSecrets(IEnumerable<JProperty> obj)
+        {
+            foreach (var prop in obj.Where(prop => prop.Value as JObject != null))
+            {
+                if (prop.Name.ToLower() == "secret")
+                {
+                    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)
-		{
-		    try
-		    {
+        {
+            try
+            {
                 Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading '{0}' from Essentials Core", dc.Type);
 
-		        var localDc = new DeviceConfig(dc);
+                var localDc = new DeviceConfig(dc);
 
-		        var key = localDc.Key;
-		        var name = localDc.Name;
-		        var type = localDc.Type;
+                var key = localDc.Key;
+                var name = localDc.Name;
+                var type = localDc.Type;
                 var properties = localDc.Properties;
-		        //var propRecurse = properties;
+                //var propRecurse = properties;
 
-		        var typeName = localDc.Type.ToLower();
+                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. 
-		        if (!FactoryMethods.ContainsKey(typeName)) return null;
+                // 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);
 
-                /*foreach (var obj in (propRecurse as JObject).FindTokens("secret").OfType<JObject>())
-                {
-                    Debug.Console(2, obj.ToString());
-                }*/
+                Debug.Console(2, "{0}", ex.StackTrace);
+                return null;
+            }
+        }
 
-
-                //look for secret in username
-		        var userSecretToken = properties["control"]["tcpSshProperties"]["username"]["secret"];
-
-		        if (userSecretToken != null)
-		        {
-		            Debug.Console(2, "Found a secret for {0} - attempting to retrieve it!", name);
-		            var userSecretResult =
-		                JsonConvert.DeserializeObject<SecretsPropertiesConfig>(userSecretToken.ToString());
-		            var userProvider = SecretsManager.GetSecretProviderByKey(userSecretResult.Provider);
-		            if (userProvider != null)
-		            {
-		                var user = userProvider.GetSecret(userSecretResult.Key);
-		                if (user == null)
-		                {
-		                    Debug.Console(1,
-		                        "Unable to retrieve secret for {0} - Make sure you've added it to the secrets provider");
-		                    return null;
-		                }
-		                properties["control"]["tcpSshProperties"]["username"] = (string) user.Value;
-		            }
-		        }
-
-                //look for secret in password
-		        var passwordSecretToken = properties["control"]["tcpSshProperties"]["password"]["secret"];
-
-		        if (passwordSecretToken != null)
-		        {
-		            Debug.Console(2, "Found a secret for {0} - attempting to retrieve it!", name);
-
-		            var passwordSecretResult =
-		                JsonConvert.DeserializeObject<SecretsPropertiesConfig>(passwordSecretToken.ToString());
-		            var passwordProvider = SecretsManager.GetSecretProviderByKey(passwordSecretResult.Provider);
-		            if (passwordProvider != null)
-		            {
-		                var password = passwordProvider.GetSecret(passwordSecretResult.Key);
-                        if (password == null)
-		                {
-		                    Debug.Console(1,
-		                        "Unable to retrieve secret for {0} - Make sure you've added it to the secrets provider");
-		                    return null;
-		                }
-                        properties["control"]["tcpSshProperties"]["password"] = (string)password.Value;
-		            }
-		        }
-
-                Debug.Console(0, "{0}", localDc.Properties.ToString());
-
-		        return FactoryMethods[typeName].FactoryMethod(localDc);
-		    }
-		    catch (Exception ex)
-		    {
-		        Debug.Console(2, "Issue with getting device - {0}", ex.Message);
-		        return null;
-		    }
-		}
-
         /// <summary>
         /// Prints the type names and associated metadata from the FactoryMethods collection.
         /// </summary>

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

@@ -10,43 +10,54 @@ namespace PepperDash.Essentials.Core
     {
         public string Key { get; set; }
         //Added for reference
-        //private readonly bool _secureSupported;
+        private static readonly bool SecureSupported;
         public CrestronSecretsProvider(string key)
         {
             Key = key;
-            //Added for future encrypted reference
-            //_secureSupported = CrestronSecureStorage.Supported;
-
-            //if (_secureSupported)
-            //{
-            //      return;
-            //}
-            CrestronDataStoreStatic.InitCrestronDataStore();
-
         }
 
+        static CrestronSecretsProvider()
+        {
+            //Added for future encrypted reference
+            SecureSupported = CrestronSecureStorage.Supported;
 
-        public void SetSecret(string key, object value)
+            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;
+                return false;
             }
-            Debug.Console(2, this, "Attempting to set Secret to {0}", secret);
             var setErrorCode = CrestronDataStoreStatic.SetLocalStringValue(key, secret);
             switch (setErrorCode)
             {
                 case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
-                    Debug.Console(2, this,"Secret Successfully Set for {0}:{1}", Key, key);
-                    break;
+                    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());
-                    break;
+                    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;
@@ -56,16 +67,18 @@ namespace PepperDash.Essentials.Core
             {
                 case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
                     Debug.Console(2, this, "Secret Successfully retrieved for {0}:{1}", Key, key);
-                    Debug.Console(2, this, "Retreived Secret = {0}", mySecret);
                     return new CrestronSecret(key, mySecret, this);
                 default:
-                    Debug.Console(2, 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());
                     return null;
             }
         }
     }
 
+    /// <summary>
+    /// Special container class for CrestronSecret provider
+    /// </summary>
     public class CrestronSecret : ISecret
     {
         public ISecretProvider Provider { get; private set; }

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

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

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

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using Crestron.SimplSharp;
 using PepperDash.Core;
 
@@ -9,12 +8,16 @@ namespace PepperDash.Essentials.Core
 {
     public static class SecretsManager
     {
-        public static List<ISecretProvider> Secrets { get; set; }
+        public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
 
+        /// <summary>
+        /// Initialize the SecretsManager
+        /// </summary>
         public static void Initialize()
         {
-            Secrets = new List<ISecretProvider> {new CrestronSecretsProvider("default")};
-            
+
+            AddSecretProvider("default", new CrestronSecretsProvider("default"));
+
             CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret",
                 "Adds secrets to secret provider",
                 ConsoleAccessLevelEnum.AccessOperator);
@@ -26,13 +29,24 @@ namespace PepperDash.Essentials.Core
             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)
         {
-            var secret = Secrets.FirstOrDefault(o => o.Key == key);
+            ISecretProvider secret;
+
+            Secrets.TryGetValue(key, out secret);
+
             if (secret == null)
             {
                 Debug.Console(1, "SecretsManager unable to retrieve SecretProvider with the key '{0}'", key);
@@ -40,6 +54,44 @@ namespace PepperDash.Essentials.Core
             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;
@@ -68,7 +120,7 @@ namespace PepperDash.Essentials.Core
 
             }
 
-            var provider = Secrets.FirstOrDefault(o => o.Key == args[0]);
+            var provider = GetSecretProviderByKey(args[0]);
 
             if (provider == null)
             {
@@ -84,11 +136,14 @@ namespace PepperDash.Essentials.Core
 
             if (provider.GetSecret(key) == null)
             {
-                provider.SetSecret(key, secret);
-                response =
-                    String.Format(
+
+                response = provider.SetSecret(key, secret)
+                    ? String.Format(
                         "Secret successfully set for {0}:{1}",
-                        provider.Key, key);
+                        provider.Key, key)
+                    : String.Format(
+                        "Unable to set secret for {0}:{1}",
+                        provider.Key, key);                    
                 CrestronConsole.ConsoleCommandResponse(response);
                 return;
             }
@@ -129,7 +184,7 @@ namespace PepperDash.Essentials.Core
 
             }
 
-            var provider = Secrets.FirstOrDefault(o => o.Key == args[0]);
+            var provider = GetSecretProviderByKey(args[0]);
 
             if (provider == null)
             {
@@ -145,10 +200,12 @@ namespace PepperDash.Essentials.Core
 
             if (provider.GetSecret(key) != null)
             {
-                provider.SetSecret(key, secret);
-                response =
-                    String.Format(
-                        "Secret successfully updated for {0}:{1}",
+                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;
@@ -191,7 +248,7 @@ namespace PepperDash.Essentials.Core
 
             }
 
-            var provider = Secrets.FirstOrDefault(o => o.Key == args[0]);
+            var provider = GetSecretProviderByKey(args[0]);
 
             if (provider == null)
             {
@@ -206,11 +263,15 @@ namespace PepperDash.Essentials.Core
 
 
             provider.SetSecret(key, "");
-            response =
-                String.Format(
+            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

@@ -7,6 +7,9 @@ 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")]