Merge branch 'develop' into bcl-ciphermode

Author: scott-xu

.github/workflows/build.yml

@@ -116,7 +116,7 @@ jobs:
       uses: actions/setup-dotnet@v4
 
     - name: Setup WSL2
-      uses: Vampire/setup-wsl@f40fb59d850112c9a292b0218bca8271305b9127 # v5.0.0
+      uses: Vampire/setup-wsl@3b46b44374d5d0ae94654c45d114a3ed7a0e07a8 # v5.0.1
       with:
         distribution: Ubuntu-24.04
 

Directory.Packages.props

@@ -4,25 +4,25 @@
     <CentralPackageVersionOverrideEnabled>false</CentralPackageVersionOverrideEnabled>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="BenchmarkDotNet" Version="0.14.0" />
-    <PackageVersion Include="BouncyCastle.Cryptography" Version="2.5.1" />
+    <PackageVersion Include="BenchmarkDotNet" Version="0.15.0" />
+    <PackageVersion Include="BouncyCastle.Cryptography" Version="2.6.1" />
     <PackageVersion Include="coverlet.collector" Version="6.0.4" />
     <PackageVersion Include="coverlet.msbuild" Version="6.0.4" />
     <PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
-    <PackageVersion Include="Meziantou.Analyzer" Version="2.0.188" />
+    <PackageVersion Include="Meziantou.Analyzer" Version="2.0.201" />
 
     <!-- Should stay on LTS .NET releases. -->
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.3" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.3" />
-    <PackageVersion Include="MSTest" Version="3.8.3" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.5" />
+    <PackageVersion Include="MSTest" Version="3.9.1" />
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="Nerdbank.GitVersioning" Version="3.7.115" />
     <PackageVersion Include="PolySharp" Version="1.15.0" />
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.7.0.110445" />
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.10.0.116381" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
 
     <!-- Should stay on LTS .NET releases. -->
     <PackageVersion Include="System.Formats.Asn1" Version="8.0.2" />
-    <PackageVersion Include="Testcontainers" Version="4.3.0" />
+    <PackageVersion Include="Testcontainers" Version="4.5.0" />
   </ItemGroup>
 </Project>

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "9.0.200",
+    "version": "9.0.300",
     "rollForward": "latestFeature"
   }
 }

src/Renci.SshNet/Channels/Channel.cs

@@ -378,9 +378,9 @@ protected virtual void OnWindowAdjust(uint bytesToAdd)
         /// Called when channel data is received.
         /// </summary>
         /// <param name="data">The data.</param>
-        protected virtual void OnData(byte[] data)
+        protected virtual void OnData(ArraySegment<byte> data)
         {
-            AdjustDataWindow(data);
+            AdjustDataWindow(data.Count);
 
             DataReceived?.Invoke(this, new ChannelDataEventArgs(LocalChannelNumber, data));
         }
@@ -392,7 +392,7 @@ protected virtual void OnData(byte[] data)
         /// <param name="dataTypeCode">The data type code.</param>
         protected virtual void OnExtendedData(byte[] data, uint dataTypeCode)
         {
-            AdjustDataWindow(data);
+            AdjustDataWindow(data.Length);
 
             ExtendedDataReceived?.Invoke(this, new ChannelExtendedDataEventArgs(LocalChannelNumber, data, dataTypeCode));
         }
@@ -651,7 +651,7 @@ private void OnChannelData(object sender, MessageEventArgs<ChannelDataMessage> e
             {
                 try
                 {
-                    OnData(e.Message.Data);
+                    OnData(new ArraySegment<byte>(e.Message.Data, e.Message.Offset, e.Message.Size));
                 }
                 catch (Exception ex)
                 {
@@ -768,9 +768,9 @@ private void OnChannelFailure(object sender, MessageEventArgs<ChannelFailureMess
             }
         }
 
-        private void AdjustDataWindow(byte[] messageData)
+        private void AdjustDataWindow(int count)
         {
-            LocalWindowSize -= (uint)messageData.Length;
+            LocalWindowSize -= (uint)count;
 
             // Adjust window if window size is too low
             if (LocalWindowSize < LocalPacketSize)

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -194,7 +194,7 @@ protected override void Close()
         /// Called when channel data is received.
         /// </summary>
         /// <param name="data">The data.</param>
-        protected override void OnData(byte[] data)
+        protected override void OnData(ArraySegment<byte> data)
         {
             base.OnData(data);
 
@@ -204,7 +204,7 @@ protected override void OnData(byte[] data)
                 {
                     if (_socket.IsConnected())
                     {
-                        SocketAbstraction.Send(_socket, data, 0, data.Length);
+                        SocketAbstraction.Send(_socket, data.Array, data.Offset, data.Count);
                     }
                 }
             }

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -201,14 +201,14 @@ protected override void Close()
         /// Called when channel data is received.
         /// </summary>
         /// <param name="data">The data.</param>
-        protected override void OnData(byte[] data)
+        protected override void OnData(ArraySegment<byte> data)
         {
             base.OnData(data);
 
             var socket = _socket;
             if (socket.IsConnected())
             {
-                SocketAbstraction.Send(socket, data, 0, data.Length);
+                SocketAbstraction.Send(socket, data.Array, data.Offset, data.Count);
             }
         }
     }

src/Renci.SshNet/Common/ChannelDataEventArgs.cs

@@ -13,17 +13,22 @@ internal class ChannelDataEventArgs : ChannelEventArgs
         /// <param name="channelNumber">Channel number.</param>
         /// <param name="data">Channel data.</param>
         /// <exception cref="ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
-        public ChannelDataEventArgs(uint channelNumber, byte[] data)
+        public ChannelDataEventArgs(uint channelNumber, ArraySegment<byte> data)
             : base(channelNumber)
         {
-            ThrowHelper.ThrowIfNull(data);
+            ThrowHelper.ThrowIfNull(data.Array);
 
             Data = data;
         }
 
+        internal ChannelDataEventArgs(uint channelNumber, byte[] data)
+            : this(channelNumber, new ArraySegment<byte>(data))
+        {
+        }
+
         /// <summary>
         /// Gets channel data.
         /// </summary>
-        public byte[] Data { get; }
+        public ArraySegment<byte> Data { get; }
     }
 }

src/Renci.SshNet/Common/ChannelExtendedDataEventArgs.cs

@@ -1,4 +1,6 @@
-namespace Renci.SshNet.Common
+using System;
+
+namespace Renci.SshNet.Common
 {
     /// <summary>
     /// Provides data for <see cref="Channels.Channel.ExtendedDataReceived"/> events.
@@ -12,7 +14,7 @@ internal sealed class ChannelExtendedDataEventArgs : ChannelDataEventArgs
         /// <param name="data">Channel data.</param>
         /// <param name="dataTypeCode">Channel data type code.</param>
         public ChannelExtendedDataEventArgs(uint channelNumber, byte[] data, uint dataTypeCode)
-            : base(channelNumber, data)
+            : base(channelNumber, new ArraySegment<byte>(data))
         {
             DataTypeCode = dataTypeCode;
         }

src/Renci.SshNet/Common/SshData.cs

@@ -232,7 +232,7 @@ protected string ReadString(Encoding encoding = null)
         }
 
         /// <summary>
-        /// Reads next data type as byte array from internal buffer.
+        /// Reads a length-prefixed byte array from the internal buffer.
         /// </summary>
         /// <returns>
         /// The bytes read.
@@ -242,6 +242,20 @@ protected byte[] ReadBinary()
             return _stream.ReadBinary();
         }
 
+        /// <summary>
+        /// Reads a length-prefixed byte array from the internal buffer,
+        /// returned as a view over the buffer.
+        /// </summary>
+        /// <remarks>
+        /// When using this method, consider whether the underlying buffer is shared
+        /// or reused, and whether the returned <see cref="ArraySegment{T}"/> may
+        /// exist beyond the lifetime for which it is valid to be used.
+        /// </remarks>
+        private protected ArraySegment<byte> ReadBinarySegment()
+        {
+            return _stream.ReadBinarySegment();
+        }
+
         /// <summary>
         /// Reads next name-list data type from internal buffer.
         /// </summary>

src/Renci.SshNet/ISftpClient.cs

@@ -700,6 +700,21 @@ public interface ISftpClient : IBaseClient
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         SftpFileAttributes GetAttributes(string path);
 
+        /// <summary>
+        /// Gets the <see cref="SftpFileAttributes"/> of the file on the path.
+        /// </summary>
+        /// <param name="path">The path to the file.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
+        /// <returns>
+        /// A <see cref="Task{SftpFileAttributes}"/> that represents the attribute retrieval operation.
+        /// The task result contains the <see cref="SftpFileAttributes"/> of the file on the path.
+        /// </returns>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
+        /// <exception cref="SshConnectionException">Client is not connected.</exception>
+        /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
+        /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        Task<SftpFileAttributes> GetAttributesAsync(string path, CancellationToken cancellationToken);
+
         /// <summary>
         /// Returns the date and time the specified file or directory was last accessed.
         /// </summary>