Refactor logging to allow a loggerfactory per session

docfx/logging.md

@@ -1,7 +1,31 @@
 Logging
 =================
 
-SSH.NET uses the [Microsoft.Extensions.Logging](https://learn.microsoft.com/dotnet/core/extensions/logging) API to log diagnostic messages. In order to access the log messages of SSH.NET in your own application for diagnosis, register your own `ILoggerFactory` before using the SSH.NET APIs, for example:
+SSH.NET uses the [Microsoft.Extensions.Logging](https://learn.microsoft.com/dotnet/core/extensions/logging) API to log diagnostic messages. 
+
+It is possible to specify a logger in the `ConnectionInfo`, for example:
+
+```cs
+using Microsoft.Extensions.Logging;
+
+ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
+{
+    builder.SetMinimumLevel(LogLevel.Debug);
+    builder.AddConsole();
+});
+
+var connectionInfo = new ConnectionInfo("sftp.foo.com",
+                                        "guest",
+                                        new PasswordAuthenticationMethod("guest", "pwd"));
+
+connectionInfo.LoggerFactory = loggerFactory;
+using (var client = new SftpClient(connectionInfo))
+{
+    client.Connect();
+}
+```
+
+You can also register an application-wide `ILoggerFactory` before using the SSH.NET APIs, this will be used as a fallback if the `ConnectionInfo` is not set, for example:
 
 ```cs
 using Microsoft.Extensions.Logging;

src/Renci.SshNet/BaseClient.cs

@@ -192,7 +192,7 @@ private protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionI
             _connectionInfo = connectionInfo;
             _ownsConnectionInfo = ownsConnectionInfo;
             _serviceFactory = serviceFactory;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = (connectionInfo.LoggerFactory ?? SshNetLoggingConfiguration.LoggerFactory).CreateLogger(GetType());
             _keepAliveInterval = Timeout.InfiniteTimeSpan;
         }
 

src/Renci.SshNet/Channels/Channel.cs

@@ -84,7 +84,7 @@ protected Channel(ISession session, uint localChannelNumber, uint localWindowSiz
             LocalChannelNumber = localChannelNumber;
             LocalPacketSize = localPacketSize;
             LocalWindowSize = localWindowSize;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = session.SessionLoggerFactory.CreateLogger(GetType());
 
             session.ChannelWindowAdjustReceived += OnChannelWindowAdjust;
             session.ChannelDataReceived += OnChannelData;

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -33,7 +33,7 @@ internal sealed class ChannelDirectTcpip : ClientChannel, IChannelDirectTcpip
         public ChannelDirectTcpip(ISession session, uint localChannelNumber, uint localWindowSize, uint localPacketSize)
             : base(session, localChannelNumber, localWindowSize, localPacketSize)
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ChannelDirectTcpip>();
+            _logger = session.SessionLoggerFactory.CreateLogger<ChannelDirectTcpip>();
         }
 
         /// <summary>

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -48,7 +48,7 @@ internal ChannelForwardedTcpip(ISession session,
                    remoteWindowSize,
                    remotePacketSize)
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ChannelForwardedTcpip>();
+            _logger = session.SessionLoggerFactory.CreateLogger<ChannelForwardedTcpip>();
         }
 
         /// <summary>

src/Renci.SshNet/Connection/ConnectorBase.cs

@@ -16,12 +16,12 @@ internal abstract class ConnectorBase : IConnector
     {
         private readonly ILogger _logger;
 
-        protected ConnectorBase(ISocketFactory socketFactory)
+        protected ConnectorBase(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
         {
             ThrowHelper.ThrowIfNull(socketFactory);
 
             SocketFactory = socketFactory;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
+            _logger = loggerFactory.CreateLogger(GetType());
         }
 
         internal ISocketFactory SocketFactory { get; private set; }

src/Renci.SshNet/Connection/DirectConnector.cs

@@ -2,12 +2,14 @@
 using System.Net.Sockets;
 using System.Threading;
 
+using Microsoft.Extensions.Logging;
+
 namespace Renci.SshNet.Connection
 {
     internal sealed class DirectConnector : ConnectorBase
     {
-        public DirectConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public DirectConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/HttpConnector.cs

@@ -5,6 +5,8 @@
 using System.Net.Sockets;
 using System.Text.RegularExpressions;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -48,8 +50,8 @@ internal sealed partial class HttpConnector : ProxyConnector
         private static readonly Regex HttpHeaderRegex = new Regex(HttpHeaderPattern, RegexOptions.Compiled);
 #endif
 
-        public HttpConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public HttpConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/ProxyConnector.cs

@@ -4,6 +4,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 
+using Microsoft.Extensions.Logging;
+
 namespace Renci.SshNet.Connection
 {
     /// <summary>
@@ -12,8 +14,8 @@ namespace Renci.SshNet.Connection
     /// </summary>
     internal abstract class ProxyConnector : ConnectorBase
     {
-        protected ProxyConnector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        protected ProxyConnector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/Socks4Connector.cs

@@ -4,6 +4,8 @@
 using System.Net.Sockets;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -17,8 +19,8 @@ namespace Renci.SshNet.Connection
     /// </remarks>
     internal sealed class Socks4Connector : ProxyConnector
     {
-        public Socks4Connector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public Socks4Connector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/Connection/Socks5Connector.cs

@@ -5,6 +5,8 @@
 using System.Net.Sockets;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Abstractions;
 using Renci.SshNet.Common;
 
@@ -18,8 +20,8 @@ namespace Renci.SshNet.Connection
     /// </remarks>
     internal sealed class Socks5Connector : ProxyConnector
     {
-        public Socks5Connector(ISocketFactory socketFactory)
-            : base(socketFactory)
+        public Socks5Connector(ISocketFactory socketFactory, ILoggerFactory loggerFactory)
+            : base(socketFactory, loggerFactory)
         {
         }
 

src/Renci.SshNet/ConnectionInfo.cs

@@ -5,6 +5,8 @@
 using System.Security.Cryptography;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 using Renci.SshNet.Compression;
 using Renci.SshNet.Messages.Authentication;
@@ -495,5 +497,13 @@ IList<IAuthenticationMethod> IConnectionInfoInternal.AuthenticationMethods
             get { return AuthenticationMethods.Cast<IAuthenticationMethod>().ToList(); }
 #pragma warning restore S2365 // Properties should not make collection or array copies
         }
+
+        /// <summary>
+        /// Gets or sets logger factory for this connection.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection. If <see langword="null"/> then <see cref="SshNetLoggingConfiguration.LoggerFactory"/> is used.
+        /// </value>
+        public ILoggerFactory LoggerFactory { get; set; }
     }
 }

src/Renci.SshNet/ForwardedPortDynamic.cs

@@ -21,7 +21,6 @@ namespace Renci.SshNet
     /// </summary>
     public class ForwardedPortDynamic : ForwardedPort
     {
-        private readonly ILogger _logger;
         private ForwardedPortStatus _status;
 
         /// <summary>
@@ -75,7 +74,6 @@ public ForwardedPortDynamic(string host, uint port)
             BoundHost = host;
             BoundPort = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortDynamic>();
         }
 
         /// <summary>
@@ -416,7 +414,12 @@ private void InternalStop(TimeSpan timeout)
 
             if (!_pendingChannelCountdown.Wait(timeout))
             {
-                _logger.LogInformation("Timeout waiting for pending channels in dynamic forwarded port to close.");
+                var session = Session;
+                if (session != null)
+                {
+                    var logger = session.SessionLoggerFactory.CreateLogger<ForwardedPortDynamic>();
+                    logger.LogInformation("Timeout waiting for pending channels in dynamic forwarded port to close.");
+                }
             }
         }
 

src/Renci.SshNet/ForwardedPortLocal.cs

@@ -14,7 +14,6 @@ namespace Renci.SshNet
     /// </summary>
     public partial class ForwardedPortLocal : ForwardedPort
     {
-        private readonly ILogger _logger;
         private ForwardedPortStatus _status;
         private bool _isDisposed;
         private Socket _listener;
@@ -103,7 +102,6 @@ public ForwardedPortLocal(string boundHost, uint boundPort, string host, uint po
             Host = host;
             Port = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortLocal>();
         }
 
         /// <summary>
@@ -390,7 +388,12 @@ private void InternalStop(TimeSpan timeout)
 
             if (!_pendingChannelCountdown.Wait(timeout))
             {
-                _logger.LogInformation("Timeout waiting for pending channels in local forwarded port to close.");
+                var session = Session;
+                if (session != null)
+                {
+                    var logger = session.SessionLoggerFactory.CreateLogger<ForwardedPortLocal>();
+                    logger.LogInformation("Timeout waiting for pending channels in local forwarded port to close.");
+                }
             }
         }
 

src/Renci.SshNet/ForwardedPortRemote.cs

@@ -16,7 +16,6 @@ namespace Renci.SshNet
     /// </summary>
     public class ForwardedPortRemote : ForwardedPort
     {
-        private readonly ILogger _logger;
         private ForwardedPortStatus _status;
         private bool _requestStatus;
         private EventWaitHandle _globalRequestResponse = new AutoResetEvent(initialState: false);
@@ -100,7 +99,6 @@ public ForwardedPortRemote(IPAddress boundHostAddress, uint boundPort, IPAddress
             HostAddress = hostAddress;
             Port = port;
             _status = ForwardedPortStatus.Stopped;
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger<ForwardedPortRemote>();
         }
 
         /// <summary>
@@ -212,7 +210,12 @@ protected override void StopPort(TimeSpan timeout)
 
             if (!_pendingChannelCountdown.Wait(timeout))
             {
-                _logger.LogInformation("Timeout waiting for pending channels in remote forwarded port to close.");
+                var session = Session;
+                if (session != null)
+                {
+                    var logger = session.SessionLoggerFactory.CreateLogger<ForwardedPortRemote>();
+                    logger.LogInformation("Timeout waiting for pending channels in remote forwarded port to close.");
+                }
             }
 
             _status = ForwardedPortStatus.Stopped;

src/Renci.SshNet/IConnectionInfo.cs

@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.Text;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 using Renci.SshNet.Messages.Connection;
 
@@ -12,6 +14,14 @@ namespace Renci.SshNet
     /// </summary>
     internal interface IConnectionInfo
     {
+        /// <summary>
+        /// Gets the logger factory for this connection.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection. If <see langword="null"/> then <see cref="SshNetLoggingConfiguration.LoggerFactory"/> is used.
+        /// </value>
+        public ILoggerFactory LoggerFactory { get; }
+
         /// <summary>
         /// Gets the timeout to used when waiting for a server to acknowledge closing a channel.
         /// </summary>

src/Renci.SshNet/ISession.cs

@@ -3,6 +3,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Channels;
 using Renci.SshNet.Common;
 using Renci.SshNet.Messages;
@@ -22,6 +24,14 @@ internal interface ISession : IDisposable
         /// <value>The connection info.</value>
         IConnectionInfo ConnectionInfo { get; }
 
+        /// <summary>
+        /// Gets the logger factory for this session.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this session. Will never return <see langword="null"/>.
+        /// </value>
+        public ILoggerFactory SessionLoggerFactory { get; }
+
         /// <summary>
         /// Gets a value indicating whether the session is connected.
         /// </summary>

src/Renci.SshNet/ISubsystemSession.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Threading;
 
+using Microsoft.Extensions.Logging;
+
 using Renci.SshNet.Common;
 
 namespace Renci.SshNet
@@ -10,6 +12,14 @@ namespace Renci.SshNet
     /// </summary>
     internal interface ISubsystemSession : IDisposable
     {
+        /// <summary>
+        /// Gets the logger factory for this subsystem session.
+        /// </summary>
+        /// <value>
+        /// The logger factory for this connection. Will never return <see langword="null"/>.
+        /// </value>
+        public ILoggerFactory SessionLoggerFactory { get; }
+
         /// <summary>
         /// Gets or sets the number of milliseconds to wait for an operation to complete.
         /// </summary>

src/Renci.SshNet/Security/KeyExchange.cs

@@ -18,7 +18,7 @@ namespace Renci.SshNet.Security
     /// </summary>
     public abstract class KeyExchange : Algorithm, IKeyExchange
     {
-        private readonly ILogger _logger;
+        private ILogger _logger;
         private Func<byte[], KeyHostAlgorithm> _hostKeyAlgorithmFactory;
         private CipherInfo _clientCipherInfo;
         private CipherInfo _serverCipherInfo;
@@ -69,13 +69,13 @@ public byte[] ExchangeHash
         /// </summary>
         protected KeyExchange()
         {
-            _logger = SshNetLoggingConfiguration.LoggerFactory.CreateLogger(GetType());
         }
 
         /// <inheritdoc/>
         public virtual void Start(Session session, KeyExchangeInitMessage message, bool sendClientInitMessage)
         {
             Session = session;
+            _logger = Session.SessionLoggerFactory.CreateLogger(GetType());
 
             if (sendClientInitMessage)
             {