Merge remote-tracking branch 'refs/remotes/origin/develop'

Author: drieseng

build/nuget/SSH.NET.nuspec

@@ -10,125 +10,7 @@
         <projectUrl>https://github.com/sshnet/SSH.NET/</projectUrl>
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
         <description>SSH.NET is a Secure Shell (SSH) library for .NET, optimized for parallelism and with broad framework support.</description>
-        <releaseNotes>2016.0.0-beta3
-==============
-
-New Features:
-
-    * Added support for .NET Core 1.0 (.NETStandard 1.3)
-
-2016.0.0-beta2
-==============
-
-Changes:
-
-    * Improved performance of ScpClient (GitHub issue #21)
-
-Fixes:
-
-    * Terminal width (pixels) is not passed in pty-req
-    * Stopping ForwardedPortDynamic without ever having started would result in a NRE
-
-2016.0.0-beta1
-==============
-
-New Features:
-
-    * Added support for HMAC-SHA512 (hmac-sha2-512 and hmac-sha2-512-96)
-    * Added support for Universal Windows Platform 10 (UAP10.0)
-
-Changes:
-
-    * Overall performance improvements
-    * Relicensed code under MIT license, explicitly permitting reuse within proprietary software
-      provided all copies of the licensed software include a copy of the MIT License terms and the
-      copyright notice
-    * Separated our hash algorithms into SshNet.Security.Cryptography project and package
-    * When available, prefer hash algorithms and encodings from target framework
-    * Refactoring to prepare for upcoming .NET Core support
-
-Fixes:
-
-    * Partial reads from stream assume end (CodePlex issue #1516)
-    * Session.Disconnect() hangs forever (CodePlex issue #2591)
-    * SshData.ReadInt64() is broken (CodePlex issue #2579)
-    * Race condition when SSH_MSG_GLOBAL_REQUEST is received immediately after successful authentication (GitHub issue #8)
-
-2014.4.6-beta2
-==============
-
-New Features:
-
-    * Improved accuracy of IsConnected on .NET
-    * Added support for ssh.com (SSH-2) private keys (issue #1987)
-    * Support an acceptable group of up to 8192 bits for SHA-1 and SHA-256 Diffie-Hellman Group and Key Exchange (issues #1973 and #1777)
-
-Changes:
-
-    * Reduced default buffer size for SftpClient from 64 KB to 32 KB as some SSH servers apply a hard limit of 64 KB at the transport level.
-
-Fixes:
-
-    * SftpClient is throwing undocumented exceptions (issue #2148)
-    * Client channels are no longer closed on dispose (issue #1943)
-    * SftpClient.Exists(string) returns true for a path that does not exist (issues #1952, #1696 and #1574)
-    * ObjectDisposedException when channel is closing (issues #1942 and #1944)
-    * Stack overflow during authentication when server returns same allowed methods after partial success (issue #2399)
-    * SshCommand doesn't cleanup subscribed events (issue #2295)
-    * Lines before protocol identification string are not skipped (issue #1935 and #2223)
-    * ShellStream.ReadLine produces incorrect output when reading multi-byte characters (issue #2190)
-    * SftpClient constructor throws ArgumentException when host contains underscore (issue #1845)
-    * Signing key is missing from source download (issue #2455)
-    * Forwarded Port channels can get stuck waiting (issue #1558)
-    * NullReferenceException when SftpFileStream is finalized after dispose of session (issue #2013)
-    * BlockCipher.Encrypt fails if input message is not padded (issue #2547)
-    * ScpClient: Missing files when using DirectoryUpload (issue #1382)
-    * Dynamic port forwarding slows down to a crawl (issue #2010)
-    * SendKeepAlive causes SocketException when connection is dropped (issue #2029)
-    * SocketException on Dispose or Disconnect (issue #2400)
-    * Sending EOF on wrong channel number (issue #1877)
-    * ForwardedPortDynamic: Unhandled exception if client terminates socket (issue #1844)
-
-2014.4.6-beta1
-==============
-
-New Features:
-
-    * Added callbacks to UploadFile, DownloadFile and ListDirectory in SftpClient (issue #1324)
-    * Allow a given private key file to be used concurrently
-    * Performance improvements:
-        - optimization of payload size for both read and write operations (SftpClient only)
-        - increase window size from 1MB to 2MB
-        - increase buffer size from 16KB to 64KB for SftpClient
-        - take into account the maximum remote packet size of the channel for write operations
-        - increase maximum size of packets that we can receive from 32 KB to 64 KB
-    * Improve exception message for authentication failures
-
-Breaking changes:
-
-    * Assembly name is now Renci.SshNet for all supported frameworks
-    * The Renci.SshNet assemblies for .NET and Silverlight are now strong-named (issue #1802)
-
-Fixes:
-
-    * Incorrect copyright in assemblies (issue #1764)
-    * Remove linefeed from WriteLine method in Shellstream class (issue #1584)
-    * Disable logging of messages in release builds (issue #1767)
-    * Stuck loop on key exchange using arcfour encryption (issue #1922)
-    * Timeout sending data to server with low window size (issue #1706)
-    * No connection possible with the same auth method requested multiple times (issue #1930)
-    * Unobserved exception rethrown by finalizer thread (issue #1298 and #1587)
-    * Client cipher is used to decrypt server messages (issue #1917)
-    * Connection dropped by server due to invalid DSA signature (issue #1918)
-    * Correct casing of Security/Cryptography/HMAC.cs to fix build on Linux (issue #1505)
-    * HTTP proxy hangs (issue #1890)
-    * Wrong parameters to SetSocketOption leads to SocketException under Mono (issue #1799)
-    * Incorrect check for timeout values (issue #1620)
-    * Wrong PKCS7 padding in DES algorithm (issue #1580)
-    * OverflowException on empty server response (issue #1562)
-    * Event handle leak (issue #1761)
-    * SftpFileStream is very slow (issue #1919)
-    * Write access required for private key file</releaseNotes>
+        <releaseNotes>https://github.com/sshnet/SSH.NET/releases/tag/2016.0.0-beta3</releaseNotes>
         <summary>A Secure Shell (SSH) library for .NET, optimized for parallelism.</summary>
         <copyright>2012-2016, RENCI</copyright>
         <language>en-US</language>

src/Renci.SshNet.Tests/Classes/Channels/ChannelTest_Close_SessionIsConnectedAndChannelIsOpen_EofReceived.cs

@@ -20,9 +20,9 @@ public class ChannelTest_Close_SessionIsConnectedAndChannelIsOpen_EofReceived
         private uint _remoteWindowSize;
         private uint _remotePacketSize;
         private ChannelStub _channel;
-        private Stopwatch _closeTimer;
         private List<ChannelEventArgs> _channelClosedRegister;
         private IList<ExceptionEventArgs> _channelExceptionRegister;
+        private ManualResetEvent _channelClosedReceived;
 
         [TestInitialize]
         public void Initialize()
@@ -31,6 +31,16 @@ public void Initialize()
             Act();
         }
 
+        [TestCleanup]
+        public void TearDown()
+        {
+            if (_channelClosedReceived != null)
+            {
+                _channelClosedReceived.Dispose();
+                _channelClosedReceived = null;
+            }
+        }
+
         private void Arrange()
         {
             var random = new Random();
@@ -40,9 +50,9 @@ private void Arrange()
             _remoteChannelNumber = (uint)random.Next(0, int.MaxValue);
             _remoteWindowSize = (uint)random.Next(0, int.MaxValue);
             _remotePacketSize = (uint)random.Next(0, int.MaxValue);
-            _closeTimer = new Stopwatch();
             _channelClosedRegister = new List<ChannelEventArgs>();
             _channelExceptionRegister = new List<ExceptionEventArgs>();
+            _channelClosedReceived = new ManualResetEvent(false);
 
             _sessionMock = new Mock<ISession>(MockBehavior.Strict);
 
@@ -55,22 +65,19 @@ private void Arrange()
                         new Thread(() =>
                             {
                                 Thread.Sleep(100);
+                                // signal that the ChannelCloseMessage was received; we use this to verify whether we've actually
+                                // waited on the EventWaitHandle to be set
+                                _channelClosedReceived.Set();
                                 // raise ChannelCloseReceived event to set waithandle for receiving
                                 // SSH_MSG_CHANNEL_CLOSE message from server which is waited on after
                                 // sending the SSH_MSG_CHANNEL_CLOSE message to the server
-                                _sessionMock.Raise(s => s.ChannelCloseReceived += null,
-                                    new MessageEventArgs<ChannelCloseMessage>(
-                                        new ChannelCloseMessage(_localChannelNumber)));
+                                // 
+                                // we're mocking the wait on the ChannelCloseMessage, but we still want
+                                // to get the channel in the state that it would have after actually receiving
+                                // the ChannelCloseMessage
+                                _sessionMock.Raise(s => s.ChannelCloseReceived += null, new MessageEventArgs<ChannelCloseMessage>(new ChannelCloseMessage(_localChannelNumber)));
                             }).Start();
-                        _closeTimer.Start();
-                        try
-                        {
-                            w.WaitOne();
-                        }
-                        finally
-                        {
-                            _closeTimer.Stop();
-                        }
+                        w.WaitOne();
                     });
 
             _channel = new ChannelStub(_sessionMock.Object, _localChannelNumber, _localWindowSize, _localPacketSize);
@@ -120,7 +127,7 @@ public void WaitOnHandleOnSessionShouldBeInvokedOnce()
         [TestMethod]
         public void WaitOnHandleOnSessionShouldWaitForChannelCloseMessageToBeReceived()
         {
-            Assert.IsTrue(_closeTimer.ElapsedMilliseconds >= 100, "Elapsed milliseconds=" + _closeTimer.ElapsedMilliseconds);
+            Assert.IsTrue(_channelClosedReceived.WaitOne(0));
         }
 
         [TestMethod]

src/Renci.SshNet.Tests/Classes/ForwardedPortDynamicTest_Started_SocketSendShutdownImmediately.cs

@@ -3,6 +3,7 @@
 using System.Net;
 using System.Net.Sockets;
 using System.Text;
+using System.Threading;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;
 using Renci.SshNet.Channels;
@@ -21,6 +22,8 @@ public class ForwardedPortDynamicTest_Started_SocketSendShutdownImmediately
         private IList<EventArgs> _closingRegister;
         private IList<ExceptionEventArgs> _exceptionRegister;
         private TimeSpan _connectionTimeout;
+        private ManualResetEvent _channelDisposed;
+        private IPEndPoint _forwardedPortEndPoint;
 
         [TestInitialize]
         public void Initialize()
@@ -38,6 +41,7 @@ public void Cleanup()
                 _connectionInfoMock.Setup(p => p.Timeout).Returns(TimeSpan.FromSeconds(5));
                 _forwardedPort.Stop();
             }
+
             if (_client != null)
             {
                 if (_client.Connected)
@@ -47,13 +51,28 @@ public void Cleanup()
                     _client = null;
                 }
             }
+
+            if (_channelDisposed != null)
+            {
+                _channelDisposed.Dispose();
+                _channelDisposed = null;
+            }
         }
 
         private void SetupData()
         {
             _closingRegister = new List<EventArgs>();
             _exceptionRegister = new List<ExceptionEventArgs>();
             _connectionTimeout = TimeSpan.FromSeconds(5);
+            _channelDisposed = new ManualResetEvent(false);
+            _forwardedPortEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
+
+            _forwardedPort = new ForwardedPortDynamic((uint) _forwardedPortEndPoint.Port);
+            _forwardedPort.Closing += (sender, args) => _closingRegister.Add(args);
+            _forwardedPort.Exception += (sender, args) => _exceptionRegister.Add(args);
+            _forwardedPort.Session = _sessionMock.Object;
+
+            _client = new Socket(_forwardedPortEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
         }
 
         private void CreateMocks()
@@ -72,30 +91,26 @@ private void SetupMocks()
             _sessionMock.InSequence(seq).Setup(p => p.ConnectionInfo).Returns(_connectionInfoMock.Object);
             _connectionInfoMock.InSequence(seq).Setup(p => p.Timeout).Returns(_connectionTimeout);
             _channelMock.InSequence(seq).Setup(p => p.Close());
-            _channelMock.InSequence(seq).Setup(p => p.Dispose());
+            _channelMock.InSequence(seq).Setup(p => p.Dispose()).Callback(() => _channelDisposed.Set());
         }
 
         private void Arrange()
         {
-            SetupData();
             CreateMocks();
+            SetupData();
             SetupMocks();
 
-            _forwardedPort = new ForwardedPortDynamic(8122);
-            _forwardedPort.Closing += (sender, args) => _closingRegister.Add(args);
-            _forwardedPort.Exception += (sender, args) => _exceptionRegister.Add(args);
-            _forwardedPort.Session = _sessionMock.Object;
             _forwardedPort.Start();
 
-            var endPoint = new IPEndPoint(IPAddress.Loopback, 8122);
-
-            _client = new Socket(endPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
-            _client.Connect(endPoint);
+            _client.Connect(_forwardedPortEndPoint);
         }
 
         private void Act()
         {
             _client.Shutdown(SocketShutdown.Send);
+
+            // wait for channel to be disposed
+            _channelDisposed.WaitOne(TimeSpan.FromMilliseconds(200));
         }
 
         [TestMethod]

src/Renci.SshNet.Tests/Classes/ForwardedPortRemoteTest_Start_PortStopped.cs

@@ -121,6 +121,7 @@ public void ForwardedPortShouldAcceptNewConnections()
             var originatorAddress = new Random().Next().ToString(CultureInfo.InvariantCulture);
             var originatorPort = (uint)new Random().Next(0, int.MaxValue);
             var channelMock = new Mock<IChannelForwardedTcpip>(MockBehavior.Strict);
+            var channelDiposed = new ManualResetEvent(false);
 
             _sessionMock.Setup(
                 p =>
@@ -132,14 +133,17 @@ public void ForwardedPortShouldAcceptNewConnections()
                             ep => ep.Address.Equals(_remoteEndpoint.Address) && ep.Port == _remoteEndpoint.Port),
                         _forwardedPort));
             channelMock.Setup(p => p.Close());
-            channelMock.Setup(p => p.Dispose());
+            channelMock.Setup(p => p.Dispose()).Callback(() => channelDiposed.Set());
 
             _sessionMock.Raise(p => p.ChannelOpenReceived += null,
                 new MessageEventArgs<ChannelOpenMessage>(new ChannelOpenMessage(channelNumber, initialWindowSize,
                     maximumPacketSize,
                     new ForwardedTcpipChannelInfo(_forwardedPort.BoundHost, _forwardedPort.BoundPort, originatorAddress,
                         originatorPort))));
 
+            // wait for channel to be disposed
+            channelDiposed.WaitOne(TimeSpan.FromMilliseconds(200));
+
             _sessionMock.Verify(p => p.CreateChannelForwardedTcpip(channelNumber, initialWindowSize, maximumPacketSize), Times.Once);
             channelMock.Verify(p => p.Bind(It.Is<IPEndPoint>(ep => ep.Address.Equals(_remoteEndpoint.Address) && ep.Port == _remoteEndpoint.Port), _forwardedPort), Times.Once);
             channelMock.Verify(p => p.Close(), Times.Once);

src/Renci.SshNet.Tests/Classes/ForwardedPortRemoteTest_Started.cs

@@ -99,6 +99,7 @@ public void ForwardedPortShouldAcceptChannelOpenMessageForBoundAddressAndBoundPo
             var originatorAddress = new Random().Next().ToString(CultureInfo.InvariantCulture);
             var originatorPort = (uint) new Random().Next(0, int.MaxValue);
             var channelMock = new Mock<IChannelForwardedTcpip>(MockBehavior.Strict);
+            var channelDisposed = new ManualResetEvent(false);
 
             _sessionMock.Setup(
                 p =>
@@ -110,14 +111,17 @@ public void ForwardedPortShouldAcceptChannelOpenMessageForBoundAddressAndBoundPo
                             ep => ep.Address.Equals(_remoteEndpoint.Address) && ep.Port == _remoteEndpoint.Port),
                         _forwardedPort));
             channelMock.Setup(p => p.Close());
-            channelMock.Setup(p => p.Dispose());
+            channelMock.Setup(p => p.Dispose()).Callback(() => channelDisposed.Set());
 
             _sessionMock.Raise(p => p.ChannelOpenReceived += null,
                 new MessageEventArgs<ChannelOpenMessage>(new ChannelOpenMessage(channelNumber, initialWindowSize,
                     maximumPacketSize,
                     new ForwardedTcpipChannelInfo(_forwardedPort.BoundHost, _forwardedPort.BoundPort, originatorAddress,
                         originatorPort))));
 
+            // wait for channel to be disposed
+            channelDisposed.WaitOne(TimeSpan.FromMilliseconds(200));
+
             _sessionMock.Verify(p => p.CreateChannelForwardedTcpip(channelNumber, initialWindowSize, maximumPacketSize), Times.Once);
             channelMock.Verify(p => p.Bind(It.Is<IPEndPoint>(ep => ep.Address.Equals(_remoteEndpoint.Address) && ep.Port == _remoteEndpoint.Port), _forwardedPort), Times.Once);
             channelMock.Verify(p => p.Close(), Times.Once);