disable CA2000

mus65 · mus65 · commit 5e7d01d37d4b · 2025-11-15T09:39:07.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -177,7 +177,7 @@ dotnet_diagnostic.S2699.severity = none
 # S2930: "IDisposables" should be disposed
 # https://rules.sonarsource.com/csharp/RSPEC-2930/
 #
-# Duplicate of CA2000.
+# too noisy.
 dotnet_diagnostic.S2930.severity = none
 
 # S2933: Fields that are only assigned in the constructor should be "readonly"
@@ -733,6 +733,11 @@ dotnet_code_quality.CA1859.api_surface = private,internal
 # CA1873: Evaluation of this argument may be expensive and unnecessary if logging is disabled
 dotnet_diagnostic.CA1873.severity = suggestion
 
+# CA2000: Dispose objects before losing scope
+#
+# too noisy.
+dotnet_diagnostic.CA2000.severity = suggestion
+
 # CA2208: Instantiate argument exceptions correctly
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2208
 #
diff --git a/src/Renci.SshNet/ForwardedPortDynamic.cs b/src/Renci.SshNet/ForwardedPortDynamic.cs
@@ -182,9 +182,7 @@ private void StartAccept(SocketAsyncEventArgs e)
         {
             if (e is null)
             {
-#pragma warning disable CA2000 // Dispose objects before losing scope
                 e = new SocketAsyncEventArgs();
-#pragma warning restore CA2000 // Dispose objects before losing scope
                 e.Completed += AcceptCompleted;
             }
             else
diff --git a/src/Renci.SshNet/ForwardedPortLocal.cs b/src/Renci.SshNet/ForwardedPortLocal.cs
@@ -212,9 +212,7 @@ private void StartAccept(SocketAsyncEventArgs e)
         {
             if (e is null)
             {
-#pragma warning disable CA2000 // Dispose objects before losing scope
                 e = new SocketAsyncEventArgs();
-#pragma warning restore CA2000 // Dispose objects before losing scope
                 e.Completed += AcceptCompleted;
             }
             else
diff --git a/src/Renci.SshNet/NetConfClient.cs b/src/Renci.SshNet/NetConfClient.cs
@@ -1,6 +1,5 @@
 ﻿#nullable enable
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Net;
 using System.Threading;
 using System.Xml;
@@ -73,7 +72,6 @@ public NetConfClient(ConnectionInfo connectionInfo)
         /// <exception cref="ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public NetConfClient(string host, int port, string username, string password)
             : this(new PasswordConnectionInfo(host, port, username, password), ownsConnectionInfo: true)
         {
@@ -102,7 +100,6 @@ public NetConfClient(string host, string username, string password)
         /// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public NetConfClient(string host, int port, string username, params IPrivateKeySource[] keyFiles)
             : this(new PrivateKeyConnectionInfo(host, port, username, keyFiles), ownsConnectionInfo: true)
         {
diff --git a/src/Renci.SshNet/PrivateKeyFile.OpenSSH.cs b/src/Renci.SshNet/PrivateKeyFile.OpenSSH.cs
@@ -200,9 +200,7 @@ public Key Parse()
 
                         // k || ENC(A)
                         unencryptedPrivateKey = privateKeyReader.ReadBinary();
-#pragma warning disable CA2000 // Dispose objects before losing scope
                         parsedKey = new ED25519Key(unencryptedPrivateKey);
-#pragma warning restore CA2000 // Dispose objects before losing scope
                         break;
                     case "ecdsa-sha2-nistp256":
                     case "ecdsa-sha2-nistp384":
@@ -212,9 +210,7 @@ public Key Parse()
                         publicKey = privateKeyReader.ReadBinary();
 
                         unencryptedPrivateKey = privateKeyReader.ReadBinary();
-#pragma warning disable CA2000 // Dispose objects before losing scope
                         parsedKey = new EcdsaKey(curve, publicKey, unencryptedPrivateKey.TrimLeadingZeros());
-#pragma warning restore CA2000 // Dispose objects before losing scope
                         break;
                     case "ssh-rsa":
                         var modulus = privateKeyReader.ReadBigInt();
@@ -223,9 +219,7 @@ public Key Parse()
                         var inverseQ = privateKeyReader.ReadBigInt();
                         var p = privateKeyReader.ReadBigInt();
                         var q = privateKeyReader.ReadBigInt();
-#pragma warning disable CA2000 // Dispose objects before losing scope
                         parsedKey = new RsaKey(modulus, exponent, d, p, q, inverseQ);
-#pragma warning restore CA2000 // Dispose objects before losing scope
                         break;
                     default:
                         throw new SshException("OpenSSH key type '" + keyType + "' is not supported.");
diff --git a/src/Renci.SshNet/PrivateKeyFile.cs b/src/Renci.SshNet/PrivateKeyFile.cs
@@ -370,10 +370,8 @@ private void Open(Stream privateKey, string? passPhrase)
             if (_key is RsaKey rsaKey)
             {
                 _hostAlgorithms.Add(new KeyHostAlgorithm("ssh-rsa", _key));
-#pragma warning disable CA2000 // Dispose objects before losing scope
                 _hostAlgorithms.Add(new KeyHostAlgorithm("rsa-sha2-512", _key, new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA512)));
                 _hostAlgorithms.Add(new KeyHostAlgorithm("rsa-sha2-256", _key, new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA256)));
-#pragma warning restore CA2000 // Dispose objects before losing scope
             }
             else
             {
@@ -420,7 +418,6 @@ private void OpenCertificate(Stream certificate)
 
                 _hostAlgorithms.Insert(0, new CertificateHostAlgorithm("ssh-rsa-cert-v01@openssh.com", Key, Certificate));
 
-#pragma warning disable CA2000 // Dispose objects before losing scope
                 _hostAlgorithms.Insert(0, new CertificateHostAlgorithm(
                     "rsa-sha2-256-cert-v01@openssh.com",
                     Key,
@@ -432,7 +429,6 @@ private void OpenCertificate(Stream certificate)
                     Key,
                     Certificate,
                     new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA512)));
-#pragma warning restore CA2000 // Dispose objects before losing scope
             }
             else
             {
diff --git a/src/Renci.SshNet/ScpClient.cs b/src/Renci.SshNet/ScpClient.cs
@@ -2,7 +2,6 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Net;
@@ -152,7 +151,6 @@ public ScpClient(ConnectionInfo connectionInfo)
         /// <exception cref="ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public ScpClient(string host, int port, string username, string password)
             : this(new PasswordConnectionInfo(host, port, username, password), ownsConnectionInfo: true)
         {
@@ -181,7 +179,6 @@ public ScpClient(string host, string username, string password)
         /// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public ScpClient(string host, int port, string username, params IPrivateKeySource[] keyFiles)
             : this(new PrivateKeyConnectionInfo(host, port, username, keyFiles), ownsConnectionInfo: true)
         {
diff --git a/src/Renci.SshNet/Sftp/SftpFileStream.cs b/src/Renci.SshNet/Sftp/SftpFileStream.cs
@@ -164,9 +164,7 @@ internal static SftpFileStream Open(
             int bufferSize,
             bool isDownloadFile = false)
         {
-#pragma warning disable CA2000 // Dispose objects before losing scope
             return Open(session, path, mode, access, bufferSize, isDownloadFile, isAsync: false, CancellationToken.None).GetAwaiter().GetResult();
-#pragma warning restore CA2000 // Dispose objects before losing scope
         }
 
         internal static Task<SftpFileStream> OpenAsync(
diff --git a/src/Renci.SshNet/SftpClient.cs b/src/Renci.SshNet/SftpClient.cs
@@ -3,7 +3,6 @@
 using System.Buffers;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -202,7 +201,6 @@ public SftpClient(ConnectionInfo connectionInfo)
         /// <exception cref="ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public SftpClient(string host, int port, string username, string password)
             : this(new PasswordConnectionInfo(host, port, username, password), ownsConnectionInfo: true)
         {
@@ -231,7 +229,6 @@ public SftpClient(string host, string username, string password)
         /// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public SftpClient(string host, int port, string username, params IPrivateKeySource[] keyFiles)
             : this(new PrivateKeyConnectionInfo(host, port, username, keyFiles), ownsConnectionInfo: true)
         {
@@ -2173,7 +2170,6 @@ private List<FileInfo> InternalSynchronizeDirectories(string sourcePath, string
                         var remoteFileName = string.Format(CultureInfo.InvariantCulture, @"{0}/{1}", destinationPath, localFile.Name);
                         try
                         {
-#pragma warning disable CA2000 // Dispose objects before losing scope
                             using (var file = File.OpenRead(localFile.FullName))
                             {
 #pragma warning disable CA2025 // Do not pass 'IDisposable' instances into unawaited tasks
@@ -2187,7 +2183,6 @@ private List<FileInfo> InternalSynchronizeDirectories(string sourcePath, string
                                     CancellationToken.None).GetAwaiter().GetResult();
 #pragma warning restore CA2025 // Do not pass 'IDisposable' instances into unawaited tasks
                             }
-#pragma warning restore CA2000 // Dispose objects before losing scope
 
                             uploadedFiles.Add(localFile);
 
diff --git a/src/Renci.SshNet/SshClient.cs b/src/Renci.SshNet/SshClient.cs
@@ -1,7 +1,6 @@
 ﻿#nullable enable
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Net;
 using System.Text;
@@ -58,9 +57,7 @@ public SshClient(ConnectionInfo connectionInfo)
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
         public SshClient(string host, int port, string username, string password)
-#pragma warning disable CA2000 // Dispose objects before losing scope
             : this(new PasswordConnectionInfo(host, port, username, password), ownsConnectionInfo: true)
-#pragma warning restore CA2000 // Dispose objects before losing scope
         {
         }
 
@@ -87,7 +84,6 @@ public SshClient(string host, string username, string password)
         /// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
-        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "Disposed in Dispose(bool) method.")]
         public SshClient(string host, int port, string username, params IPrivateKeySource[] keyFiles)
             : this(new PrivateKeyConnectionInfo(host, port, username, keyFiles), ownsConnectionInfo: true)
         {
diff --git a/test/Renci.SshNet.Benchmarks/.editorconfig b/test/Renci.SshNet.Benchmarks/.editorconfig
@@ -74,10 +74,6 @@ dotnet_diagnostic.MA0026.severity = silent
 
 #### .NET Compiler Platform analysers rules ####
 
-# CA2000: Dispose objects before losing scope
-# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2000
-dotnet_diagnostic.CA2000.severity = silent
-
 # IDE0046: Use conditional expression for return
 # https://learn.microsoft.com/en-ca/dotnet/fundamentals/code-analysis/style-rules/ide0046
 dotnet_diagnostic.IDE0046.severity = silent
diff --git a/test/Renci.SshNet.IntegrationBenchmarks/.editorconfig b/test/Renci.SshNet.IntegrationBenchmarks/.editorconfig
@@ -70,10 +70,6 @@ dotnet_diagnostic.MA0053.severity = suggestion
 
 #### .NET Compiler Platform analysers rules ####
 
-# CA2000: Dispose objects before losing scope
-# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2000
-dotnet_diagnostic.CA2000.severity = suggestion
-
 # Error CS8892: Method 'TestingPlatformEntryPoint.Main(string[])' will not be used as an entry point because a synchronous entry point 'Program.Main(string[])' was found.
 # https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/warning-waves#cs8892---method-will-not-be-used-as-an-entry-point-because-a-synchronous-entry-point-method-was-found
 dotnet_diagnostic.CS8892.severity = suggestion
diff --git a/test/Renci.SshNet.IntegrationTests/.editorconfig b/test/Renci.SshNet.IntegrationTests/.editorconfig
@@ -310,10 +310,6 @@ dotnet_diagnostic.CA1851.severity = silent
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1859
 dotnet_diagnostic.CA1859.severity = silent
 
-# CA2000: Dispose objects before losing scope
-# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2000
-dotnet_diagnostic.CA2000.severity = silent
-
 # CA2007: Do not directly await a Task
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2007
 dotnet_diagnostic.CA2007.severity = silent
diff --git a/test/Renci.SshNet.Tests/.editorconfig b/test/Renci.SshNet.Tests/.editorconfig
@@ -358,10 +358,6 @@ dotnet_diagnostic.CA1841.severity = silent
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1859
 dotnet_diagnostic.CA1859.severity = silent
 
-# CA2000: Dispose objects before losing scope
-# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2000
-dotnet_diagnostic.CA2000.severity = silent
-
 # CA2007: Do not directly await a Task
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2007
 dotnet_diagnostic.CA2007.severity = silent

Original file line number	Diff line number	Diff line change
`@@ -182,9 +182,7 @@ private void StartAccept(SocketAsyncEventArgs e)`
`182`	`182`	`{`
`183`	`183`	`if (e is null)`
`184`	`184`	`{`
`185`		`-#pragma warning disable CA2000 // Dispose objects before losing scope`
`186`	`185`	`e = new SocketAsyncEventArgs();`
`187`		`-#pragma warning restore CA2000 // Dispose objects before losing scope`
`188`	`186`	`e.Completed += AcceptCompleted;`
`189`	`187`	`}`
`190`	`188`	`else`
Original file line number	Diff line number	Diff line change
`@@ -212,9 +212,7 @@ private void StartAccept(SocketAsyncEventArgs e)`
`212`	`212`	`{`
`213`	`213`	`if (e is null)`
`214`	`214`	`{`
`215`		`-#pragma warning disable CA2000 // Dispose objects before losing scope`
`216`	`215`	`e = new SocketAsyncEventArgs();`
`217`		`-#pragma warning restore CA2000 // Dispose objects before losing scope`
`218`	`216`	`e.Completed += AcceptCompleted;`
`219`	`217`	`}`
`220`	`218`	`else`
Original file line number	Diff line number	Diff line change
`@@ -370,10 +370,8 @@ private void Open(Stream privateKey, string? passPhrase)`
`370`	`370`	`if (_key is RsaKey rsaKey)`
`371`	`371`	`{`
`372`	`372`	`_hostAlgorithms.Add(new KeyHostAlgorithm("ssh-rsa", _key));`
`373`		`-#pragma warning disable CA2000 // Dispose objects before losing scope`
`374`	`373`	`_hostAlgorithms.Add(new KeyHostAlgorithm("rsa-sha2-512", _key, new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA512)));`
`375`	`374`	`_hostAlgorithms.Add(new KeyHostAlgorithm("rsa-sha2-256", _key, new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA256)));`
`376`		`-#pragma warning restore CA2000 // Dispose objects before losing scope`
`377`	`375`	`}`
`378`	`376`	`else`
`379`	`377`	`{`
`@@ -420,7 +418,6 @@ private void OpenCertificate(Stream certificate)`
`420`	`418`
`421`	`419`	`_hostAlgorithms.Insert(0, new CertificateHostAlgorithm("[email protected]", Key, Certificate));`
`422`	`420`
`423`		`-#pragma warning disable CA2000 // Dispose objects before losing scope`
`424`	`421`	`_hostAlgorithms.Insert(0, new CertificateHostAlgorithm(`
`425`	`422`	`"[email protected]",`
`426`	`423`	`Key,`
`@@ -432,7 +429,6 @@ private void OpenCertificate(Stream certificate)`
`432`	`429`	`Key,`
`433`	`430`	`Certificate,`
`434`	`431`	`new RsaDigitalSignature(rsaKey, HashAlgorithmName.SHA512)));`
`435`		`-#pragma warning restore CA2000 // Dispose objects before losing scope`
`436`	`432`	`}`
`437`	`433`	`else`
`438`	`434`	`{`
Original file line number	Diff line number	Diff line change
`@@ -164,9 +164,7 @@ internal static SftpFileStream Open(`
`164`	`164`	`int bufferSize,`
`165`	`165`	`bool isDownloadFile = false)`
`166`	`166`	`{`
`167`		`-#pragma warning disable CA2000 // Dispose objects before losing scope`
`168`	`167`	`return Open(session, path, mode, access, bufferSize, isDownloadFile, isAsync: false, CancellationToken.None).GetAwaiter().GetResult();`
`169`		`-#pragma warning restore CA2000 // Dispose objects before losing scope`
`170`	`168`	`}`
`171`	`169`
`172`	`170`	`internal static Task<SftpFileStream> OpenAsync(`