Fixes spelling errors (#1668)

* Fixes spelling errors in comments, private members, and public members in test projects

* Adds en-GB as spell checker option; reverts notable cases of American English

* convert file UTF-16 LE BOM -> UTF-8

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

.editorconfig

@@ -1,4 +1,4 @@
-// Avoid looking for .editorconfig files in parent directories
+# Avoid looking for .editorconfig files in parent directories
 root=true
 
 [*]
@@ -7,6 +7,9 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 tab_width = 4
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = exclusion.dic
+spelling_checkable_types = all
 
 [*.{xml,csproj,props}]
 
@@ -776,14 +779,14 @@ dotnet_diagnostic.IDE0032.severity = suggestion
 dotnet_diagnostic.IDE0045.severity = none
 
 # IDE0046: Use conditional expression for return
-# 
+#
 # Using a conditional expression is not always a clear win for readability.
 #
 # Configured using 'dotnet_style_prefer_conditional_expression_over_return'
 dotnet_diagnostic.IDE0046.severity = suggestion
 
 # IDE0047: Remove unnecessary parentheses
-# 
+#
 # Removing "unnecessary" parentheses is not always a clear win for readability.
 dotnet_diagnostic.IDE0047.severity = suggestion
 
@@ -794,7 +797,7 @@ dotnet_diagnostic.IDE0047.severity = suggestion
 dotnet_diagnostic.IDE0130.severity = none
 
 # IDE0270: Null check can be simplified
-# 
+#
 # var inputPath = originalDossierPathList.Find(x => x.id == updatedPath.id);
 # if (inputPath is null)
 # {
@@ -938,7 +941,7 @@ csharp_new_line_before_catch = true
 csharp_new_line_before_finally = true
 # Enabling this setting breaks Resharper formatting for an enum field reference that is
 # deeply nested in an object initializer.
-# 
+#
 # For an example, see TDataExchangeGeneralEnricher_CernInfrastructureObstruction.
 #csharp_new_line_before_members_in_object_initializers = true
 csharp_new_line_before_members_in_anonymous_types = true
@@ -1021,19 +1024,19 @@ dotnet_naming_rule.private_const_fields_pascal_case.severity = warning
 
 dotnet_naming_symbols.interface.applicable_kinds = interface
 dotnet_naming_symbols.interface.applicable_accessibilities = *
-dotnet_naming_symbols.interface.required_modifiers = 
+dotnet_naming_symbols.interface.required_modifiers =
 
 dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
 dotnet_naming_symbols.types.applicable_accessibilities = *
-dotnet_naming_symbols.types.required_modifiers = 
+dotnet_naming_symbols.types.required_modifiers =
 
 dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
 dotnet_naming_symbols.non_field_members.applicable_accessibilities = *
-dotnet_naming_symbols.non_field_members.required_modifiers = 
+dotnet_naming_symbols.non_field_members.required_modifiers =
 
 dotnet_naming_symbols.private_fields.applicable_kinds = field
 dotnet_naming_symbols.private_fields.applicable_accessibilities = private
-dotnet_naming_symbols.private_fields.required_modifiers = 
+dotnet_naming_symbols.private_fields.required_modifiers =
 
 dotnet_naming_symbols.private_static_fields.applicable_kinds = field
 dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private
@@ -1050,18 +1053,18 @@ dotnet_naming_symbols.private_const_fields.required_modifiers = const
 # Naming styles
 
 dotnet_naming_style.begins_with_i.required_prefix = I
-dotnet_naming_style.begins_with_i.required_suffix = 
-dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.required_suffix =
+dotnet_naming_style.begins_with_i.word_separator =
 dotnet_naming_style.begins_with_i.capitalization = pascal_case
 
-dotnet_naming_style.pascal_case.required_prefix = 
-dotnet_naming_style.pascal_case.required_suffix = 
-dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.required_prefix =
+dotnet_naming_style.pascal_case.required_suffix =
+dotnet_naming_style.pascal_case.word_separator =
 dotnet_naming_style.pascal_case.capitalization = pascal_case
 
 dotnet_naming_style.camel_case_begins_with_underscore.required_prefix = _
-dotnet_naming_style.camel_case_begins_with_underscore.required_suffix = 
-dotnet_naming_style.camel_case_begins_with_underscore.word_separator = 
+dotnet_naming_style.camel_case_begins_with_underscore.required_suffix =
+dotnet_naming_style.camel_case_begins_with_underscore.word_separator =
 dotnet_naming_style.camel_case_begins_with_underscore.capitalization = camel_case
 
 #### .NET Compiler Platform general options ####

Renci.SshNet.sln

@@ -14,6 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		CONTRIBUTING.md = CONTRIBUTING.md
 		Directory.Build.props = Directory.Build.props
 		Directory.Packages.props = Directory.Packages.props
+		exclusion.dic = exclusion.dic
 		global.json = global.json
 		LICENSE = LICENSE
 		nuget.config = nuget.config

exclusion.dic

@@ -0,0 +1,53 @@
+args
+atime
+bcrypt
+bigint
+bourne
+cbc
+chacha
+csproj
+decryptor
+dest
+diffie
+docfx
+ecdh
+ecdsa
+emerle
+exe
+fallback
+github
+hmac
+hostbased
+identd
+ietf
+impl
+infocmp
+kewl
+kex
+mindrot
+mtime
+netconf
+nist
+nistp
+openssh
+pkcs
+posix
+privatekey
+protoversion
+pubkey
+publickey
+renci
+ripemd
+slen
+sntrup
+softwareversion
+sshd
+tcpip
+threadpool
+umac
+unpad
+unix
+waithandle
+xoff
+xmldoc
+zlib

src/Renci.SshNet/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../exclusion.dic
+spelling_checkable_types = all
 
 #### Sonar rules ####
 

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -350,7 +350,7 @@ namespace Renci.SshNet.Abstractions
                     }
                     else
                     {
-                        throw; // any serious error occurr
+                        throw; // any serious error occur
                     }
                 }
             }

src/Renci.SshNet/BaseClient.cs

@@ -408,7 +408,7 @@ namespace Renci.SshNet
         {
         }
 
-        private void Session_ErrorOccured(object? sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object? sender, ExceptionEventArgs e)
         {
             ErrorOccurred?.Invoke(this, e);
         }
@@ -558,7 +558,7 @@ namespace Renci.SshNet
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -577,7 +577,7 @@ namespace Renci.SshNet
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -593,7 +593,7 @@ namespace Renci.SshNet
 
         private void DisposeSession(ISession session)
         {
-            session.ErrorOccured -= Session_ErrorOccured;
+            session.ErrorOccured -= Session_ErrorOccurred;
             session.HostKeyReceived -= Session_HostKeyReceived;
             session.ServerIdentificationReceived -= Session_ServerIdentificationReceived;
             session.Dispose();

src/Renci.SshNet/Channels/Channel.cs

@@ -94,7 +94,7 @@ namespace Renci.SshNet.Channels
             session.ChannelRequestReceived += OnChannelRequest;
             session.ChannelSuccessReceived += OnChannelSuccess;
             session.ChannelFailureReceived += OnChannelFailure;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
             session.Disconnected += Session_Disconnected;
         }
 
@@ -102,7 +102,7 @@ namespace Renci.SshNet.Channels
         /// Gets the session.
         /// </summary>
         /// <value>
-        ///  Thhe session.
+        ///  The session.
         /// </value>
         protected ISession Session
         {
@@ -328,7 +328,7 @@ namespace Renci.SshNet.Channels
         /// multiple chunks and will wait for the remote window size to be adjusted when it's zero.
         /// </para>
         /// <para>
-        /// This is done to support SSH servers will a small window size that do not agressively
+        /// This is done to support SSH servers will a small window size that do not aggressively
         /// increase their window size. We need to take into account that there may be SSH servers
         /// that only increase their window size when it has reached zero.
         /// </para>
@@ -586,7 +586,7 @@ namespace Renci.SshNet.Channels
         {
         }
 
-        protected virtual void OnErrorOccured(Exception exp)
+        protected virtual void OnErrorOccurred(Exception exp)
         {
         }
 
@@ -609,20 +609,20 @@ namespace Renci.SshNet.Channels
         /// </summary>
         /// <param name="ex">The <see cref="Exception"/>.</param>
         /// <remarks>
-        /// This method will in turn invoke <see cref="OnErrorOccured(System.Exception)"/>, and
+        /// This method will in turn invoke <see cref="OnErrorOccurred(System.Exception)"/>, and
         /// raise the <see cref="Exception"/> event.
         /// </remarks>
         protected void OnChannelException(Exception ex)
         {
-            OnErrorOccured(ex);
+            OnErrorOccurred(ex);
             RaiseExceptionEvent(ex);
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             try
             {
-                OnErrorOccured(e.Exception);
+                OnErrorOccurred(e.Exception);
             }
             catch (Exception ex)
             {
@@ -854,7 +854,7 @@ namespace Renci.SshNet.Channels
                     session.ChannelRequestReceived -= OnChannelRequest;
                     session.ChannelSuccessReceived -= OnChannelSuccess;
                     session.ChannelFailureReceived -= OnChannelFailure;
-                    session.ErrorOccured -= Session_ErrorOccured;
+                    session.ErrorOccured -= Session_ErrorOccurred;
                     session.Disconnected -= Session_Disconnected;
                 }
 

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -249,9 +249,9 @@ namespace Renci.SshNet.Channels
         /// Called whenever an unhandled <see cref="Exception"/> occurs in <see cref="Session"/> causing
         /// the message loop to be interrupted, or when an exception occurred processing a channel message.
         /// </summary>
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
-            base.OnErrorOccured(exp);
+            base.OnErrorOccurred(exp);
 
             // signal to the client that we will not send anything anymore; this will also interrupt the
             // blocking receive in Bind if the client sends FIN/ACK in time
@@ -261,7 +261,7 @@ namespace Renci.SshNet.Channels
         }
 
         /// <summary>
-        /// Called when the server wants to terminate the connection immmediately.
+        /// Called when the server wants to terminate the connection immediately.
         /// </summary>
         /// <remarks>
         /// The sender MUST NOT send or receive any data after this message, and

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -98,9 +98,9 @@ namespace Renci.SshNet.Channels
             SocketAbstraction.ReadContinuous(_socket, buffer, 0, buffer.Length, SendData);
         }
 
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
-            base.OnErrorOccured(exp);
+            base.OnErrorOccurred(exp);
 
             // signal to the server that we will not send anything anymore; this will also interrupt the
             // blocking receive in Bind if the server sends FIN/ACK in time

src/Renci.SshNet/Channels/ChannelSession.cs

@@ -35,7 +35,7 @@ namespace Renci.SshNet.Channels
 
         private EventWaitHandle _channelRequestResponse = new ManualResetEvent(initialState: false);
 
-        private bool _channelRequestSucces;
+        private bool _channelRequestSuccess;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ChannelSession"/> class.
@@ -136,7 +136,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new PseudoTerminalRequestInfo(environmentVariable, columns, rows, width, height, terminalModeValues)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -154,7 +154,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new X11ForwardingRequestInfo(isSingleConnection, protocol, cookie, screenNumber)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -170,7 +170,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new EnvironmentVariableRequestInfo(variableName, variableValue)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -184,7 +184,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new ShellRequestInfo()));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -199,7 +199,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new ExecRequestInfo(command, ConnectionInfo.Encoding)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -214,7 +214,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new BreakRequestInfo(breakLength)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -229,7 +229,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new SubsystemRequestInfo(subsystem)));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -277,7 +277,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new EndOfWriteRequestInfo()));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -291,7 +291,7 @@ namespace Renci.SshNet.Channels
             _ = _channelRequestResponse.Reset();
             SendMessage(new ChannelRequestMessage(RemoteChannelNumber, new KeepAliveRequestInfo()));
             WaitOnHandle(_channelRequestResponse);
-            return _channelRequestSucces;
+            return _channelRequestSuccess;
         }
 
         /// <summary>
@@ -301,7 +301,7 @@ namespace Renci.SshNet.Channels
         {
             base.OnSuccess();
 
-            _channelRequestSucces = true;
+            _channelRequestSuccess = true;
             _ = _channelRequestResponse?.Set();
         }
 
@@ -312,7 +312,7 @@ namespace Renci.SshNet.Channels
         {
             base.OnFailure();
 
-            _channelRequestSucces = false;
+            _channelRequestSuccess = false;
             _ = _channelRequestResponse?.Set();
         }
 

src/Renci.SshNet/Channels/IChannel.cs

@@ -102,7 +102,7 @@ namespace Renci.SshNet.Channels
         /// multiple chunks and will wait for the remote window size to be adjusted when it's zero.
         /// </para>
         /// <para>
-        /// This is done to support SSH servers will a small window size that do not agressively
+        /// This is done to support SSH servers will a small window size that do not aggressively
         /// increase their window size. We need to take into account that there may be SSH servers
         /// that only increase their window size when it has reached zero.
         /// </para>

src/Renci.SshNet/ClientAuthentication.cs

@@ -116,7 +116,7 @@ namespace Renci.SshNet
 
             foreach (var authenticationMethod in authenticationState.GetActiveAuthenticationMethods(matchingAuthenticationMethods))
             {
-                // guard against a stack overlow for servers that do not update the list of allowed authentication
+                // guard against a stack overflow for servers that do not update the list of allowed authentication
                 // methods after a partial success
                 if (authenticationState.GetPartialSuccessCount(authenticationMethod) >= _partialSuccessLimit)
                 {

src/Renci.SshNet/Common/ExceptionEventArgs.cs

@@ -3,7 +3,7 @@
 namespace Renci.SshNet.Common
 {
     /// <summary>
-    /// Provides data for the ErrorOccured events.
+    /// Provides data for the ErrorOccurred events.
     /// </summary>
     public class ExceptionEventArgs : EventArgs
     {

src/Renci.SshNet/Common/SshDataStream.cs

@@ -213,7 +213,7 @@ namespace Renci.SshNet.Common
         }
 
         /// <summary>
-        /// Reads a <see cref="BigInteger"/> from the SSH datastream.
+        /// Reads a <see cref="BigInteger"/> from the SSH data stream.
         /// </summary>
         /// <returns>
         /// The <see cref="BigInteger"/> read from the SSH data stream.

src/Renci.SshNet/Connection/Socks5Connector.cs

@@ -180,7 +180,7 @@ namespace Renci.SshNet.Connection
 
             var index = 0;
 
-            // Version of the negiotiation
+            // Version of the negotiation
             authenticationRequest[index++] = 0x01;
 
             // Length of the username

src/Renci.SshNet/ForwardedPort.cs

@@ -64,7 +64,7 @@ namespace Renci.SshNet
                 throw new SshConnectionException("Client not connected.");
             }
 
-            Session.ErrorOccured += Session_ErrorOccured;
+            Session.ErrorOccured += Session_ErrorOccurred;
             StartPort();
         }
 
@@ -107,7 +107,7 @@ namespace Renci.SshNet
             var session = Session;
             if (session is not null)
             {
-                session.ErrorOccured -= Session_ErrorOccured;
+                session.ErrorOccured -= Session_ErrorOccurred;
             }
         }
 
@@ -162,11 +162,11 @@ namespace Renci.SshNet
         }
 
         /// <summary>
-        /// Handles session ErrorOccured event.
+        /// Handles session ErrorOccurred event.
         /// </summary>
         /// <param name="sender">The source of the event.</param>
         /// <param name="e">The <see cref="ExceptionEventArgs"/> instance containing the event data.</param>
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             RaiseExceptionEvent(e.Exception);
         }

src/Renci.SshNet/ForwardedPortDynamic.cs

@@ -171,7 +171,7 @@ namespace Renci.SshNet
             // update bound port (in case original was passed as zero)
             BoundPort = (uint)((IPEndPoint)_listener.LocalEndPoint).Port;
 
-            Session.ErrorOccured += Session_ErrorOccured;
+            Session.ErrorOccured += Session_ErrorOccurred;
             Session.Disconnected += Session_Disconnected;
 
             // consider port started when we're listening for inbound connections
@@ -401,7 +401,7 @@ namespace Renci.SshNet
             var session = Session;
             if (session is not null)
             {
-                session.ErrorOccured -= Session_ErrorOccured;
+                session.ErrorOccured -= Session_ErrorOccurred;
                 session.Disconnected -= Session_Disconnected;
             }
         }
@@ -449,7 +449,7 @@ namespace Renci.SshNet
             }
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             var session = Session;
             if (session is not null)

src/Renci.SshNet/ForwardedPortLocal.cs

@@ -199,7 +199,7 @@ namespace Renci.SshNet
             // update bound port (in case original was passed as zero)
             BoundPort = (uint)((IPEndPoint)_listener.LocalEndPoint).Port;
 
-            Session.ErrorOccured += Session_ErrorOccured;
+            Session.ErrorOccured += Session_ErrorOccurred;
             Session.Disconnected += Session_Disconnected;
 
             InitializePendingChannelCountdown();
@@ -375,7 +375,7 @@ namespace Renci.SshNet
             var session = Session;
             if (session != null)
             {
-                session.ErrorOccured -= Session_ErrorOccured;
+                session.ErrorOccured -= Session_ErrorOccurred;
                 session.Disconnected -= Session_Disconnected;
             }
         }
@@ -423,7 +423,7 @@ namespace Renci.SshNet
             }
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             var session = Session;
             if (session is not null)

src/Renci.SshNet/IServiceFactory.cs

@@ -121,7 +121,7 @@ namespace Renci.SshNet
         /// <remarks>
         /// <para>
         /// The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
-        /// You can get a detailed list of these cababilities by using the ‘infocmp’ command.
+        /// You can get a detailed list of these capabilities by using the ‘infocmp’ command.
         /// </para>
         /// <para>
         /// The column/row dimensions override the pixel dimensions(when non-zero). Pixel dimensions refer

src/Renci.SshNet/ISubsystemSession.cs

@@ -42,7 +42,7 @@ namespace Renci.SshNet
         /// Waits a specified time for a given <see cref="WaitHandle"/> to get signaled.
         /// </summary>
         /// <param name="waitHandle">The handle to wait for.</param>
-        /// <param name="millisecondsTimeout">The number of millieseconds wait for <paramref name="waitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
+        /// <param name="millisecondsTimeout">The number of milliseconds wait for <paramref name="waitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
         /// <exception cref="SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
@@ -105,7 +105,7 @@ namespace Renci.SshNet
         /// </returns>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
-        /// <exception cref="SshOperationTimeoutException">No object satified the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
+        /// <exception cref="SshOperationTimeoutException">No object satisfied the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
         /// <remarks>
         /// For the return value, the index of the first non-system object is considered to be zero.
         /// </remarks>

src/Renci.SshNet/Messages/Connection/ChannelOpen/ChannelOpenMessage.cs

@@ -93,7 +93,7 @@ namespace Renci.SshNet.Messages.Connection
         /// </summary>
         public ChannelOpenMessage()
         {
-            // Required for dynamicly loading request type when it comes from the server
+            // Required for dynamically loading request type when it comes from the server
         }
 
         /// <summary>

src/Renci.SshNet/Messages/Connection/ChannelRequest/PseudoTerminalRequestInfo.cs

@@ -105,7 +105,7 @@ namespace Renci.SshNet.Messages.Connection
         /// <remarks>
         /// <para>
         /// The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
-        /// You can get a detailed list of these cababilities by using the ‘infocmp’ command.
+        /// You can get a detailed list of these capabilities by using the ‘infocmp’ command.
         /// </para>
         /// <para>
         /// The column/row dimensions override the pixel dimensions(when nonzero). Pixel dimensions refer

src/Renci.SshNet/PrivateKeyFile.OpenSSH.cs

@@ -66,7 +66,7 @@ namespace Renci.SshNet
                     throw new SshException("At this time only one public key in the openssh key is supported.");
                 }
 
-                // read public key in ssh-format, but we dont need it
+                // read public key in ssh-format, but we don't need it
                 _ = keyReader.ReadString(Encoding.UTF8);
 
                 // possibly encrypted private key

src/Renci.SshNet/RemotePathShellQuoteTransformation.cs

@@ -118,7 +118,7 @@ namespace Renci.SshNet
                         break;
                     case '!':
                         /*
-                         * In C-Shell, an exclamatation point can only be protected from shell interpretation
+                         * In C-Shell, an exclamation point can only be protected from shell interpretation
                          * when escaped by a backslash.
                          *
                          * Source:

src/Renci.SshNet/Security/Certificate.cs

@@ -176,7 +176,7 @@ namespace Renci.SshNet.Security
         /// The key identifies the option and the value encodes
         /// option-specific information.
         /// All such options are "critical" in the sense that an implementation
-        /// must refuse to authorise a key that has an unrecognised option.
+        /// must refuse to authorize a key that has an unrecognised option.
         /// </summary>
         public IDictionary<string, string> CriticalOptions
         {

src/Renci.SshNet/Security/Cryptography/Ciphers/AesGcmCipher.cs

@@ -22,7 +22,7 @@ namespace Renci.SshNet.Security.Cryptography.Ciphers
 #endif
 
         /// <summary>
-        /// Gets the minimun block size.
+        /// Gets the minimum block size.
         /// The reader is reminded that SSH requires that the data to be
         /// encrypted MUST be padded out to a multiple of the block size
         /// (16-octets for AES-GCM).
@@ -164,7 +164,7 @@ namespace Renci.SshNet.Security.Cryptography.Ciphers
         /// <summary>
         /// Dispose the instance.
         /// </summary>
-        /// <param name="disposing">Set to True to dispose of resouces.</param>
+        /// <param name="disposing">Set to True to dispose of resources.</param>
         public void Dispose(bool disposing)
         {
             if (disposing)

src/Renci.SshNet/Security/Cryptography/Ciphers/ChaCha20Poly1305Cipher.cs

@@ -27,7 +27,7 @@ namespace Renci.SshNet.Security.Cryptography.Ciphers
         private readonly Poly1305 _mac;
 
         /// <summary>
-        /// Gets the minimun block size.
+        /// Gets the minimum block size.
         /// </summary>
         public override byte MinimumSize
         {

src/Renci.SshNet/Security/SshKeyData.cs

@@ -58,7 +58,7 @@ namespace Renci.SshNet.Security
         /// <summary>
         /// Initializes a new instance of the <see cref="SshKeyData"/> class.
         /// </summary>
-        /// <param name="name">The public key format identifer.</param>
+        /// <param name="name">The public key format identifier.</param>
         /// <param name="keys">The public key constituents.</param>
         public SshKeyData(string name, BigInteger[] keys)
         {

src/Renci.SshNet/Session.cs

@@ -355,6 +355,7 @@ namespace Renci.SshNet
         /// <summary>
         /// Occurs when an error occurred.
         /// </summary>
+        /// <remarks>A known misspelling of "occurred" preserved for backward compatibility.</remarks>
         public event EventHandler<ExceptionEventArgs> ErrorOccured;
 
         /// <summary>

src/Renci.SshNet/SftpClient.cs

@@ -2165,7 +2165,7 @@ namespace Renci.SshNet
             ThrowHelper.ThrowIfNull(sourcePath);
             ThrowHelper.ThrowIfNullOrWhiteSpace(destinationPath);
 
-            return InternalSynchronizeDirectories(sourcePath, destinationPath, searchPattern, asynchResult: null);
+            return InternalSynchronizeDirectories(sourcePath, destinationPath, searchPattern, asyncResult: null);
         }
 
         /// <summary>
@@ -2227,7 +2227,7 @@ namespace Renci.SshNet
             return ar.EndInvoke();
         }
 
-        private List<FileInfo> InternalSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, SftpSynchronizeDirectoriesAsyncResult? asynchResult)
+        private List<FileInfo> InternalSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, SftpSynchronizeDirectoriesAsyncResult? asyncResult)
         {
             if (!Directory.Exists(sourcePath))
             {
@@ -2293,7 +2293,7 @@ namespace Renci.SshNet
 
                             uploadedFiles.Add(localFile);
 
-                            asynchResult?.Update(uploadedFiles.Count);
+                            asyncResult?.Update(uploadedFiles.Count);
                         }
                         catch (Exception ex)
                         {
@@ -2318,7 +2318,7 @@ namespace Renci.SshNet
         /// <param name="asyncResult">An <see cref="IAsyncResult"/> that references the asynchronous request.</param>
         /// <param name="listCallback">The list callback.</param>
         /// <returns>
-        /// A list of files in the specfied directory.
+        /// A list of files in the specified directory.
         /// </returns>
         /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
         /// <exception cref="SshConnectionException">Client not connected.</exception>
@@ -2490,7 +2490,7 @@ namespace Renci.SshNet
 
             // We will send out all the write requests without waiting for each response.
             // Afterwards, we may wait on this handle until all responses are received
-            // or an error has occured.
+            // or an error has occurred.
             using var mres = new ManualResetEventSlim(initialState: false);
 
             ExceptionDispatchInfo? exception = null;

src/Renci.SshNet/Shell.cs

@@ -154,7 +154,7 @@ namespace Renci.SshNet
             _channel.ExtendedDataReceived += Channel_ExtendedDataReceived;
             _channel.Closed += Channel_Closed;
             _session.Disconnected += Session_Disconnected;
-            _session.ErrorOccured += Session_ErrorOccured;
+            _session.ErrorOccured += Session_ErrorOccurred;
 
             _channel.Open();
             if (!_noTerminal)
@@ -224,7 +224,7 @@ namespace Renci.SshNet
             _channel?.Dispose();
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             RaiseError(e);
         }
@@ -297,7 +297,7 @@ namespace Renci.SshNet
             }
 
             session.Disconnected -= Session_Disconnected;
-            session.ErrorOccured -= Session_ErrorOccured;
+            session.ErrorOccured -= Session_ErrorOccurred;
         }
 
         private bool _disposed;

src/Renci.SshNet/ShellStream.cs

@@ -162,7 +162,7 @@ namespace Renci.SshNet
             _channel.DataReceived += Channel_DataReceived;
             _channel.Closed += Channel_Closed;
             _session.Disconnected += Session_Disconnected;
-            _session.ErrorOccured += Session_ErrorOccured;
+            _session.ErrorOccured += Session_ErrorOccurred;
 
             _readBuffer = new System.Net.ArrayBuffer(bufferSize);
             _writeBuffer = new System.Net.ArrayBuffer(bufferSize);
@@ -927,7 +927,7 @@ namespace Renci.SshNet
 
                 // Do not dispose _session (we don't own it)
                 _session.Disconnected -= Session_Disconnected;
-                _session.ErrorOccured -= Session_ErrorOccured;
+                _session.ErrorOccured -= Session_ErrorOccurred;
 
                 // But we do own _channel
                 _channel.DataReceived -= Channel_DataReceived;
@@ -940,7 +940,7 @@ namespace Renci.SshNet
             base.Dispose(disposing);
         }
 
-        private void Session_ErrorOccured(object? sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object? sender, ExceptionEventArgs e)
         {
             ErrorOccurred?.Invoke(this, e);
         }

src/Renci.SshNet/SshCommand.cs

@@ -225,7 +225,7 @@ namespace Renci.SshNet
             OutputStream = new PipeStream();
             ExtendedOutputStream = new PipeStream();
             _session.Disconnected += Session_Disconnected;
-            _session.ErrorOccured += Session_ErrorOccured;
+            _session.ErrorOccured += Session_ErrorOccurred;
             _channel = _session.CreateChannelSession();
         }
 
@@ -263,7 +263,7 @@ namespace Renci.SshNet
                 OutputStream.Dispose();
                 ExtendedOutputStream.Dispose();
 
-                // Initialize output streams. We already initialised them for the first
+                // Initialise output streams. We already initialised them for the first
                 // execution in the constructor (to allow passing them around before execution)
                 // so we just need to reinitialise them for subsequent executions.
                 OutputStream = new PipeStream();
@@ -512,7 +512,7 @@ namespace Renci.SshNet
             SetAsyncComplete(setResult: false);
         }
 
-        private void Session_ErrorOccured(object? sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object? sender, ExceptionEventArgs e)
         {
             _ = _tcs?.TrySetException(e.Exception);
 
@@ -642,7 +642,7 @@ namespace Renci.SshNet
                 // unsubscribe from session events to ensure other objects that we're going to dispose
                 // are not accessed while disposing
                 _session.Disconnected -= Session_Disconnected;
-                _session.ErrorOccured -= Session_ErrorOccured;
+                _session.ErrorOccured -= Session_ErrorOccurred;
 
                 // unsubscribe from channel events to ensure other objects that we're going to dispose
                 // are not accessed while disposing

src/Renci.SshNet/SubsystemSession.cs

@@ -27,7 +27,7 @@ namespace Renci.SshNet
         private ISession _session;
         private IChannelSession _channel;
         private Exception _exception;
-        private EventWaitHandle _errorOccuredWaitHandle = new ManualResetEvent(initialState: false);
+        private EventWaitHandle _errorOccurredWaitHandle = new ManualResetEvent(initialState: false);
         private EventWaitHandle _sessionDisconnectedWaitHandle = new ManualResetEvent(initialState: false);
         private EventWaitHandle _channelClosedWaitHandle = new ManualResetEvent(initialState: false);
         private bool _isDisposed;
@@ -106,12 +106,12 @@ namespace Renci.SshNet
             }
 
             // reset waithandles in case we're reconnecting
-            _ = _errorOccuredWaitHandle.Reset();
+            _ = _errorOccurredWaitHandle.Reset();
             _ = _sessionDisconnectedWaitHandle.Reset();
             _ = _sessionDisconnectedWaitHandle.Reset();
             _ = _channelClosedWaitHandle.Reset();
 
-            _session.ErrorOccured += Session_ErrorOccured;
+            _session.ErrorOccured += Session_ErrorOccurred;
             _session.Disconnected += Session_Disconnected;
 
             _channel = _session.CreateChannelSession();
@@ -185,7 +185,7 @@ namespace Renci.SshNet
 
             _logger.LogInformation(error, "Raised exception");
 
-            _ = _errorOccuredWaitHandle?.Set();
+            _ = _errorOccurredWaitHandle?.Set();
 
             SignalErrorOccurred(error);
         }
@@ -224,7 +224,7 @@ namespace Renci.SshNet
         {
             var waitHandles = new[]
                 {
-                    _errorOccuredWaitHandle,
+                    _errorOccurredWaitHandle,
                     _sessionDisconnectedWaitHandle,
                     _channelClosedWaitHandle,
                     waitHandle
@@ -253,8 +253,8 @@ namespace Renci.SshNet
         {
             cancellationToken.ThrowIfCancellationRequested();
 
-            var errorOccuredReg = ThreadPool.RegisterWaitForSingleObject(
-                _errorOccuredWaitHandle,
+            var errorOccurredReg = ThreadPool.RegisterWaitForSingleObject(
+                _errorOccurredWaitHandle,
                 (tcs, _) => ((TaskCompletionSource<T>)tcs).TrySetException(_exception),
                 state: tcs,
                 millisecondsTimeOutInterval: -1,
@@ -296,7 +296,7 @@ namespace Renci.SshNet
             }
             finally
             {
-                _ = errorOccuredReg.Unregister(waitObject: null);
+                _ = errorOccurredReg.Unregister(waitObject: null);
                 _ = sessionDisconnectedReg.Unregister(waitObject: null);
                 _ = channelClosedReg.Unregister(waitObject: null);
             }
@@ -323,7 +323,7 @@ namespace Renci.SshNet
         {
             var waitHandles = new[]
                 {
-                    _errorOccuredWaitHandle,
+                    _errorOccurredWaitHandle,
                     _sessionDisconnectedWaitHandle,
                     _channelClosedWaitHandle,
                     waitHandle
@@ -377,7 +377,7 @@ namespace Renci.SshNet
         {
             var waitHandles = new[]
                 {
-                    _errorOccuredWaitHandle,
+                    _errorOccurredWaitHandle,
                     _sessionDisconnectedWaitHandle,
                     _channelClosedWaitHandle,
                     waitHandleA,
@@ -416,7 +416,7 @@ namespace Renci.SshNet
         /// </returns>
         /// <exception cref="SshException">The connection was closed by the server.</exception>
         /// <exception cref="SshException">The channel was closed.</exception>
-        /// <exception cref="SshOperationTimeoutException">No object satified the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
+        /// <exception cref="SshOperationTimeoutException">No object satisfied the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
         /// <remarks>
         /// For the return value, the index of the first non-system object is considered to be zero.
         /// </remarks>
@@ -452,7 +452,7 @@ namespace Renci.SshNet
         {
             return new WaitHandle[]
                 {
-                    _errorOccuredWaitHandle,
+                    _errorOccurredWaitHandle,
                     _sessionDisconnectedWaitHandle,
                     _channelClosedWaitHandle,
                     waitHandle1,
@@ -471,7 +471,7 @@ namespace Renci.SshNet
         public WaitHandle[] CreateWaitHandleArray(params WaitHandle[] waitHandles)
         {
             var array = new WaitHandle[waitHandles.Length + SystemWaitHandleCount];
-            array[0] = _errorOccuredWaitHandle;
+            array[0] = _errorOccurredWaitHandle;
             array[1] = _sessionDisconnectedWaitHandle;
             array[2] = _channelClosedWaitHandle;
 
@@ -490,7 +490,7 @@ namespace Renci.SshNet
             SignalDisconnected();
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             RaiseError(e.Exception);
         }
@@ -528,7 +528,7 @@ namespace Renci.SshNet
             }
 
             session.Disconnected -= Session_Disconnected;
-            session.ErrorOccured -= Session_ErrorOccured;
+            session.ErrorOccured -= Session_ErrorOccurred;
         }
 
         /// <summary>
@@ -557,11 +557,11 @@ namespace Renci.SshNet
 
                 _session = null;
 
-                var errorOccuredWaitHandle = _errorOccuredWaitHandle;
-                if (errorOccuredWaitHandle != null)
+                var errorOccurredWaitHandle = _errorOccurredWaitHandle;
+                if (errorOccurredWaitHandle != null)
                 {
-                    _errorOccuredWaitHandle = null;
-                    errorOccuredWaitHandle.Dispose();
+                    _errorOccurredWaitHandle = null;
+                    errorOccurredWaitHandle.Dispose();
                 }
 
                 var sessionDisconnectedWaitHandle = _sessionDisconnectedWaitHandle;

src/exclusion.dic

@@ -0,0 +1,2 @@
+renci
+openssh

test/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Sonar rules ####
 

test/Renci.SshNet.Benchmarks/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Sonar rules ####
 

test/Renci.SshNet.IntegrationBenchmarks/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Sonar rules ####
 

test/Renci.SshNet.IntegrationTests/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Sonar rules ####
 

test/Renci.SshNet.IntegrationTests/ScpTests.cs

@@ -1596,11 +1596,11 @@ namespace Renci.SshNet.IntegrationTests
             var remotePathFile1 = CombinePaths(remoteDirectory, "file1");
             var remotePathFile2 = CombinePaths(remoteDirectory, "file2");
 
-            var absoluteremoteSubDirectory1 = CombinePaths(absoluteRemoteDirectory, "sub1");
+            var absoluteRemoteSubDirectory1 = CombinePaths(absoluteRemoteDirectory, "sub1");
             var remoteSubDirectory1 = CombinePaths(remoteDirectory, "sub1");
             var remotePathSubFile1 = CombinePaths(remoteSubDirectory1, "file1");
             var remotePathSubFile2 = CombinePaths(remoteSubDirectory1, "file2");
-            var absoluteremoteSubDirectory2 = CombinePaths(absoluteRemoteDirectory, "sub2");
+            var absoluteRemoteSubDirectory2 = CombinePaths(absoluteRemoteDirectory, "sub2");
             var remoteSubDirectory2 = CombinePaths(remoteDirectory, "sub2");
 
             using (var client = new SftpClient(_connectionInfoFactory.Create()))
@@ -1726,7 +1726,7 @@ namespace Renci.SshNet.IntegrationTests
                     Assert.IsTrue(client.Exists(remoteSubDirectory1));
                     remoteSftpDirectory = client.Get(remoteSubDirectory1);
                     Assert.IsNotNull(remoteSftpDirectory);
-                    Assert.AreEqual(absoluteremoteSubDirectory1, remoteSftpDirectory.FullName);
+                    Assert.AreEqual(absoluteRemoteSubDirectory1, remoteSftpDirectory.FullName);
                     Assert.IsTrue(remoteSftpDirectory.IsDirectory);
                     Assert.IsFalse(remoteSftpDirectory.IsRegularFile);
                     Assert.AreEqual(Directory.GetLastWriteTimeUtc(localSubDirectory1), remoteSftpDirectory.LastWriteTimeUtc);
@@ -1740,7 +1740,7 @@ namespace Renci.SshNet.IntegrationTests
                     Assert.IsTrue(client.Exists(remoteSubDirectory2));
                     remoteSftpDirectory = client.Get(remoteSubDirectory2);
                     Assert.IsNotNull(remoteSftpDirectory);
-                    Assert.AreEqual(absoluteremoteSubDirectory2, remoteSftpDirectory.FullName);
+                    Assert.AreEqual(absoluteRemoteSubDirectory2, remoteSftpDirectory.FullName);
                     Assert.IsTrue(remoteSftpDirectory.IsDirectory);
                     Assert.IsFalse(remoteSftpDirectory.IsRegularFile);
                     Assert.AreEqual(Directory.GetLastWriteTimeUtc(localSubDirectory2), remoteSftpDirectory.LastWriteTimeUtc);

test/Renci.SshNet.IntegrationTests/SftpTests.cs

@@ -4570,9 +4570,9 @@ namespace Renci.SshNet.IntegrationTests
                         Assert.AreEqual(seekOffset + writeBuffer.Length, fs.Length);
                         Assert.AreEqual(0x04, fs.ReadByte());
 
-                        var soughtOverReadBufferffer = new byte[seekOffset - 1];
-                        Assert.AreEqual(soughtOverReadBufferffer.Length, fs.Read(soughtOverReadBufferffer, offset: 0, soughtOverReadBufferffer.Length));
-                        Assert.IsTrue(new byte[soughtOverReadBufferffer.Length].IsEqualTo(soughtOverReadBufferffer));
+                        var soughtOverReadBuffer = new byte[seekOffset - 1];
+                        Assert.AreEqual(soughtOverReadBuffer.Length, fs.Read(soughtOverReadBuffer, offset: 0, soughtOverReadBuffer.Length));
+                        Assert.IsTrue(new byte[soughtOverReadBuffer.Length].IsEqualTo(soughtOverReadBuffer));
 
                         var readBuffer = new byte[writeBuffer.Length];
                         Assert.AreEqual(readBuffer.Length, fs.Read(readBuffer, offset: 0, readBuffer.Length));
@@ -4612,9 +4612,9 @@ namespace Renci.SshNet.IntegrationTests
                         Assert.AreEqual(seekOffset + writeBuffer.Length, fs.Length);
                         Assert.AreEqual(0x04, fs.ReadByte());
 
-                        var soughtOverReadBufferffer = new byte[seekOffset - 1];
-                        Assert.AreEqual(soughtOverReadBufferffer.Length, fs.Read(soughtOverReadBufferffer, offset: 0, soughtOverReadBufferffer.Length));
-                        Assert.IsTrue(new byte[soughtOverReadBufferffer.Length].IsEqualTo(soughtOverReadBufferffer));
+                        var soughtOverReadBuffer = new byte[seekOffset - 1];
+                        Assert.AreEqual(soughtOverReadBuffer.Length, fs.Read(soughtOverReadBuffer, offset: 0, soughtOverReadBuffer.Length));
+                        Assert.IsTrue(new byte[soughtOverReadBuffer.Length].IsEqualTo(soughtOverReadBuffer));
 
                         var readBuffer = new byte[writeBuffer.Length];
                         Assert.AreEqual(readBuffer.Length, fs.Read(readBuffer, offset: 0, readBuffer.Length));
@@ -5315,9 +5315,9 @@ namespace Renci.SshNet.IntegrationTests
                         Assert.AreEqual(seekOffset + writeBuffer.Length, fs.Length);
                         Assert.AreEqual(0x04, fs.ReadByte());
 
-                        var soughtOverReadBufferffer = new byte[seekOffset - 1];
-                        Assert.AreEqual(soughtOverReadBufferffer.Length, fs.Read(soughtOverReadBufferffer, offset: 0, soughtOverReadBufferffer.Length));
-                        Assert.IsTrue(new byte[soughtOverReadBufferffer.Length].IsEqualTo(soughtOverReadBufferffer));
+                        var soughtOverReadBuffer = new byte[seekOffset - 1];
+                        Assert.AreEqual(soughtOverReadBuffer.Length, fs.Read(soughtOverReadBuffer, offset: 0, soughtOverReadBuffer.Length));
+                        Assert.IsTrue(new byte[soughtOverReadBuffer.Length].IsEqualTo(soughtOverReadBuffer));
 
                         var readBuffer = new byte[writeBuffer.Length];
                         Assert.AreEqual(readBuffer.Length, fs.Read(readBuffer, offset: 0, readBuffer.Length));
@@ -5398,9 +5398,9 @@ namespace Renci.SshNet.IntegrationTests
 
                         Assert.AreEqual(0x04, fs.ReadByte());
 
-                        var soughtOverReadBufferffer = new byte[seekOffset - 1];
-                        Assert.AreEqual(seekOffset - 1, fs.Read(soughtOverReadBufferffer, offset: 0, soughtOverReadBufferffer.Length));
-                        Assert.IsTrue(new byte[seekOffset - 1].IsEqualTo(soughtOverReadBufferffer));
+                        var soughtOverReadBuffer = new byte[seekOffset - 1];
+                        Assert.AreEqual(seekOffset - 1, fs.Read(soughtOverReadBuffer, offset: 0, soughtOverReadBuffer.Length));
+                        Assert.IsTrue(new byte[seekOffset - 1].IsEqualTo(soughtOverReadBuffer));
 
                         var readBuffer = new byte[writeBuffer.Length];
                         Assert.AreEqual(writeBuffer.Length, fs.Read(readBuffer, offset: 0, readBuffer.Length));

test/Renci.SshNet.IntegrationTests/SshTests.cs

@@ -831,7 +831,7 @@ namespace Renci.SshNet.IntegrationTests
                                 continue;
                             }
 
-                            // If hostname is currently mapped to another IP address, then remove the 
+                            // If hostname is currently mapped to another IP address, then remove the
                             // current mapping
                             hostConfig.Entries.RemoveAt(i);
                         }

test/Renci.SshNet.TestTools.OpenSSH/.editorconfig

@@ -1,4 +1,6 @@
 [*.cs]
+spelling_exclusion_path = ../../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Meziantou.Analyzer rules ####
 

test/Renci.SshNet.Tests/.editorconfig

@@ -1,4 +1,7 @@
 [*.cs]
+spelling_languages = en-us,en-gb
+spelling_exclusion_path = ../../exclusion.dic
+spelling_checkable_types = identifiers,comments
 
 #### Sonar rules ####
 

test/Renci.SshNet.Tests/Classes/BaseClientTest_Connect_OnConnectedThrowsException.cs

@@ -102,7 +102,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void ErrorOccuredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnBaseClient()
+        public void ErrorOccurredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnBaseClient()
         {
             var errorOccurredSignalCount = 0;
 

test/Renci.SshNet.Tests/Classes/BaseClientTest_Disconnected_Connect.cs

@@ -78,7 +78,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void CreateSocketFactoryOnServiceFactoryShouldBeInvokedTwic()
+        public void CreateSocketFactoryOnServiceFactoryShouldBeInvokedTwice()
         {
             ServiceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Exactly(2));
         }

test/Renci.SshNet.Tests/Classes/Channels/ChannelDirectTcpipTest.cs

@@ -142,7 +142,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
                         {
                             // sleep for a short period to allow channel to actually start receiving from socket
                             Thread.Sleep(100);
-                            // raise ErrorOccured event on session
+                            // raise ErrorOccurred event on session
                             _sessionMock.Raise(s => s.ErrorOccured += null,
                                                new ExceptionEventArgs(new SystemException()));
                         });

test/Renci.SshNet.Tests/Classes/Channels/ChannelSessionTest_Open_OnOpenFailureReceived_RetriesAvalable.cs → test/Renci.SshNet.Tests/Classes/Channels/ChannelSessionTest_Open_OnOpenFailureReceived_RetriesAvailable.cs

@@ -14,7 +14,7 @@ using Renci.SshNet.Messages.Connection;
 namespace Renci.SshNet.Tests.Classes.Channels
 {
     [TestClass]
-    public class ChannelSessionTest_Open_OnOpenFailureReceived_RetriesAvalable : ChannelSessionTestBase
+    public class ChannelSessionTest_Open_OnOpenFailureReceived_RetriesAvailable : ChannelSessionTestBase
     {
         private ChannelSession _channel;
         private uint _localChannelNumber;

test/Renci.SshNet.Tests/Classes/Channels/ChannelStub.cs

@@ -108,7 +108,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
             }
         }
 
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
             OnErrorOccurredInvocations.Add(exp);
 

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelCloseReceived_OnClose_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onCloseException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelDataReceived_OnData_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onDataException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelEofReceived_OnEof_Exception.cs

@@ -64,7 +64,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onEofException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelExtendedDataReceived_OnExtendedData_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onExtendedDataException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelFailureReceived_OnFailure_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onFailureException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelRequestReceived_OnRequest_Exception.cs

@@ -60,7 +60,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onRequestException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelSuccessReceived_OnSuccess_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onSuccessException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionChannelWindowAdjustReceived_OnWindowAdjust_Exception.cs

@@ -65,7 +65,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onWindowAdjustException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionDisconnected_OnDisconnected_Exception.cs

@@ -54,7 +54,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onDisconnectedException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ChannelTest_OnSessionErrorOccurred_OnErrorOccurred_Exception.cs

@@ -56,7 +56,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_errorOccurredException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ClientChannelStub.cs

@@ -112,7 +112,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
             }
         }
 
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
             OnErrorOccurredInvocations.Add(exp);
 

test/Renci.SshNet.Tests/Classes/Channels/ClientChannelTest_OnSessionChannelOpenConfirmationReceived_OnOpenConfirmation_Exception.cs

@@ -62,7 +62,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onOpenConfirmationException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/Channels/ClientChannelTest_OnSessionChannelOpenFailureReceived_OnOpenFailure_Exception.cs

@@ -59,7 +59,7 @@ namespace Renci.SshNet.Tests.Classes.Channels
         }
 
         [TestMethod]
-        public void OnErrorOccuredShouldBeInvokedOnce()
+        public void OnErrorOccurredShouldBeInvokedOnce()
         {
             Assert.AreEqual(1, _channel.OnErrorOccurredInvocations.Count);
             Assert.AreSame(_onOpenFailureException, _channel.OnErrorOccurredInvocations[0]);

test/Renci.SshNet.Tests/Classes/ConnectionInfoTest.cs

@@ -19,7 +19,7 @@ namespace Renci.SshNet.Tests.Classes
     {
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldNotThrowExceptionhenProxyTypesIsNoneAndProxyHostIsNull()
+        public void ConstructorShouldNotThrowExceptionWhenProxyTypesIsNoneAndProxyHostIsNull()
         {
             const string proxyHost = null;
 
@@ -32,7 +32,7 @@ namespace Renci.SshNet.Tests.Classes
 
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldThrowArgumentNullExceptionhenProxyTypesIsNotNoneAndProxyHostIsNull()
+        public void ConstructorShouldThrowArgumentNullExceptionWhenProxyTypesIsNotNoneAndProxyHostIsNull()
         {
             try
             {
@@ -153,7 +153,7 @@ namespace Renci.SshNet.Tests.Classes
 
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldThrowArgumentNullExceptionhenHostIsNull()
+        public void ConstructorShouldThrowArgumentNullExceptionWhenHostIsNull()
         {
             try
             {
@@ -358,7 +358,7 @@ namespace Renci.SshNet.Tests.Classes
 
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldThrowArgumentExceptionhenUsernameIsNull()
+        public void ConstructorShouldThrowArgumentExceptionWhenUsernameIsNull()
         {
             const string username = null;
 
@@ -384,7 +384,7 @@ namespace Renci.SshNet.Tests.Classes
 
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldThrowArgumentExceptionhenUsernameIsEmpty()
+        public void ConstructorShouldThrowArgumentExceptionWhenUsernameIsEmpty()
         {
             var username = string.Empty;
 
@@ -411,7 +411,7 @@ namespace Renci.SshNet.Tests.Classes
 
         [TestMethod]
         [TestCategory("ConnectionInfo")]
-        public void ConstructorShouldThrowArgumentExceptionhenUsernameContainsOnlyWhitespace()
+        public void ConstructorShouldThrowArgumentExceptionWhenUsernameContainsOnlyWhitespace()
         {
             const string username = " \t\r";
 

test/Renci.SshNet.Tests/Classes/ForwardedPortDynamicTest_Start_PortStarted.cs

@@ -77,7 +77,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void StartShouldThrowInvalidOperatationException()
+        public void StartShouldThrowInvalidOperationException()
         {
             Assert.IsNotNull(_actualException);
             Assert.AreEqual("Forwarded port is already started.", _actualException.Message);

test/Renci.SshNet.Tests/Classes/ForwardedPortLocalTest_Start_PortStarted.cs

@@ -83,7 +83,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void StartShouldThrowInvalidOperatationException()
+        public void StartShouldThrowInvalidOperationException()
         {
             Assert.IsNotNull(_actualException);
             Assert.AreEqual("Forwarded port is already started.", _actualException.Message);

test/Renci.SshNet.Tests/Classes/ForwardedPortRemoteTest_Start_PortStarted.cs

@@ -103,7 +103,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void StartShouldThrowInvalidOperatationException()
+        public void StartShouldThrowInvalidOperationException()
         {
             Assert.IsNotNull(_actualException);
             Assert.AreEqual("Forwarded port is already started.", _actualException.Message);

test/Renci.SshNet.Tests/Classes/ForwardedPortStatusTest_Stopped.cs

@@ -49,7 +49,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void Equals_ShouldReturTrueWhenOtherIsStopped()
+        public void Equals_ShouldReturnTrueWhenOtherIsStopped()
         {
             var other = ForwardedPortStatus.Stopped;
 

test/Renci.SshNet.Tests/Classes/NetConfClientTest_Connect_NetConfSessionConnectFailure.cs

@@ -84,7 +84,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void ErrorOccuredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnNetConfClient()
+        public void ErrorOccurredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnNetConfClient()
         {
             var errorOccurredSignalCount = 0;
 

test/Renci.SshNet.Tests/Classes/SftpClientTest_Connect_SftpSessionConnectFailure.cs

@@ -93,7 +93,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void ErrorOccuredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnSftpClient()
+        public void ErrorOccurredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnSftpClient()
         {
             var errorOccurredSignalCount = 0;
 

test/Renci.SshNet.Tests/Classes/ShellStreamTest_Write_WriteBufferEmptyAndWriteMoreBytesThanBufferSize.cs

@@ -129,7 +129,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void FlushShouldSendRemaningBytesToServer()
+        public void FlushShouldSendRemainingBytesToServer()
         {
             var expectedBytesSent = _data.Take(_bufferSize * 2, _data.Length - (_bufferSize * 2));
 

test/Renci.SshNet.Tests/Classes/SshCommandTest_Dispose.cs

@@ -83,7 +83,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void RaisingErrorOccuredOnSessionShouldDoNothing()
+        public void RaisingErrorOccurredOnSessionShouldDoNothing()
         {
             _sessionMock.Raise(s => s.ErrorOccured += null, new ExceptionEventArgs(new Exception()));
         }

test/Renci.SshNet.Tests/Classes/SubsystemSession_Connect_SendSubsystemRequestFails.cs

@@ -107,7 +107,7 @@ namespace Renci.SshNet.Tests.Classes
         }
 
         [TestMethod]
-        public void ErrorOccuredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnSubsystemSession()
+        public void ErrorOccurredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnSubsystemSession()
         {
             _sessionMock.Raise(p => p.ErrorOccured += null, new ExceptionEventArgs(new Exception()));