Remove unnecessary finalizers (#1209)

All of the finalizers in the library are no-ops, but their existence means that
when Dispose (and thus GC.SuppressFinalize) is not called, the objects' lifetimes
are extended unnecessarily while they are waiting to be finalized.

Co-authored-by: Wojciech Nagórski <[email protected]>

Author: Rob-Hague

src/Renci.SshNet/BaseClient.cs

@@ -461,14 +461,6 @@ protected void CheckDisposed()
 #endif // NET7_0_OR_GREATER
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="BaseClient"/> class.
-        /// </summary>
-        ~BaseClient()
-        {
-            Dispose(disposing: false);
-        }
-
         /// <summary>
         /// Stops the keep-alive timer, and waits until all timer callbacks have been
         /// executed.

src/Renci.SshNet/Channels/Channel.cs

@@ -868,13 +868,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="Channel"/> class.
-        /// </summary>
-        ~Channel()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/Compression/Compressor.cs

@@ -175,14 +175,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Releases unmanaged resources and performs other cleanup operations before the <see cref="Compressor"/> is reclaimed
-        /// by garbage collection.
-        /// </summary>
-        ~Compressor()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/ForwardedPortRemote.cs

@@ -379,13 +379,5 @@ protected override void Dispose(bool disposing)
 
             _isDisposed = true;
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="ForwardedPortRemote"/> class.
-        /// </summary>
-        ~ForwardedPortRemote()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/KeyboardInteractiveAuthenticationMethod.cs

@@ -183,13 +183,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="KeyboardInteractiveAuthenticationMethod"/> class.
-        /// </summary>
-        ~KeyboardInteractiveAuthenticationMethod()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/KeyboardInteractiveConnectionInfo.cs

@@ -174,13 +174,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="KeyboardInteractiveConnectionInfo"/> class.
-        /// </summary>
-        ~KeyboardInteractiveConnectionInfo()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/NoneAuthenticationMethod.cs

@@ -121,13 +121,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="NoneAuthenticationMethod"/> class.
-        /// </summary>
-        ~NoneAuthenticationMethod()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/PasswordAuthenticationMethod.cs

@@ -201,13 +201,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="PasswordAuthenticationMethod"/> class.
-        /// </summary>
-        ~PasswordAuthenticationMethod()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/PasswordConnectionInfo.cs

@@ -291,13 +291,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="PasswordConnectionInfo"/> class.
-        /// </summary>
-        ~PasswordConnectionInfo()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/PrivateKeyAuthenticationMethod.cs

@@ -191,14 +191,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="PrivateKeyAuthenticationMethod"/> class.
-        /// </summary>
-        ~PrivateKeyAuthenticationMethod()
-        {
-            Dispose(disposing: false);
-        }
-
         private sealed class SignatureData : SshData
         {
             private readonly RequestMessagePublicKey _message;

src/Renci.SshNet/PrivateKeyConnectionInfo.cs

@@ -170,13 +170,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="PrivateKeyConnectionInfo"/> class.
-        /// </summary>
-        ~PrivateKeyConnectionInfo()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/PrivateKeyFile.cs

@@ -669,14 +669,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="PrivateKeyFile"/> class.
-        /// </summary>
-        ~PrivateKeyFile()
-        {
-            Dispose(disposing: false);
-        }
-
         private sealed class SshDataReader : SshData
         {
             public SshDataReader(byte[] data)

src/Renci.SshNet/Security/Cryptography/ED25519DigitalSignature.cs

@@ -83,13 +83,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="ED25519DigitalSignature"/> class.
-        /// </summary>
-        ~ED25519DigitalSignature()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/Security/Cryptography/ED25519Key.cs

@@ -131,13 +131,5 @@ protected virtual void Dispose(bool disposing)
                 _isDisposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="ED25519Key"/> class.
-        /// </summary>
-        ~ED25519Key()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/Security/KeyExchange.cs

@@ -564,15 +564,6 @@ protected virtual void Dispose(bool disposing)
         {
         }
 
-        /// <summary>
-        /// Releases unmanaged resources and performs other cleanup operations before the
-        /// <see cref="KeyExchange"/> is reclaimed by garbage collection.
-        /// </summary>
-        ~KeyExchange()
-        {
-            Dispose(disposing: false);
-        }
-
         #endregion
     }
 }

src/Renci.SshNet/Session.cs

@@ -2253,14 +2253,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="Session"/> class.
-        /// </summary>
-        ~Session()
-        {
-            Dispose(disposing: false);
-        }
-
         /// <summary>
         /// Gets the connection info.
         /// </summary>

src/Renci.SshNet/Sftp/SftpFileReader.cs

@@ -219,11 +219,6 @@ public byte[] Read()
             return read;
         }
 
-        ~SftpFileReader()
-        {
-            Dispose(disposing: false);
-        }
-
         public void Dispose()
         {
             Dispose(disposing: true);

src/Renci.SshNet/Sftp/SftpFileStream.cs

@@ -439,14 +439,6 @@ internal static async Task<SftpFileStream> OpenAsync(ISftpSession session, strin
             return new SftpFileStream(session, path, access, bufferSize, handle, position);
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="SftpFileStream"/> class.
-        /// </summary>
-        ~SftpFileStream()
-        {
-            Dispose(disposing: false);
-        }
-
         /// <summary>
         /// Clears all buffers for this stream and causes any buffered data to be written to the file.
         /// </summary>

src/Renci.SshNet/Shell.cs

@@ -350,13 +350,5 @@ protected virtual void Dispose(bool disposing)
                 _disposed = true;
             }
         }
-
-        /// <summary>
-        /// Finalizes an instance of the <see cref="Shell"/> class.
-        /// </summary>
-        ~Shell()
-        {
-            Dispose(disposing: false);
-        }
     }
 }

src/Renci.SshNet/SubsystemSession.cs

@@ -537,14 +537,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        /// <summary>
-        /// Finalizes an instance of the <see cref="SubsystemSession" /> class.
-        /// </summary>
-        ~SubsystemSession()
-        {
-            Dispose(disposing: false);
-        }
-
         private void EnsureNotDisposed()
         {
 #if NET7_0_OR_GREATER