Moving in ssh client

Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs

@@ -0,0 +1,312 @@
+using System;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.Ssh;
+using Crestron.SimplSharp.Ssh.Common;
+
+namespace PepperDash.Core
+{
+	public class ConnectionChangeEventArgs : EventArgs
+	{
+		public bool IsConnected { get; private set; }
+		public GenericSshClient Client { get; private set; }
+		public ushort Status { get { return Client.UStatus; } }
+
+		// S+ Constructor
+		public ConnectionChangeEventArgs() { }
+
+		public ConnectionChangeEventArgs(bool isConnected, GenericSshClient client)
+		{
+			IsConnected = isConnected;
+			Client = client;
+		}
+	}
+
+	//*****************************************************************************************************
+	//*****************************************************************************************************
+
+	public class GenericSshClient : Device, IBasicCommunication
+	{
+		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
+		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
+
+		public event EventHandler<ConnectionChangeEventArgs> ConnectionChange;
+		//public event EventHandler<DataReceiveEventArgs> DataReceive;
+
+		public string Hostname { get; set; }
+		/// <summary>
+		/// Port on server
+		/// </summary>
+		public int Port { get; set; }
+		public string Username { get; set; }
+		public string Password { get; set; }
+
+		public bool IsConnected 
+		{ 
+			// returns false if no client or not connected
+			get { return (Client != null ? Client.IsConnected : false); }
+			set
+			{
+				if (value)
+					UStatus = 2;
+				OnConnectionChange();
+			}
+		}
+		/// <summary>
+		/// Contains the familiar Simpl analog status values 
+		/// </summary>
+		public ushort UStatus { get; private set; }
+
+		/// <summary>
+		/// Determines whether client will attempt reconnection on failure
+		/// </summary>
+	
+		public bool AutoReconnect { get; set; }
+		/// <summary>
+		/// S+ helper for bool value
+		/// </summary>		
+		public ushort UAutoReconnect
+		{
+			set { AutoReconnect = value == 1; }
+		}
+
+		/// <summary>
+		/// Millisecond value, determines the timeout period in between reconnect attempts
+		/// </summary>
+		public ushort AutoReconnectIntervalMs { get; set; }
+
+		SshClient Client;
+		ShellStream TheStream;
+		CTimer ReconnectTimer;
+		bool ReconnectTimerRunning;
+
+		public GenericSshClient(string key, string hostname, int port, string username, string password) :
+			base(key)
+		{
+			AutoReconnectIntervalMs = 5000;
+			
+			Hostname = hostname;
+			Port = port;
+			Username = username;
+			Password = password;
+		}
+
+		/// <summary>
+		/// Connect to the server, using the provided properties.
+		/// </summary>
+		public void Connect()
+		{
+			ReconnectTimerRunning = false;
+			if (Hostname != null && Hostname != string.Empty && Port > 0 &&
+				Username != null && Password != null)
+			{
+				Debug.Console(1, this, "attempting connect, IsConnected={0}", IsConnected);
+				if (!IsConnected)
+				{
+					UStatus = 1;
+					IsConnected = false;
+
+					// This handles both password and keyboard-interactive (like on OS-X, 'nixes)
+					KeyboardInteractiveAuthenticationMethod kauth = new KeyboardInteractiveAuthenticationMethod(Username);
+					kauth.AuthenticationPrompt += new EventHandler<AuthenticationPromptEventArgs>(kauth_AuthenticationPrompt);
+					PasswordAuthenticationMethod pauth = new PasswordAuthenticationMethod(Username, Password);
+					ConnectionInfo connectionInfo = new ConnectionInfo(Hostname, Port, Username, pauth, kauth);
+					Client = new SshClient(connectionInfo);
+					Client.ErrorOccurred += Client_ErrorOccurred;
+					try
+					{
+						Client.Connect();
+						if (Client.IsConnected)
+						{
+							Client.KeepAliveInterval = TimeSpan.FromSeconds(2);
+							Client.SendKeepAlive();
+							IsConnected = true;
+							Debug.Console(1, this, "Connected");
+							TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 65534);
+							TheStream.DataReceived += Stream_DataReceived;
+							TheStream.ErrorOccurred += Stream_ErrorOccurred;
+							
+						}
+						return;
+					}
+					catch (SshConnectionException e)
+					{
+						var ie = e.InnerException; // The details are inside!!
+						string msg;
+						if (ie is SocketException)
+							msg = string.Format("'{0}' CONNECTION failure: Cannot reach host, ({1})", Key, ie.GetType());
+						else if (ie is System.Net.Sockets.SocketException)
+							msg = string.Format("'{0}' Connection failure: Cannot reach host '{1}' on port {2}, ({3})",
+								Key, Hostname, Port, ie.GetType());
+						else if (ie is SshAuthenticationException)
+						{
+							msg = string.Format("'{0}' Authentication failure for username '{1}', ({2})", 
+								Username, Key, ie.GetType());
+							Debug.Console(0, this, "Authentication failure for username '{0}', ({1})", 
+								Username, ie.GetType());
+						}
+						else
+							Debug.Console(0, this, "Error on connect:\r({0})", e);
+					}
+				}
+			}
+			else
+			{
+				Debug.Console(0, this, "Connect failed.  Check hostname, port, username and password are set or not null");
+			}
+
+			// Sucess will not make it this far
+			UStatus = 3;
+			IsConnected = false;
+			HandleConnectionFailure();
+		}
+
+		/// <summary>
+		/// Disconnect the clients and put away it's resources.
+		/// </summary>
+		public void Disconnect()
+		{
+			// Stop trying reconnects, if we are
+			if(ReconnectTimer != null) ReconnectTimer.Stop();
+			// Otherwise just close up
+			if (Client != null) // && Client.IsConnected) <-- Doesn't always report properly...
+			{
+				Debug.Console(1, this, "Disconnecting");
+				Client.Disconnect();
+				Cleanup();
+				UStatus = 5;
+				IsConnected = false;
+			}
+		}
+
+		/// <summary>
+		/// Anything to do with reestablishing connection on failures
+		/// </summary>
+		void HandleConnectionFailure()
+		{
+			Debug.Console(2, this, "Checking autoreconnect: {0}, {1}ms", 
+				AutoReconnect, AutoReconnectIntervalMs);
+			if (AutoReconnect)
+			{
+				if (ReconnectTimer == null || !ReconnectTimerRunning)
+				{
+					ReconnectTimer = new CTimer(o => Connect(), AutoReconnectIntervalMs);
+					ReconnectTimerRunning = true;
+					Debug.Console(1, this, "Attempting connection in {0} seconds",
+						(float)(AutoReconnectIntervalMs / 1000));
+				}
+				else
+				{
+					Debug.Console(2, this, "{0} second reconnect cycle running",
+						(float)(AutoReconnectIntervalMs / 1000));
+				}
+			}
+		}
+
+		void Cleanup()
+		{
+			Debug.Console(2, this, "cleaning up resources");
+			Client = null;
+		}
+
+		/// <summary>
+		/// Handles the keyboard interactive authentication, should it be required.
+		/// </summary>
+		void kauth_AuthenticationPrompt(object sender, AuthenticationPromptEventArgs e)
+		{
+			foreach (AuthenticationPrompt prompt in e.Prompts)
+				if (prompt.Request.IndexOf("Password:", StringComparison.InvariantCultureIgnoreCase) != -1)
+					prompt.Response = Password;
+		}
+	
+		/// <summary>
+		/// Handler for data receive on ShellStream.  Passes data across to queue for line parsing.
+		/// </summary>
+		void Stream_DataReceived(object sender, Crestron.SimplSharp.Ssh.Common.ShellDataEventArgs e)
+		{
+			var bytes = e.Data;
+			if (bytes.Length > 0)
+			{
+				var bytesHandler = BytesReceived;
+				if (bytesHandler != null)
+					bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
+				var textHandler = TextReceived;
+				if (textHandler != null)
+				{
+					var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
+					textHandler(this, new GenericCommMethodReceiveTextArgs(str));
+				}
+			}
+		}
+
+		/// <summary>
+		/// Error event handler for stream events
+		/// </summary>
+		void Stream_ErrorOccurred(object sender, ExceptionEventArgs e)
+		{
+			Debug.Console(2, this, "CRITICAL: PLEASE REPORT - SSH client stream error:\r{0}", e.Exception);
+		}
+
+		/// <summary>
+		/// Error event handler for client events - disconnect, etc.  Will forward those events via ConnectionChange
+		/// event
+		/// </summary>
+		void Client_ErrorOccurred(object sender, Crestron.SimplSharp.Ssh.Common.ExceptionEventArgs e)
+		{
+			Debug.Console(0, this, "SSH client error: {0}", e.Exception);
+			if (e.Exception is SocketException)
+			{
+				// ****LOG SOMETHING
+				UStatus = 4;
+			}
+			IsConnected = false;
+			HandleConnectionFailure();
+		}
+
+		/// <summary>
+		/// Helper for ConnectionChange event
+		/// </summary>
+		void OnConnectionChange()
+		{
+			if(ConnectionChange != null)
+				ConnectionChange(this, new ConnectionChangeEventArgs(IsConnected, this));
+		}
+
+		#region IBasicCommunication Members
+
+		public void SendText(string text)
+		{
+			try
+			{
+				TheStream.Write(text);
+				TheStream.Flush();
+			}
+			catch
+			{
+				Debug.Console(1, this, "Stream write failed. Disconnected, closing");
+				UStatus = 4;
+				IsConnected = false;
+				HandleConnectionFailure();
+			}
+		}
+
+		public void SendBytes(byte[] bytes)
+		{
+			try
+			{
+				TheStream.Write(bytes, 0, bytes.Length);
+				TheStream.Flush();
+			}
+			catch
+			{
+				Debug.Console(1, this, "Stream write failed. Disconnected, closing");
+				UStatus = 4;
+				IsConnected = false;
+				HandleConnectionFailure();
+			}
+		}
+
+		#endregion
+	}
+}

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs

@@ -16,6 +16,7 @@ namespace PepperDash.Core
 		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
 		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
+		public TCPClient Client { get; private set; }
 		public bool IsConnected { get { return Client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; } }
 		public string Status { get { return Client.ClientStatus.ToString(); } }
 		public string ConnectionFailure { get { return Client.ClientStatus.ToString(); } }
@@ -25,7 +26,6 @@ namespace PepperDash.Core
 			get { return Client.ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; }
 		}
 
-		public TCPClient Client { get; private set; }
 		CTimer RetryTimer;
 
 		public GenericTcpIpClient(string key, string address, int port, int bufferSize)
@@ -74,9 +74,7 @@ namespace PepperDash.Core
 			if (numBytes > 0)
 			{
 				var bytes = client.IncomingDataBuffer.Take(numBytes).ToArray();
-				//if (Debug.Level == 2)
-				//    Debug.Console(2, this, "Received: {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
-				var bytesHandler = BytesReceived;
+ 				var bytesHandler = BytesReceived;
 				if (bytesHandler != null)
 					bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
 				var textHandler = TextReceived;
@@ -106,8 +104,6 @@ namespace PepperDash.Core
 		/// </summary>
 		public void SendEscapedText(string text)
 		{
-			//if (Client.ClientStatus != SocketStatus.SOCKET_STATUS_CONNECTED)
-			//    Connect();
 			var unescapedText = Regex.Replace(text, @"\\x([0-9a-fA-F][0-9a-fA-F])", s =>
 				{
 					var hex = s.Groups[1].Value;
@@ -115,9 +111,6 @@ namespace PepperDash.Core
 				});
 			SendText(unescapedText);
 
-			//var bytes = Encoding.GetEncoding(28591).GetBytes(unescapedText);
-			//Debug.Console(2, this, "Sending {0} bytes: '{1}'", bytes.Length, text);
-			//Client.SendData(bytes, bytes.Length);
 		}
 
 		public void SendBytes(byte[] bytes)

Pepperdash Core/Pepperdash Core/Comm/SshConfig.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+using Newtonsoft.Json;
+
+namespace PepperDash.Core
+{
+	public class SshConfig : TcpIpConfig
+	{
+		public string Username { get; set; }
+		public string Password { get; set; }
+	}
+}

Pepperdash Core/Pepperdash Core/CommunicationExtras.cs

@@ -16,13 +16,27 @@ namespace PepperDash.Core
 	{
 		event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
 		event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
+
 		bool IsConnected { get; }
-		bool Connected { get; }
 		void SendText(string text);
 		void SendBytes(byte[] bytes);
 		void Connect();
 	}
 
+	/// <summary>
+	/// 
+	/// </summary>
+	public enum eGenericCommMethodStatusChangeType
+	{
+		Connected, Disconnected
+	}
+
+	/// <summary>
+	/// This delegate defines handler for IBasicCommunication status changes
+	/// </summary>
+	/// <param name="comm">Device firing the status change</param>
+	/// <param name="status"></param>
+	public delegate void GenericCommMethodStatusHandler(IBasicCommunication comm, eGenericCommMethodStatusChangeType status);
 
 	/// <summary>
 	/// 

Pepperdash Core/Pepperdash Core/CoreInterfaces.cs

@@ -10,4 +10,9 @@ namespace PepperDash.Core
 	{
 		string Key { get; }
 	}
+
+	public interface IKeyName : IKeyed
+	{
+		string Name { get; }
+	}
 }

Pepperdash Core/Pepperdash Core/Debug.cs

@@ -8,8 +8,10 @@ using Crestron.SimplSharp.CrestronDataStore;
 
 namespace PepperDash.Core
 {
-	public class Debug
+	public static class Debug
 	{
+
+
 		public static uint Level { get; private set; }
 
 		/// <summary>

Pepperdash Core/Pepperdash Core/Device.cs

@@ -8,7 +8,7 @@ namespace PepperDash.Core
 	/// <summary>
 	/// The core event and status-bearing class that most if not all device and connectors can derive from.
 	/// </summary>
-	public class Device : IKeyed
+	public class Device : IKeyName
 	{
 		public string Key { get; protected set; }
 		public string Name { get; protected set; }

Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj

@@ -63,11 +63,13 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="CommunicationExtras.cs" />
+    <Compile Include="Comm\GenericSshClient.cs" />
+    <Compile Include="Comm\SshConfig.cs" />
     <Compile Include="CoreInterfaces.cs" />
     <Compile Include="Debug.cs" />
     <Compile Include="Device.cs" />
     <Compile Include="EthernetHelper.cs" />
-    <Compile Include="GenericTcpIpClient.cs" />
+    <Compile Include="Comm\GenericTcpIpClient.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <None Include="Properties\ControlSystem.cfg" />
   </ItemGroup>
@@ -80,7 +82,7 @@
         <Programmer />
         <ArchiveFilename>C:\Users\hvolm\Desktop\working\pepperdash-simplsharp-core\Pepperdash Core\Pepperdash Core\bin\PepperDash_Core.clz</ArchiveFilename>
         <MinFirmwareVersion>1.007.0017</MinFirmwareVersion>
-        <CompiledOn>6/17/2016 10:42:36 AM</CompiledOn>
+        <CompiledOn>8/3/2016 3:25:15 PM</CompiledOn>
         <AdditionalInfo />
         <EmbedSourceArchive>False</EmbedSourceArchive>
         <CopyTo />

Pepperdash Core/Pepperdash Core/bin/PepperDash_Core.config

@@ -10,7 +10,7 @@
     <ArchiveName />
   </RequiredInfo>
   <OptionalInfo>
-    <CompiledOn>6/17/2016 10:42:36 AM</CompiledOn>
-    <CompilerRev>1.0.0.17477</CompilerRev>
+    <CompiledOn>8/3/2016 3:25:15 PM</CompiledOn>
+    <CompilerRev>1.0.0.25957</CompilerRev>
   </OptionalInfo>
 </ProgramInfo>

Pepperdash Core/Pepperdash Core/bin/manifest.info

@@ -1,4 +1,4 @@
-MainAssembly=PepperDash_Core.dll:2aa20b6ac2f133d96f5ebf4bd3388e0f
+MainAssembly=PepperDash_Core.dll:2888e497caab5a6d6578b6174add3a96
 MainAssemblyMinFirmwareVersion=1.007.0017
 ü
 DependencySource=Newtonsoft.Json.Compact.dll:ea996aa2ec65aa1878e7c9d09e37a896