///
* G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1
*
- * where a = primitive root of field generator 0x14D
+ * where a = primitive root of field generator 0x14D.
*
*/
private static int RS_rem(int x)
{
- var b = (int)(((uint)x >> 24) & 0xff);
+ var b = (int) (((uint) x >> 24) & 0xff);
var g2 = ((b << 1) ^ ((b & 0x80) != 0 ? RS_GF_FDBK : 0)) & 0xff;
- var g3 = ((int)((uint)b >> 1) ^ ((b & 0x01) != 0 ? (int)((uint)RS_GF_FDBK >> 1) : 0)) ^ g2;
+ var g3 = ((int) ((uint) b >> 1) ^ ((b & 0x01) != 0 ? (int) ((uint) RS_GF_FDBK >> 1) : 0)) ^ g2;
return (x << 8) ^ (g3 << 24) ^ (g2 << 16) ^ (g3 << 8) ^ b;
}
@@ -484,18 +486,18 @@ private static int M_b3(int x)
private static int Fe32_0(int[] gSBox1, int x)
{
- return gSBox1[0x000 + 2 * (x & 0xff)] ^
- gSBox1[0x001 + 2 * ((int)((uint)x >> 8) & 0xff)] ^
- gSBox1[0x200 + 2 * ((int)((uint)x >> 16) & 0xff)] ^
- gSBox1[0x201 + 2 * ((int)((uint)x >> 24) & 0xff)];
+ return gSBox1[0x000 + (2 * (x & 0xff))] ^
+ gSBox1[0x001 + (2 * ((int)((uint)x >> 8) & 0xff))] ^
+ gSBox1[0x200 + (2 * ((int)((uint)x >> 16) & 0xff))] ^
+ gSBox1[0x201 + (2 * ((int)((uint)x >> 24) & 0xff))];
}
private static int Fe32_3(int[] gSBox1, int x)
{
- return gSBox1[0x000 + 2 * ((int)((uint)x >> 24) & 0xff)] ^
- gSBox1[0x001 + 2 * (x & 0xff)] ^
- gSBox1[0x200 + 2 * ((int)((uint)x >> 8) & 0xff)] ^
- gSBox1[0x201 + 2 * ((int)((uint)x >> 16) & 0xff)];
+ return gSBox1[0x000 + (2 * ((int) ((uint) x >> 24) & 0xff))] ^
+ gSBox1[0x001 + (2 * (x & 0xff))] ^
+ gSBox1[0x200 + (2 * ((int)((uint)x >> 8) & 0xff))] ^
+ gSBox1[0x201 + (2 * ((int)((uint)x >> 16) & 0xff))];
}
private static int BytesTo32Bits(byte[] b, int p)
diff --git a/src/Renci.SshNet/Security/Cryptography/DigitalSignature.cs b/src/Renci.SshNet/Security/Cryptography/DigitalSignature.cs
index e675fe325..3e7cee7db 100644
--- a/src/Renci.SshNet/Security/Cryptography/DigitalSignature.cs
+++ b/src/Renci.SshNet/Security/Cryptography/DigitalSignature.cs
@@ -1,7 +1,7 @@
namespace Renci.SshNet.Security.Cryptography
{
///
- /// Base class for signature implementations
+ /// Base class for signature implementations.
///
public abstract class DigitalSignature
{
@@ -10,7 +10,9 @@ public abstract class DigitalSignature
///
/// The input.
/// The signature.
- /// if signature was successfully verified; otherwise .
+ ///
+ /// if signature was successfully verified; otherwise .
+ ///
public abstract bool Verify(byte[] input, byte[] signature);
///
diff --git a/src/Renci.SshNet/Security/Cryptography/DsaDigitalSignature.cs b/src/Renci.SshNet/Security/Cryptography/DsaDigitalSignature.cs
index 03b4d0169..a5aae17c0 100644
--- a/src/Renci.SshNet/Security/Cryptography/DsaDigitalSignature.cs
+++ b/src/Renci.SshNet/Security/Cryptography/DsaDigitalSignature.cs
@@ -80,10 +80,10 @@ public override bool Verify(byte[] input, byte[] signature)
var w = BigInteger.ModInverse(s, _key.Q);
// Calculate u1 = H(m)·w mod q
- var u1 = hm * w % _key.Q;
+ var u1 = (hm * w) % _key.Q;
// Calculate u2 = r * w mod q
- var u2 = r * w % _key.Q;
+ var u2 = (r * w) % _key.Q;
u1 = BigInteger.ModPow(_key.G, u1, _key.P);
u2 = BigInteger.ModPow(_key.Y, u2, _key.P);
diff --git a/src/Renci.SshNet/Security/Cryptography/DsaKey.cs b/src/Renci.SshNet/Security/Cryptography/DsaKey.cs
index cdd0c4def..65c6fceec 100644
--- a/src/Renci.SshNet/Security/Cryptography/DsaKey.cs
+++ b/src/Renci.SshNet/Security/Cryptography/DsaKey.cs
@@ -160,7 +160,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/Cryptography/ED25519DigitalSignature.cs b/src/Renci.SshNet/Security/Cryptography/ED25519DigitalSignature.cs
index 1e8e21bce..2d3cdb956 100644
--- a/src/Renci.SshNet/Security/Cryptography/ED25519DigitalSignature.cs
+++ b/src/Renci.SshNet/Security/Cryptography/ED25519DigitalSignature.cs
@@ -64,7 +64,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/Cryptography/ED25519Key.cs b/src/Renci.SshNet/Security/Cryptography/ED25519Key.cs
index 48c3a74b4..bb0037945 100644
--- a/src/Renci.SshNet/Security/Cryptography/ED25519Key.cs
+++ b/src/Renci.SshNet/Security/Cryptography/ED25519Key.cs
@@ -11,17 +11,21 @@ namespace Renci.SshNet.Security
///
public class ED25519Key : Key, IDisposable
{
- private ED25519DigitalSignature _digitalSignature;
-
- private byte[] _publicKey = new byte[Ed25519.PublicKeySizeInBytes];
#pragma warning disable IDE1006 // Naming Styles
+#pragma warning disable SX1309 // Field names should begin with underscore
private readonly byte[] privateKey = new byte[Ed25519.ExpandedPrivateKeySizeInBytes];
+#pragma warning restore SX1309 // Field names should begin with underscore
#pragma warning restore IDE1006 // Naming Styles
+ private ED25519DigitalSignature _digitalSignature;
+ private byte[] _publicKey = new byte[Ed25519.PublicKeySizeInBytes];
private bool _isDisposed;
///
- /// Gets the Key String.
+ /// Gets the name of the key.
///
+ ///
+ /// The name of the key.
+ ///
public override string ToString()
{
return "ssh-ed25519";
@@ -132,7 +136,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/Cryptography/EcdsaDigitalSignature.cs b/src/Renci.SshNet/Security/Cryptography/EcdsaDigitalSignature.cs
index 5c9025d54..74f114341 100644
--- a/src/Renci.SshNet/Security/Cryptography/EcdsaDigitalSignature.cs
+++ b/src/Renci.SshNet/Security/Cryptography/EcdsaDigitalSignature.cs
@@ -83,7 +83,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
@@ -106,81 +106,81 @@ protected virtual void Dispose(bool disposing)
{
Dispose(disposing: false);
}
- }
- internal sealed class SshDataSignature : SshData
- {
- private readonly int _signature_size;
+ private sealed class SshDataSignature : SshData
+ {
+ private readonly int _signature_size;
- private byte[] _signature_r;
- private byte[] _signature_s;
+ private byte[] _signature_r;
+ private byte[] _signature_s;
- public byte[] Signature
- {
- get
+ public byte[] Signature
{
- var signature = new byte[_signature_size];
- Buffer.BlockCopy(_signature_r, 0, signature, 0, _signature_r.Length);
- Buffer.BlockCopy(_signature_s, 0, signature, _signature_r.Length, _signature_s.Length);
- return signature;
+ get
+ {
+ var signature = new byte[_signature_size];
+ Buffer.BlockCopy(_signature_r, 0, signature, 0, _signature_r.Length);
+ Buffer.BlockCopy(_signature_s, 0, signature, _signature_r.Length, _signature_s.Length);
+ return signature;
+ }
+ set
+ {
+ var signed_r = new byte[_signature_size / 2];
+ Buffer.BlockCopy(value, 0, signed_r, 0, signed_r.Length);
+ _signature_r = signed_r.ToBigInteger2().ToByteArray().Reverse();
+
+ var signed_s = new byte[_signature_size / 2];
+ Buffer.BlockCopy(value, signed_r.Length, signed_s, 0, signed_s.Length);
+ _signature_s = signed_s.ToBigInteger2().ToByteArray().Reverse();
+ }
}
- set
- {
- var signed_r = new byte[_signature_size / 2];
- Buffer.BlockCopy(value, 0, signed_r, 0, signed_r.Length);
- _signature_r = signed_r.ToBigInteger2().ToByteArray().Reverse();
- var signed_s = new byte[_signature_size / 2];
- Buffer.BlockCopy(value, signed_r.Length, signed_s, 0, signed_s.Length);
- _signature_s = signed_s.ToBigInteger2().ToByteArray().Reverse();
+ public SshDataSignature(int sig_size)
+ {
+ _signature_size = sig_size;
}
- }
- public SshDataSignature(int sig_size)
- {
- _signature_size = sig_size;
- }
+ public SshDataSignature(byte[] data, int sig_size)
+ {
+ _signature_size = sig_size;
+ Load(data);
+ }
- public SshDataSignature(byte[] data, int sig_size)
- {
- _signature_size = sig_size;
- Load(data);
- }
+ protected override void LoadData()
+ {
+ _signature_r = ReadBinary().TrimLeadingZeros().Pad(_signature_size / 2);
+ _signature_s = ReadBinary().TrimLeadingZeros().Pad(_signature_size / 2);
+ }
- protected override void LoadData()
- {
- _signature_r = ReadBinary().TrimLeadingZeros().Pad(_signature_size / 2);
- _signature_s = ReadBinary().TrimLeadingZeros().Pad(_signature_size / 2);
- }
+ protected override void SaveData()
+ {
+ WriteBinaryString(_signature_r.ToBigInteger2().ToByteArray().Reverse());
+ WriteBinaryString(_signature_s.ToBigInteger2().ToByteArray().Reverse());
+ }
- protected override void SaveData()
- {
- WriteBinaryString(_signature_r.ToBigInteger2().ToByteArray().Reverse());
- WriteBinaryString(_signature_s.ToBigInteger2().ToByteArray().Reverse());
- }
+ public new byte[] ReadBinary()
+ {
+ var length = ReadUInt32();
- public new byte[] ReadBinary()
- {
- var length = ReadUInt32();
+ if (length > int.MaxValue)
+ {
+ throw new NotSupportedException(string.Format(CultureInfo.CurrentCulture, "Strings longer than {0} is not supported.", int.MaxValue));
+ }
- if (length > int.MaxValue)
- {
- throw new NotSupportedException(string.Format(CultureInfo.CurrentCulture, "Strings longer than {0} is not supported.", int.MaxValue));
+ return ReadBytes((int) length);
}
- return ReadBytes((int)length);
- }
-
- protected override int BufferCapacity
- {
- get
+ protected override int BufferCapacity
{
- var capacity = base.BufferCapacity;
- capacity += 4; // r length
- capacity += _signature_r.Length; // signature r
- capacity += 4; // s length
- capacity += _signature_s.Length; // signature s
- return capacity;
+ get
+ {
+ var capacity = base.BufferCapacity;
+ capacity += 4; // r length
+ capacity += _signature_r.Length; // signature r
+ capacity += 4; // s length
+ capacity += _signature_s.Length; // signature s
+ return capacity;
+ }
}
}
}
diff --git a/src/Renci.SshNet/Security/Cryptography/EcdsaKey.cs b/src/Renci.SshNet/Security/Cryptography/EcdsaKey.cs
index fe38dfec2..455bb1363 100644
--- a/src/Renci.SshNet/Security/Cryptography/EcdsaKey.cs
+++ b/src/Renci.SshNet/Security/Cryptography/EcdsaKey.cs
@@ -1,12 +1,11 @@
using System;
#if NETFRAMEWORK
+using System.Globalization;
using System.IO;
-#endif // NETFRAMEWORK
-using System.Text;
-#if NETFRAMEWORK
using System.Runtime.InteropServices;
#endif // NETFRAMEWORK
using System.Security.Cryptography;
+using System.Text;
using Renci.SshNet.Common;
using Renci.SshNet.Security.Cryptography;
@@ -18,9 +17,11 @@ namespace Renci.SshNet.Security
///
public class EcdsaKey : Key, IDisposable
{
- internal const string ECDSA_P256_OID_VALUE = "1.2.840.10045.3.1.7"; // Also called nistP256 or secP256r1
- internal const string ECDSA_P384_OID_VALUE = "1.3.132.0.34"; // Also called nistP384 or secP384r1
- internal const string ECDSA_P521_OID_VALUE = "1.3.132.0.35"; // Also called nistP521or secP521r1
+#pragma warning disable SA1310 // Field names should not contain underscore
+ private const string ECDSA_P256_OID_VALUE = "1.2.840.10045.3.1.7"; // Also called nistP256 or secP256r1
+ private const string ECDSA_P384_OID_VALUE = "1.3.132.0.34"; // Also called nistP384 or secP384r1
+ private const string ECDSA_P521_OID_VALUE = "1.3.132.0.35"; // Also called nistP521or secP521r1
+#pragma warning restore SA1310 // Field names should not contain underscore
private EcdsaDigitalSignature _digitalSignature;
private bool _isDisposed;
@@ -52,7 +53,7 @@ internal enum KeyBlobMagicNumber
internal struct BCRYPT_ECCKEY_BLOB
{
internal KeyBlobMagicNumber Magic;
- internal int cbKey;
+ internal int CbKey;
}
#endif
@@ -69,7 +70,7 @@ public override string ToString()
#if NETFRAMEWORK
///
- /// Gets the HashAlgorithm to use
+ /// Gets the HashAlgorithm to use.
///
public CngAlgorithm HashAlgorithm
{
@@ -84,7 +85,7 @@ public CngAlgorithm HashAlgorithm
case 521:
return CngAlgorithm.Sha512;
default:
- throw new SshException("Unknown KeySize: " + Ecdsa.KeySize);
+ throw new SshException("Unknown KeySize: " + Ecdsa.KeySize.ToString(CultureInfo.InvariantCulture));
}
}
}
@@ -380,6 +381,7 @@ private void Import(string curve_oid, byte[] publickey, byte[] privatekey)
bw.Write(privatekey); // d
}
}
+
_key = CngKey.Import(blob, privatekey is null ? CngKeyBlobFormat.EccPublicBlob : CngKeyBlobFormat.EccPrivateBlob);
Ecdsa = new ECDsaCng(_key);
@@ -413,13 +415,13 @@ private void Import(string curve_oid, byte[] publickey, byte[] privatekey)
private static string GetCurveOid(string curve_s)
{
- switch (curve_s.ToLower())
+ switch (curve_s.ToUpperInvariant())
{
- case "nistp256":
+ case "NISTP256":
return ECDSA_P256_OID_VALUE;
- case "nistp384":
+ case "NISTP384":
return ECDSA_P384_OID_VALUE;
- case "nistp521":
+ case "NISTP521":
return ECDSA_P521_OID_VALUE;
default:
throw new SshException("Unexpected Curve Name: " + curve_s);
diff --git a/src/Renci.SshNet/Security/Cryptography/HMACMD5.cs b/src/Renci.SshNet/Security/Cryptography/HMACMD5.cs
index cd129fe69..bd9585448 100644
--- a/src/Renci.SshNet/Security/Cryptography/HMACMD5.cs
+++ b/src/Renci.SshNet/Security/Cryptography/HMACMD5.cs
@@ -11,22 +11,29 @@ public class HMACMD5 : System.Security.Cryptography.HMACMD5
private readonly int _hashSize;
///
- /// Initializes a with the specified key.
+ /// Initializes a new instance of the class with the specified key.
///
/// The key.
public HMACMD5(byte[] key)
+#pragma warning disable CA5351 // Do Not Use Broken Cryptographic Algorithms
: base(key)
+#pragma warning restore CA5351 // Do Not Use Broken Cryptographic Algorithms
{
+#pragma warning disable MA0056 // Do not call overridable members in constructor
_hashSize = base.HashSize;
+#pragma warning restore MA0056 // Do not call overridable members in constructor
}
///
- /// Initializes a with the specified key and size of the computed hash code.
+ /// Initializes a new instance of the class with the specified key
+ /// and size of the computed hash code.
///
/// The key.
/// The size, in bits, of the computed hash code.
public HMACMD5(byte[] key, int hashSize)
+#pragma warning disable CA5351 // Do Not Use Broken Cryptographic Algorithms
: base(key)
+#pragma warning restore CA5351 // Do Not Use Broken Cryptographic Algorithms
{
_hashSize = hashSize;
}
@@ -50,7 +57,9 @@ public override int HashSize
///
protected override byte[] HashFinal()
{
+#pragma warning disable CA5351 // Do Not Use Broken Cryptographic Algorithms
var hash = base.HashFinal();
+#pragma warning restore CA5351 // Do Not Use Broken Cryptographic Algorithms
return hash.Take(HashSize / 8);
}
}
diff --git a/src/Renci.SshNet/Security/Cryptography/HMACSHA1.cs b/src/Renci.SshNet/Security/Cryptography/HMACSHA1.cs
index 05a9730ed..ca4adfdaf 100644
--- a/src/Renci.SshNet/Security/Cryptography/HMACSHA1.cs
+++ b/src/Renci.SshNet/Security/Cryptography/HMACSHA1.cs
@@ -16,9 +16,13 @@ public class HMACSHA1 : System.Security.Cryptography.HMACSHA1
///
/// The key.
public HMACSHA1(byte[] key)
+#pragma warning disable CA5350 // Do Not Use Weak Cryptographic Algorithms
: base(key)
+#pragma warning restore CA5350 // Do Not Use Weak Cryptographic Algorithms
{
+#pragma warning disable MA0056 // Do not call overridable members in constructor
_hashSize = base.HashSize;
+#pragma warning restore MA0056 // Do not call overridable members in constructor
}
///
@@ -27,7 +31,9 @@ public HMACSHA1(byte[] key)
/// The key.
/// The size, in bits, of the computed hash code.
public HMACSHA1(byte[] key, int hashSize)
+#pragma warning disable CA5350 // Do Not Use Weak Cryptographic Algorithms
: base(key)
+#pragma warning restore CA5350 // Do Not Use Weak Cryptographic Algorithms
{
_hashSize = hashSize;
}
@@ -51,7 +57,9 @@ public override int HashSize
///
protected override byte[] HashFinal()
{
+#pragma warning disable CA5350 // Do Not Use Weak Cryptographic Algorithms
var hash = base.HashFinal();
+#pragma warning restore CA5350 // Do Not Use Weak Cryptographic Algorithms
return hash.Take(HashSize / 8);
}
}
diff --git a/src/Renci.SshNet/Security/Cryptography/HMACSHA256.cs b/src/Renci.SshNet/Security/Cryptography/HMACSHA256.cs
index 2598704e4..20f752a86 100644
--- a/src/Renci.SshNet/Security/Cryptography/HMACSHA256.cs
+++ b/src/Renci.SshNet/Security/Cryptography/HMACSHA256.cs
@@ -11,17 +11,20 @@ public class HMACSHA256 : System.Security.Cryptography.HMACSHA256
private readonly int _hashSize;
///
- /// Initializes a with the specified key.
+ /// Initializes a new instance of the class with the specified key.
///
/// The key.
public HMACSHA256(byte[] key)
: base(key)
{
+#pragma warning disable MA0056 // Do not call overridable members in constructor
_hashSize = base.HashSize;
+#pragma warning restore MA0056 // Do not call overridable members in constructor
}
///
- /// Initializes a with the specified key and size of the computed hash code.
+ /// Initializes a new instance of the class with the specified key
+ /// and size of the computed hash code.
///
/// The key.
/// The size, in bits, of the computed hash code.
@@ -48,7 +51,6 @@ public override int HashSize
///
/// The computed hash code.
///
-
protected override byte[] HashFinal()
{
var hash = base.HashFinal();
diff --git a/src/Renci.SshNet/Security/Cryptography/HMACSHA384.cs b/src/Renci.SshNet/Security/Cryptography/HMACSHA384.cs
index f5f0b26c5..e13d720c8 100644
--- a/src/Renci.SshNet/Security/Cryptography/HMACSHA384.cs
+++ b/src/Renci.SshNet/Security/Cryptography/HMACSHA384.cs
@@ -11,17 +11,20 @@ public class HMACSHA384 : System.Security.Cryptography.HMACSHA384
private readonly int _hashSize;
///
- /// Initializes a with the specified key.
+ /// Initializes a new instance of the class with the specified key.
///
/// The key.
public HMACSHA384(byte[] key)
: base(key)
{
+#pragma warning disable MA0056 // Do not call overridable members in constructor
_hashSize = base.HashSize;
+#pragma warning restore MA0056 // Do not call overridable members in constructor
}
///
- /// Initializes a with the specified key and size of the computed hash code.
+ /// Initializes a new instance of the class with the specified key
+ /// and size of the computed hash code.
///
/// The key.
/// The size, in bits, of the computed hash code.
diff --git a/src/Renci.SshNet/Security/Cryptography/HMACSHA512.cs b/src/Renci.SshNet/Security/Cryptography/HMACSHA512.cs
index 72e758155..8d756efef 100644
--- a/src/Renci.SshNet/Security/Cryptography/HMACSHA512.cs
+++ b/src/Renci.SshNet/Security/Cryptography/HMACSHA512.cs
@@ -11,17 +11,20 @@ public class HMACSHA512 : System.Security.Cryptography.HMACSHA512
private readonly int _hashSize;
///
- /// Initializes a with the specified key.
+ /// Initializes a new instance of the class with the specified key.
///
/// The key.
public HMACSHA512(byte[] key)
: base(key)
{
+#pragma warning disable MA0056 // Do not call overridable members in constructor
_hashSize = base.HashSize;
+#pragma warning restore MA0056 // Do not call overridable members in constructor
}
///
- /// Initializes a with the specified key and size of the computed hash code.
+ /// Initializes a new instance of the class with the specified key
+ /// and size of the computed hash code.
///
/// The key.
/// The size, in bits, of the computed hash code.
diff --git a/src/Renci.SshNet/Security/Cryptography/Key.cs b/src/Renci.SshNet/Security/Cryptography/Key.cs
index 3110a2b91..81580a1ab 100644
--- a/src/Renci.SshNet/Security/Cryptography/Key.cs
+++ b/src/Renci.SshNet/Security/Cryptography/Key.cs
@@ -14,7 +14,9 @@ public abstract class Key
///
/// Specifies array of big integers that represent private key.
///
+#pragma warning disable SA1401 // Fields should be private
protected BigInteger[] _privateKey;
+#pragma warning restore SA1401 // Fields should be private
///
/// Gets the default digital signature implementation for this key.
diff --git a/src/Renci.SshNet/Security/Cryptography/RsaDigitalSignature.cs b/src/Renci.SshNet/Security/Cryptography/RsaDigitalSignature.cs
index ccb252efd..00a4898f9 100644
--- a/src/Renci.SshNet/Security/Cryptography/RsaDigitalSignature.cs
+++ b/src/Renci.SshNet/Security/Cryptography/RsaDigitalSignature.cs
@@ -18,7 +18,8 @@ public class RsaDigitalSignature : CipherDigitalSignature, IDisposable
/// The RSA key.
public RsaDigitalSignature(RsaKey rsaKey)
: this(rsaKey, HashAlgorithmName.SHA1)
- { }
+ {
+ }
///
/// Initializes a new instance of the class.
@@ -58,7 +59,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/Cryptography/RsaKey.cs b/src/Renci.SshNet/Security/Cryptography/RsaKey.cs
index 2f1367a29..19c8bedc7 100644
--- a/src/Renci.SshNet/Security/Cryptography/RsaKey.cs
+++ b/src/Renci.SshNet/Security/Cryptography/RsaKey.cs
@@ -5,15 +5,19 @@
namespace Renci.SshNet.Security
{
///
- /// Contains RSA private and public key
+ /// Contains the RSA private and public key.
///
public class RsaKey : Key, IDisposable
{
private bool _isDisposed;
+ private RsaDigitalSignature _digitalSignature;
///
- /// Gets the Key String.
+ /// Gets the name of the key.
///
+ ///
+ /// The name of the key.
+ ///
public override string ToString()
{
return "ssh-rsa";
@@ -22,6 +26,9 @@ public override string ToString()
///
/// Gets the modulus.
///
+ ///
+ /// The modulus.
+ ///
public BigInteger Modulus
{
get
@@ -33,6 +40,9 @@ public BigInteger Modulus
///
/// Gets the exponent.
///
+ ///
+ /// The exponent.
+ ///
public BigInteger Exponent
{
get
@@ -44,6 +54,9 @@ public BigInteger Exponent
///
/// Gets the D.
///
+ ///
+ /// The D.
+ ///
public BigInteger D
{
get
@@ -60,6 +73,9 @@ public BigInteger D
///
/// Gets the P.
///
+ ///
+ /// The P.
+ ///
public BigInteger P
{
get
@@ -69,7 +85,6 @@ public BigInteger P
return _privateKey[3];
}
-
return BigInteger.Zero;
}
}
@@ -77,6 +92,9 @@ public BigInteger P
///
/// Gets the Q.
///
+ ///
+ /// The Q.
+ ///
public BigInteger Q
{
get
@@ -93,6 +111,9 @@ public BigInteger Q
///
/// Gets the DP.
///
+ ///
+ /// The DP.
+ ///
public BigInteger DP
{
get
@@ -109,6 +130,9 @@ public BigInteger DP
///
/// Gets the DQ.
///
+ ///
+ /// The DQ.
+ ///
public BigInteger DQ
{
get
@@ -125,6 +149,9 @@ public BigInteger DQ
///
/// Gets the inverse Q.
///
+ ///
+ /// The inverse Q.
+ ///
public BigInteger InverseQ
{
get
@@ -152,10 +179,8 @@ public override int KeyLength
}
}
- private RsaDigitalSignature _digitalSignature;
-
///
- ///
+ /// Gets the digital signature implementation for this key.
///
///
/// An implementation of an RSA digital signature using the SHA-1 hash algorithm.
@@ -253,7 +278,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/GroupExchangeHashData.cs b/src/Renci.SshNet/Security/GroupExchangeHashData.cs
index 82b889bb8..921841094 100644
--- a/src/Renci.SshNet/Security/GroupExchangeHashData.cs
+++ b/src/Renci.SshNet/Security/GroupExchangeHashData.cs
@@ -16,7 +16,6 @@ public string ServerVersion
set { _serverVersion = Utf8.GetBytes(value); }
}
-
public string ClientVersion
{
private get { return Utf8.GetString(_clientVersion, 0, _clientVersion.Length); }
diff --git a/src/Renci.SshNet/Security/KeyExchange.cs b/src/Renci.SshNet/Security/KeyExchange.cs
index 6d8c53748..5024941bf 100644
--- a/src/Renci.SshNet/Security/KeyExchange.cs
+++ b/src/Renci.SshNet/Security/KeyExchange.cs
@@ -13,7 +13,7 @@
namespace Renci.SshNet.Security
{
///
- /// Represents base class for different key exchange algorithm implementations
+ /// Represents base class for different key exchange algorithm implementations.
///
public abstract class KeyExchange : Algorithm, IKeyExchange
{
@@ -511,7 +511,7 @@ public void Dispose()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected virtual void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Security/KeyExchangeDiffieHellman.cs b/src/Renci.SshNet/Security/KeyExchangeDiffieHellman.cs
index 5cdba5b4d..4f31514a7 100644
--- a/src/Renci.SshNet/Security/KeyExchangeDiffieHellman.cs
+++ b/src/Renci.SshNet/Security/KeyExchangeDiffieHellman.cs
@@ -6,10 +6,11 @@
namespace Renci.SshNet.Security
{
///
- /// Represents base class for Diffie Hellman key exchange algorithm
+ /// Represents base class for Diffie Hellman key exchange algorithm.
///
internal abstract class KeyExchangeDiffieHellman : KeyExchange
{
+#pragma warning disable SA1401 // Fields should be private
///
/// Specifies key exchange group number.
///
@@ -26,7 +27,7 @@ internal abstract class KeyExchangeDiffieHellman : KeyExchange
protected byte[] _clientPayload;
///
- /// Specifies server payload
+ /// Specifies server payload.
///
protected byte[] _serverPayload;
@@ -54,6 +55,7 @@ internal abstract class KeyExchangeDiffieHellman : KeyExchange
/// Specifies signature data.
///
protected byte[] _signature;
+#pragma warning restore SA1401 // Fields should be private
///
/// Gets the size, in bits, of the computed hash code.
diff --git a/src/Renci.SshNet/Security/KeyExchangeEC.cs b/src/Renci.SshNet/Security/KeyExchangeEC.cs
index f2ae22fb7..4368affbf 100644
--- a/src/Renci.SshNet/Security/KeyExchangeEC.cs
+++ b/src/Renci.SshNet/Security/KeyExchangeEC.cs
@@ -4,13 +4,14 @@ namespace Renci.SshNet.Security
{
internal abstract class KeyExchangeEC : KeyExchange
{
+#pragma warning disable SA1401 // Fields should be private
///
- /// Specifies client payload
+ /// Specifies client payload.
///
protected byte[] _clientPayload;
///
- /// Specifies server payload
+ /// Specifies server payload.
///
protected byte[] _serverPayload;
@@ -33,6 +34,7 @@ internal abstract class KeyExchangeEC : KeyExchange
/// Specifies signature data.
///
protected byte[] _signature;
+#pragma warning restore SA1401 // Fields should be private
///
/// Gets the size, in bits, of the computed hash code.
diff --git a/src/Renci.SshNet/Security/KeyExchangeHash.cs b/src/Renci.SshNet/Security/KeyExchangeHashData.cs
similarity index 100%
rename from src/Renci.SshNet/Security/KeyExchangeHash.cs
rename to src/Renci.SshNet/Security/KeyExchangeHashData.cs
diff --git a/src/Renci.SshNet/Security/KeyHostAlgorithm.cs b/src/Renci.SshNet/Security/KeyHostAlgorithm.cs
index f0d2b41d8..0a0232a58 100644
--- a/src/Renci.SshNet/Security/KeyHostAlgorithm.cs
+++ b/src/Renci.SshNet/Security/KeyHostAlgorithm.cs
@@ -13,18 +13,27 @@ namespace Renci.SshNet.Security
public class KeyHostAlgorithm : HostAlgorithm
{
///
- /// The key used in this host key algorithm.
+ /// Gets the key used in this host key algorithm.
///
+ ///
+ /// The key used in this host key algorithm.
+ ///
public Key Key { get; private set; }
///
- /// The signature implementation used in this host key algorithm.
+ /// Gets the signature implementation used in this host key algorithm.
///
+ ///
+ /// The signature implementation used in this host key algorithm.
+ ///
public DigitalSignature DigitalSignature { get; private set; }
///
/// Gets the encoded public key data.
///
+ ///
+ /// The encoded public key data.
+ ///
public override byte[] Data
{
get
@@ -202,11 +211,13 @@ protected override int BufferCapacity
var capacity = base.BufferCapacity;
capacity += 4; // Name length
capacity += _name.Length; // Name
+
foreach (var key in _keys)
{
capacity += 4; // Key length
capacity += key.Length; // Key
}
+
return capacity;
}
}
@@ -246,8 +257,11 @@ protected override void SaveData()
internal sealed class SignatureKeyData : SshData
{
///
- /// Gets or sets the signature format identifier
+ /// Gets or sets the signature format identifier.
///
+ ///
+ /// The signature format identifier.
+ ///
public string AlgorithmName { get; set; }
///
diff --git a/src/Renci.SshNet/Session.cs b/src/Renci.SshNet/Session.cs
index 23eef6f78..2d913d072 100644
--- a/src/Renci.SshNet/Session.cs
+++ b/src/Renci.SshNet/Session.cs
@@ -121,6 +121,12 @@ public class Session : ISession
///
private readonly object _socketDisposeLock = new object();
+ ///
+ /// Holds an object that is used to ensure only a single thread can connect
+ /// and lazy initialize the at any given time.
+ ///
+ private readonly object _connectAndLazySemaphoreInitLock = new object();
+
///
/// Holds metadata about session messages.
///
@@ -192,6 +198,10 @@ public class Session : ISession
private SemaphoreLight _sessionSemaphore;
+ private bool _isDisconnectMessageSent;
+
+ private uint _nextChannelNumber;
+
///
/// Holds connection socket.
///
@@ -209,7 +219,7 @@ public SemaphoreLight SessionSemaphore
{
if (_sessionSemaphore is null)
{
- lock (this)
+ lock (_connectAndLazySemaphoreInitLock)
{
_sessionSemaphore ??= new SemaphoreLight(ConnectionInfo.MaxSessions);
}
@@ -219,10 +229,6 @@ public SemaphoreLight SessionSemaphore
}
}
- private bool _isDisconnectMessageSent;
-
- private uint _nextChannelNumber;
-
///
/// Gets the next channel number.
///
@@ -235,7 +241,7 @@ private uint NextChannelNumber
{
uint result;
- lock (this)
+ lock (_connectAndLazySemaphoreInitLock)
{
result = _nextChannelNumber++;
}
@@ -586,7 +592,7 @@ public void Connect()
return;
}
- lock (this)
+ lock (_connectAndLazySemaphoreInitLock)
{
// If connected don't connect again
if (IsConnected)
@@ -635,7 +641,7 @@ public void Connect()
// Start incoming request listener
// ToDo: Make message pump async, to not consume a thread for every session
- ThreadAbstraction.ExecuteThreadLongRunning(MessageListener);
+ _ = ThreadAbstraction.ExecuteThreadLongRunning(MessageListener);
// Wait for key exchange to be completed
WaitOnHandle(_keyExchangeCompletedWaitHandle);
@@ -747,7 +753,7 @@ public async Task ConnectAsync(CancellationToken cancellationToken)
// Start incoming request listener
// ToDo: Make message pump async, to not consume a thread for every session
- ThreadAbstraction.ExecuteThreadLongRunning(MessageListener);
+ _ = ThreadAbstraction.ExecuteThreadLongRunning(MessageListener);
// Wait for key exchange to be completed
WaitOnHandle(_keyExchangeCompletedWaitHandle);
@@ -1257,8 +1263,8 @@ private Message ReceiveMessage(Socket socket)
var clientHash = _serverMac.ComputeHash(data, 0, data.Length - serverMacLength);
var serverHash = data.Take(data.Length - serverMacLength, serverMacLength);
- // TODO add IsEqualTo overload that takes left+right index and number of bytes to compare;
- // TODO that way we can eliminate the extra allocation of the Take above
+ // TODO Add IsEqualTo overload that takes left+right index and number of bytes to compare.
+ // TODO That way we can eliminate the extra allocation of the Take above.
if (!serverHash.IsEqualTo(clientHash))
{
throw new SshConnectionException("MAC error", DisconnectReason.MacError);
@@ -1269,10 +1275,10 @@ private Message ReceiveMessage(Socket socket)
{
data = _serverDecompression.Decompress(data, messagePayloadOffset, messagePayloadLength);
- // data now only contains the decompressed payload, and as such the offset is reset to zero
+ // Data now only contains the decompressed payload, and as such the offset is reset to zero
messagePayloadOffset = 0;
- // the length of the payload is now the complete decompressed content
+ // The length of the payload is now the complete decompressed content
messagePayloadLength = data.Length;
}
@@ -1285,10 +1291,10 @@ private void TrySendDisconnect(DisconnectReason reasonCode, string message)
{
var disconnectMessage = new DisconnectMessage(reasonCode, message);
- // send the disconnect message, but ignore the outcome
+ // Send the disconnect message, but ignore the outcome
_ = TrySendMessage(disconnectMessage);
- // mark disconnect message sent regardless of whether the send sctually succeeded
+ // Mark disconnect message sent regardless of whether the send sctually succeeded
_isDisconnectMessageSent = true;
}
@@ -1440,12 +1446,9 @@ internal void OnNewKeysReceived(NewKeysMessage message)
_serverDecompression = _keyExchange.CreateDecompressor();
// Dispose of old KeyExchange object as it is no longer needed.
- if (_keyExchange != null)
- {
- _keyExchange.HostKeyReceived -= KeyExchange_HostKeyReceived;
- _keyExchange.Dispose();
- _keyExchange = null;
- }
+ _keyExchange.HostKeyReceived -= KeyExchange_HostKeyReceived;
+ _keyExchange.Dispose();
+ _keyExchange = null;
// Enable activated messages that are not key exchange related
_sshMessageFactory.EnableActivatedMessages();
@@ -2059,6 +2062,13 @@ IConnectionInfo ISession.ConnectionInfo
get { return ConnectionInfo; }
}
+ ///
+ /// Gets a that can be used to wait for the message listener loop to complete.
+ ///
+ ///
+ /// A that can be used to wait for the message listener loop to complete, or
+ /// when the session has not been connected.
+ ///
WaitHandle ISession.MessageListenerCompleted
{
get { return _messageListenerCompleted; }
@@ -2089,6 +2099,9 @@ IChannelDirectTcpip ISession.CreateChannelDirectTcpip()
///
/// Creates a "forwarded-tcpip" SSH channel.
///
+ /// The number of the remote channel.
+ /// The window size of the remote channel.
+ /// The data packet size of the remote channel.
///
/// A new "forwarded-tcpip" SSH channel.
///
diff --git a/src/Renci.SshNet/Sftp/Flags.cs b/src/Renci.SshNet/Sftp/Flags.cs
index 68ae5b10b..6f0a0e6ca 100644
--- a/src/Renci.SshNet/Sftp/Flags.cs
+++ b/src/Renci.SshNet/Sftp/Flags.cs
@@ -3,31 +3,44 @@
namespace Renci.SshNet.Sftp
{
[Flags]
+#pragma warning disable S2344 // Enumeration type names should not have "Flags" or "Enum" suffixes
+#pragma warning disable MA0062 // Non-flags enums should not be marked with "FlagsAttribute"
internal enum Flags
+#pragma warning restore MA0062 // Non-flags enums should not be marked with "FlagsAttribute"
+#pragma warning restore S2344 // Enumeration type names should not have "Flags" or "Enum" suffixes
{
+ ///
+ /// None.
+ ///
None = 0x00000000,
+
///
- /// SSH_FXF_READ
+ /// SSH_FXF_READ.
///
Read = 0x00000001,
+
///
- /// SSH_FXF_WRITE
+ /// SSH_FXF_WRITE.
///
Write = 0x00000002,
+
///
- /// SSH_FXF_APPEND
+ /// SSH_FXF_APPEND.
///
Append = 0x00000004,
+
///
- /// SSH_FXF_CREAT
+ /// SSH_FXF_CREAT.
///
CreateNewOrOpen = 0x00000008,
+
///
- /// SSH_FXF_TRUNC
+ /// SSH_FXF_TRUNC.
///
Truncate = 0x00000010,
+
///
- /// SSH_FXF_EXCL
+ /// SSH_FXF_EXCL.
///
CreateNew = 0x00000028
}
diff --git a/src/Renci.SshNet/Sftp/ISftpFile.cs b/src/Renci.SshNet/Sftp/ISftpFile.cs
index a74e8fbf9..02dff7215 100644
--- a/src/Renci.SshNet/Sftp/ISftpFile.cs
+++ b/src/Renci.SshNet/Sftp/ISftpFile.cs
@@ -156,7 +156,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the owner can write into this file.
///
///
- /// if owner can write into this file; otherwise, .
+ /// if owner can write into this file; otherwise, .
///
bool OwnerCanWrite { get; set; }
@@ -164,7 +164,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the owner can execute this file.
///
///
- /// if owner can execute this file; otherwise, .
+ /// if owner can execute this file; otherwise, .
///
bool OwnerCanExecute { get; set; }
@@ -172,7 +172,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the group members can read from this file.
///
///
- /// if group members can read from this file; otherwise, .
+ /// if group members can read from this file; otherwise, .
///
bool GroupCanRead { get; set; }
@@ -180,7 +180,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the group members can write into this file.
///
///
- /// if group members can write into this file; otherwise, .
+ /// if group members can write into this file; otherwise, .
///
bool GroupCanWrite { get; set; }
@@ -188,7 +188,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the group members can execute this file.
///
///
- /// if group members can execute this file; otherwise, .
+ /// if group members can execute this file; otherwise, .
///
bool GroupCanExecute { get; set; }
@@ -196,7 +196,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the others can read from this file.
///
///
- /// if others can read from this file; otherwise, .
+ /// if others can read from this file; otherwise, .
///
bool OthersCanRead { get; set; }
@@ -204,7 +204,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the others can write into this file.
///
///
- /// if others can write into this file; otherwise, .
+ /// if others can write into this file; otherwise, .
///
bool OthersCanWrite { get; set; }
@@ -212,7 +212,7 @@ public interface ISftpFile
/// Gets or sets a value indicating whether the others can execute this file.
///
///
- /// if others can execute this file; otherwise, .
+ /// if others can execute this file; otherwise, .
///
bool OthersCanExecute { get; set; }
diff --git a/src/Renci.SshNet/Sftp/ISftpFileReader.cs b/src/Renci.SshNet/Sftp/ISftpFileReader.cs
index 684cc4187..823b2e23a 100644
--- a/src/Renci.SshNet/Sftp/ISftpFileReader.cs
+++ b/src/Renci.SshNet/Sftp/ISftpFileReader.cs
@@ -1,9 +1,23 @@
using System;
+using Renci.SshNet.Common;
+
namespace Renci.SshNet.Sftp
{
+ ///
+ /// Reads a given file.
+ ///
internal interface ISftpFileReader : IDisposable
{
+ ///
+ /// Reads a sequence of bytes from the current file and advances the position within the file by the number of bytes read.
+ ///
+ ///
+ /// The sequence of bytes read from the file, or a zero-length array if the end of the file
+ /// has been reached.
+ ///
+ /// The current is disposed.
+ /// Attempting to read beyond the end of the file.
byte[] Read();
}
}
diff --git a/src/Renci.SshNet/Sftp/ISftpResponseFactory.cs b/src/Renci.SshNet/Sftp/ISftpResponseFactory.cs
index afb440c10..ae57110fc 100644
--- a/src/Renci.SshNet/Sftp/ISftpResponseFactory.cs
+++ b/src/Renci.SshNet/Sftp/ISftpResponseFactory.cs
@@ -2,8 +2,21 @@
namespace Renci.SshNet.Sftp
{
+ ///
+ /// Represents a factory for creating SFTP response messages.
+ ///
internal interface ISftpResponseFactory
{
+ ///
+ /// Creates a SFTP response message for the specified protocol version and message type, and
+ /// with the specified .
+ ///
+ /// The protocol version.
+ /// The message type.
+ /// The .
+ ///
+ /// A .
+ ///
SftpMessage Create(uint protocolVersion, byte messageType, Encoding encoding);
}
}
diff --git a/src/Renci.SshNet/Sftp/ISftpSession.cs b/src/Renci.SshNet/Sftp/ISftpSession.cs
index 31b091fac..ed9b72369 100644
--- a/src/Renci.SshNet/Sftp/ISftpSession.cs
+++ b/src/Renci.SshNet/Sftp/ISftpSession.cs
@@ -7,6 +7,9 @@
namespace Renci.SshNet.Sftp
{
+ ///
+ /// Represents an SFTP session.
+ ///
internal interface ISftpSession : ISubsystemSession
{
///
@@ -40,25 +43,44 @@ internal interface ISftpSession : ISubsystemSession
///
string GetCanonicalPath(string path);
+ ///
+ /// Asynchronously resolves a given path into an absolute path on the server.
+ ///
+ /// The path to resolve.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents an asynchronous operation to resolve into
+ /// an absolute path. The value of its contains the absolute
+ /// path of the specified path.
+ ///
Task GetCanonicalPathAsync(string path, CancellationToken cancellationToken);
///
- /// Performs SSH_FXP_FSTAT request.
+ /// Asynchronously performs a SSH_FXP_FSTAT request.
///
/// The handle.
- /// if set to returns instead of throwing an exception.
+ /// If set to , is returned in case of an error.
///
- /// File attributes
+ /// The file attributes.
///
SftpFileAttributes RequestFStat(byte[] handle, bool nullOnError);
+ ///
+ /// Asynchronously performs a SSH_FXP_FSTAT request.
+ ///
+ /// The handle.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task the represents the asynchronous SSH_FXP_FSTAT request. The value of its
+ /// contains the file attributes of the specified handle.
+ ///
Task RequestFStatAsync(byte[] handle, CancellationToken cancellationToken);
///
/// Performs SSH_FXP_STAT request.
///
/// The path.
- /// if set to returns null instead of throwing an exception.
+ /// If set to , is returned in case of an error.
///
/// File attributes.
///
@@ -90,7 +112,7 @@ internal interface ISftpSession : ISubsystemSession
///
/// The path.
///
- /// File attributes
+ /// File attributes.
///
SftpFileAttributes RequestLStat(string path);
@@ -122,14 +144,26 @@ internal interface ISftpSession : ISubsystemSession
void RequestMkDir(string path);
///
- /// Performs SSH_FXP_OPEN request.
+ /// Performs a SSH_FXP_OPEN request.
///
/// The path.
/// The flags.
- /// if set to returns instead of throwing an exception.
- /// File handle.
+ /// If set to , is returned in case of an error.
+ ///
+ /// The file handle for the specified path.
+ ///
byte[] RequestOpen(string path, Flags flags, bool nullOnError = false);
+ ///
+ /// Asynchronously performs a SSH_FXP_OPEN request.
+ ///
+ /// The path.
+ /// The flags.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task the represents the asynchronous SSH_FXP_OPEN request. The value of its
+ /// contains the file handle of the specified path.
+ ///
Task RequestOpenAsync(string path, Flags flags, CancellationToken cancellationToken);
///
@@ -159,13 +193,24 @@ internal interface ISftpSession : ISubsystemSession
byte[] EndOpen(SftpOpenAsyncResult asyncResult);
///
- /// Performs SSH_FXP_OPENDIR request.
+ /// Performs a SSH_FXP_OPENDIR request.
///
/// The path.
- /// if set to returns null instead of throwing an exception.
- /// File handle.
+ /// If set to , is returned in case of an error.
+ ///
+ /// A file handle for the specified path.
+ ///
byte[] RequestOpenDir(string path, bool nullOnError = false);
+ ///
+ /// Asynchronously performs a SSH_FXP_OPENDIR request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_OPENDIR request. The value of its
+ /// contains the handle of the specified path.
+ ///
Task RequestOpenDirAsync(string path, CancellationToken cancellationToken);
///
@@ -181,7 +226,7 @@ internal interface ISftpSession : ISubsystemSession
/// The handle.
/// The offset.
/// The length.
- /// data array; null if EOF
+ /// data array; null if EOF.
byte[] RequestRead(byte[] handle, ulong offset, uint length);
///
@@ -211,15 +256,41 @@ internal interface ISftpSession : ISubsystemSession
/// is .
byte[] EndRead(SftpReadAsyncResult asyncResult);
+ ///
+ /// Asynchronously performs a SSH_FXP_READ request.
+ ///
+ /// The handle to the file to read from.
+ /// The offset in the file to start reading from.
+ /// The number of bytes to read.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_READ request. The value of
+ /// its contains the data read from the file, or an empty
+ /// array when the end of the file is reached.
+ ///
Task RequestReadAsync(byte[] handle, ulong offset, uint length, CancellationToken cancellationToken);
///
- /// Performs SSH_FXP_READDIR request.
+ /// Performs a SSH_FXP_READDIR request.
///
- /// The handle.
- ///
+ /// The handle of the directory to read.
+ ///
+ /// A where the key is the name of a file in the directory
+ /// and the value is the of the file.
+ ///
KeyValuePair[] RequestReadDir(byte[] handle);
+ ///
+ /// Performs a SSH_FXP_READDIR request.
+ ///
+ /// The handle of the directory to read.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_READDIR request. The value of its
+ /// contains a where the
+ /// key is the name of a file in the directory and the value is the
+ /// of the file.
+ ///
Task[]> RequestReadDirAsync(byte[] handle, CancellationToken cancellationToken);
///
@@ -244,20 +315,37 @@ internal interface ISftpSession : ISubsystemSession
string EndRealPath(SftpRealPathAsyncResult asyncResult);
///
- /// Performs SSH_FXP_REMOVE request.
+ /// Performs a SSH_FXP_REMOVE request.
///
/// The path.
void RequestRemove(string path);
+ ///
+ /// Asynchronously performs a SSH_FXP_REMOVE request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_REMOVE request.
+ ///
Task RequestRemoveAsync(string path, CancellationToken cancellationToken);
///
- /// Performs SSH_FXP_RENAME request.
+ /// Performs a SSH_FXP_RENAME request.
///
/// The old path.
/// The new path.
void RequestRename(string oldPath, string newPath);
+ ///
+ /// Asynchronously performs a SSH_FXP_RENAME request.
+ ///
+ /// The old path.
+ /// The new path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_RENAME request.
+ ///
Task RequestRenameAsync(string oldPath, string newPath, CancellationToken cancellationToken);
///
@@ -274,13 +362,26 @@ internal interface ISftpSession : ISubsystemSession
void RequestSetStat(string path, SftpFileAttributes attributes);
///
- /// Performs statvfs@openssh.com extended request.
+ /// Performs a statvfs@openssh.com extended request.
///
/// The path.
- /// if set to [null on error].
- ///
+ /// If set to , is returned in case of an error.
+ ///
+ /// The file system information for the specified path, or when
+ /// the request failed and is .
+ ///
SftpFileSytemInformation RequestStatVfs(string path, bool nullOnError = false);
+ ///
+ /// Asynchronously performs a statvfs@openssh.com extended request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the statvfs@openssh.com extended request. The value of its
+ /// contains the file system information for the specified
+ /// path.
+ ///
Task RequestStatVfsAsync(string path, CancellationToken cancellationToken);
///
@@ -315,14 +416,34 @@ void RequestWrite(byte[] handle,
AutoResetEvent wait,
Action writeCompleted = null);
+ ///
+ /// Asynchronouly performs a SSH_FXP_WRITE request.
+ ///
+ /// The handle.
+ /// The the zero-based offset (in bytes) relative to the beginning of the file that the write must start at.
+ /// The buffer holding the data to write.
+ /// the zero-based offset in at which to begin taking bytes to write.
+ /// The length (in bytes) of the data to write.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_WRITE request.
+ ///
Task RequestWriteAsync(byte[] handle, ulong serverOffset, byte[] data, int offset, int length, CancellationToken cancellationToken);
///
- /// Performs SSH_FXP_CLOSE request.
+ /// Performs a SSH_FXP_CLOSE request.
///
/// The handle.
void RequestClose(byte[] handle);
+ ///
+ /// Performs a SSH_FXP_CLOSE request.
+ ///
+ /// The handle.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_CLOSE request.
+ ///
Task RequestCloseAsync(byte[] handle, CancellationToken cancellationToken);
///
@@ -365,6 +486,18 @@ void RequestWrite(byte[] handle,
///
uint CalculateOptimalWriteLength(uint bufferSize, byte[] handle);
+ ///
+ /// Creates an for reading the content of the file represented by a given .
+ ///
+ /// The handle of the file to read.
+ /// The SFTP session.
+ /// The maximum number of bytes to read with each chunk.
+ /// The maximum number of pending reads.
+ /// The size of the file or when the size could not be determined.
+ ///
+ /// An for reading the content of the file represented by the
+ /// specified .
+ ///
ISftpFileReader CreateFileReader(byte[] handle, ISftpSession sftpSession, uint chunkSize, int maxPendingReads, long? fileSize);
}
}
diff --git a/src/Renci.SshNet/Sftp/Requests/SftpExtendedRequest.cs b/src/Renci.SshNet/Sftp/Requests/SftpExtendedRequest.cs
index 8693929d5..59da98af5 100644
--- a/src/Renci.SshNet/Sftp/Requests/SftpExtendedRequest.cs
+++ b/src/Renci.SshNet/Sftp/Requests/SftpExtendedRequest.cs
@@ -15,7 +15,10 @@ public override SftpMessageTypes SftpMessageType
public string Name
{
- get { return _name; }
+ get
+ {
+ return _name;
+ }
private set
{
_name = value;
@@ -52,4 +55,4 @@ protected override void SaveData()
WriteBinaryString(_nameBytes);
}
}
-}
\ No newline at end of file
+}
diff --git a/src/Renci.SshNet/Sftp/Responses/ExtendedReplies/StatVfsReplyInfo.cs b/src/Renci.SshNet/Sftp/Responses/ExtendedReplies/StatVfsReplyInfo.cs
index 768764419..d7cecf8f9 100644
--- a/src/Renci.SshNet/Sftp/Responses/ExtendedReplies/StatVfsReplyInfo.cs
+++ b/src/Renci.SshNet/Sftp/Responses/ExtendedReplies/StatVfsReplyInfo.cs
@@ -18,8 +18,7 @@ public override void LoadData(SshDataStream stream)
stream.ReadUInt64(), // AvailableNodes
stream.ReadUInt64(), // Sid
stream.ReadUInt64(), // Flags
- stream.ReadUInt64() // MaxNameLenght
- );
+ stream.ReadUInt64()); // MaxNameLenght
}
}
}
diff --git a/src/Renci.SshNet/Sftp/Responses/SftpDataResponse.cs b/src/Renci.SshNet/Sftp/Responses/SftpDataResponse.cs
index ce0d414c5..04a7d4d82 100644
--- a/src/Renci.SshNet/Sftp/Responses/SftpDataResponse.cs
+++ b/src/Renci.SshNet/Sftp/Responses/SftpDataResponse.cs
@@ -17,7 +17,7 @@ public SftpDataResponse(uint protocolVersion)
protected override void LoadData()
{
base.LoadData();
-
+
Data = ReadBinary();
}
diff --git a/src/Renci.SshNet/Sftp/Responses/SftpExtendedReplyResponse.cs b/src/Renci.SshNet/Sftp/Responses/SftpExtendedReplyResponse.cs
index bbd41680f..84fe93d35 100644
--- a/src/Renci.SshNet/Sftp/Responses/SftpExtendedReplyResponse.cs
+++ b/src/Renci.SshNet/Sftp/Responses/SftpExtendedReplyResponse.cs
@@ -12,7 +12,8 @@ public SftpExtendedReplyResponse(uint protocolVersion)
{
}
- public T GetReply() where T : ExtendedReplyInfo, new()
+ public T GetReply()
+ where T : ExtendedReplyInfo, new()
{
var result = new T();
result.LoadData(DataStream);
diff --git a/src/Renci.SshNet/Sftp/Responses/SftpHandleResponse.cs b/src/Renci.SshNet/Sftp/Responses/SftpHandleResponse.cs
index 31da2e937..21af8f835 100644
--- a/src/Renci.SshNet/Sftp/Responses/SftpHandleResponse.cs
+++ b/src/Renci.SshNet/Sftp/Responses/SftpHandleResponse.cs
@@ -17,7 +17,7 @@ public SftpHandleResponse(uint protocolVersion)
protected override void LoadData()
{
base.LoadData();
-
+
Handle = ReadBinary();
}
diff --git a/src/Renci.SshNet/Sftp/Responses/SftpResponse.cs b/src/Renci.SshNet/Sftp/Responses/SftpResponse.cs
index 3b784bf09..5e3ac145b 100644
--- a/src/Renci.SshNet/Sftp/Responses/SftpResponse.cs
+++ b/src/Renci.SshNet/Sftp/Responses/SftpResponse.cs
@@ -14,7 +14,7 @@ protected SftpResponse(uint protocolVersion)
protected override void LoadData()
{
base.LoadData();
-
+
ResponseId = ReadUInt32();
}
diff --git a/src/Renci.SshNet/Sftp/SftpDownloadAsyncResult.cs b/src/Renci.SshNet/Sftp/SftpDownloadAsyncResult.cs
index b2505b20a..9e706d9e0 100644
--- a/src/Renci.SshNet/Sftp/SftpDownloadAsyncResult.cs
+++ b/src/Renci.SshNet/Sftp/SftpDownloadAsyncResult.cs
@@ -6,7 +6,7 @@ namespace Renci.SshNet.Sftp
///
/// Encapsulates the results of an asynchronous download operation.
///
- public class SftpDownloadAsyncResult : AsyncResult
+ public class SftpDownloadAsyncResult : AsyncResult
{
///
/// Gets or sets a value indicating whether to cancel asynchronous download operation.
diff --git a/src/Renci.SshNet/Sftp/SftpFileAttributes.cs b/src/Renci.SshNet/Sftp/SftpFileAttributes.cs
index 824a3a0fb..2f32b4796 100644
--- a/src/Renci.SshNet/Sftp/SftpFileAttributes.cs
+++ b/src/Renci.SshNet/Sftp/SftpFileAttributes.cs
@@ -13,6 +13,7 @@ namespace Renci.SshNet.Sftp
public class SftpFileAttributes
{
#pragma warning disable IDE1006 // Naming Styles
+#pragma warning disable SA1310 // Field names should not contain underscore
private const uint S_IFMT = 0xF000; // bitmask for the file type bitfields
private const uint S_IFSOCK = 0xC000; // socket
private const uint S_IFLNK = 0xA000; // symbolic link
@@ -33,6 +34,7 @@ public class SftpFileAttributes
private const uint S_IROTH = 0x0004; // others have read permission
private const uint S_IWOTH = 0x0002; // others have write permission
private const uint S_IXOTH = 0x0001; // others have execute permission
+#pragma warning restore SA1310 // Field names should not contain underscore
#pragma warning restore IDE1006 // Naming Styles
private readonly DateTime _originalLastAccessTimeUtc;
@@ -165,7 +167,7 @@ public DateTime LastWriteTime
/// Gets a value indicating whether file represents a socket.
///
///
- /// if file represents a socket; otherwise, .
+ /// if file represents a socket; otherwise, .
///
public bool IsSocket { get; private set; }
@@ -477,7 +479,7 @@ public void SetPermissions(short mode)
var modeBytes = mode.ToString(CultureInfo.InvariantCulture).PadLeft(3, '0').ToCharArray();
- var permission = (modeBytes[0] & 0x0F) * 8 * 8 + (modeBytes[1] & 0x0F) * 8 + (modeBytes[2] & 0x0F);
+ var permission = ((modeBytes[0] & 0x0F) * 8 * 8) + ((modeBytes[1] & 0x0F) * 8) + (modeBytes[2] & 0x0F);
OwnerCanRead = (permission & S_IRUSR) == S_IRUSR;
OwnerCanWrite = (permission & S_IWUSR) == S_IWUSR;
@@ -500,79 +502,88 @@ public void SetPermissions(short mode)
///
public byte[] GetBytes()
{
- var stream = new SshDataStream(4);
-
- uint flag = 0;
-
- if (IsSizeChanged && IsRegularFile)
+ using (var stream = new SshDataStream(4))
{
- flag |= 0x00000001;
- }
+ uint flag = 0;
- if (IsUserIdChanged || IsGroupIdChanged)
- {
- flag |= 0x00000002;
- }
+ if (IsSizeChanged && IsRegularFile)
+ {
+ flag |= 0x00000001;
+ }
- if (IsPermissionsChanged)
- {
- flag |= 0x00000004;
- }
+ if (IsUserIdChanged || IsGroupIdChanged)
+ {
+ flag |= 0x00000002;
+ }
- if (IsLastAccessTimeChanged || IsLastWriteTimeChanged)
- {
- flag |= 0x00000008;
- }
+ if (IsPermissionsChanged)
+ {
+ flag |= 0x00000004;
+ }
- if (IsExtensionsChanged)
- {
- flag |= 0x80000000;
- }
+ if (IsLastAccessTimeChanged || IsLastWriteTimeChanged)
+ {
+ flag |= 0x00000008;
+ }
- stream.Write(flag);
+ if (IsExtensionsChanged)
+ {
+ flag |= 0x80000000;
+ }
- if (IsSizeChanged && IsRegularFile)
- {
- stream.Write((ulong) Size);
- }
+ stream.Write(flag);
- if (IsUserIdChanged || IsGroupIdChanged)
- {
- stream.Write((uint) UserId);
- stream.Write((uint) GroupId);
- }
+ if (IsSizeChanged && IsRegularFile)
+ {
+ stream.Write((ulong) Size);
+ }
- if (IsPermissionsChanged)
- {
- stream.Write(Permissions);
- }
+ if (IsUserIdChanged || IsGroupIdChanged)
+ {
+ stream.Write((uint) UserId);
+ stream.Write((uint) GroupId);
+ }
- if (IsLastAccessTimeChanged || IsLastWriteTimeChanged)
- {
- var time = (uint)(LastAccessTimeUtc.ToFileTimeUtc() / 10000000 - 11644473600);
- stream.Write(time);
- time = (uint)(LastWriteTimeUtc.ToFileTimeUtc() / 10000000 - 11644473600);
- stream.Write(time);
- }
+ if (IsPermissionsChanged)
+ {
+ stream.Write(Permissions);
+ }
- if (IsExtensionsChanged)
- {
- foreach (var item in Extensions)
+ if (IsLastAccessTimeChanged || IsLastWriteTimeChanged)
{
- // TODO: we write as ASCII but read as UTF8 !!!
+ var time = (uint) ((LastAccessTimeUtc.ToFileTimeUtc() / 10000000) - 11644473600);
+ stream.Write(time);
+ time = (uint) ((LastWriteTimeUtc.ToFileTimeUtc() / 10000000) - 11644473600);
+ stream.Write(time);
+ }
- stream.Write(item.Key, SshData.Ascii);
- stream.Write(item.Value, SshData.Ascii);
+ if (IsExtensionsChanged)
+ {
+ foreach (var item in Extensions)
+ {
+ /*
+ * TODO: we write as ASCII but read as UTF8 !!!
+ */
+
+ stream.Write(item.Key, SshData.Ascii);
+ stream.Write(item.Value, SshData.Ascii);
+ }
}
- }
- return stream.ToArray();
+ return stream.ToArray();
+ }
}
internal static readonly SftpFileAttributes Empty = new SftpFileAttributes();
internal static SftpFileAttributes FromBytes(SshDataStream stream)
{
+ const uint SSH_FILEXFER_ATTR_SIZE = 0x00000001;
+ const uint SSH_FILEXFER_ATTR_UIDGID = 0x00000002;
+ const uint SSH_FILEXFER_ATTR_PERMISSIONS = 0x00000004;
+ const uint SSH_FILEXFER_ATTR_ACMODTIME = 0x00000008;
+ const uint SSH_FILEXFER_ATTR_EXTENDED = 0x80000000;
+
var flag = stream.ReadUInt32();
long size = -1;
@@ -583,24 +594,24 @@ internal static SftpFileAttributes FromBytes(SshDataStream stream)
DateTime modifyTime;
Dictionary extensions = null;
- if ((flag & 0x00000001) == 0x00000001) // SSH_FILEXFER_ATTR_SIZE
+ if ((flag & SSH_FILEXFER_ATTR_SIZE) == SSH_FILEXFER_ATTR_SIZE)
{
size = (long) stream.ReadUInt64();
}
- if ((flag & 0x00000002) == 0x00000002) // SSH_FILEXFER_ATTR_UIDGID
+ if ((flag & SSH_FILEXFER_ATTR_UIDGID) == SSH_FILEXFER_ATTR_UIDGID)
{
userId = (int) stream.ReadUInt32();
groupId = (int) stream.ReadUInt32();
}
- if ((flag & 0x00000004) == 0x00000004) // SSH_FILEXFER_ATTR_PERMISSIONS
+ if ((flag & SSH_FILEXFER_ATTR_PERMISSIONS) == SSH_FILEXFER_ATTR_PERMISSIONS)
{
permissions = stream.ReadUInt32();
}
- if ((flag & 0x00000008) == 0x00000008) // SSH_FILEXFER_ATTR_ACMODTIME
+ if ((flag & SSH_FILEXFER_ATTR_ACMODTIME) == SSH_FILEXFER_ATTR_ACMODTIME)
{
// The incoming times are "Unix times", so they're already in UTC. We need to preserve that
// to avoid losing information in a local time conversion during the "fall back" hour in DST.
@@ -615,7 +626,7 @@ internal static SftpFileAttributes FromBytes(SshDataStream stream)
modifyTime = DateTime.SpecifyKind(DateTime.MinValue, DateTimeKind.Utc);
}
- if ((flag & 0x80000000) == 0x80000000) // SSH_FILEXFER_ATTR_EXTENDED
+ if ((flag & SSH_FILEXFER_ATTR_EXTENDED) == SSH_FILEXFER_ATTR_EXTENDED)
{
var extendedCount = (int) stream.ReadUInt32();
extensions = new Dictionary(extendedCount);
diff --git a/src/Renci.SshNet/Sftp/SftpFileReader.cs b/src/Renci.SshNet/Sftp/SftpFileReader.cs
index e10107b15..af32f87a7 100644
--- a/src/Renci.SshNet/Sftp/SftpFileReader.cs
+++ b/src/Renci.SshNet/Sftp/SftpFileReader.cs
@@ -74,10 +74,14 @@ public SftpFileReader(byte[] handle, ISftpSession sftpSession, uint chunkSize, i
public byte[] Read()
{
+#if NET7_0_OR_GREATER
+ ObjectDisposedException.ThrowIf(_disposingOrDisposed, this);
+#else
if (_disposingOrDisposed)
{
throw new ObjectDisposedException(GetType().FullName);
}
+#endif // NET7_0_OR_GREATER
if (_exception is not null)
{
@@ -168,7 +172,9 @@ public byte[] Read()
var bytesToCatchUp = nextChunk.Offset - _offset;
- // TODO: break loop and interrupt blocking wait in case of exception
+ /*
+ * TODO: break loop and interrupt blocking wait in case of exception
+ */
var read = _sftpSession.RequestRead(_handle, _offset, (uint) bytesToCatchUp);
if (read.Length == 0)
diff --git a/src/Renci.SshNet/Sftp/SftpFileStream.cs b/src/Renci.SshNet/Sftp/SftpFileStream.cs
index be1e756ac..03b9e088f 100644
--- a/src/Renci.SshNet/Sftp/SftpFileStream.cs
+++ b/src/Renci.SshNet/Sftp/SftpFileStream.cs
@@ -1,5 +1,6 @@
using System;
using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
@@ -12,7 +13,9 @@ namespace Renci.SshNet.Sftp
/// Exposes a around a remote SFTP file, supporting both synchronous and asynchronous read and write operations.
///
///
+#pragma warning disable CA1844 // Provide memory-based overrides of async methods when subclassing 'Stream'
public class SftpFileStream : Stream
+#pragma warning restore CA1844 // Provide memory-based overrides of async methods when subclassing 'Stream'
{
private readonly object _lock = new object();
private readonly int _readBufferSize;
@@ -181,9 +184,9 @@ private SftpFileStream(ISftpSession session, string path, FileAccess access, int
Name = path;
_session = session;
- _canRead = (access & FileAccess.Read) != 0;
+ _canRead = (access & FileAccess.Read) == FileAccess.Read;
_canSeek = true;
- _canWrite = (access & FileAccess.Write) != 0;
+ _canWrite = (access & FileAccess.Write) == FileAccess.Write;
_handle = handle;
@@ -221,9 +224,9 @@ internal SftpFileStream(ISftpSession session, string path, FileMode mode, FileAc
// Initialize the object state.
_session = session;
- _canRead = (access & FileAccess.Read) != 0;
+ _canRead = (access & FileAccess.Read) == FileAccess.Read;
_canSeek = true;
- _canWrite = (access & FileAccess.Write) != 0;
+ _canWrite = (access & FileAccess.Write) == FileAccess.Write;
var flags = Flags.None;
@@ -243,20 +246,25 @@ internal SftpFileStream(ISftpSession session, string path, FileMode mode, FileAc
throw new ArgumentOutOfRangeException(nameof(access));
}
- if ((access & FileAccess.Read) != 0 && mode == FileMode.Append)
+ if ((access & FileAccess.Read) == FileAccess.Read && mode == FileMode.Append)
{
- throw new ArgumentException(string.Format("{0} mode can be requested only when combined with write-only access.", mode.ToString("G")));
+ throw new ArgumentException(string.Format(CultureInfo.InvariantCulture,
+ "{0} mode can be requested only when combined with write-only access.",
+ mode.ToString("G")),
+ nameof(mode));
}
- if ((access & FileAccess.Write) == 0)
+ if ((access & FileAccess.Write) != FileAccess.Write)
{
if (mode is FileMode.Create or FileMode.CreateNew or FileMode.Truncate or FileMode.Append)
{
- throw new ArgumentException(string.Format("Combining {0}: {1} with {2}: {3} is invalid.",
+ throw new ArgumentException(string.Format(CultureInfo.InvariantCulture,
+ "Combining {0}: {1} with {2}: {3} is invalid.",
nameof(FileMode),
mode,
nameof(FileAccess),
- access));
+ access),
+ nameof(mode));
}
}
@@ -345,20 +353,25 @@ internal static async Task OpenAsync(ISftpSession session, strin
throw new ArgumentOutOfRangeException(nameof(access));
}
- if ((access & FileAccess.Read) != 0 && mode == FileMode.Append)
+ if ((access & FileAccess.Read) == FileAccess.Read && mode == FileMode.Append)
{
- throw new ArgumentException(string.Format("{0} mode can be requested only when combined with write-only access.", mode.ToString("G")));
+ throw new ArgumentException(string.Format(CultureInfo.InvariantCulture,
+ "{0} mode can be requested only when combined with write-only access.",
+ mode.ToString("G")),
+ nameof(mode));
}
- if ((access & FileAccess.Write) == 0)
+ if ((access & FileAccess.Write) != FileAccess.Write)
{
if (mode is FileMode.Create or FileMode.CreateNew or FileMode.Truncate or FileMode.Append)
{
- throw new ArgumentException(string.Format("Combining {0}: {1} with {2}: {3} is invalid.",
+ throw new ArgumentException(string.Format(CultureInfo.InvariantCulture,
+ "Combining {0}: {1} with {2}: {3} is invalid.",
nameof(FileMode),
mode,
nameof(FileAccess),
- access));
+ access),
+ nameof(mode));
}
}
@@ -1318,10 +1331,14 @@ private void SetupWrite()
private void CheckSessionIsOpen()
{
+#if NET7_0_OR_GREATER
+ ObjectDisposedException.ThrowIf(_session is null, this);
+#else
if (_session is null)
{
throw new ObjectDisposedException(GetType().FullName);
}
+#endif // NET7_0_OR_GREATER
if (!_session.IsOpen)
{
diff --git a/src/Renci.SshNet/Sftp/SftpFileSystemInformation.cs b/src/Renci.SshNet/Sftp/SftpFileSystemInformation.cs
index 61f32e1de..89d24a727 100644
--- a/src/Renci.SshNet/Sftp/SftpFileSystemInformation.cs
+++ b/src/Renci.SshNet/Sftp/SftpFileSystemInformation.cs
@@ -5,10 +5,14 @@ namespace Renci.SshNet.Sftp
///
/// Contains File system information exposed by statvfs@openssh.com request.
///
+#pragma warning disable SA1649 // File name should match first type name
public class SftpFileSytemInformation
+#pragma warning restore SA1649 // File name should match first type name
{
+#pragma warning disable SA1310 // Field names should not contain underscore
internal const ulong SSH_FXE_STATVFS_ST_RDONLY = 0x1;
internal const ulong SSH_FXE_STATVFS_ST_NOSUID = 0x2;
+#pragma warning restore SA1310 // Field names should not contain underscore
private readonly ulong _flag;
@@ -99,7 +103,7 @@ public bool IsReadOnly
/// Gets a value indicating whether [supports set uid].
///
///
- /// if [supports set uid]; otherwise, .
+ /// if [supports set uid]; otherwise, .
///
public bool SupportsSetUid
{
@@ -158,4 +162,4 @@ internal void SaveData(SshDataStream stream)
stream.Write(MaxNameLenght);
}
}
-}
\ No newline at end of file
+}
diff --git a/src/Renci.SshNet/Sftp/SftpSession.cs b/src/Renci.SshNet/Sftp/SftpSession.cs
index efca5d06f..0fec92230 100644
--- a/src/Renci.SshNet/Sftp/SftpSession.cs
+++ b/src/Renci.SshNet/Sftp/SftpSession.cs
@@ -11,6 +11,9 @@
namespace Renci.SshNet.Sftp
{
+ ///
+ /// Represents an SFTP session.
+ ///
internal sealed class SftpSession : SubsystemSession, ISftpSession
{
internal const int MaximumSupportedVersion = 3;
@@ -114,14 +117,22 @@ public string GetCanonicalPath(string path)
if (fullPath.EndsWith("/.", StringComparison.OrdinalIgnoreCase) ||
fullPath.EndsWith("/..", StringComparison.OrdinalIgnoreCase) ||
fullPath.Equals("/", StringComparison.OrdinalIgnoreCase) ||
+#if NET || NETSTANDARD2_1_OR_GREATER
+ fullPath.IndexOf('/', StringComparison.OrdinalIgnoreCase) < 0)
+#else
fullPath.IndexOf('/') < 0)
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
return fullPath;
}
var pathParts = fullPath.Split('/');
+#if NET || NETSTANDARD2_1_OR_GREATER
+ var partialFullPath = string.Join('/', pathParts, 0, pathParts.Length - 1);
+#else
var partialFullPath = string.Join("/", pathParts, 0, pathParts.Length - 1);
+#endif // NET || NETSTANDARD2_1_OR_GREATER
if (string.IsNullOrEmpty(partialFullPath))
{
@@ -149,6 +160,14 @@ public string GetCanonicalPath(string path)
return string.Format(CultureInfo.InvariantCulture, "{0}{1}{2}", canonizedPath, slash, pathParts[pathParts.Length - 1]);
}
+ ///
+ /// Asynchronously resolves a given path into an absolute path on the server.
+ ///
+ /// The path to resolve.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task representing the absolute path.
+ ///
public async Task GetCanonicalPathAsync(string path, CancellationToken cancellationToken)
{
var fullPath = GetFullRemotePath(path);
@@ -169,14 +188,22 @@ public async Task GetCanonicalPathAsync(string path, CancellationToken c
if (fullPath.EndsWith("/.", StringComparison.Ordinal) ||
fullPath.EndsWith("/..", StringComparison.Ordinal) ||
fullPath.Equals("/", StringComparison.Ordinal) ||
+#if NET || NETSTANDARD2_1_OR_GREATER
+ fullPath.IndexOf('/', StringComparison.Ordinal) < 0)
+#else
fullPath.IndexOf('/') < 0)
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
return fullPath;
}
var pathParts = fullPath.Split('/');
- var partialFullPath = string.Join("/", pathParts, 0, pathParts.Length - 1);
+#if NET || NETSTANDARD2_1_OR_GREATER
+ var partialFullPath = string.Join('/', pathParts);
+#else
+ var partialFullPath = string.Join("/", pathParts);
+#endif // NET || NETSTANDARD2_1_OR_GREATER
if (string.IsNullOrEmpty(partialFullPath))
{
@@ -204,6 +231,18 @@ public async Task GetCanonicalPathAsync(string path, CancellationToken c
return canonizedPath + slash + pathParts[pathParts.Length - 1];
}
+ ///
+ /// Creates an for reading the content of the file represented by a given .
+ ///
+ /// The handle of the file to read.
+ /// The SFTP session.
+ /// The maximum number of bytes to read with each chunk.
+ /// The maximum number of pending reads.
+ /// The size of the file or when the size could not be determined.
+ ///
+ /// An for reading the content of the file represented by the
+ /// specified .
+ ///
public ISftpFileReader CreateFileReader(byte[] handle, ISftpSession sftpSession, uint chunkSize, int maxPendingReads, long? fileSize)
{
return new SftpFileReader(handle, sftpSession, chunkSize, maxPendingReads, fileSize);
@@ -224,6 +263,7 @@ internal string GetFullRemotePath(string path)
fullPath = WorkingDirectory + '/' + path;
}
}
+
return fullPath;
}
@@ -417,7 +457,7 @@ private void SendRequest(SftpRequest request)
///
/// The path.
/// The flags.
- /// if set to returns instead of throwing an exception.
+ /// If set to returns instead of throwing an exception.
/// File handle.
public byte[] RequestOpen(string path, Flags flags, bool nullOnError = false)
{
@@ -432,44 +472,61 @@ public byte[] RequestOpen(string path, Flags flags, bool nullOnError = false)
_encoding,
flags,
response =>
- {
- handle = response.Handle;
- _ = wait.Set();
- },
+ {
+ handle = response.Handle;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
+#pragma warning restore CA1508 // Avoid dead conditional code
return handle;
}
+ ///
+ /// Asynchronously performs a SSH_FXP_OPEN request.
+ ///
+ /// The path.
+ /// The flags.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_OPEN request. The value of its
+ /// contains the file handle of the specified path.
+ ///
public async Task RequestOpenAsync(string path, Flags flags, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpOpenRequest(ProtocolVersion,
- NextRequestId,
- path,
- _encoding,
- flags,
- response => tcs.TrySetResult(response.Handle),
- response => tcs.TrySetException(GetSftpException(response))));
+ NextRequestId,
+ path,
+ _encoding,
+ flags,
+ response => tcs.TrySetResult(response.Handle),
+ response => tcs.TrySetException(GetSftpException(response))));
return await tcs.Task.ConfigureAwait(false);
}
@@ -495,13 +552,13 @@ public SftpOpenAsyncResult BeginOpen(string path, Flags flags, AsyncCallback cal
_encoding,
flags,
response =>
- {
- asyncResult.SetAsCompleted(response.Handle, completedSynchronously: false);
- },
+ {
+ asyncResult.SetAsCompleted(response.Handle, completedSynchronously: false);
+ },
response =>
- {
- asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
- });
+ {
+ asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
+ });
SendRequest(request);
@@ -558,22 +615,32 @@ public void RequestClose(byte[] handle)
NextRequestId,
handle,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
}
+ ///
+ /// Performs a SSH_FXP_CLOSE request.
+ ///
+ /// The handle.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_CLOSE request.
+ ///
public async Task RequestCloseAsync(byte[] handle, CancellationToken cancellationToken)
{
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
@@ -582,21 +649,25 @@ public async Task RequestCloseAsync(byte[] handle, CancellationToken cancellatio
NextRequestId,
handle,
response =>
+ {
+ if (response.StatusCode == StatusCodes.Ok)
{
- if (response.StatusCode == StatusCodes.Ok)
- {
- _ = tcs.TrySetResult(true);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
- }));
+ _ = tcs.TrySetResult(true);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
+ }));
// Only check for cancellation after the SftpCloseRequest was sent
cancellationToken.ThrowIfCancellationRequested();
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
_ = await tcs.Task.ConfigureAwait(false);
}
@@ -619,9 +690,9 @@ public SftpCloseAsyncResult BeginClose(byte[] handle, AsyncCallback callback, ob
NextRequestId,
handle,
response =>
- {
- asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
- });
+ {
+ asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
+ });
SendRequest(request);
return asyncResult;
@@ -740,7 +811,9 @@ public byte[] EndRead(SftpReadAsyncResult asyncResult)
/// The handle.
/// The offset.
/// The length.
- /// data array; null if EOF
+ ///
+ /// The data that was read, or an empty array when the end of the file was reached.
+ ///
public byte[] RequestRead(byte[] handle, ulong offset, uint length)
{
SshException exception = null;
@@ -755,30 +828,32 @@ public byte[] RequestRead(byte[] handle, ulong offset, uint length)
offset,
length,
response =>
- {
- data = response.Data;
- _ = wait.Set();
- },
+ {
+ data = response.Data;
+ _ = wait.Set();
+ },
response =>
+ {
+ if (response.StatusCode != StatusCodes.Eof)
{
- if (response.StatusCode != StatusCodes.Eof)
- {
- exception = GetSftpException(response);
- }
- else
- {
- data = Array.Empty();
- }
+ exception = GetSftpException(response);
+ }
+ else
+ {
+ data = Array.Empty();
+ }
- _ = wait.Set();
- });
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -786,13 +861,29 @@ public byte[] RequestRead(byte[] handle, ulong offset, uint length)
return data;
}
+ ///
+ /// Asynchronously performs a SSH_FXP_READ request.
+ ///
+ /// The handle to the file to read from.
+ /// The offset in the file to start reading from.
+ /// The number of bytes to read.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_READ request. The value of
+ /// its contains the data read from the file, or an empty
+ /// array when the end of the file is reached.
+ ///
public async Task RequestReadAsync(byte[] handle, ulong offset, uint length, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpReadRequest(ProtocolVersion,
NextRequestId,
@@ -844,36 +935,54 @@ public void RequestWrite(byte[] handle,
offset,
length,
response =>
- {
- writeCompleted?.Invoke(response);
+ {
+ writeCompleted?.Invoke(response);
- exception = GetSftpException(response);
- if (wait != null)
- {
- _ = wait.Set();
- }
- });
+ exception = GetSftpException(response);
+ if (wait != null)
+ {
+ _ = wait.Set();
+ }
+ });
SendRequest(request);
- if (wait != null)
+ if (wait is not null)
{
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
}
+ ///
+ /// Asynchronouly performs a SSH_FXP_WRITE request.
+ ///
+ /// The handle.
+ /// The the zero-based offset (in bytes) relative to the beginning of the file that the write must start at.
+ /// The buffer holding the data to write.
+ /// the zero-based offset in at which to begin taking bytes to write.
+ /// The length (in bytes) of the data to write.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_WRITE request.
+ ///
public async Task RequestWriteAsync(byte[] handle, ulong serverOffset, byte[] data, int offset, int length, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpWriteRequest(ProtocolVersion,
NextRequestId,
@@ -883,16 +992,16 @@ public async Task RequestWriteAsync(byte[] handle, ulong serverOffset, byte[] da
offset,
length,
response =>
+ {
+ if (response.StatusCode == StatusCodes.Ok)
{
- if (response.StatusCode == StatusCodes.Ok)
- {
- _ = tcs.TrySetResult(true);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
- }));
+ _ = tcs.TrySetResult(true);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
+ }));
_ = await tcs.Task.ConfigureAwait(false);
}
@@ -917,22 +1026,24 @@ public SftpFileAttributes RequestLStat(string path)
path,
_encoding,
response =>
- {
- attributes = response.Attributes;
- _ = wait.Set();
- },
+ {
+ attributes = response.Attributes;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -958,13 +1069,13 @@ public SFtpStatAsyncResult BeginLStat(string path, AsyncCallback callback, objec
path,
_encoding,
response =>
- {
- asyncResult.SetAsCompleted(response.Attributes, completedSynchronously: false);
- },
+ {
+ asyncResult.SetAsCompleted(response.Attributes, completedSynchronously: false);
+ },
response =>
- {
- asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
- });
+ {
+ asyncResult.SetAsCompleted(GetSftpException(response), completedSynchronously: false);
+ });
SendRequest(request);
return asyncResult;
@@ -1006,7 +1117,7 @@ public SftpFileAttributes EndLStat(SFtpStatAsyncResult asyncResult)
/// Performs SSH_FXP_FSTAT request.
///
/// The handle.
- /// if set to returns instead of throwing an exception.
+ /// If set to , returns instead of throwing an exception.
///
/// File attributes.
///
@@ -1021,22 +1132,24 @@ public SftpFileAttributes RequestFStat(byte[] handle, bool nullOnError)
NextRequestId,
handle,
response =>
- {
- attributes = response.Attributes;
- _ = wait.Set();
- },
+ {
+ attributes = response.Attributes;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null && !nullOnError)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1044,13 +1157,26 @@ public SftpFileAttributes RequestFStat(byte[] handle, bool nullOnError)
return attributes;
}
+ ///
+ /// Asynchronously performs a SSH_FXP_FSTAT request.
+ ///
+ /// The handle.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_FSTAT request. The value of its
+ /// contains the file attributes of the specified handle.
+ ///
public async Task RequestFStatAsync(byte[] handle, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpFStatRequest(ProtocolVersion,
NextRequestId,
@@ -1079,17 +1205,19 @@ public void RequestSetStat(string path, SftpFileAttributes attributes)
_encoding,
attributes,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1111,17 +1239,19 @@ public void RequestFSetStat(byte[] handle, SftpFileAttributes attributes)
handle,
attributes,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1131,7 +1261,7 @@ public void RequestFSetStat(byte[] handle, SftpFileAttributes attributes)
/// Performs SSH_FXP_OPENDIR request.
///
/// The path.
- /// if set to returns instead of throwing an exception.
+ /// If set to , returns instead of throwing an exception.
/// File handle.
public byte[] RequestOpenDir(string path, bool nullOnError = false)
{
@@ -1146,22 +1276,24 @@ public byte[] RequestOpenDir(string path, bool nullOnError = false)
path,
_encoding,
response =>
- {
- handle = response.Handle;
- _ = wait.Set();
- },
+ {
+ handle = response.Handle;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1169,13 +1301,26 @@ public byte[] RequestOpenDir(string path, bool nullOnError = false)
return handle;
}
+ ///
+ /// Asynchronously performs a SSH_FXP_OPENDIR request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_OPENDIR request. The value of its
+ /// contains the handle of the specified path.
+ ///
public async Task RequestOpenDirAsync(string path, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpOpenDirRequest(ProtocolVersion,
NextRequestId,
@@ -1191,8 +1336,11 @@ public async Task RequestOpenDirAsync(string path, CancellationToken can
///
/// Performs SSH_FXP_READDIR request.
///
- /// The handle.
- ///
+ /// The handle of the directory to read.
+ ///
+ /// A where the key is the name of a file in
+ /// the directory and the value is the of the file.
+ ///
public KeyValuePair[] RequestReadDir(byte[] handle)
{
SshException exception = null;
@@ -1205,26 +1353,28 @@ public KeyValuePair[] RequestReadDir(byte[] handle)
NextRequestId,
handle,
response =>
- {
- result = response.Files;
- _ = wait.Set();
- },
+ {
+ result = response.Files;
+ _ = wait.Set();
+ },
response =>
+ {
+ if (response.StatusCode != StatusCodes.Eof)
{
- if (response.StatusCode != StatusCodes.Eof)
- {
- exception = GetSftpException(response);
- }
+ exception = GetSftpException(response);
+ }
- _ = wait.Set();
- });
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1232,29 +1382,44 @@ public KeyValuePair[] RequestReadDir(byte[] handle)
return result;
}
+ ///
+ /// Performs a SSH_FXP_READDIR request.
+ ///
+ /// The handle of the directory to read.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_READDIR request. The value of its
+ /// contains a where the
+ /// key is the name of a file in the directory and the value is the
+ /// of the file.
+ ///
public async Task[]> RequestReadDirAsync(byte[] handle, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource[]>(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource[]>) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource[]>) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource[]>) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpReadDirRequest(ProtocolVersion,
NextRequestId,
handle,
response => tcs.TrySetResult(response.Files),
response =>
+ {
+ if (response.StatusCode == StatusCodes.Eof)
{
- if (response.StatusCode == StatusCodes.Eof)
- {
- _ = tcs.TrySetResult(null);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
- }));
+ _ = tcs.TrySetResult(null);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
+ }));
return await tcs.Task.ConfigureAwait(false);
}
@@ -1275,45 +1440,59 @@ public void RequestRemove(string path)
path,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
}
+ ///
+ /// Asynchronously performs a SSH_FXP_REMOVE request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_REMOVE request.
+ ///
public async Task RequestRemoveAsync(string path, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpRemoveRequest(ProtocolVersion,
NextRequestId,
path,
_encoding,
response =>
+ {
+ if (response.StatusCode == StatusCodes.Ok)
{
- if (response.StatusCode == StatusCodes.Ok)
- {
- _ = tcs.TrySetResult(true);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
- }));
+ _ = tcs.TrySetResult(true);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
+ }));
_ = await tcs.Task.ConfigureAwait(false);
}
@@ -1334,17 +1513,19 @@ public void RequestMkDir(string path)
path,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1365,17 +1546,19 @@ public void RequestRmDir(string path)
path,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1402,22 +1585,24 @@ internal KeyValuePair[] RequestRealPath(string path,
path,
_encoding,
response =>
- {
- result = response.Files;
- _ = wait.Set();
- },
+ {
+ result = response.Files;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1431,7 +1616,11 @@ internal async Task[]> RequestRealPathA
var tcs = new TaskCompletionSource[]>(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource[]>) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource[]>) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource[]>) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpRealPathRequest(ProtocolVersion,
NextRequestId,
@@ -1439,15 +1628,15 @@ internal async Task[]> RequestRealPathA
_encoding,
response => tcs.TrySetResult(response.Files),
response =>
+ {
+ if (nullOnError)
{
- if (nullOnError)
- {
- _ = tcs.TrySetResult(null);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
+ _ = tcs.TrySetResult(null);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
}));
return await tcs.Task.ConfigureAwait(false);
@@ -1531,22 +1720,24 @@ public SftpFileAttributes RequestStat(string path, bool nullOnError = false)
path,
_encoding,
response =>
- {
- attributes = response.Attributes;
- _ = wait.Set();
- },
+ {
+ attributes = response.Attributes;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1632,29 +1823,44 @@ public void RequestRename(string oldPath, string newPath)
newPath,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
}
+ ///
+ /// Asynchronously performs a SSH_FXP_RENAME request.
+ ///
+ /// The old path.
+ /// The new path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the asynchronous SSH_FXP_RENAME request.
+ ///
public async Task RequestRenameAsync(string oldPath, string newPath, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new SftpRenameRequest(ProtocolVersion,
NextRequestId,
@@ -1662,16 +1868,16 @@ public async Task RequestRenameAsync(string oldPath, string newPath, Cancellatio
newPath,
_encoding,
response =>
+ {
+ if (response.StatusCode == StatusCodes.Ok)
{
- if (response.StatusCode == StatusCodes.Ok)
- {
- _ = tcs.TrySetResult(true);
- }
- else
- {
- _ = tcs.TrySetException(GetSftpException(response));
- }
- }));
+ _ = tcs.TrySetResult(true);
+ }
+ else
+ {
+ _ = tcs.TrySetException(GetSftpException(response));
+ }
+ }));
_ = await tcs.Task.ConfigureAwait(false);
}
@@ -1681,8 +1887,11 @@ public async Task RequestRenameAsync(string oldPath, string newPath, Cancellatio
/// Performs SSH_FXP_READLINK request.
///
/// The path.
- /// if set to returns null instead of throwing an exception.
- ///
+ /// if set to returns instead of throwing an exception.
+ ///
+ /// An array of where the key is the name of
+ /// a file and the value is the of the file.
+ ///
internal KeyValuePair[] RequestReadLink(string path, bool nullOnError = false)
{
if (ProtocolVersion < 3)
@@ -1701,22 +1910,24 @@ internal KeyValuePair[] RequestReadLink(string path,
path,
_encoding,
response =>
- {
- result = response.Files;
- _ = wait.Set();
- },
+ {
+ result = response.Files;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1746,17 +1957,19 @@ public void RequestSymLink(string linkpath, string targetpath)
targetpath,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
SendRequest(request);
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1784,10 +1997,10 @@ public void RequestPosixRename(string oldPath, string newPath)
newPath,
_encoding,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
if (!_supportedExtensions.ContainsKey(request.Name))
{
@@ -1799,7 +2012,9 @@ public void RequestPosixRename(string oldPath, string newPath)
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1831,15 +2046,15 @@ public SftpFileSytemInformation RequestStatVfs(string path, bool nullOnError = f
path,
_encoding,
response =>
- {
- information = response.GetReply().Information;
- _ = wait.Set();
- },
+ {
+ information = response.GetReply().Information;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
if (!_supportedExtensions.ContainsKey(request.Name))
{
@@ -1851,7 +2066,9 @@ public SftpFileSytemInformation RequestStatVfs(string path, bool nullOnError = f
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1859,6 +2076,16 @@ public SftpFileSytemInformation RequestStatVfs(string path, bool nullOnError = f
return information;
}
+ ///
+ /// Asynchronously performs a statvfs@openssh.com extended request.
+ ///
+ /// The path.
+ /// The token to monitor for cancellation requests.
+ ///
+ /// A task that represents the statvfs@openssh.com extended request. The value of its
+ /// contains the file system information for the specified
+ /// path.
+ ///
public async Task RequestStatVfsAsync(string path, CancellationToken cancellationToken)
{
if (ProtocolVersion < 3)
@@ -1870,7 +2097,11 @@ public async Task RequestStatVfsAsync(string path, Can
var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
- using (cancellationToken.Register((s) => ((TaskCompletionSource) s).TrySetCanceled(), tcs, useSynchronizationContext: false))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ await using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+#else
+ using (cancellationToken.Register(s => ((TaskCompletionSource) s).TrySetCanceled(cancellationToken), tcs, useSynchronizationContext: false))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
SendRequest(new StatVfsRequest(ProtocolVersion,
NextRequestId,
@@ -1909,15 +2140,15 @@ internal SftpFileSytemInformation RequestFStatVfs(byte[] handle, bool nullOnErro
NextRequestId,
handle,
response =>
- {
- information = response.GetReply().Information;
- _ = wait.Set();
- },
+ {
+ information = response.GetReply().Information;
+ _ = wait.Set();
+ },
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
if (!_supportedExtensions.ContainsKey(request.Name))
{
@@ -1929,7 +2160,9 @@ internal SftpFileSytemInformation RequestFStatVfs(byte[] handle, bool nullOnErro
WaitOnHandle(wait, OperationTimeout);
}
- if (!nullOnError && exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (!nullOnError && exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -1958,10 +2191,10 @@ internal void HardLink(string oldPath, string newPath)
oldPath,
newPath,
response =>
- {
- exception = GetSftpException(response);
- _ = wait.Set();
- });
+ {
+ exception = GetSftpException(response);
+ _ = wait.Set();
+ });
if (!_supportedExtensions.ContainsKey(request.Name))
{
@@ -1973,7 +2206,9 @@ internal void HardLink(string oldPath, string newPath)
WaitOnHandle(wait, OperationTimeout);
}
- if (exception != null)
+#pragma warning disable CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
+ if (exception is not null)
+#pragma warning restore CA1508 // Avoid dead conditional code; Remove when we upgrade to newer SDK in which bug is fixed
{
throw exception;
}
@@ -2033,7 +2268,7 @@ public uint CalculateOptimalWriteLength(uint bufferSize, byte[] handle)
* WinSCP uses data length of 32739 bytes (total 32768 bytes; 32739 + 25 + 4 bytes for handle)
*/
- var lengthOfNonDataProtocolFields = 25u + (uint)handle.Length;
+ var lengthOfNonDataProtocolFields = 25u + (uint) handle.Length;
var maximumPacketSize = Channel.RemotePacketSize;
return Math.Min(bufferSize, maximumPacketSize) - lengthOfNonDataProtocolFields;
}
@@ -2061,7 +2296,7 @@ private void HandleResponse(SftpResponse response)
lock (_requests)
{
_ = _requests.TryGetValue(response.ResponseId, out request);
- if (request != null)
+ if (request is not null)
{
_ = _requests.Remove(response.ResponseId);
}
diff --git a/src/Renci.SshNet/Sftp/StatusCodes.cs b/src/Renci.SshNet/Sftp/StatusCodes.cs
index 101b8c0bc..12997a47e 100644
--- a/src/Renci.SshNet/Sftp/StatusCodes.cs
+++ b/src/Renci.SshNet/Sftp/StatusCodes.cs
@@ -1,135 +1,165 @@
-
-namespace Renci.SshNet.Sftp
+namespace Renci.SshNet.Sftp
{
internal enum StatusCodes : uint
{
///
- /// SSH_FX_OK
+ /// SSH_FX_OK.
///
Ok = 0,
+
///
- /// SSH_FX_EOF
+ /// SSH_FX_EOF.
///
Eof = 1,
+
///
- /// SSH_FX_NO_SUCH_FILE
+ /// SSH_FX_NO_SUCH_FILE.
///
NoSuchFile = 2,
+
///
- /// SSH_FX_PERMISSION_DENIED
+ /// SSH_FX_PERMISSION_DENIED.
///
PermissionDenied = 3,
+
///
- /// SSH_FX_FAILURE
+ /// SSH_FX_FAILURE.
///
Failure = 4,
+
///
- /// SSH_FX_BAD_MESSAGE
+ /// SSH_FX_BAD_MESSAGE.
///
BadMessage = 5,
+
///
- /// SSH_FX_NO_CONNECTION
+ /// SSH_FX_NO_CONNECTION.
///
NoConnection = 6,
+
///
- /// SSH_FX_CONNECTION_LOST
+ /// SSH_FX_CONNECTION_LOST.
///
ConnectionLost = 7,
+
///
- /// SSH_FX_OP_UNSUPPORTED
+ /// SSH_FX_OP_UNSUPPORTED.
///
OperationUnsupported = 8,
+
///
- /// SSH_FX_INVALID_HANDLE
+ /// SSH_FX_INVALID_HANDLE.
///
InvalidHandle = 9,
+
///
- /// SSH_FX_NO_SUCH_PATH
+ /// SSH_FX_NO_SUCH_PATH.
///
NoSuchPath = 10,
+
///
- /// SSH_FX_FILE_ALREADY_EXISTS
+ /// SSH_FX_FILE_ALREADY_EXISTS.
///
FileAlreadyExists = 11,
+
///
- /// SSH_FX_WRITE_PROTECT
+ /// SSH_FX_WRITE_PROTECT.
///
WriteProtect = 12,
+
///
- /// SSH_FX_NO_MEDIA
+ /// SSH_FX_NO_MEDIA.
///
NoMedia = 13,
+
///
- /// SSH_FX_NO_SPACE_ON_FILESYSTEM
+ /// SSH_FX_NO_SPACE_ON_FILESYSTEM.
///
NoSpaceOnFilesystem = 14,
+
///
- /// SSH_FX_QUOTA_EXCEEDED
+ /// SSH_FX_QUOTA_EXCEEDED.
///
QuotaExceeded = 15,
+
///
- /// SSH_FX_UNKNOWN_PRINCIPAL
+ /// SSH_FX_UNKNOWN_PRINCIPAL.
///
UnknownPrincipal = 16,
+
///
- /// SSH_FX_LOCK_CONFLICT
+ /// SSH_FX_LOCK_CONFLICT.
///
LockConflict = 17,
+
///
- /// SSH_FX_DIR_NOT_EMPTY
+ /// SSH_FX_DIR_NOT_EMPTY.
///
DirNotEmpty = 18,
+
///
- /// SSH_FX_NOT_A_DIRECTORY
+ /// SSH_FX_NOT_A_DIRECTORY.
///
NotDirectory = 19,
+
///
- /// SSH_FX_INVALID_FILENAME
+ /// SSH_FX_INVALID_FILENAME.
///
InvalidFilename = 20,
+
///
- /// SSH_FX_LINK_LOOP
+ /// SSH_FX_LINK_LOOP.
///
LinkLoop = 21,
+
///
- /// SSH_FX_CANNOT_DELETE
+ /// SSH_FX_CANNOT_DELETE.
///
CannotDelete = 22,
+
///
- /// SSH_FX_INVALID_PARAMETER
+ /// SSH_FX_INVALID_PARAMETER.
///
InvalidParameter = 23,
+
///
- /// SSH_FX_FILE_IS_A_DIRECTORY
+ /// SSH_FX_FILE_IS_A_DIRECTORY.
///
FileIsADirectory = 24,
+
///
- /// SSH_FX_BYTE_RANGE_LOCK_CONFLICT
+ /// SSH_FX_BYTE_RANGE_LOCK_CONFLICT.
///
ByteRangeLockConflict = 25,
+
///
- /// SSH_FX_BYTE_RANGE_LOCK_REFUSED
+ /// SSH_FX_BYTE_RANGE_LOCK_REFUSED.
///
ByteRangeLockRefused = 26,
+
///
- /// SSH_FX_DELETE_PENDING
+ /// SSH_FX_DELETE_PENDING.
///
DeletePending = 27,
+
///
- /// SSH_FX_FILE_CORRUPT
+ /// SSH_FX_FILE_CORRUPT.
///
FileCorrupt = 28,
+
///
- /// SSH_FX_OWNER_INVALID
+ /// SSH_FX_OWNER_INVALID.
///
OwnerInvalid = 29,
+
///
- /// SSH_FX_GROUP_INVALID
+ /// SSH_FX_GROUP_INVALID.
///
GroupInvalid = 30,
+
///
- /// SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK
+ /// SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK.
///
- NoMatchingByteRangeLock = 31,
+ NoMatchingByteRangeLock = 31
}
}
diff --git a/src/Renci.SshNet/SftpClient.cs b/src/Renci.SshNet/SftpClient.cs
index 5467ceb92..aa30efadb 100644
--- a/src/Renci.SshNet/SftpClient.cs
+++ b/src/Renci.SshNet/SftpClient.cs
@@ -1,16 +1,17 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
-using System.IO;
using System.Globalization;
+using System.IO;
using System.Net;
+using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
+using System.Threading.Tasks;
+
using Renci.SshNet.Abstractions;
using Renci.SshNet.Common;
using Renci.SshNet.Sftp;
-using System.Threading.Tasks;
-using System.Runtime.CompilerServices;
namespace Renci.SshNet
{
@@ -213,7 +214,7 @@ public SftpClient(string host, string username, string password)
/// Authentication username.
/// Authentication private key file(s) .
/// is .
- /// is invalid. -or- is null or contains only whitespace characters.
+ /// is invalid. -or- is or contains only whitespace characters.
/// is not within and .
[SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
public SftpClient(string host, int port, string username, params IPrivateKeySource[] keyFiles)
@@ -448,18 +449,17 @@ public void RenameFile(string oldPath, string newPath)
}
///
- /// Asynchronously renames remote file from old path to new path.
+ /// Renames remote file from old path to new path.
///
/// Path to the old file location.
/// Path to the new file location.
- /// The to observe.
- /// A that represents the asynchronous rename operation.
- /// is . -or- or is .
+ /// if set to then perform a posix rename.
+ /// is . -or- or is .
/// Client is not connected.
/// Permission to rename the file was denied by the remote host. -or- A SSH command was denied by the server.
- /// A SSH error where is the message from the remote host.
+ /// A SSH error where is the message from the remote host.
/// The method was called after the client was disposed.
- public async Task RenameFileAsync(string oldPath, string newPath, CancellationToken cancellationToken)
+ public void RenameFile(string oldPath, string newPath, bool isPosix)
{
CheckDisposed();
@@ -478,25 +478,33 @@ public async Task RenameFileAsync(string oldPath, string newPath, CancellationTo
throw new SshConnectionException("Client not connected.");
}
- cancellationToken.ThrowIfCancellationRequested();
+ var oldFullPath = _sftpSession.GetCanonicalPath(oldPath);
- var oldFullPath = await _sftpSession.GetCanonicalPathAsync(oldPath, cancellationToken).ConfigureAwait(false);
- var newFullPath = await _sftpSession.GetCanonicalPathAsync(newPath, cancellationToken).ConfigureAwait(false);
- await _sftpSession.RequestRenameAsync(oldFullPath, newFullPath, cancellationToken).ConfigureAwait(false);
+ var newFullPath = _sftpSession.GetCanonicalPath(newPath);
+
+ if (isPosix)
+ {
+ _sftpSession.RequestPosixRename(oldFullPath, newFullPath);
+ }
+ else
+ {
+ _sftpSession.RequestRename(oldFullPath, newFullPath);
+ }
}
///
- /// Renames remote file from old path to new path.
+ /// Asynchronously renames remote file from old path to new path.
///
/// Path to the old file location.
/// Path to the new file location.
- /// if set to then perform a posix rename.
- /// is . -or- or is .
+ /// The to observe.
+ /// A that represents the asynchronous rename operation.
+ /// is . -or- or is .
/// Client is not connected.
/// Permission to rename the file was denied by the remote host. -or- A SSH command was denied by the server.
- /// A SSH error where is the message from the remote host.
+ /// A SSH error where is the message from the remote host.
/// The method was called after the client was disposed.
- public void RenameFile(string oldPath, string newPath, bool isPosix)
+ public async Task RenameFileAsync(string oldPath, string newPath, CancellationToken cancellationToken)
{
CheckDisposed();
@@ -515,18 +523,11 @@ public void RenameFile(string oldPath, string newPath, bool isPosix)
throw new SshConnectionException("Client not connected.");
}
- var oldFullPath = _sftpSession.GetCanonicalPath(oldPath);
-
- var newFullPath = _sftpSession.GetCanonicalPath(newPath);
+ cancellationToken.ThrowIfCancellationRequested();
- if (isPosix)
- {
- _sftpSession.RequestPosixRename(oldFullPath, newFullPath);
- }
- else
- {
- _sftpSession.RequestRename(oldFullPath, newFullPath);
- }
+ var oldFullPath = await _sftpSession.GetCanonicalPathAsync(oldPath, cancellationToken).ConfigureAwait(false);
+ var newFullPath = await _sftpSession.GetCanonicalPathAsync(newPath, cancellationToken).ConfigureAwait(false);
+ await _sftpSession.RequestRenameAsync(oldFullPath, newFullPath, cancellationToken).ConfigureAwait(false);
}
///
@@ -735,7 +736,7 @@ public ISftpFile Get(string path)
}
///
- /// Checks whether file or directory exists;
+ /// Checks whether file or directory exists.
///
/// The path.
///
@@ -762,22 +763,24 @@ public bool Exists(string path)
var fullPath = _sftpSession.GetCanonicalPath(path);
- // using SSH_FXP_REALPATH is not an alternative as the SFTP specification has not always
- // been clear on how the server should respond when the specified path is not present on
- // the server:
- //
- // SSH 1 to 4:
- // No mention of how the server should respond if the path is not present on the server.
- //
- // SSH 5:
- // The server SHOULD fail the request if the path is not present on the server.
- //
- // SSH 6:
- // Draft 06: The server SHOULD fail the request if the path is not present on the server.
- // Draft 07 to 13: The server MUST NOT fail the request if the path does not exist.
- //
- // Note that SSH 6 (draft 06 and forward) allows for more control options, but we
- // currently only support up to v3.
+ /*
+ * Using SSH_FXP_REALPATH is not an alternative as the SFTP specification has not always
+ * been clear on how the server should respond when the specified path is not present on
+ * the server:
+ *
+ * SSH 1 to 4:
+ * No mention of how the server should respond if the path is not present on the server.
+ *
+ * SSH 5:
+ * The server SHOULD fail the request if the path is not present on the server.
+ *
+ * SSH 6:
+ * Draft 06: The server SHOULD fail the request if the path is not present on the server.
+ * Draft 07 to 13: The server MUST NOT fail the request if the path does not exist.
+ *
+ * Note that SSH 6 (draft 06 and forward) allows for more control options, but we
+ * currently only support up to v3.
+ */
try
{
@@ -1233,12 +1236,12 @@ public async Task GetStatusAsync(string path, Cancella
///
/// The file to append the lines to. The file is created if it does not already exist.
/// The lines to append to the file.
- /// is -or- is .
+ /// is . -or- is .
/// Client is not connected.
/// The specified path is invalid, or its directory was not found on the remote host.
/// The method was called after the client was disposed.
///
- /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM)
+ /// The characters are written to the file using UTF-8 encoding without a byte-order mark (BOM).
///
public void AppendAllLines(string path, IEnumerable contents)
{
@@ -1710,10 +1713,13 @@ public string[] ReadAllLines(string path)
/// The method was called after the client was disposed.
public string[] ReadAllLines(string path, Encoding encoding)
{
- // we use the default buffer size for StreamReader - which is 1024 bytes - and the configured buffer size
- // for the SftpFileStream; may want to revisit this later
+ /*
+ * We use the default buffer size for StreamReader - which is 1024 bytes - and the configured buffer size
+ * for the SftpFileStream. We may want to revisit this later.
+ */
var lines = new List();
+
using (var stream = new StreamReader(OpenRead(path), encoding))
{
while (!stream.EndOfStream)
@@ -1721,6 +1727,7 @@ public string[] ReadAllLines(string path, Encoding encoding)
lines.Add(stream.ReadLine());
}
}
+
return lines.ToArray();
}
@@ -1752,8 +1759,10 @@ public string ReadAllText(string path)
/// The method was called after the client was disposed.
public string ReadAllText(string path, Encoding encoding)
{
- // we use the default buffer size for StreamReader - which is 1024 bytes - and the configured buffer size
- // for the SftpFileStream; may want to revisit this later
+ /*
+ * We use the default buffer size for StreamReader - which is 1024 bytes - and the configured buffer size
+ * for the SftpFileStream. We may want to revisit this later.
+ */
using (var stream = new StreamReader(OpenRead(path), encoding))
{
@@ -2074,15 +2083,6 @@ public void SetAttributes(string path, SftpFileAttributes fileAttributes)
_sftpSession.RequestSetStat(fullPath, fileAttributes);
}
- // Please don't forget this when you implement these methods: is .
- //public FileSecurity GetAccessControl(string path);
- //public FileSecurity GetAccessControl(string path, AccessControlSections includeSections);
- //public DateTime GetCreationTime(string path);
- //public DateTime GetCreationTimeUtc(string path);
- //public void SetAccessControl(string path, FileSecurity fileSecurity);
- //public void SetCreationTime(string path, DateTime creationTime);
- //public void SetCreationTimeUtc(string path, DateTime creationTimeUtc);
-
#endregion // File Methods
#region SynchronizeDirectories
@@ -2099,7 +2099,7 @@ public void SetAttributes(string path, SftpFileAttributes fileAttributes)
/// is .
/// is or contains only whitespace.
/// was not found on the remote host.
- /// If a problem occurs while copying the file
+ /// If a problem occurs while copying the file.
public IEnumerable SynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern)
{
if (sourcePath is null)
@@ -2128,7 +2128,7 @@ public IEnumerable SynchronizeDirectories(string sourcePath, string de
///
/// is .
/// is or contains only whitespace.
- /// If a problem occurs while copying the file
+ /// If a problem occurs while copying the file.
public IAsyncResult BeginSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, AsyncCallback asyncCallback, object state)
{
if (sourcePath is null)
@@ -2180,7 +2180,7 @@ public IEnumerable EndSynchronizeDirectories(IAsyncResult asyncResult)
return ar.EndInvoke();
}
- private IEnumerable InternalSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, SftpSynchronizeDirectoriesAsyncResult asynchResult)
+ private List InternalSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, SftpSynchronizeDirectoriesAsyncResult asynchResult)
{
if (!Directory.Exists(sourcePath))
{
@@ -2228,8 +2228,7 @@ private IEnumerable InternalSynchronizeDirectories(string sourcePath,
var isDifferent = true;
if (destDict.TryGetValue(localFile.Name, out var remoteFile))
{
- // TODO: Use md5 to detect a difference
- //ltang: File exists at the destination => Using filesize to detect the difference
+ // File exists at the destination, use filesize to detect if there's a difference
isDifferent = localFile.Length != remoteFile.Length;
}
@@ -2238,7 +2237,9 @@ private IEnumerable InternalSynchronizeDirectories(string sourcePath,
var remoteFileName = string.Format(CultureInfo.InvariantCulture, @"{0}/{1}", destinationPath, localFile.Name);
try
{
+#pragma warning disable CA2000 // Dispose objects before losing scope; false positive
using (var file = File.OpenRead(localFile.FullName))
+#pragma warning restore CA2000 // Dispose objects before losing scope; false positive
{
InternalUploadFile(file, remoteFileName, uploadFlag, asyncResult: null, uploadCallback: null);
}
@@ -2273,7 +2274,7 @@ private IEnumerable InternalSynchronizeDirectories(string sourcePath,
///
/// is .
/// Client not connected.
- private IEnumerable InternalListDirectory(string path, Action listCallback)
+ private List InternalListDirectory(string path, Action listCallback)
{
if (path is null)
{
@@ -2291,7 +2292,11 @@ private IEnumerable InternalListDirectory(string path, Action li
var basePath = fullPath;
- if (!basePath.EndsWith("/"))
+#if NET || NETSTANDARD2_1_OR_GREATER
+ if (!basePath.EndsWith('/'))
+#else
+ if (!basePath.EndsWith("/", StringComparison.Ordinal))
+#endif // NET || NETSTANDARD2_1_OR_GREATER
{
basePath = string.Format("{0}/", fullPath);
}
@@ -2309,10 +2314,10 @@ private IEnumerable InternalListDirectory(string path, Action li
f.Value));
}
- // Call callback to report number of files read
+ // Call callback to report number of files read
if (listCallback is not null)
{
- // Execute callback on different thread
+ // Execute callback on different thread
ThreadAbstraction.ExecuteThread(() => listCallback(result.Count));
}
@@ -2377,10 +2382,10 @@ private void InternalDownloadFile(string path, Stream output, SftpDownloadAsyncR
if (downloadCallback is not null)
{
- // copy offset to ensure it's not modified between now and execution of callback
+ // Copy offset to ensure it's not modified between now and execution of callback
var downloadOffset = totalBytesRead;
- // Execute callback on different thread
+ // Execute callback on different thread
ThreadAbstraction.ExecuteThread(() => { downloadCallback(downloadOffset); });
}
}
@@ -2447,10 +2452,10 @@ private void InternalUploadFile(Stream input, string path, Flags flags, SftpUplo
_ = Interlocked.Decrement(ref expectedResponses);
_ = responseReceivedWaitHandle.Set();
- // Call callback to report number of bytes written
+ // Call callback to report number of bytes written
if (uploadCallback is not null)
{
- // Execute callback on different thread
+ // Execute callback on different thread
ThreadAbstraction.ExecuteThread(() => uploadCallback(writtenBytes));
}
}
@@ -2464,13 +2469,14 @@ private void InternalUploadFile(Stream input, string path, Flags flags, SftpUplo
}
else if (expectedResponses > 0)
{
- // Wait for expectedResponses to change
+ // Wait for expectedResponses to change
_sftpSession.WaitOnHandle(responseReceivedWaitHandle, _operationTimeout);
}
}
while (expectedResponses > 0 || bytesRead > 0);
_sftpSession.RequestClose(handle);
+ responseReceivedWaitHandle.Dispose();
}
///
@@ -2501,7 +2507,7 @@ protected override void OnDisconnecting()
}
///
- /// Releases unmanaged and - optionally - managed resources
+ /// Releases unmanaged and - optionally - managed resources.
///
/// to release both managed and unmanaged resources; to release only unmanaged resources.
protected override void Dispose(bool disposing)
diff --git a/src/Renci.SshNet/Shell.cs b/src/Renci.SshNet/Shell.cs
index 0f80c3ca7..4a73e58fb 100644
--- a/src/Renci.SshNet/Shell.cs
+++ b/src/Renci.SshNet/Shell.cs
@@ -24,9 +24,9 @@ public class Shell : IDisposable
private readonly Stream _outputStream;
private readonly Stream _extendedOutputStream;
private readonly int _bufferSize;
- private EventWaitHandle _dataReaderTaskCompleted;
+ private ManualResetEvent _dataReaderTaskCompleted;
private IChannelSession _channel;
- private EventWaitHandle _channelClosedWaitHandle;
+ private AutoResetEvent _channelClosedWaitHandle;
private Stream _input;
///
@@ -130,7 +130,7 @@ public void Start()
var readTask = _input.ReadAsync(buffer, 0, buffer.Length);
var readWaitHandle = ((IAsyncResult) readTask).AsyncWaitHandle;
- if (WaitHandle.WaitAny(new[] {readWaitHandle, _channelClosedWaitHandle}) == 0)
+ if (WaitHandle.WaitAny(new[] { readWaitHandle, _channelClosedWaitHandle }) == 0)
{
var read = readTask.GetAwaiter().GetResult();
_channel.SendData(buffer, 0, read);
diff --git a/src/Renci.SshNet/ShellStream.cs b/src/Renci.SshNet/ShellStream.cs
index 80097bafe..ce57072d5 100644
--- a/src/Renci.SshNet/ShellStream.cs
+++ b/src/Renci.SshNet/ShellStream.cs
@@ -155,10 +155,14 @@ public override bool CanWrite
/// Methods were called after the stream was closed.
public override void Flush()
{
+#if NET7_0_OR_GREATER
+ ObjectDisposedException.ThrowIf(_channel is null, this);
+#else
if (_channel is null)
{
- throw new ObjectDisposedException("ShellStream");
+ throw new ObjectDisposedException(GetType().FullName);
}
+#endif // NET7_0_OR_GREATER
if (_outgoing.Count > 0)
{
@@ -199,36 +203,6 @@ public override long Position
set { throw new NotSupportedException(); }
}
- ///
- /// Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
- ///
- /// An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
- /// The zero-based byte offset in at which to begin storing the data read from the current stream.
- /// The maximum number of bytes to be read from the current stream.
- ///
- /// The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
- ///
- /// The sum of and is larger than the buffer length.
- /// is .
- /// or is negative.
- /// An I/O error occurs.
- /// The stream does not support reading.
- /// Methods were called after the stream was closed.
- public override int Read(byte[] buffer, int offset, int count)
- {
- var i = 0;
-
- lock (_incoming)
- {
- for (; i < count && _incoming.Count > 0; i++)
- {
- buffer[offset + i] = _incoming.Dequeue();
- }
- }
-
- return i;
- }
-
///
/// This method is not supported.
///
@@ -257,31 +231,6 @@ public override void SetLength(long value)
throw new NotSupportedException();
}
- ///
- /// Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
- ///
- /// An array of bytes. This method copies bytes from to the current stream.
- /// The zero-based byte offset in at which to begin copying bytes to the current stream.
- /// The number of bytes to be written to the current stream.
- /// The sum of and is greater than the buffer length.
- /// is .
- /// or is negative.
- /// An I/O error occurs.
- /// The stream does not support writing.
- /// Methods were called after the stream was closed.
- public override void Write(byte[] buffer, int offset, int count)
- {
- foreach (var b in buffer.Take(offset, count))
- {
- if (_outgoing.Count == _bufferSize)
- {
- Flush();
- }
-
- _outgoing.Enqueue(b);
- }
- }
-
///
/// Expects the specified expression and performs action when one is found.
///
@@ -351,6 +300,95 @@ public void Expect(TimeSpan timeout, params ExpectAction[] expectActions)
while (!expectedFound);
}
+ ///
+ /// Expects the expression specified by text.
+ ///
+ /// The text to expect.
+ ///
+ /// Text available in the shell that ends with expected text.
+ ///
+ public string Expect(string text)
+ {
+ return Expect(new Regex(Regex.Escape(text)), Session.InfiniteTimeSpan);
+ }
+
+ ///
+ /// Expects the expression specified by text.
+ ///
+ /// The text to expect.
+ /// Time to wait for input.
+ ///
+ /// The text available in the shell that ends with expected text, or if the specified time has elapsed.
+ ///
+ public string Expect(string text, TimeSpan timeout)
+ {
+ return Expect(new Regex(Regex.Escape(text)), timeout);
+ }
+
+ ///
+ /// Expects the expression specified by regular expression.
+ ///
+ /// The regular expression to expect.
+ ///
+ /// The text available in the shell that contains all the text that ends with expected expression.
+ ///
+ public string Expect(Regex regex)
+ {
+ return Expect(regex, TimeSpan.Zero);
+ }
+
+ ///
+ /// Expects the expression specified by regular expression.
+ ///
+ /// The regular expression to expect.
+ /// Time to wait for input.
+ ///
+ /// The text available in the shell that contains all the text that ends with expected expression,
+ /// or if the specified time has elapsed.
+ ///
+ public string Expect(Regex regex, TimeSpan timeout)
+ {
+ var text = string.Empty;
+
+ while (true)
+ {
+ lock (_incoming)
+ {
+ if (_incoming.Count > 0)
+ {
+ text = _encoding.GetString(_incoming.ToArray(), 0, _incoming.Count);
+ }
+
+ var match = regex.Match(text);
+
+ if (match.Success)
+ {
+ // Remove processed items from the queue
+ for (var i = 0; i < match.Index + match.Length && _incoming.Count > 0; i++)
+ {
+ _ = _incoming.Dequeue();
+ }
+
+ break;
+ }
+ }
+
+ if (timeout.Ticks > 0)
+ {
+ if (!_dataReceived.WaitOne(timeout))
+ {
+ return null;
+ }
+ }
+ else
+ {
+ _ = _dataReceived.WaitOne();
+ }
+ }
+
+ return text;
+ }
+
///
/// Begins the expect.
///
@@ -400,7 +438,9 @@ public IAsyncResult BeginExpect(AsyncCallback callback, object state, params Exp
///
/// An that references the asynchronous operation.
///
+#pragma warning disable CA1859 // Use concrete types when possible for improved performance
public IAsyncResult BeginExpect(TimeSpan timeout, AsyncCallback callback, object state, params ExpectAction[] expectActions)
+#pragma warning restore CA1859 // Use concrete types when possible for improved performance
{
var text = string.Empty;
@@ -481,6 +521,9 @@ public IAsyncResult BeginExpect(TimeSpan timeout, AsyncCallback callback, object
/// Ends the execute.
///
/// The async result.
+ ///
+ /// Text available in the shell that ends with expected text.
+ ///
/// Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult.
public string EndExpect(IAsyncResult asyncResult)
{
@@ -493,95 +536,6 @@ public string EndExpect(IAsyncResult asyncResult)
return ar.EndInvoke();
}
- ///
- /// Expects the expression specified by text.
- ///
- /// The text to expect.
- ///
- /// Text available in the shell that ends with expected text.
- ///
- public string Expect(string text)
- {
- return Expect(new Regex(Regex.Escape(text)), Session.InfiniteTimeSpan);
- }
-
- ///
- /// Expects the expression specified by text.
- ///
- /// The text to expect.
- /// Time to wait for input.
- ///
- /// The text available in the shell that ends with expected text, or if the specified time has elapsed.
- ///
- public string Expect(string text, TimeSpan timeout)
- {
- return Expect(new Regex(Regex.Escape(text)), timeout);
- }
-
- ///
- /// Expects the expression specified by regular expression.
- ///
- /// The regular expression to expect.
- ///
- /// The text available in the shell that contains all the text that ends with expected expression.
- ///
- public string Expect(Regex regex)
- {
- return Expect(regex, TimeSpan.Zero);
- }
-
- ///
- /// Expects the expression specified by regular expression.
- ///
- /// The regular expression to expect.
- /// Time to wait for input.
- ///
- /// The text available in the shell that contains all the text that ends with expected expression,
- /// or if the specified time has elapsed.
- ///
- public string Expect(Regex regex, TimeSpan timeout)
- {
- var text = string.Empty;
-
- while (true)
- {
- lock (_incoming)
- {
- if (_incoming.Count > 0)
- {
- text = _encoding.GetString(_incoming.ToArray(), 0, _incoming.Count);
- }
-
- var match = regex.Match(text);
-
- if (match.Success)
- {
- // Remove processed items from the queue
- for (var i = 0; i < match.Index + match.Length && _incoming.Count > 0; i++)
- {
- _ = _incoming.Dequeue();
- }
-
- break;
- }
- }
-
- if (timeout.Ticks > 0)
- {
- if (!_dataReceived.WaitOne(timeout))
- {
- return null;
- }
- }
- else
- {
- _ = _dataReceived.WaitOne();
- }
- }
-
- return text;
- }
-
///
/// Reads the line from the shell. If line is not available it will block the execution and will wait for new line.
///
@@ -667,6 +621,36 @@ public string Read()
return text;
}
+ ///
+ /// Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
+ ///
+ /// An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source.
+ /// The zero-based byte offset in at which to begin storing the data read from the current stream.
+ /// The maximum number of bytes to be read from the current stream.
+ ///
+ /// The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
+ ///
+ /// The sum of and is larger than the buffer length.
+ /// is .
+ /// or is negative.
+ /// An I/O error occurs.
+ /// The stream does not support reading.
+ /// Methods were called after the stream was closed.
+ public override int Read(byte[] buffer, int offset, int count)
+ {
+ var i = 0;
+
+ lock (_incoming)
+ {
+ for (; i < count && _incoming.Count > 0; i++)
+ {
+ buffer[offset + i] = _incoming.Dequeue();
+ }
+ }
+
+ return i;
+ }
+
///
/// Writes the specified text to the shell.
///
@@ -681,15 +665,44 @@ public void Write(string text)
return;
}
+#if NET7_0_OR_GREATER
+ ObjectDisposedException.ThrowIf(_channel is null, this);
+#else
if (_channel is null)
{
- throw new ObjectDisposedException("ShellStream");
+ throw new ObjectDisposedException(GetType().FullName);
}
+#endif // NET7_0_OR_GREATER
var data = _encoding.GetBytes(text);
_channel.SendData(data);
}
+ ///
+ /// Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
+ ///
+ /// An array of bytes. This method copies bytes from to the current stream.
+ /// The zero-based byte offset in at which to begin copying bytes to the current stream.
+ /// The number of bytes to be written to the current stream.
+ /// The sum of and is greater than the buffer length.
+ /// is .
+ /// or is negative.
+ /// An I/O error occurs.
+ /// The stream does not support writing.
+ /// Methods were called after the stream was closed.
+ public override void Write(byte[] buffer, int offset, int count)
+ {
+ foreach (var b in buffer.Take(offset, count))
+ {
+ if (_outgoing.Count == _bufferSize)
+ {
+ Flush();
+ }
+
+ _outgoing.Enqueue(b);
+ }
+ }
+
///
/// Writes the line to the shell.
///
diff --git a/src/Renci.SshNet/SshClient.cs b/src/Renci.SshNet/SshClient.cs
index 171b79775..753ab8f9f 100644
--- a/src/Renci.SshNet/SshClient.cs
+++ b/src/Renci.SshNet/SshClient.cs
@@ -27,7 +27,7 @@ public class SshClient : BaseClient
///