1681 misleading signature of mqttclientconnectasync mqttclientconnectresultcode expected but throws exception (#1749)

Update MqttClient.cs

.github/workflows/ReleaseNotes.md

@@ -1,4 +1,13 @@
 * [Core] Add validation of maximum string lengths (#1718).
+* [Core] Added .NET 4.8 builds (#1729).
+* [Core] Exposed more details of DISCONNECT packet in log (#1729).
+* [Core] Fixed _ArgumentNullException_ in _ConvertPayloadToString_ (#1745, thanks to @ramonsmits).
 * [Client] Added overloads for setting packet payload and will payload (#1720).
-* [Client] The proper connect result is now exposed in the _Disconnected_ event when authentication fails (#1139). 
+* [Client] The proper connect result is now exposed in the _Disconnected_ event when authentication fails (#1139).
+* [Client] Exposed _UseDefaultCredentials_ and more for Web Socket options and proxy options (#1734, thanks to @impworks).
+* [Client] Exposed more TLS options (#1729).
+* [Client] Fixed wrong return code conversion (#1729).
+* [Client] Added an option to avoid throwing an exception when the server returned a proper non success (but valid) response (#1681).
 * [Server] Improved performance by changing internal locking strategy for subscriptions (#1716, thanks to @zeheng).
+* [Server] Fixed exceptions when clients are connecting and disconnecting very fast while accessing the client status for connection validation (#1742).
+* [Server] Exposed more properties in _ClientConnectedEventArgs_ (#1738).

Source/MQTTnet.Extensions.ManagedClient/MQTTnet.Extensions.ManagedClient.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <TargetFrameworks>netstandard1.3;netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
-        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461</TargetFrameworks>
+        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461;net48</TargetFrameworks>
         <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' AND '$(MSBuildRuntimeType)' != 'Core' ">$(TargetFrameworks);uap10.0</TargetFrameworks>
         
         <AssemblyName>MQTTnet.Extensions.ManagedClient</AssemblyName>

Source/MQTTnet.Extensions.Rpc/MQTTnet.Extensions.Rpc.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <TargetFrameworks>netstandard1.3;netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
-        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461</TargetFrameworks>
+        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461;net48</TargetFrameworks>
         <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' AND '$(MSBuildRuntimeType)' != 'Core' ">$(TargetFrameworks);uap10.0</TargetFrameworks>
         
         <AssemblyName>MQTTnet.Extensions.Rpc</AssemblyName>

Source/MQTTnet.Extensions.WebSocket4Net/MQTTnet.Extensions.WebSocket4Net.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <TargetFrameworks>netstandard1.3;netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
-        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461</TargetFrameworks>
+        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461;net48</TargetFrameworks>
         <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' AND '$(MSBuildRuntimeType)' != 'Core' ">$(TargetFrameworks);uap10.0</TargetFrameworks>
         
         <AssemblyName>MQTTnet.Extensions.WebSocket4Net</AssemblyName>

Source/MQTTnet.Tests/Clients/MqttClient/Extended_Authentication_Tests.cs

@@ -1,159 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System;
-using System.Text;
-using System.Threading;
-using System.Threading.Tasks;
-using Microsoft.VisualStudio.TestTools.UnitTesting;
-using MQTTnet.Client;
-using MQTTnet.Formatter;
-using MQTTnet.Internal;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Tests.Clients.MqttClient
-{
-    [TestClass]
-    public sealed class Extended_Authentication_Tests : BaseTestClass
-    {
-        [TestMethod]
-        public async Task ReAuthenticate()
-        {
-            using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500))
-            {
-                var server = await testEnvironment.StartServer();
-                
-                server.ValidatingConnectionAsync += async args =>
-                {
-                    using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(10)))
-                    {
-                        // Just do a simple custom authentication.
-                        await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, cancellationToken: timeout.Token);
-                        var clientResponse = await args.ReceiveAuthenticationDataAsync(timeout.Token);
-                        CollectionAssert.AreEqual(clientResponse.AuthenticationData, Encoding.ASCII.GetBytes("TOKEN"));
-
-                        var userProperties = new MqttUserPropertiesBuilder().With("x", "y").Build();
-                        await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, cancellationToken: timeout.Token, userProperties: userProperties);
-                        
-                        args.ReasonCode = MqttConnectReasonCode.Success;
-                    }
-                };
-
-                server.ClientReAuthenticatingAsync += args =>
-                {
-                    
-                    return CompletedTask.Instance;
-                };
-                
-                var client = testEnvironment.CreateClient();
-                client.ExtendedAuthenticationExchangeAsync += async args =>
-                {
-                    await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, Encoding.ASCII.GetBytes("TOKEN"));
-
-                    var serverResponse = await args.ReceiveAuthenticationDataAsync(CancellationToken.None);
-                    Assert.IsNotNull(serverResponse.UserProperties);
-                    Assert.AreEqual("x", serverResponse.UserProperties[0].Name);
-                    Assert.AreEqual("y", serverResponse.UserProperties[0].Value);
-                };
-
-                var clientOptions = testEnvironment.CreateDefaultClientOptionsBuilder().WithTimeout(TimeSpan.FromSeconds(10)).WithAuthentication("CUSTOM").Build();
-                await client.ConnectAsync(clientOptions);
-
-                await LongTestDelay();
-
-                await client.ReAuthenticateAsync();
-
-                await LongTestDelay();
-
-                var pingResult = await client.TryPingAsync();
-                
-                Assert.IsTrue(pingResult);
-            }
-        }
-        
-        [TestMethod]
-        public async Task Use_Extended_Authentication()
-        {
-            var initialContextToken = Encoding.ASCII.GetBytes("initial context token");
-            var replyContextToken = Encoding.ASCII.GetBytes("reply context token");
-            var outcomeOfAuthentication = Encoding.ASCII.GetBytes("outcome of authentication");
-
-            using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500))
-            {
-                var server = await testEnvironment.StartServer();
-                
-                /*
-                Sample flow from RFC:
-                
-                1. Client to Server CONNECT Authentication Method="GS2-KRB5"
-                2. Server to Client AUTH rc=0x18 Authentication Method="GS2-KRB5"
-                3. Client to Server AUTH rc=0x18 Authentication Method="GS2-KRB5" Authentication Data=initial context token
-                4. Server to Client AUTH rc=0x18 Authentication Method="GS2-KRB5" Authentication Data=reply context token
-                5. Client to Server AUTH rc=0x18 Authentication Method="GS2-KRB5"
-                6. Server to Client CONNACK rc=0 Authentication Method="GS2-KRB5" Authentication Data=outcome of authentication
-                 */
-
-                server.ValidatingConnectionAsync += async args =>
-                {
-                    using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(10)))
-                    {
-                        // 1.
-                        if (args.AuthenticationMethod != "GS2-KRB5")
-                        {
-                            args.ReasonCode = MqttConnectReasonCode.BadAuthenticationMethod;
-                            return;
-                        }
-
-                        // 2.
-                        await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, cancellationToken: timeout.Token);
-
-                        // 3.
-                        var clientResponse = await args.ReceiveAuthenticationDataAsync(timeout.Token);
-                        CollectionAssert.AreEqual(clientResponse.AuthenticationData, initialContextToken);
-                        Assert.AreEqual(MqttAuthenticateReasonCode.ContinueAuthentication, clientResponse.ReasonCode);
-
-                        // 4.
-                        await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, replyContextToken, cancellationToken: timeout.Token);
-
-                        // 5.
-                        clientResponse = await args.ReceiveAuthenticationDataAsync(timeout.Token);
-                        Assert.AreEqual(clientResponse.AuthenticationData, null);
-                        Assert.AreEqual(MqttAuthenticateReasonCode.ContinueAuthentication, clientResponse.ReasonCode);
-
-                        // 6.
-                        args.ResponseAuthenticationData = outcomeOfAuthentication;
-                        args.ReasonCode = MqttConnectReasonCode.Success;
-                    }
-                };
-
-                var client = testEnvironment.CreateClient();
-                client.ExtendedAuthenticationExchangeAsync += async args =>
-                {
-                    if (args.AuthenticationMethod != "GS2-KRB5")
-                    {
-                        Assert.Fail("Authentication method is wrong.");
-                    }
-
-                    // 2. THE FACT THAT THE SERVER SENDS THE AUTH PACKET WILL TRIGGER THIS EVENT SO THE INITIAL DATA IS IN THE EVENT ARGS!
-                    Assert.AreEqual(MqttAuthenticateReasonCode.ContinueAuthentication, args.ReasonCode);
-                    
-                    // 3.
-                    await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication, initialContextToken);
-
-                    // 4.
-                    var serverResponse = await args.ReceiveAuthenticationDataAsync(CancellationToken.None);
-                    CollectionAssert.AreEqual(serverResponse.AuthenticationData, replyContextToken);
-                    Assert.AreEqual(MqttAuthenticateReasonCode.ContinueAuthentication, serverResponse.ReasonCode);
-                    
-                    // 5.
-                    await args.SendAuthenticationDataAsync(MqttAuthenticateReasonCode.ContinueAuthentication);
-                };
-
-                var clientOptions = testEnvironment.CreateDefaultClientOptionsBuilder().WithTimeout(TimeSpan.FromSeconds(10)).WithAuthentication("GS2-KRB5").Build();
-                await client.ConnectAsync(clientOptions);
-            }
-        }
-    }
-}

Source/MQTTnet.Tests/Clients/MqttClient/MqttClient_Connection_Tests.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
@@ -10,6 +11,7 @@ using MQTTnet.Client;
 using MQTTnet.Exceptions;
 using MQTTnet.Formatter;
 using MQTTnet.Internal;
+using MQTTnet.Packets;
 using MQTTnet.Protocol;
 using MQTTnet.Server;
 
@@ -128,7 +130,7 @@ namespace MQTTnet.Tests.Clients.MqttClient
                 await client.DisconnectAsync(disconnectOptions);
 
                 await LongTestDelay();
-                
+
                 Assert.IsNotNull(eventArgs);
                 Assert.AreEqual(MqttDisconnectReasonCode.MessageRateTooHigh, eventArgs.ReasonCode);
             }
@@ -156,7 +158,7 @@ namespace MQTTnet.Tests.Clients.MqttClient
                 await client.DisconnectAsync(disconnectOptions);
 
                 await LongTestDelay();
-                
+
                 Assert.IsNotNull(eventArgs);
                 Assert.IsNotNull(eventArgs.UserProperties);
                 Assert.AreEqual(1, eventArgs.UserProperties.Count);
@@ -164,5 +166,35 @@ namespace MQTTnet.Tests.Clients.MqttClient
                 Assert.AreEqual("test_value", eventArgs.UserProperties[0].Value);
             }
         }
+
+        [TestMethod]
+        public async Task Return_Non_Success()
+        {
+            using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500))
+            {
+                var server = await testEnvironment.StartServer();
+
+                server.ValidatingConnectionAsync += args =>
+                {
+                    args.ResponseUserProperties = new List<MqttUserProperty>
+                    {
+                        new MqttUserProperty("Property", "Value")
+                    };
+
+                    args.ReasonCode = MqttConnectReasonCode.QuotaExceeded;
+
+                    return CompletedTask.Instance;
+                };
+
+                var client = testEnvironment.CreateClient();
+
+                var response = await client.ConnectAsync(testEnvironment.CreateDefaultClientOptionsBuilder().WithoutThrowOnNonSuccessfulConnectResponse().Build());
+
+                Assert.IsNotNull(response);
+                Assert.AreEqual(MqttClientConnectResultCode.QuotaExceeded, response.ResultCode);
+                Assert.AreEqual(response.UserProperties[0].Name, "Property");
+                Assert.AreEqual(response.UserProperties[0].Value, "Value");
+            }
+        }
     }
 }

Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Tests.cs

@@ -78,7 +78,7 @@ namespace MQTTnet.Tests.Formatter
             Assert.IsNull(deserialized.UserProperties); // Not supported in v3.1.1
         }
         
-                [TestMethod]
+        [TestMethod]
         public void Serialize_Full_MqttConnAckPacket_V310()
         {
             var connAckPacket = new MqttConnAckPacket

Source/MQTTnet.Tests/Mockups/TestEnvironment.cs

@@ -277,7 +277,8 @@ namespace MQTTnet.Tests.Mockups
                     // Null is used when the client id is assigned from the server!
                     if (!string.IsNullOrEmpty(e.ClientId) && !e.ClientId.StartsWith(TestContext.TestName))
                     {
-                        Assert.Fail($"Client ID does not start with test name ({TestContext.TestName}).");
+                        TrackException(new InvalidOperationException($"Invalid client ID used ({e.ClientId}). It must start with UnitTest name."));
+                        e.ReasonCode = MqttConnectReasonCode.ClientIdentifierNotValid;
                     }
                 }
 
@@ -291,12 +292,23 @@ namespace MQTTnet.Tests.Mockups
         {
             foreach (var mqttClient in _clients)
             {
-                mqttClient?.Dispose();
+                try
+                {
+                    //mqttClient.DisconnectAsync().GetAwaiter().GetResult();
+                }
+                catch
+                {
+                    // This can happen when the test already disconnected the client.
+                }
+                finally
+                {
+                    mqttClient?.Dispose();
+                }
             }
 
             foreach (var lowLevelMqttClient in _lowLevelClients)
             {
-                lowLevelMqttClient?.Dispose();
+                lowLevelMqttClient.Dispose();
             }
 
             try

Source/MQTTnet/Client/Authentication/MqttClientPartialAuthenticationResponse.cs

@@ -1,19 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System.Collections.Generic;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Client
-{
-    public sealed class MqttClientPartialAuthenticationResponse
-    {
-        public byte[] AuthenticationData { get; set; }
-
-        public MqttAuthenticateReasonCode ReasonCode { get; set; }
-
-        public List<MqttUserProperty> UserProperties { get; set; }
-    }
-}

Source/MQTTnet/Client/Authentication/MqttExtendedAuthenticationExchangeEventArgs.cs

@@ -1,111 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System;
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
-using MQTTnet.Client.Internal;
-using MQTTnet.Exceptions;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Client
-{
-    public sealed class MqttExtendedAuthenticationExchangeEventArgs : EventArgs
-    {
-        static readonly IReadOnlyCollection<MqttUserProperty> EmptyUserProperties = new List<MqttUserProperty>();
-
-        readonly IMqttAuthenticationTransportStrategy _transportStrategy;
-
-        public MqttExtendedAuthenticationExchangeEventArgs(MqttAuthPacket authPacket, IMqttAuthenticationTransportStrategy transportStrategy)
-        {
-            if (authPacket == null)
-            {
-                throw new ArgumentNullException(nameof(authPacket));
-            }
-
-            _transportStrategy = transportStrategy ?? throw new ArgumentNullException(nameof(transportStrategy));
-
-            ReasonCode = authPacket.ReasonCode;
-            ReasonString = authPacket.ReasonString;
-            AuthenticationMethod = authPacket.AuthenticationMethod;
-            AuthenticationData = authPacket.AuthenticationData;
-            UserProperties = authPacket.UserProperties ?? EmptyUserProperties;
-        }
-
-        /// <summary>
-        ///     Gets the authentication data.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public byte[] AuthenticationData { get; }
-
-        /// <summary>
-        ///     Gets the authentication method.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string AuthenticationMethod { get; }
-
-        /// <summary>
-        ///     Gets the reason code.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public MqttAuthenticateReasonCode ReasonCode { get; }
-
-        /// <summary>
-        ///     Gets the reason string.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string ReasonString { get; }
-
-        // /// <summary>
-        // ///     Gets the response which will be sent to the server.
-        // /// </summary>
-        // public MqttExtendedAuthenticationExchangeResponse Response { get; } = new MqttExtendedAuthenticationExchangeResponse();
-
-        /// <summary>
-        ///     Gets or sets the user properties.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public IReadOnlyCollection<MqttUserProperty> UserProperties { get; }
-
-        public async Task<MqttClientPartialAuthenticationResponse> ReceiveAuthenticationDataAsync(CancellationToken cancellationToken)
-        {
-            var receivePacket = await _transportStrategy.ReceivePacketAsync(AuthenticationMethod, cancellationToken).ConfigureAwait(false);
-            if (receivePacket == null)
-            {
-                throw new MqttCommunicationException("The client closed the connection.");
-            }
-
-            return new MqttClientPartialAuthenticationResponse
-            {
-                ReasonCode = receivePacket.ReasonCode,
-                AuthenticationData = receivePacket.AuthenticationData,
-                UserProperties = receivePacket.UserProperties
-            };
-        }
-
-        public Task SendAuthenticationDataAsync(
-            MqttAuthenticateReasonCode reasonCode,
-            byte[] authenticationData = null,
-            string reasonString = null,
-            List<MqttUserProperty> userProperties = null,
-            CancellationToken cancellationToken = default)
-        {
-            // The authentication method will never change so we must use the already known one [MQTT-4.12.0-5].
-            //var authPacket = MqttPacketFactories.Auth.Create(AuthenticationMethod, reasonCode);
-
-            var authPacket = new MqttAuthPacket
-            {
-                AuthenticationMethod = AuthenticationMethod,
-                AuthenticationData = authenticationData,
-                UserProperties = userProperties,
-                ReasonCode = reasonCode,
-                ReasonString = reasonString
-            };
-
-            return _transportStrategy.SendPacketAsync(authPacket, cancellationToken);
-        }
-    }
-}

Source/MQTTnet/Client/Authentication/MqttReAuthenticationOptions.cs

@@ -1,28 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System.Collections.Generic;
-using MQTTnet.Packets;
-
-namespace MQTTnet.Client
-{
-    public sealed class MqttReAuthenticationOptions
-    {
-        /// <summary>
-        ///     Gets or sets the authentication data.
-        ///     Authentication data is binary information used to transmit multiple iterations of cryptographic secrets of protocol
-        ///     steps.
-        ///     The content of the authentication data is highly dependent on the specific implementation of the authentication
-        ///     method.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public byte[] AuthenticationData { get; set; }
-
-        /// <summary>
-        ///     Gets or sets the user properties.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public List<MqttUserProperty> UserProperties { get; set; }
-    }
-}

Source/MQTTnet/Client/Connecting/MqttClientConnectResult.cs

@@ -11,112 +11,110 @@ namespace MQTTnet.Client
     public sealed class MqttClientConnectResult
     {
         /// <summary>
-        ///     Gets the client identifier which was chosen by the server.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string AssignedClientIdentifier { get; internal set; }
-
-        /// <summary>
-        ///     Gets the authentication data.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public byte[] AuthenticationData { get; internal set; }
-
-        /// <summary>
-        ///     Gets the authentication method.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string AuthenticationMethod { get; internal set; }
-
-        /// <summary>
-        ///     Gets a value indicating whether a session was already available or not.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public bool IsSessionPresent { get; internal set; }
-
-        public uint? MaximumPacketSize { get; internal set; }
-
-        /// <summary>
-        ///     Gets the maximum QoS which is supported by the server.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public MqttQualityOfServiceLevel MaximumQoS { get; internal set; }
-
-        /// <summary>
-        ///     Gets the reason string.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string ReasonString { get; internal set; }
-
-        public ushort? ReceiveMaximum { get; internal set; }
-
-        /// <summary>
-        ///     Gets the response information.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
-        /// </summary>
-        public string ResponseInformation { get; internal set; }
-
-        /// <summary>
-        ///     Gets the result code.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets the result code.
+        /// MQTTv5 only.
         /// </summary>
         public MqttClientConnectResultCode ResultCode { get; internal set; }
 
         /// <summary>
-        ///     Gets whether the server supports retained messages.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets a value indicating whether a session was already available or not.
+        /// MQTTv5 only.
+        /// </summary>
+        public bool IsSessionPresent { get; internal set; }
+
+        /// <summary>
+        /// Gets a value indicating whether wildcards can be used in subscriptions at the current server.
+        /// MQTTv5 only.
+        /// </summary>
+        public bool WildcardSubscriptionAvailable { get; internal set; }
+
+        /// <summary>
+        /// Gets whether the server supports retained messages.
+        /// MQTTv5 only.
         /// </summary>
         public bool RetainAvailable { get; internal set; }
 
         /// <summary>
-        ///     MQTTv5 only.
-        ///     Gets the keep alive interval which was chosen by the server instead of the
-        ///     keep alive interval from the client CONNECT packet.
-        ///     A value of 0 indicates that the feature is not used.
+        /// Gets the client identifier which was chosen by the server.
+        /// MQTTv5 only.
         /// </summary>
-        public ushort ServerKeepAlive { get; internal set; }
+        public string AssignedClientIdentifier { get; internal set; }
 
         /// <summary>
-        ///     Gets an alternate server which should be used instead of the current one.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets the authentication method.
+        /// MQTTv5 only.
         /// </summary>
-        public string ServerReference { get; internal set; }
-
-        public uint? SessionExpiryInterval { get; internal set; }
+        public string AuthenticationMethod { get; internal set; }
 
         /// <summary>
-        ///     Gets a value indicating whether the shared subscriptions are available or not.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets the authentication data.
+        /// MQTTv5 only.
         /// </summary>
-        public bool SharedSubscriptionAvailable { get; internal set; }
+        public byte[] AuthenticationData { get; internal set; }
+
+        public uint? MaximumPacketSize { get; internal set; }
 
         /// <summary>
-        ///     Gets a value indicating whether the subscription identifiers are available or not.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets the reason string.
+        /// MQTTv5 only.
         /// </summary>
-        public bool SubscriptionIdentifiersAvailable { get; internal set; }
+        public string ReasonString { get; internal set; }
+
+        public ushort? ReceiveMaximum { get; internal set; }
+        
+        /// <summary>
+        /// Gets the maximum QoS which is supported by the server.
+        /// MQTTv5 only.
+        /// </summary>
+        public MqttQualityOfServiceLevel MaximumQoS { get; internal set; }
 
         /// <summary>
-        ///     Gets the maximum value for a topic alias. 0 means not supported.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets the response information.
+        /// MQTTv5 only.
+        /// </summary>
+        public string ResponseInformation { get; internal set; }
+
+        /// <summary>
+        /// Gets the maximum value for a topic alias. 0 means not supported.
+        /// MQTTv5 only.
         /// </summary>
         public ushort TopicAliasMaximum { get; internal set; }
 
         /// <summary>
-        ///     Gets the user properties.
-        ///     In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT
-        ///     packet.
-        ///     As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add
-        ///     metadata to MQTT messages and pass information between publisher, broker, and subscriber.
-        ///     The feature is very similar to the HTTP header concept.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// Gets an alternate server which should be used instead of the current one.
+        /// MQTTv5 only.
         /// </summary>
-        public List<MqttUserProperty> UserProperties { get; internal set; }
+        public string ServerReference { get; internal set; }
 
         /// <summary>
-        ///     Gets a value indicating whether wildcards can be used in subscriptions at the current server.
-        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// MQTTv5 only.
+        /// Gets the keep alive interval which was chosen by the server instead of the
+        /// keep alive interval from the client CONNECT packet.
+        /// A value of 0 indicates that the feature is not used.
         /// </summary>
-        public bool WildcardSubscriptionAvailable { get; internal set; }
+        public ushort ServerKeepAlive { get; internal set; }
+
+        public uint? SessionExpiryInterval { get; internal set; }
+
+        /// <summary>
+        /// Gets a value indicating whether the subscription identifiers are available or not.
+        /// MQTTv5 only.
+        /// </summary>
+        public bool SubscriptionIdentifiersAvailable { get; internal set; }
+
+        /// <summary>
+        /// Gets a value indicating whether the shared subscriptions are available or not.
+        /// MQTTv5 only.
+        /// </summary>
+        public bool SharedSubscriptionAvailable { get; internal set; }
+
+        /// <summary>
+        /// Gets the user properties.
+        /// In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet.
+        /// As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber.
+        /// The feature is very similar to the HTTP header concept.
+        /// MQTTv5 only.
+        /// </summary>
+        public List<MqttUserProperty> UserProperties { get; internal set; }
     }
-}
+}

Source/MQTTnet/Client/ExtendedAuthenticationExchange/IMqttExtendedAuthenticationExchangeHandler.cs

@@ -0,0 +1,13 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Threading.Tasks;
+
+namespace MQTTnet.Client
+{
+    public interface IMqttExtendedAuthenticationExchangeHandler
+    {
+        Task HandleRequestAsync(MqttExtendedAuthenticationExchangeContext context);
+    }
+}

Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeContext.cs

@@ -0,0 +1,62 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using MQTTnet.Packets;
+using MQTTnet.Protocol;
+
+namespace MQTTnet.Client
+{
+    public class MqttExtendedAuthenticationExchangeContext
+    {
+        public MqttExtendedAuthenticationExchangeContext(MqttAuthPacket authPacket, MqttClient client)
+        {
+            if (authPacket == null) throw new ArgumentNullException(nameof(authPacket));
+
+            ReasonCode = authPacket.ReasonCode;
+            ReasonString = authPacket.ReasonString;
+            AuthenticationMethod = authPacket.AuthenticationMethod;
+            AuthenticationData = authPacket.AuthenticationData;
+            UserProperties = authPacket.UserProperties;
+
+            Client = client ?? throw new ArgumentNullException(nameof(client));
+        }
+
+        /// <summary>
+        /// Gets the reason code.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public MqttAuthenticateReasonCode ReasonCode { get; }
+
+        /// <summary>
+        /// Gets the reason string.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public string ReasonString { get; }
+
+        /// <summary>
+        /// Gets the authentication method.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public string AuthenticationMethod { get; }
+
+        /// <summary>
+        /// Gets the authentication data.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public byte[] AuthenticationData { get; }
+
+        /// <summary>
+        /// Gets the user properties.
+        /// In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet.
+        /// As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber.
+        /// The feature is very similar to the HTTP header concept.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public List<MqttUserProperty> UserProperties { get; }
+
+        public MqttClient Client { get; }
+    }
+}

Source/MQTTnet/Client/ExtendedAuthenticationExchange/MqttExtendedAuthenticationExchangeData.cs

@@ -0,0 +1,42 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Collections.Generic;
+using MQTTnet.Packets;
+using MQTTnet.Protocol;
+
+namespace MQTTnet.Client
+{
+    public class MqttExtendedAuthenticationExchangeData
+    {
+        /// <summary>
+        /// Gets or sets the reason code.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public MqttAuthenticateReasonCode ReasonCode { get; set; }
+
+        /// <summary>
+        /// Gets or sets the reason string.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public string ReasonString { get; set; }
+
+        /// <summary>
+        /// Gets or sets the authentication data.
+        /// Authentication data is binary information used to transmit multiple iterations of cryptographic secrets of protocol steps.
+        /// The content of the authentication data is highly dependent on the specific implementation of the authentication method.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public byte[] AuthenticationData { get; set; }
+
+        /// <summary>
+        /// Gets or sets the user properties.
+        /// In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet.
+        /// As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber.
+        /// The feature is very similar to the HTTP header concept.
+        /// Hint: MQTT 5 feature only.
+        /// </summary>
+        public List<MqttUserProperty> UserProperties { get; }
+    }
+}

Source/MQTTnet/Client/IMqttClient.cs

@@ -8,15 +8,13 @@ namespace MQTTnet.Client
     public interface IMqttClient : IDisposable
     {
         event Func<MqttApplicationMessageReceivedEventArgs, Task> ApplicationMessageReceivedAsync;
-
+        
         event Func<MqttClientConnectedEventArgs, Task> ConnectedAsync;
 
         event Func<MqttClientConnectingEventArgs, Task> ConnectingAsync;
 
         event Func<MqttClientDisconnectedEventArgs, Task> DisconnectedAsync;
 
-        event Func<MqttExtendedAuthenticationExchangeEventArgs, Task> ExtendedAuthenticationExchangeAsync;
-
         event Func<InspectMqttPacketEventArgs, Task> InspectPacketAsync;
 
         bool IsConnected { get; }
@@ -31,7 +29,7 @@ namespace MQTTnet.Client
 
         Task<MqttClientPublishResult> PublishAsync(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken = default);
 
-        Task ReAuthenticateAsync(MqttReAuthenticationOptions options, CancellationToken cancellationToken = default);
+        Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken = default);
 
         Task<MqttClientSubscribeResult> SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken = default);
 

Source/MQTTnet/Client/Internal/MqttClientAuthenticationHandler.cs

@@ -1,225 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System;
-using System.Threading;
-using System.Threading.Tasks;
-using MQTTnet.Adapter;
-using MQTTnet.Diagnostics;
-using MQTTnet.Exceptions;
-using MQTTnet.Formatter;
-using MQTTnet.Internal;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Client.Internal
-{
-    public sealed class MqttInitialAuthenticationStrategy : IMqttAuthenticationTransportStrategy
-    {
-        readonly IMqttChannelAdapter _channelAdapter;
-
-        public MqttInitialAuthenticationStrategy(IMqttChannelAdapter channelAdapter)
-        {
-            _channelAdapter = channelAdapter ?? throw new ArgumentNullException(nameof(channelAdapter));
-        }
-
-
-        public Task SendPacketAsync(MqttAuthPacket authPacket, CancellationToken cancellationToken)
-        {
-            if (authPacket == null)
-            {
-                throw new ArgumentNullException(nameof(authPacket));
-            }
-
-            return _channelAdapter.SendPacketAsync(authPacket, cancellationToken);
-        }
-
-        public async Task<MqttAuthPacket> ReceivePacketAsync(string authenticationMethod, CancellationToken cancellationToken)
-        {
-            if (authenticationMethod == null)
-            {
-                throw new ArgumentNullException(nameof(authenticationMethod));
-            }
-
-            var receivePacket = await _channelAdapter.ReceivePacketAsync(cancellationToken).ConfigureAwait(false);
-            if (receivePacket is MqttAuthPacket authPacket)
-            {
-                if (!string.Equals(authPacket.AuthenticationMethod, authenticationMethod, StringComparison.Ordinal))
-                {
-                    throw new MqttProtocolViolationException("The authentication method is not allowed to change while authenticating.");
-                }
-
-                return authPacket;
-            }
-
-            if (receivePacket == null)
-            {
-                throw new MqttCommunicationException("The server closed the connection.");
-            }
-
-            throw new MqttProtocolViolationException("Expected an AUTH packet from the client.");
-        }
-    }
-    
-    public interface IMqttAuthenticationTransportStrategy
-    {
-        Task SendPacketAsync(MqttAuthPacket authPacket, CancellationToken cancellationToken);
-        
-        Task<MqttAuthPacket> ReceivePacketAsync(string authenticationMethod, CancellationToken cancellationToken);
-    }
-    
-    public sealed class MqttClientAuthenticationHandler
-    {
-        readonly MqttClient _client;
-
-        readonly AsyncEvent<MqttExtendedAuthenticationExchangeEventArgs> _extendedAuthenticationExchangeEvent = new AsyncEvent<MqttExtendedAuthenticationExchangeEventArgs>();
-        readonly MqttNetSourceLogger _logger;
-
-        public MqttClientAuthenticationHandler(MqttClient client, IMqttNetLogger logger)
-        {
-            if (logger == null)
-            {
-                throw new ArgumentNullException(nameof(logger));
-            }
-
-            _client = client ?? throw new ArgumentNullException(nameof(client));
-            _logger = logger.WithSource(nameof(MqttClientAuthenticationHandler));
-        }
-
-        public void AddHandler(Func<MqttExtendedAuthenticationExchangeEventArgs, Task> handler)
-        {
-            _extendedAuthenticationExchangeEvent.AddHandler(handler);
-        }
-
-        public async Task<MqttClientConnectResult> Authenticate(IMqttChannelAdapter channelAdapter, MqttClientOptions options, CancellationToken cancellationToken)
-        {
-            if (channelAdapter == null)
-            {
-                throw new ArgumentNullException(nameof(channelAdapter));
-            }
-
-            if (options == null)
-            {
-                throw new ArgumentNullException(nameof(options));
-            }
-
-            // From the RFC:
-            // The CONNACK packet is the packet sent by the Server in response to a CONNECT packet received from a Client.
-            // The Server MUST send a CONNACK with a 0x00 (Success) Reason Code before sending any Packet other than AUTH [MQTT-3.2.0-1].
-            // The Server MUST NOT send more than one CONNACK in a Network Connection [MQTT-3.2.0-2].
-
-            MqttClientConnectResult result;
-
-            try
-            {
-                // Send the CONNECT packet..
-                var connectPacket = MqttPacketFactories.Connect.Create(options);
-                await _client.Send(connectPacket, cancellationToken).ConfigureAwait(false);
-
-                // Wait for the CONNACK packet...
-                MqttConnAckPacket connAckPacket = null;
-                while (!cancellationToken.IsCancellationRequested)
-                {
-                    var receivedPacket = await channelAdapter.ReceivePacketAsync(cancellationToken).ConfigureAwait(false);
-
-                    if (receivedPacket is MqttAuthPacket initialAuthPacket)
-                    {
-                        // MQTT v3.1.1 cannot send an AUTH packet.
-                        // If the Server requires additional information to complete the authentication, it can send an AUTH packet to the Client.
-                        // This packet MUST contain a Reason Code of 0x18 (Continue authentication)
-                        if (initialAuthPacket.ReasonCode != MqttAuthenticateReasonCode.ContinueAuthentication)
-                        {
-                            throw new MqttProtocolViolationException("Wrong reason code received [MQTT-4.12.0-2].");
-                        }
-
-                        //var response = await HandleExtendedAuthentication(authPacket, channelAdapter).ConfigureAwait(false);
-                        await HandleExtendedAuthentication(initialAuthPacket, new MqttInitialAuthenticationStrategy(channelAdapter)).ConfigureAwait(false);
-                    }
-                    else if (receivedPacket is MqttConnAckPacket connAckPacketBuffer)
-                    {
-                        connAckPacket = connAckPacketBuffer;
-                        
-                        // The CONNACK packet is the last packet when authenticating so there is no further AUTH packet allowed!
-                        break;
-                    }
-                    else
-                    {
-                        throw new MqttProtocolViolationException($"Received {receivedPacket.GetRfcName()} while authenticating.");
-                    }
-                }
-
-                cancellationToken.ThrowIfCancellationRequested();
-
-                // If the initial CONNECT packet included an Authentication Method property then all AUTH packets,
-                // and any successful CONNACK packet MUST include an Authentication Method Property with the same
-                // value as in the CONNECT packet [MQTT-4.12.0-5].
-                if (!string.IsNullOrEmpty(connectPacket.AuthenticationMethod))
-                {
-                    if (!string.Equals(connectPacket.AuthenticationMethod, connAckPacket?.AuthenticationMethod))
-                    {
-                        throw new MqttProtocolViolationException("The CONNACK packet does not have the same authentication method as the CONNECT packet.");
-                    }
-                }
-
-                result = MqttClientResultFactory.ConnectResult.Create(connAckPacket, channelAdapter.PacketFormatterAdapter.ProtocolVersion);
-            }
-            catch (Exception exception)
-            {
-                throw new MqttConnectingFailedException($"Error while authenticating. {exception.Message}", exception, null);
-            }
-
-            // This is no feature. It is basically a backward compatibility option and should be removed in the future.
-            // The client should not throw any exception if the transport layer connection was successful and the server
-            // did send a proper ACK packet.
-            if (options.ThrowOnNonSuccessfulResponseFromServer)
-            {
-                _logger.Warning(
-                    "Client will now throw an _MqttConnectingFailedException_. This is obsolete and will be removed in the future. Consider setting _ThrowOnNonSuccessfulResponseFromServer=False_ in client options.");
-
-                if (result.ResultCode != MqttClientConnectResultCode.Success)
-                {
-                    throw new MqttConnectingFailedException($"Connecting with MQTT server failed ({result.ResultCode}).", null, result);
-                }
-            }
-
-            _logger.Verbose("Authenticated MQTT connection with server established.");
-
-            return result;
-        }
-
-        public Task HandleExtendedAuthentication(MqttAuthPacket initialAuthPacket, IMqttAuthenticationTransportStrategy transportStrategy)
-        {
-            ValidateEventHandler();
-
-            var eventArgs = new MqttExtendedAuthenticationExchangeEventArgs(initialAuthPacket, transportStrategy);
-            return _extendedAuthenticationExchangeEvent.InvokeAsync(eventArgs);
-        }
-
-        void ValidateEventHandler()
-        {
-            if (!_extendedAuthenticationExchangeEvent.HasHandlers)
-            {
-                throw new InvalidOperationException("Cannot handle extended authentication without attached event handler.");
-            }
-        }
-        
-        public void RemoveHandler(Func<MqttExtendedAuthenticationExchangeEventArgs, Task> handler)
-        {
-            _extendedAuthenticationExchangeEvent.RemoveHandler(handler);
-        }
-
-        public async Task ReAuthenticate(MqttReAuthenticationOptions options, CancellationToken cancellationToken)
-        {
-            ValidateEventHandler();
-            
-            var authPacket = MqttPacketFactories.Auth.CreateReAuthenticationPacket(_client.Options, options);
-
-            
-            
-            // Sending the AUTH packet will trigger the re authentication and the event handler will
-            // handle the details.
-            await _client.Send(authPacket, cancellationToken).ConfigureAwait(false);
-        }
-    }
-}

Source/MQTTnet/Client/Internal/MqttClientKeepAliveHandler.cs

@@ -1,126 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System;
-using System.Threading;
-using System.Threading.Tasks;
-using MQTTnet.Diagnostics;
-using MQTTnet.Exceptions;
-
-namespace MQTTnet.Client.Internal
-{
-    public sealed class MqttClientKeepAliveHandler
-    {
-        readonly MqttClient _client;
-        readonly MqttNetSourceLogger _logger;
-
-        CancellationTokenSource _cancellationToken;
-        TimeSpan _keepAliveInterval;
-        Task _keepAlivePacketsSenderTask;
-        DateTime _lastPacketSentTimestamp;
-
-        public MqttClientKeepAliveHandler(MqttClient client, IMqttNetLogger logger)
-        {
-            _client = client ?? throw new ArgumentNullException(nameof(client));
-            _logger = logger.WithSource(nameof(MqttClientKeepAliveHandler));
-        }
-
-        public void Disable()
-        {
-            try
-            {
-                _cancellationToken?.Cancel(false);
-            }
-            finally
-            {
-                _cancellationToken?.Dispose();
-                _cancellationToken = null;
-            }
-        }
-
-        public void Enable(MqttClientConnectResult connectResult)
-        {
-            if (connectResult == null)
-            {
-                throw new ArgumentNullException(nameof(connectResult));
-            }
-
-            _keepAliveInterval = _client.Options.KeepAlivePeriod;
-
-            if (connectResult.ServerKeepAlive > 0)
-            {
-                _logger.Info("Using keep alive value {0} sent from the server", connectResult.ServerKeepAlive);
-                _keepAliveInterval = TimeSpan.FromSeconds(connectResult.ServerKeepAlive);
-            }
-
-            if (_keepAliveInterval == TimeSpan.Zero)
-            {
-                return;
-            }
-
-            _cancellationToken = new CancellationTokenSource();
-            _keepAlivePacketsSenderTask = Task.Run(() => SendKeepAliveMessagesLoop(_cancellationToken.Token), _cancellationToken.Token);
-        }
-
-        public void TrackSentPacket()
-        {
-            // Only use UTC to avoid performance hit by loading current time zone all the time.
-            _lastPacketSentTimestamp = DateTime.UtcNow;
-        }
-
-        async Task SendKeepAliveMessagesLoop(CancellationToken cancellationToken)
-        {
-            try
-            {
-                _logger.Verbose("Start sending keep alive packets.");
-
-                while (!cancellationToken.IsCancellationRequested)
-                {
-                    // Values described here: [MQTT-3.1.2-24].
-                    var timeWithoutPacketSent = DateTime.UtcNow - _lastPacketSentTimestamp;
-
-                    if (timeWithoutPacketSent > _keepAliveInterval)
-                    {
-                        using (var timeout = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken))
-                        {
-                            timeout.CancelAfter(_client.Options.Timeout);
-                            await _client.PingAsync(timeout.Token).ConfigureAwait(false);
-                        }
-                    }
-
-                    // Wait a fixed time in all cases. Calculation of the remaining time is complicated
-                    // due to some edge cases and was buggy in the past. Now we wait several ms because the
-                    // min keep alive value is one second so that the server will wait 1.5 seconds for a PING packet.
-                    await Task.Delay(250, cancellationToken).ConfigureAwait(false);
-                }
-            }
-            catch (Exception exception)
-            {
-                if (_client._cleanDisconnectInitiated)
-                {
-                    return;
-                }
-
-                if (exception is OperationCanceledException)
-                {
-                    return;
-                }
-                else if (exception is MqttCommunicationException)
-                {
-                    _logger.Warning(exception, "Communication error while sending/receiving keep alive packets");
-                }
-                else
-                {
-                    _logger.Error(exception, "Error exception while sending/receiving keep alive packets");
-                }
-
-                await _client.DisconnectInternalAsync(_keepAlivePacketsSenderTask, exception, null).ConfigureAwait(false);
-            }
-            finally
-            {
-                _logger.Verbose("Stopped sending keep alive packets");
-            }
-        }
-    }
-}

Source/MQTTnet/Client/MqttClient.cs

@@ -21,19 +21,17 @@ namespace MQTTnet.Client
     public sealed class MqttClient : Disposable, IMqttClient
     {
         readonly IMqttClientAdapterFactory _adapterFactory;
-        readonly MqttClientAuthenticationHandler _authenticationHandler;
+
         readonly object _disconnectLock = new object();
         readonly MqttClientEvents _events = new MqttClientEvents();
-        readonly MqttClientKeepAliveHandler _keepAliveHandler;
         readonly MqttNetSourceLogger _logger;
+
         readonly MqttPacketIdentifierProvider _packetIdentifierProvider = new MqttPacketIdentifierProvider();
         readonly IMqttNetLogger _rootLogger;
 
-        IMqttChannelAdapter _channelAdapter;
+        IMqttChannelAdapter _adapter;
 
-        internal bool _cleanDisconnectInitiated;
-
-        CancellationTokenSource _clientAlive;
+        bool _cleanDisconnectInitiated;
         volatile int _connectionStatus;
 
         // The value for this field can be set from two different enums.
@@ -41,6 +39,11 @@ namespace MQTTnet.Client
         int _disconnectReason;
         string _disconnectReasonString;
         List<MqttUserProperty> _disconnectUserProperties;
+
+        Task _keepAlivePacketsSenderTask;
+        DateTime _lastPacketSentTimestamp;
+
+        CancellationTokenSource _mqttClientAlive;
         MqttPacketDispatcher _packetDispatcher;
         Task _packetReceiverTask;
         AsyncQueue<MqttPublishPacket> _publishPacketReceiverQueue;
@@ -51,9 +54,6 @@ namespace MQTTnet.Client
             _adapterFactory = channelFactory ?? throw new ArgumentNullException(nameof(channelFactory));
             _rootLogger = logger ?? throw new ArgumentNullException(nameof(logger));
             _logger = logger.WithSource(nameof(MqttClient));
-
-            _authenticationHandler = new MqttClientAuthenticationHandler(this, logger);
-            _keepAliveHandler = new MqttClientKeepAliveHandler(this, logger);
         }
 
         public event Func<MqttApplicationMessageReceivedEventArgs, Task> ApplicationMessageReceivedAsync
@@ -80,12 +80,6 @@ namespace MQTTnet.Client
             remove => _events.DisconnectedEvent.RemoveHandler(value);
         }
 
-        public event Func<MqttExtendedAuthenticationExchangeEventArgs, Task> ExtendedAuthenticationExchangeAsync
-        {
-            add => _authenticationHandler.AddHandler(value);
-            remove => _authenticationHandler.RemoveHandler(value);
-        }
-
         public event Func<InspectMqttPacketEventArgs, Task> InspectPacketAsync
         {
             add => _events.InspectPacketEvent.AddHandler(value);
@@ -122,14 +116,16 @@ namespace MQTTnet.Client
 
                 _packetIdentifierProvider.Reset();
                 _packetDispatcher = new MqttPacketDispatcher();
-                _clientAlive = new CancellationTokenSource();
+
+                _mqttClientAlive = new CancellationTokenSource();
+                var mqttClientAliveToken = _mqttClientAlive.Token;
 
                 var adapter = _adapterFactory.CreateClientAdapter(options, new MqttPacketInspector(_events.InspectPacketEvent, _rootLogger), _rootLogger);
-                _channelAdapter = adapter;
+                _adapter = adapter ?? throw new InvalidOperationException("The adapter factory did not provide an adapter.");
 
                 if (cancellationToken.CanBeCanceled)
                 {
-                    connectResult = await ConnectInternal(cancellationToken).ConfigureAwait(false);
+                    connectResult = await ConnectInternal(adapter, cancellationToken).ConfigureAwait(false);
                 }
                 else
                 {
@@ -137,10 +133,30 @@ namespace MQTTnet.Client
                     // CancellationToken.None or similar.
                     using (var timeout = new CancellationTokenSource(Options.Timeout))
                     {
-                        connectResult = await ConnectInternal(timeout.Token).ConfigureAwait(false);
+                        connectResult = await ConnectInternal(adapter, timeout.Token).ConfigureAwait(false);
                     }
                 }
 
+                if (connectResult.ResultCode != MqttClientConnectResultCode.Success)
+                {
+                    _logger.Warning("Connecting failed: {0}", connectResult.ResultCode);
+                    return connectResult;
+                }
+
+                _lastPacketSentTimestamp = DateTime.UtcNow;
+
+                var keepAliveInterval = Options.KeepAlivePeriod;
+                if (connectResult.ServerKeepAlive > 0)
+                {
+                    _logger.Info($"Using keep alive value ({connectResult.ServerKeepAlive}) sent from the server");
+                    keepAliveInterval = TimeSpan.FromSeconds(connectResult.ServerKeepAlive);
+                }
+
+                if (keepAliveInterval != TimeSpan.Zero)
+                {
+                    _keepAlivePacketsSenderTask = Task.Run(() => TrySendKeepAliveMessages(mqttClientAliveToken), mqttClientAliveToken);
+                }
+
                 CompareExchangeConnectionStatus(MqttClientConnectionStatus.Connected, MqttClientConnectionStatus.Connecting);
 
                 _logger.Info("Connected");
@@ -194,7 +210,7 @@ namespace MQTTnet.Client
 
                 if (Options.ValidateFeatures)
                 {
-                    MqttClientDisconnectOptionsValidator.ThrowIfNotSupported(options, _channelAdapter.PacketFormatterAdapter.ProtocolVersion);
+                    MqttClientDisconnectOptionsValidator.ThrowIfNotSupported(options, _adapter.PacketFormatterAdapter.ProtocolVersion);
                 }
 
                 // Sending the DISCONNECT may fail due to connection issues. The resulting exception
@@ -245,7 +261,7 @@ namespace MQTTnet.Client
 
             if (Options.ValidateFeatures)
             {
-                MqttApplicationMessageValidator.ThrowIfNotSupported(applicationMessage, _channelAdapter.PacketFormatterAdapter.ProtocolVersion);
+                MqttApplicationMessageValidator.ThrowIfNotSupported(applicationMessage, _adapter.PacketFormatterAdapter.ProtocolVersion);
             }
 
             var publishPacket = MqttPacketFactories.Publish.Create(applicationMessage);
@@ -271,25 +287,26 @@ namespace MQTTnet.Client
             }
         }
 
-        public Task ReAuthenticateAsync(MqttReAuthenticationOptions options, CancellationToken cancellationToken = default)
+        public Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken = default)
         {
-            if (options == null)
+            if (data == null)
             {
-                throw new ArgumentNullException(nameof(options));
+                throw new ArgumentNullException(nameof(data));
             }
 
             ThrowIfDisposed();
             ThrowIfNotConnected();
 
-            if (cancellationToken.CanBeCanceled)
+            var authPacket = new MqttAuthPacket
             {
-                return _authenticationHandler.ReAuthenticate(options, cancellationToken);
-            }
+                // This must always be equal to the value from the CONNECT packet. So we use it here to ensure that.
+                AuthenticationMethod = Options.AuthenticationMethod,
+                AuthenticationData = data.AuthenticationData,
+                ReasonString = data.ReasonString,
+                UserProperties = data.UserProperties
+            };
 
-            using (var timeout = new CancellationTokenSource(Options.Timeout))
-            {
-                return _authenticationHandler.ReAuthenticate(options, timeout.Token);
-            }
+            return Send(authPacket, cancellationToken);
         }
 
         public async Task<MqttClientSubscribeResult> SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken = default)
@@ -306,7 +323,7 @@ namespace MQTTnet.Client
 
             if (Options.ValidateFeatures)
             {
-                MqttClientSubscribeOptionsValidator.ThrowIfNotSupported(options, _channelAdapter.PacketFormatterAdapter.ProtocolVersion);
+                MqttClientSubscribeOptionsValidator.ThrowIfNotSupported(options, _adapter.PacketFormatterAdapter.ProtocolVersion);
             }
 
             ThrowIfDisposed();
@@ -348,7 +365,7 @@ namespace MQTTnet.Client
 
             if (Options.ValidateFeatures)
             {
-                MqttClientUnsubscribeOptionsValidator.ThrowIfNotSupported(options, _channelAdapter.PacketFormatterAdapter.ProtocolVersion);
+                MqttClientUnsubscribeOptionsValidator.ThrowIfNotSupported(options, _adapter.PacketFormatterAdapter.ProtocolVersion);
             }
 
             var unsubscribePacket = MqttPacketFactories.Unsubscribe.Create(options);
@@ -370,27 +387,6 @@ namespace MQTTnet.Client
             return MqttClientResultFactory.UnsubscribeResult.Create(unsubscribePacket, unsubAckPacket);
         }
 
-        internal Task DisconnectInternalAsync(Task sender, Exception exception, MqttClientConnectResult connectResult)
-        {
-            var clientWasConnected = IsConnected;
-
-            if (!DisconnectIsPendingOrFinished())
-            {
-                return DisconnectCore(sender, exception, connectResult, clientWasConnected);
-            }
-
-            return CompletedTask.Instance;
-        }
-
-        internal Task Send(MqttPacket packet, CancellationToken cancellationToken)
-        {
-            cancellationToken.ThrowIfCancellationRequested();
-
-            _keepAliveHandler.TrackSentPacket();
-
-            return _channelAdapter.SendPacketAsync(packet, cancellationToken);
-        }
-
         protected override void Dispose(bool disposing)
         {
             if (disposing)
@@ -431,22 +427,66 @@ namespace MQTTnet.Client
             return CompletedTask.Instance;
         }
 
+        async Task<MqttClientConnectResult> Authenticate(IMqttChannelAdapter channelAdapter, MqttClientOptions options, CancellationToken cancellationToken)
+        {
+            MqttClientConnectResult result;
+
+            try
+            {
+                var connectPacket = MqttPacketFactories.Connect.Create(options);
+                await Send(connectPacket, cancellationToken).ConfigureAwait(false);
+
+                var receivedPacket = await Receive(cancellationToken).ConfigureAwait(false);
+
+                if (receivedPacket is MqttConnAckPacket connAckPacket)
+                {
+                    result = MqttClientResultFactory.ConnectResult.Create(connAckPacket, _adapter.PacketFormatterAdapter.ProtocolVersion);
+                }
+                else
+                {
+                    throw new NotSupportedException("Extended authentication handler is not yet supported");
+                }
+            }
+            catch (Exception exception)
+            {
+                throw new MqttConnectingFailedException($"Error while authenticating. {exception.Message}", exception, null);
+            }
+
+            // This is no feature. It is basically a backward compatibility option and should be removed in the future.
+            // The client should not throw any exception if the transport layer connection was successful and the server
+            // did send a proper ACK packet with a non success response.
+            if (options.ThrowOnNonSuccessfulConnectResponse)
+            {
+                _logger.Warning(
+                    "Client will now throw an _MqttConnectingFailedException_. This is obsolete and will be removed in the future. Consider setting _ThrowOnNonSuccessfulResponseFromServer=False_ in client options.");
+
+                if (result.ResultCode != MqttClientConnectResultCode.Success)
+                {
+                    throw new MqttConnectingFailedException($"Connecting with MQTT server failed ({result.ResultCode}).", null, result);
+                }
+            }
+
+            _logger.Verbose("Authenticated MQTT connection with server established.");
+
+            return result;
+        }
+
         void Cleanup()
         {
             try
             {
-                _clientAlive?.Cancel(false);
+                _mqttClientAlive?.Cancel(false);
             }
             finally
             {
-                _clientAlive?.Dispose();
-                _clientAlive = null;
+                _mqttClientAlive?.Dispose();
+                _mqttClientAlive = null;
 
                 _publishPacketReceiverQueue?.Dispose();
                 _publishPacketReceiverQueue = null;
 
-                _channelAdapter?.Dispose();
-                _channelAdapter = null;
+                _adapter?.Dispose();
+                _adapter = null;
 
                 _packetDispatcher?.Dispose();
                 _packetDispatcher = null;
@@ -458,29 +498,24 @@ namespace MQTTnet.Client
             return (MqttClientConnectionStatus)Interlocked.CompareExchange(ref _connectionStatus, (int)value, (int)comparand);
         }
 
-        async Task<MqttClientConnectResult> ConnectInternal(CancellationToken cancellationToken)
+        async Task<MqttClientConnectResult> ConnectInternal(IMqttChannelAdapter channelAdapter, CancellationToken cancellationToken)
         {
-            var clientAliveToken = _clientAlive.Token;
+            var backgroundCancellationToken = _mqttClientAlive.Token;
 
-            using (var effectiveCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(clientAliveToken, cancellationToken))
+            using (var effectiveCancellationToken = CancellationTokenSource.CreateLinkedTokenSource(backgroundCancellationToken, cancellationToken))
             {
                 _logger.Verbose("Trying to connect with server '{0}'", Options.ChannelOptions);
-
-                await _channelAdapter.ConnectAsync(effectiveCancellationToken.Token).ConfigureAwait(false);
-
+                await _adapter.ConnectAsync(effectiveCancellationToken.Token).ConfigureAwait(false);
                 _logger.Verbose("Connection with server established");
 
-                var connectResult = await _authenticationHandler.Authenticate(_channelAdapter, Options, effectiveCancellationToken.Token).ConfigureAwait(false);
+                _publishPacketReceiverQueue?.Dispose();
+                _publishPacketReceiverQueue = new AsyncQueue<MqttPublishPacket>();
 
+                var connectResult = await Authenticate(channelAdapter, Options, effectiveCancellationToken.Token).ConfigureAwait(false);
                 if (connectResult.ResultCode == MqttClientConnectResultCode.Success)
                 {
-                    _publishPacketReceiverQueue?.Dispose();
-                    _publishPacketReceiverQueue = new AsyncQueue<MqttPublishPacket>();
-
-                    _publishPacketReceiverTask = Task.Run(() => ProcessReceivedPublishPacketsLoop(clientAliveToken), clientAliveToken);
-                    _packetReceiverTask = Task.Run(() => ReceivePacketsLoop(clientAliveToken), clientAliveToken);
-
-                    _keepAliveHandler.Enable(connectResult);
+                    _publishPacketReceiverTask = Task.Run(() => ProcessReceivedPublishPackets(backgroundCancellationToken), backgroundCancellationToken);
+                    _packetReceiverTask = Task.Run(() => ReceivePacketsLoop(backgroundCancellationToken), backgroundCancellationToken);
                 }
 
                 return connectResult;
@@ -493,13 +528,13 @@ namespace MQTTnet.Client
 
             try
             {
-                if (_channelAdapter != null)
+                if (_adapter != null)
                 {
                     _logger.Verbose("Disconnecting [Timeout={0}]", Options.Timeout);
 
                     using (var timeout = new CancellationTokenSource(Options.Timeout))
                     {
-                        await _channelAdapter.DisconnectAsync(timeout.Token).ConfigureAwait(false);
+                        await _adapter.DisconnectAsync(timeout.Token).ConfigureAwait(false);
                     }
                 }
 
@@ -516,10 +551,9 @@ namespace MQTTnet.Client
 
                 var receiverTask = _packetReceiverTask.WaitAsync(sender, _logger);
                 var publishPacketReceiverTask = _publishPacketReceiverTask.WaitAsync(sender, _logger);
+                var keepAliveTask = _keepAlivePacketsSenderTask.WaitAsync(sender, _logger);
 
-                _keepAliveHandler.Disable();
-
-                await Task.WhenAll(receiverTask, publishPacketReceiverTask).ConfigureAwait(false);
+                await Task.WhenAll(receiverTask, publishPacketReceiverTask, keepAliveTask).ConfigureAwait(false);
             }
             catch (Exception innerException)
             {
@@ -618,6 +652,17 @@ namespace MQTTnet.Client
             return CompletedTask.Instance;
         }
 
+        Task ProcessReceivedAuthPacket(MqttAuthPacket authPacket)
+        {
+            var extendedAuthenticationExchangeHandler = Options.ExtendedAuthenticationExchangeHandler;
+            if (extendedAuthenticationExchangeHandler != null)
+            {
+                return extendedAuthenticationExchangeHandler.HandleRequestAsync(new MqttExtendedAuthenticationExchangeContext(authPacket, this));
+            }
+
+            return CompletedTask.Instance;
+        }
+
         Task ProcessReceivedDisconnectPacket(MqttDisconnectPacket disconnectPacket)
         {
             _disconnectReason = (int)disconnectPacket.ReasonCode;
@@ -630,7 +675,7 @@ namespace MQTTnet.Client
             return DisconnectInternal(_packetReceiverTask, null, null);
         }
 
-        async Task ProcessReceivedPublishPacketsLoop(CancellationToken cancellationToken)
+        async Task ProcessReceivedPublishPackets(CancellationToken cancellationToken)
         {
             while (!cancellationToken.IsCancellationRequested)
             {
@@ -710,7 +755,7 @@ namespace MQTTnet.Client
 
         async Task<MqttPacket> Receive(CancellationToken cancellationToken)
         {
-            var packetTask = _channelAdapter.ReceivePacketAsync(cancellationToken);
+            var packetTask = _adapter.ReceivePacketAsync(cancellationToken);
 
             MqttPacket packet;
             if (packetTask.IsCompleted)
@@ -784,36 +829,15 @@ namespace MQTTnet.Client
             }
         }
 
-        internal async Task<TPacket> Receive<TPacket>(int packetIdentifier, CancellationToken cancellationToken) where TPacket : MqttPacket
-        {
-            using (var packetAwaitable = _packetDispatcher.AddAwaitable<TPacket>(packetIdentifier))
-            {
-                return await packetAwaitable.WaitOneAsync(cancellationToken);
-            }
-        }
-        
-        internal async Task<TResponsePacket> Request<TResponsePacket>(MqttPacket requestPacket, CancellationToken cancellationToken) where TResponsePacket : MqttPacket
+        async Task<TResponsePacket> Request<TResponsePacket>(MqttPacket requestPacket, CancellationToken cancellationToken) where TResponsePacket : MqttPacket
         {
             cancellationToken.ThrowIfCancellationRequested();
 
-            // Some packets are a direct response to another packet but have no packet identifier for correlation!
-            int packetIdentifier;
+            ushort packetIdentifier = 0;
             if (requestPacket is MqttPacketWithIdentifier packetWithIdentifier)
             {
                 packetIdentifier = packetWithIdentifier.PacketIdentifier;
             }
-            else if (requestPacket is MqttPingReqPacket)
-            {
-                packetIdentifier = MqttPacketDispatcher.PingRespPacketFakeIdentifier;
-            }
-            else if (requestPacket is MqttAuthPacket)
-            {
-                packetIdentifier = MqttPacketDispatcher.AuthPacketFakeIdentifier;
-            }
-            else
-            {
-                throw new MqttProtocolViolationException($"Expecting a response for packet {requestPacket.GetRfcName()} is not supported.");
-            }
 
             using (var packetAwaitable = _packetDispatcher.AddAwaitable<TResponsePacket>(packetIdentifier))
             {
@@ -843,6 +867,15 @@ namespace MQTTnet.Client
             }
         }
 
+        Task Send(MqttPacket packet, CancellationToken cancellationToken)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+
+            _lastPacketSentTimestamp = DateTime.UtcNow;
+
+            return _adapter.SendPacketAsync(packet, cancellationToken);
+        }
+
         void ThrowIfConnected(string message)
         {
             if (IsConnected)
@@ -888,7 +921,7 @@ namespace MQTTnet.Client
             {
                 try
                 {
-                    _clientAlive?.Cancel(false);
+                    _mqttClientAlive?.Cancel(false);
                 }
                 catch (Exception exception)
                 {
@@ -917,31 +950,23 @@ namespace MQTTnet.Client
                 {
                     await ProcessReceivedDisconnectPacket(disconnectPacket).ConfigureAwait(false);
                 }
-                // else if (packet is MqttAuthPacket authPacket)
-                // {
-                //     await _authenticationHandler.HandleExtendedAuthentication(authPacket, new MqttInitialAuthenticationStrategy(_channelAdapter)).ConfigureAwait(false);
-                // }
+                else if (packet is MqttAuthPacket authPacket)
+                {
+                    await ProcessReceivedAuthPacket(authPacket).ConfigureAwait(false);
+                }
                 else if (packet is MqttPingRespPacket)
                 {
                     _packetDispatcher.TryDispatch(packet);
                 }
                 else if (packet is MqttPingReqPacket)
                 {
-                    throw new MqttProtocolViolationException("The PINGREQ packet can only be sent from client to server.");
-                }
-                else if (packet is MqttConnAckPacket)
-                {
-                    throw new MqttProtocolViolationException("The CONNACK packet can only be send while connecting.");
-                }
-                else if (packet is MqttConnectPacket)
-                {
-                    throw new MqttProtocolViolationException("The CONNECT packet can only be sent from client to server.");
+                    throw new MqttProtocolViolationException("The PINGREQ Packet is sent from a Client to the Server only.");
                 }
                 else
                 {
                     if (!_packetDispatcher.TryDispatch(packet))
                     {
-                        throw new MqttProtocolViolationException($"Received unexpected {packet} packet.");
+                        throw new MqttProtocolViolationException($"Received packet '{packet}' at an unexpected time.");
                     }
                 }
             }
@@ -969,5 +994,62 @@ namespace MQTTnet.Client
                 await DisconnectInternal(_packetReceiverTask, exception, null).ConfigureAwait(false);
             }
         }
+
+        async Task TrySendKeepAliveMessages(CancellationToken cancellationToken)
+        {
+            try
+            {
+                _logger.Verbose("Start sending keep alive packets.");
+
+                var keepAlivePeriod = Options.KeepAlivePeriod;
+
+                while (!cancellationToken.IsCancellationRequested)
+                {
+                    // Values described here: [MQTT-3.1.2-24].
+                    var timeWithoutPacketSent = DateTime.UtcNow - _lastPacketSentTimestamp;
+
+                    if (timeWithoutPacketSent > keepAlivePeriod)
+                    {
+                        using (var timeoutCancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken))
+                        {
+                            timeoutCancellationTokenSource.CancelAfter(Options.Timeout);
+                            await PingAsync(timeoutCancellationTokenSource.Token).ConfigureAwait(false);
+                        }
+                    }
+
+                    // Wait a fixed time in all cases. Calculation of the remaining time is complicated
+                    // due to some edge cases and was buggy in the past. Now we wait several ms because the
+                    // min keep alive value is one second so that the server will wait 1.5 seconds for a PING
+                    // packet.
+                    await Task.Delay(250, cancellationToken).ConfigureAwait(false);
+                }
+            }
+            catch (Exception exception)
+            {
+                if (_cleanDisconnectInitiated)
+                {
+                    return;
+                }
+
+                if (exception is OperationCanceledException)
+                {
+                    return;
+                }
+                else if (exception is MqttCommunicationException)
+                {
+                    _logger.Warning(exception, "Communication error while sending/receiving keep alive packets.");
+                }
+                else
+                {
+                    _logger.Error(exception, "Error exception while sending/receiving keep alive packets.");
+                }
+
+                await DisconnectInternal(_keepAlivePacketsSenderTask, exception, null).ConfigureAwait(false);
+            }
+            finally
+            {
+                _logger.Verbose("Stopped sending keep alive packets.");
+            }
+        }
     }
 }

Source/MQTTnet/Client/MqttClientExtensions.cs

@@ -14,8 +14,6 @@ namespace MQTTnet.Client
 {
     public static class MqttClientExtensions
     {
-        static readonly MqttReAuthenticationOptions EmptyReAuthenticationOptions = new MqttReAuthenticationOptions();
-
         public static Task DisconnectAsync(
             this IMqttClient client,
             MqttClientDisconnectOptionsReason reason = MqttClientDisconnectOptionsReason.NormalDisconnection,
@@ -79,11 +77,6 @@ namespace MQTTnet.Client
             return mqttClient.PublishBinaryAsync(topic, payloadBuffer, qualityOfServiceLevel, retain, cancellationToken);
         }
 
-        public static Task ReAuthenticateAsync(this IMqttClient client, CancellationToken cancellationToken = default)
-        {
-            return client.ReAuthenticateAsync(EmptyReAuthenticationOptions, cancellationToken);
-        }
-
         public static Task ReconnectAsync(this IMqttClient client, CancellationToken cancellationToken = default)
         {
             if (client.Options == null)
@@ -95,6 +88,16 @@ namespace MQTTnet.Client
             return client.ConnectAsync(client.Options, cancellationToken);
         }
 
+        public static Task SendExtendedAuthenticationExchangeDataAsync(this IMqttClient client, MqttExtendedAuthenticationExchangeData data)
+        {
+            if (client == null)
+            {
+                throw new ArgumentNullException(nameof(client));
+            }
+
+            return client.SendExtendedAuthenticationExchangeDataAsync(data, CancellationToken.None);
+        }
+
         public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient mqttClient, MqttTopicFilter topicFilter, CancellationToken cancellationToken = default)
         {
             if (mqttClient == null)

Source/MQTTnet/Client/Options/MqttClientOptions.cs

@@ -53,7 +53,9 @@ namespace MQTTnet.Client
         public string ClientId { get; set; } = Guid.NewGuid().ToString("N");
 
         public IMqttClientCredentialsProvider Credentials { get; set; }
-        
+
+        public IMqttExtendedAuthenticationExchangeHandler ExtendedAuthenticationExchangeHandler { get; set; }
+
         /// <summary>
         ///     Gets or sets the keep alive period.
         ///     The connection is normally left open by the client so that is can send and receive data at any time.
@@ -101,7 +103,7 @@ namespace MQTTnet.Client
         /// <summary>
         ///     Gets or sets whether an exception should be thrown when the server has sent a non success ACK packet.
         /// </summary>
-        public bool ThrowOnNonSuccessfulResponseFromServer { get; set; } = true;
+        public bool ThrowOnNonSuccessfulConnectResponse { get; set; } = true;
 
         /// <summary>
         ///     Gets or sets the timeout which will be applied at socket level and internal operations.

Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs

@@ -78,8 +78,18 @@ namespace MQTTnet.Client
 
             return _options;
         }
-
-        public MqttClientOptionsBuilder WithAuthentication(string method, byte[] data = null)
+        
+        /// <summary>
+        /// The client will not throw an exception when the MQTT server responses with a non success ACK packet.
+        /// This will become the default behavior in future versions of the library.
+        /// </summary>
+        public MqttClientOptionsBuilder WithoutThrowOnNonSuccessfulConnectResponse()
+        {
+            _options.ThrowOnNonSuccessfulConnectResponse = false;
+            return this;
+        }
+        
+        public MqttClientOptionsBuilder WithAuthentication(string method, byte[] data)
         {
             _options.AuthenticationMethod = method;
             _options.AuthenticationData = data;
@@ -177,6 +187,12 @@ namespace MQTTnet.Client
             return this;
         }
 
+        public MqttClientOptionsBuilder WithExtendedAuthenticationExchangeHandler(IMqttExtendedAuthenticationExchangeHandler handler)
+        {
+            _options.ExtendedAuthenticationExchangeHandler = handler;
+            return this;
+        }
+
         public MqttClientOptionsBuilder WithKeepAlivePeriod(TimeSpan value)
         {
             _options.KeepAlivePeriod = value;

Source/MQTTnet/Client/Options/MqttClientTlsOptions.cs

@@ -4,6 +4,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Net.Security;
 using System.Security.Authentication;
 using System.Security.Cryptography.X509Certificates;
 
@@ -30,11 +31,21 @@ namespace MQTTnet.Client
 #endif
 
 #if NETCOREAPP3_1_OR_GREATER
-        public List<System.Net.Security.SslApplicationProtocol> ApplicationProtocols { get; set; }
-        
-        public System.Net.Security.CipherSuitesPolicy CipherSuitesPolicy { get; set; }
+        public List<SslApplicationProtocol> ApplicationProtocols { get; set; }
+
+        public CipherSuitesPolicy CipherSuitesPolicy { get; set; }
+
+        public EncryptionPolicy EncryptionPolicy { get; set; } = EncryptionPolicy.RequireEncryption;
+
+        public bool AllowRenegotiation { get; set; } = true;
 #endif
 
+        /// <summary>
+        ///     Gets or sets the target host.
+        ///     If the value is null or empty the same host as the TCP socket host will be used.
+        /// </summary>
+        public string TargetHost { get; set; }
+
 #if NET48 || NETCOREAPP3_1_OR_GREATER
         public SslProtocols SslProtocol { get; set; } = SslProtocols.Tls12 | SslProtocols.Tls13;
 #else

Source/MQTTnet/Client/Options/MqttClientWebSocketOptions.cs

@@ -2,15 +2,19 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System;
 using System.Collections.Generic;
 using System.Net;
+using System.Net.WebSockets;
 
 namespace MQTTnet.Client
 {
     public sealed class MqttClientWebSocketOptions : IMqttClientChannelOptions
     {
         public CookieContainer CookieContainer { get; set; }
-        
+
+        public ICredentials Credentials { get; set; }
+
         public MqttClientWebSocketProxyOptions ProxyOptions { get; set; }
 
         public IDictionary<string, string> RequestHeaders { get; set; }
@@ -18,12 +22,34 @@ namespace MQTTnet.Client
         public ICollection<string> SubProtocols { get; set; } = new List<string> { "mqtt" };
 
         public MqttClientTlsOptions TlsOptions { get; set; } = new MqttClientTlsOptions();
-        
+
         public string Uri { get; set; }
 
         public override string ToString()
         {
             return Uri;
         }
+
+#if !NETSTANDARD1_3
+#if !WINDOWS_UWP
+        /// <summary>
+        ///     Gets or sets the keep alive interval for the Web Socket connection.
+        ///     This is not related to the keep alive interval for the MQTT protocol.
+        /// </summary>
+        public TimeSpan KeepAliveInterval { get; set; } = WebSocket.DefaultKeepAliveInterval;
+
+        /// <summary>
+        ///     Gets or sets whether the default (system) credentials should be used when connecting via Web Socket connection.
+        ///     This is not related to the credentials which are used for the MQTT protocol.
+        /// </summary>
+        public bool UseDefaultCredentials { get; set; }
+#else
+        /// <summary>
+        ///     Gets or sets the keep alive interval for the Web Socket connection.
+        ///     This is not related to the keep alive interval for the MQTT protocol.
+        /// </summary>
+        public TimeSpan KeepAliveInterval { get; set; } = TimeSpan.FromSeconds(30);
+#endif
+#endif
     }
 }

Source/MQTTnet/Client/Options/MqttClientWebSocketProxyOptions.cs

@@ -16,6 +16,8 @@ namespace MQTTnet.Client
 
         public bool BypassOnLocal { get; set; }
 
+        public bool UseDefaultCredentials { get; set; }
+
         public string[] BypassList { get; set; }
     }
 }

Source/MQTTnet/Diagnostics/Runtime/TargetFrameworkProvider.cs

@@ -16,6 +16,8 @@ namespace MQTTnet.Diagnostics
                 return "net461";
 #elif NET472
                 return "net472";
+#elif NET48
+                return "net48";
 #elif NETSTANDARD1_3
                 return "netstandard1.3";
 #elif NETSTANDARD2_0

Source/MQTTnet/Formatter/MqttAuthPacketFactory.cs

@@ -1,37 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System;
-using MQTTnet.Client;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Formatter
-{
-    public sealed class MqttAuthPacketFactory
-    {
-        public MqttAuthPacket CreateReAuthenticationPacket(MqttClientOptions clientOptions, MqttReAuthenticationOptions reAuthenticationOptions)
-        {
-            if (clientOptions == null)
-            {
-                throw new ArgumentNullException(nameof(clientOptions));
-            }
-
-            if (reAuthenticationOptions == null)
-            {
-                throw new ArgumentNullException(nameof(reAuthenticationOptions));
-            }
-
-            return new MqttAuthPacket
-            {
-                // The authentication method cannot change and must be always the same as long as the client is connected.
-                AuthenticationMethod = clientOptions.AuthenticationMethod,
-                ReasonCode = MqttAuthenticateReasonCode.ReAuthenticate,
-                AuthenticationData = reAuthenticationOptions.AuthenticationData,
-                UserProperties = reAuthenticationOptions.UserProperties,
-                ReasonString = null
-            };
-        }
-    }
-}

Source/MQTTnet/Formatter/MqttConnectReasonCodeConverter.cs

@@ -2,54 +2,12 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-using MQTTnet.Exceptions;
 using MQTTnet.Protocol;
 
 namespace MQTTnet.Formatter
 {
     public static class MqttConnectReasonCodeConverter
     {
-        public static MqttConnectReasonCode ToConnectReasonCode(MqttConnectReturnCode returnCode)
-        {
-            switch (returnCode)
-            {
-                case MqttConnectReturnCode.ConnectionAccepted:
-                {
-                    return MqttConnectReasonCode.Success;
-                }
-
-                case MqttConnectReturnCode.ConnectionRefusedUnacceptableProtocolVersion:
-                {
-                    return MqttConnectReasonCode.UnsupportedProtocolVersion;
-                }
-
-                case MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword:
-                {
-                    return MqttConnectReasonCode.BadUserNameOrPassword;
-                }
-
-                case MqttConnectReturnCode.ConnectionRefusedIdentifierRejected:
-                {
-                    return MqttConnectReasonCode.ClientIdentifierNotValid;
-                }
-
-                case MqttConnectReturnCode.ConnectionRefusedServerUnavailable:
-                {
-                    return MqttConnectReasonCode.ServerUnavailable;
-                }
-
-                case MqttConnectReturnCode.ConnectionRefusedNotAuthorized:
-                {
-                    return MqttConnectReasonCode.NotAuthorized;
-                }
-
-                default:
-                {
-                    throw new MqttProtocolViolationException("Unable to convert connect reason code (MQTTv5) to return code (MQTTv3).");
-                }
-            }
-        }
-
         public static MqttConnectReturnCode ToConnectReturnCode(MqttConnectReasonCode reasonCode)
         {
             switch (reasonCode)
@@ -59,13 +17,13 @@ namespace MQTTnet.Formatter
                     return MqttConnectReturnCode.ConnectionAccepted;
                 }
 
-                case MqttConnectReasonCode.BadAuthenticationMethod:
                 case MqttConnectReasonCode.Banned:
                 case MqttConnectReasonCode.NotAuthorized:
                 {
                     return MqttConnectReturnCode.ConnectionRefusedNotAuthorized;
                 }
 
+                case MqttConnectReasonCode.BadAuthenticationMethod:
                 case MqttConnectReasonCode.BadUserNameOrPassword:
                 {
                     return MqttConnectReturnCode.ConnectionRefusedBadUsernameOrPassword;
@@ -75,12 +33,12 @@ namespace MQTTnet.Formatter
                 {
                     return MqttConnectReturnCode.ConnectionRefusedIdentifierRejected;
                 }
-                
+
                 case MqttConnectReasonCode.UnsupportedProtocolVersion:
                 {
                     return MqttConnectReturnCode.ConnectionRefusedUnacceptableProtocolVersion;
                 }
-                
+
                 case MqttConnectReasonCode.UseAnotherServer:
                 case MqttConnectReasonCode.ServerUnavailable:
                 case MqttConnectReasonCode.ServerBusy:
@@ -90,10 +48,7 @@ namespace MQTTnet.Formatter
                 }
 
                 default:
-                {
-                    // This is the most best matching value.
                     return MqttConnectReturnCode.ConnectionRefusedUnacceptableProtocolVersion;
-                }
             }
         }
     }

Source/MQTTnet/Formatter/MqttPacketFactories.cs

@@ -6,8 +6,6 @@ namespace MQTTnet.Formatter
 {
     public static class MqttPacketFactories
     {
-        public static MqttAuthPacketFactory Auth { get; } = new MqttAuthPacketFactory();
-        
         public static MqttConnAckPacketFactory ConnAck { get; } = new MqttConnAckPacketFactory();
         
         public static MqttConnectPacketFactory Connect { get; } = new MqttConnectPacketFactory();

Source/MQTTnet/Formatter/V5/MqttV5PacketDecoder.cs

@@ -130,6 +130,9 @@ namespace MQTTnet.Formatter.V5
                 MaximumQoS = MqttQualityOfServiceLevel.ExactlyOnce
             };
 
+            // Also set the return code of MQTT 3.1.1 for backward compatibility and debugging purposes.
+            packet.ReturnCode = MqttConnectReasonCodeConverter.ToConnectReturnCode(packet.ReasonCode);
+
             var propertiesReader = new MqttV5PropertiesReader(_bufferReader);
             while (propertiesReader.MoveNext())
             {

Source/MQTTnet/Implementations/MqttTcpChannel.cs

@@ -100,6 +100,12 @@ namespace MQTTnet.Implementations
 
                 if (_tcpOptions.TlsOptions?.UseTls == true)
                 {
+                    var targetHost = _tcpOptions.TlsOptions.TargetHost;
+                    if (string.IsNullOrEmpty(targetHost))
+                    {
+                        targetHost = _tcpOptions.Server;
+                    }
+                    
                     var sslStream = new SslStream(networkStream, false, InternalUserCertificateValidationCallback);
                     try
                     {
@@ -111,14 +117,16 @@ namespace MQTTnet.Implementations
                             EnabledSslProtocols = _tcpOptions.TlsOptions.SslProtocol,
                             CertificateRevocationCheckMode =
  _tcpOptions.TlsOptions.IgnoreCertificateRevocationErrors ? X509RevocationMode.NoCheck : _tcpOptions.TlsOptions.RevocationMode,
-                            TargetHost = _tcpOptions.Server,
-                            CipherSuitesPolicy = _tcpOptions.TlsOptions.CipherSuitesPolicy
+                            TargetHost = targetHost,
+                            CipherSuitesPolicy = _tcpOptions.TlsOptions.CipherSuitesPolicy,
+                            EncryptionPolicy = _tcpOptions.TlsOptions.EncryptionPolicy,
+                            AllowRenegotiation = _tcpOptions.TlsOptions.AllowRenegotiation
                         };
 
                         await sslStream.AuthenticateAsClientAsync(sslOptions, cancellationToken).ConfigureAwait(false);
 #else
                         await sslStream.AuthenticateAsClientAsync(
-                                _tcpOptions.Server,
+                                targetHost,
                                 LoadCertificates(),
                                 _tcpOptions.TlsOptions.SslProtocol,
                                 !_tcpOptions.TlsOptions.IgnoreCertificateRevocationErrors)
@@ -290,12 +298,12 @@ namespace MQTTnet.Implementations
 
         X509CertificateCollection LoadCertificates()
         {
-            var certificates = new X509CertificateCollection();
             if (_tcpOptions.TlsOptions.Certificates == null)
             {
-                return certificates;
+                return null;
             }
 
+            var certificates = new X509CertificateCollection();
             foreach (var certificate in _tcpOptions.TlsOptions.Certificates)
             {
                 certificates.Add(certificate);

Source/MQTTnet/Implementations/MqttWebSocketChannel.cs

@@ -155,14 +155,26 @@ namespace MQTTnet.Implementations
             throw new NotSupportedException("Proxies are not supported when using 'netstandard 1.3'.");
 #else
             var proxyUri = new Uri(_options.ProxyOptions.Address);
-
+            WebProxy webProxy;
+            
             if (!string.IsNullOrEmpty(_options.ProxyOptions.Username) && !string.IsNullOrEmpty(_options.ProxyOptions.Password))
             {
                 var credentials = new NetworkCredential(_options.ProxyOptions.Username, _options.ProxyOptions.Password, _options.ProxyOptions.Domain);
-                return new WebProxy(proxyUri, _options.ProxyOptions.BypassOnLocal, _options.ProxyOptions.BypassList, credentials);
+                webProxy = new WebProxy(proxyUri, _options.ProxyOptions.BypassOnLocal, _options.ProxyOptions.BypassList, credentials);
+            }
+            else
+            {
+                webProxy = new WebProxy(proxyUri, _options.ProxyOptions.BypassOnLocal, _options.ProxyOptions.BypassList);    
+            }
+            
+            if (_options.ProxyOptions.UseDefaultCredentials)
+            {
+                // Only update the property if required because setting it to false will alter
+                // the used credentials internally!
+                webProxy.UseDefaultCredentials = true;
             }
 
-            return new WebProxy(proxyUri, _options.ProxyOptions.BypassOnLocal, _options.ProxyOptions.BypassList);
+            return webProxy;
 #endif
         }
 
@@ -207,6 +219,14 @@ namespace MQTTnet.Implementations
                 }
             }
 
+#if !NETSTANDARD1_3
+#if !WINDOWS_UWP
+            clientWebSocket.Options.UseDefaultCredentials = _options.UseDefaultCredentials;
+#endif
+            clientWebSocket.Options.KeepAliveInterval = _options.KeepAliveInterval;
+#endif
+            clientWebSocket.Options.Credentials = _options.Credentials;
+            
             var certificateValidationHandler = _options.TlsOptions?.CertificateValidationHandler;
             if (certificateValidationHandler != null)
             {
@@ -220,6 +240,8 @@ namespace MQTTnet.Implementations
                 throw new NotSupportedException("Remote certificate validation callback is not supported when using 'net452'.");
 #elif NET461
                 throw new NotSupportedException("Remote certificate validation callback is not supported when using 'net461'.");
+#elif NET48
+                throw new NotSupportedException("Remote certificate validation callback is not supported when using 'net48'.");
 #else
                 clientWebSocket.Options.RemoteCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) =>
                 {

Source/MQTTnet/MQTTnet.csproj

@@ -11,7 +11,7 @@
 
     <PropertyGroup>
         <TargetFrameworks>netstandard1.3;netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
-        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461</TargetFrameworks>
+        <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);net452;net461;net48</TargetFrameworks>
         <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' AND '$(MSBuildRuntimeType)' != 'Core' ">$(TargetFrameworks);uap10.0</TargetFrameworks>
         <LangVersion>7.3</LangVersion>
         <AssemblyName>MQTTnet</AssemblyName>

Source/MQTTnet/MQTTnet.csproj.DotSettings

@@ -1,5 +1,4 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
-	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=client_005Cauthentication/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=client_005Cconnecting/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=client_005Cdiagnostics/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=client_005Cdisconnecting/@EntryIndexedValue">True</s:Boolean>

Source/MQTTnet/MqttApplicationMessageExtensions.cs

@@ -4,6 +4,7 @@
 
 using System;
 using System.Text;
+using MQTTnet.Internal;
 
 namespace MQTTnet
 {
@@ -16,6 +17,16 @@ namespace MQTTnet
                 throw new ArgumentNullException(nameof(applicationMessage));
             }
 
+            if(applicationMessage.PayloadSegment == EmptyBuffer.ArraySegment)
+            {
+                return null;
+            }
+
+            if (applicationMessage.PayloadSegment.Array == null)
+            {
+                return null;
+            }
+
             var payloadSegment = applicationMessage.PayloadSegment;
             return Encoding.UTF8.GetString(payloadSegment.Array, payloadSegment.Offset, payloadSegment.Count);
         }

Source/MQTTnet/PacketDispatcher/IMqttPacketAwaitable.cs

@@ -9,7 +9,7 @@ namespace MQTTnet.PacketDispatcher
 {
     public interface IMqttPacketAwaitable : IDisposable
     {
-        int PacketIdentifier { get; }
+        MqttPacketAwaitableFilter Filter { get; }
         
         void Complete(MqttPacket packet);
 

Source/MQTTnet/PacketDispatcher/MqttPacketAwaitable.cs

@@ -16,13 +16,18 @@ namespace MQTTnet.PacketDispatcher
         readonly AsyncTaskCompletionSource<MqttPacket> _promise = new AsyncTaskCompletionSource<MqttPacket>();
         readonly MqttPacketDispatcher _owningPacketDispatcher;
 
-        public MqttPacketAwaitable(int packetPacketIdentifier, MqttPacketDispatcher owningPacketDispatcher)
+        public MqttPacketAwaitable(ushort packetIdentifier, MqttPacketDispatcher owningPacketDispatcher)
         {
-            PacketIdentifier = packetPacketIdentifier;
+            Filter = new MqttPacketAwaitableFilter
+            {
+                Type = typeof(TPacket),
+                Identifier = packetIdentifier
+            };
+            
             _owningPacketDispatcher = owningPacketDispatcher ?? throw new ArgumentNullException(nameof(owningPacketDispatcher));
         }
         
-        public int PacketIdentifier { get; }
+        public MqttPacketAwaitableFilter Filter { get; }
         
         public async Task<TPacket> WaitOneAsync(CancellationToken cancellationToken)
         {

Source/MQTTnet/PacketDispatcher/MqttPacketAwaitableFilter.cs

@@ -4,10 +4,12 @@
 
 using System;
 
-namespace MQTTnet.Server
+namespace MQTTnet.PacketDispatcher
 {
-    public sealed class ClientReAuthenticatingEventArgs : EventArgs
+    public sealed class MqttPacketAwaitableFilter
     {
+        public Type Type { get; set; }
         
+        public ushort Identifier { get; set; }
     }
 }

Source/MQTTnet/PacketDispatcher/MqttPacketDispatcher.cs

@@ -10,15 +10,11 @@ namespace MQTTnet.PacketDispatcher
 {
     public sealed class MqttPacketDispatcher : IDisposable
     {
-        public const int PingRespPacketFakeIdentifier = 2147483647;
-        public const int AuthPacketFakeIdentifier = 2147483646;
-        public const int SuccessAuthPacketFakeIdentifier = 2147483647;
-        
         readonly List<IMqttPacketAwaitable> _waiters = new List<IMqttPacketAwaitable>();
 
         bool _isDisposed;
 
-        public MqttPacketAwaitable<TResponsePacket> AddAwaitable<TResponsePacket>(int packetIdentifier) where TResponsePacket : MqttPacket
+        public MqttPacketAwaitable<TResponsePacket> AddAwaitable<TResponsePacket>(ushort packetIdentifier) where TResponsePacket : MqttPacket
         {
             var awaitable = new MqttPacketAwaitable<TResponsePacket>(packetIdentifier, this);
 
@@ -103,21 +99,15 @@ namespace MQTTnet.PacketDispatcher
                 throw new ArgumentNullException(nameof(packet));
             }
 
-            var identifier = 0;
+            ushort identifier = 0;
             if (packet is MqttPacketWithIdentifier packetWithIdentifier)
             {
                 identifier = packetWithIdentifier.PacketIdentifier;
             }
-            else if (packet is MqttPingRespPacket)
-            {
-                identifier = PingRespPacketFakeIdentifier;
-            }
-            else
-            {
-                throw new InvalidOperationException($"Cannot dispatch {packet.GetRfcName()} packet.");
-            }
-            
+
+            var packetType = packet.GetType();
             var waiters = new List<IMqttPacketAwaitable>();
+
             lock (_waiters)
             {
                 ThrowIfDisposed();
@@ -125,8 +115,11 @@ namespace MQTTnet.PacketDispatcher
                 for (var i = _waiters.Count - 1; i >= 0; i--)
                 {
                     var entry = _waiters[i];
-                    
-                    if (entry.PacketIdentifier != identifier)
+
+                    // Note: The PingRespPacket will also arrive here and has NO identifier but there
+                    // is code which waits for it. So the code must be able to deal with filters which
+                    // are referring to the type only (identifier is 0)!
+                    if (entry.Filter.Type != packetType || entry.Filter.Identifier != identifier)
                     {
                         continue;
                     }

Source/MQTTnet/Packets/MqttConnAckPacket.cs

@@ -28,7 +28,7 @@ namespace MQTTnet.Packets
         public MqttQualityOfServiceLevel MaximumQoS { get; set; }
 
         /// <summary>
-        ///     The return code is only used in MQTTv 5.0.0 and higher.
+        ///     Added in MQTTv5.
         /// </summary>
         public MqttConnectReasonCode ReasonCode { get; set; }
 
@@ -39,16 +39,13 @@ namespace MQTTnet.Packets
         public string ResponseInformation { get; set; }
 
         public bool RetainAvailable { get; set; }
-
-        /// <summary>
-        ///     The return code is only used in MQTTv 3.1.1 and lower.
-        /// </summary>
+        
         public MqttConnectReturnCode ReturnCode { get; set; }
 
         public ushort ServerKeepAlive { get; set; }
 
         public string ServerReference { get; set; }
-
+        
         public uint SessionExpiryInterval { get; set; }
 
         public bool SharedSubscriptionAvailable { get; set; }

Source/MQTTnet/Packets/MqttDisconnectPacket.cs

@@ -36,7 +36,7 @@ namespace MQTTnet.Packets
 
         public override string ToString()
         {
-            return $"Disconnect: [ReasonCode={ReasonCode}]";
+            return $"Disconnect: [ReasonCode={ReasonCode}] [ReasonString={ReasonString}] [ServerReference={ServerReference}] [SessionExpiryInterval={SessionExpiryInterval}]";
         }
     }
 }

Source/MQTTnet/Packets/MqttUserPropertiesBuilder.cs

@@ -1,24 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System.Collections.Generic;
-
-namespace MQTTnet.Packets
-{
-    public sealed class MqttUserPropertiesBuilder
-    {
-        readonly List<MqttUserProperty> _properties = new List<MqttUserProperty>();
-
-        public List<MqttUserProperty> Build()
-        {
-            return _properties;
-        }
-
-        public MqttUserPropertiesBuilder With(string name, string value = "")
-        {
-            _properties.Add(new MqttUserProperty(name, value));
-            return this;
-        }
-    }
-}

Source/MQTTnet/Server/Events/ClientConnectedEventArgs.cs

@@ -4,26 +4,33 @@
 
 using System;
 using System.Collections;
+using System.Collections.Generic;
 using MQTTnet.Formatter;
+using MQTTnet.Packets;
 
 namespace MQTTnet.Server
 {
     public sealed class ClientConnectedEventArgs : EventArgs
     {
-        public ClientConnectedEventArgs(string clientId, string userName, MqttProtocolVersion protocolVersion, string endpoint, IDictionary sessionItems)
+        readonly MqttConnectPacket _connectPacket;
+
+        public ClientConnectedEventArgs(MqttConnectPacket connectPacket, MqttProtocolVersion protocolVersion, string endpoint, IDictionary sessionItems)
         {
-            ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
-            UserName = userName;
+            _connectPacket = connectPacket ?? throw new ArgumentNullException(nameof(connectPacket));
             ProtocolVersion = protocolVersion;
             Endpoint = endpoint;
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
         }
 
+        public byte[] AuthenticationData => _connectPacket.AuthenticationData;
+
+        public string AuthenticationMethod => _connectPacket.AuthenticationMethod;
+
         /// <summary>
         ///     Gets the client identifier of the connected client.
         ///     Hint: This identifier needs to be unique over all used clients / devices on the broker to avoid connection issues.
         /// </summary>
-        public string ClientId { get; }
+        public string ClientId => _connectPacket.ClientId;
 
         /// <summary>
         ///     Gets the endpoint of the connected client.
@@ -43,6 +50,12 @@ namespace MQTTnet.Server
         /// <summary>
         ///     Gets the user name of the connected client.
         /// </summary>
-        public string UserName { get; }
+        public string UserName => _connectPacket.Username;
+
+        /// <summary>
+        ///     Gets the user properties sent by the client.
+        ///     <remarks>MQTT 5.0.0+ feature.</remarks>
+        /// </summary>
+        public List<MqttUserProperty> UserProperties => _connectPacket?.UserProperties;
     }
 }

Source/MQTTnet/Server/Events/PartialAuthenticationResponse.cs

@@ -1,19 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
-
-using System.Collections.Generic;
-using MQTTnet.Packets;
-using MQTTnet.Protocol;
-
-namespace MQTTnet.Server
-{
-    public sealed class PartialAuthenticationResponse
-    {
-        public byte[] AuthenticationData { get; set; }
-
-        public MqttAuthenticateReasonCode ReasonCode { get; set; }
-
-        public List<MqttUserProperty> UserProperties { get; set; }
-    }
-}

Source/MQTTnet/Server/Events/ValidatingConnectionEventArgs.cs

@@ -7,10 +7,7 @@ using System.Collections;
 using System.Collections.Generic;
 using System.Security.Cryptography.X509Certificates;
 using System.Text;
-using System.Threading;
-using System.Threading.Tasks;
 using MQTTnet.Adapter;
-using MQTTnet.Exceptions;
 using MQTTnet.Formatter;
 using MQTTnet.Internal;
 using MQTTnet.Packets;
@@ -22,12 +19,11 @@ namespace MQTTnet.Server
     {
         readonly MqttConnectPacket _connectPacket;
 
-        public ValidatingConnectionEventArgs(MqttConnectPacket connectPacket, IMqttChannelAdapter clientAdapter, IDictionary sessionItems, CancellationToken cancellationToken)
+        public ValidatingConnectionEventArgs(MqttConnectPacket connectPacket, IMqttChannelAdapter clientAdapter, IDictionary sessionItems)
         {
             _connectPacket = connectPacket ?? throw new ArgumentNullException(nameof(connectPacket));
             ChannelAdapter = clientAdapter ?? throw new ArgumentNullException(nameof(clientAdapter));
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
-            CancellationToken = cancellationToken;
         }
 
         /// <summary>
@@ -48,11 +44,6 @@ namespace MQTTnet.Server
         /// </summary>
         public string AuthenticationMethod => _connectPacket.AuthenticationMethod;
 
-        /// <summary>
-        ///     Gets a cancellation token which is being canceled as soon as the transport connection is closed.
-        /// </summary>
-        public CancellationToken CancellationToken { get; }
-
         /// <summary>
         ///     Gets the channel adapter. This can be a _MqttConnectionContext_ (used in ASP.NET), a _MqttChannelAdapter_ (used for
         ///     TCP or WebSockets) or a custom implementation.
@@ -198,51 +189,5 @@ namespace MQTTnet.Server
         ///     A value of 0 indicates that the value is not used.
         /// </summary>
         public uint WillDelayInterval => _connectPacket.WillDelayInterval;
-
-        public async Task<PartialAuthenticationResponse> ReceiveAuthenticationDataAsync(CancellationToken cancellationToken = default)
-        {
-            var receivePacket = await ChannelAdapter.ReceivePacketAsync(cancellationToken).ConfigureAwait(false);
-            if (receivePacket is MqttAuthPacket authPacket)
-            {
-                if (!string.Equals(authPacket.AuthenticationMethod, AuthenticationMethod, StringComparison.Ordinal))
-                {
-                    throw new MqttProtocolViolationException("The authentication method is not allowed to change while authenticating.");
-                }
-
-                return new PartialAuthenticationResponse
-                {
-                    ReasonCode = authPacket.ReasonCode,
-                    AuthenticationData = authPacket.AuthenticationData,
-                    UserProperties = authPacket.UserProperties
-                };
-            }
-
-            if (receivePacket == null)
-            {
-                throw new MqttCommunicationException("The client closed the connection.");
-            }
-
-            throw new MqttProtocolViolationException("Expected an AUTH packet from the client.");
-        }
-
-        public Task SendAuthenticationDataAsync(
-            MqttAuthenticateReasonCode reasonCode,
-            byte[] authenticationData = null,
-            string reasonString = null,
-            List<MqttUserProperty> userProperties = null,
-            CancellationToken cancellationToken = default)
-        {
-            // The authentication method will never change so we must use the already known one [MQTT-4.12.0-5].
-            var authPacket = new MqttAuthPacket
-            {
-                AuthenticationMethod = AuthenticationMethod,
-                AuthenticationData = authenticationData,
-                UserProperties = userProperties,
-                ReasonCode = reasonCode,
-                ReasonString = reasonString
-            };
-
-            return ChannelAdapter.SendPacketAsync(authPacket, cancellationToken);
-        }
     }
 }

Source/MQTTnet/Server/Internal/MqttClient.cs

@@ -95,9 +95,8 @@ namespace MQTTnet.Server
             {
                 var cancellationToken = _cancellationToken.Token;
                 IsRunning = true;
-
-                _ = Task.Factory.StartNew(() => SendPacketsLoop(cancellationToken), cancellationToken, TaskCreationOptions.PreferFairness, TaskScheduler.Default)
-                    .ConfigureAwait(false);
+                
+                _ = Task.Factory.StartNew(() => SendPacketsLoop(cancellationToken), cancellationToken, TaskCreationOptions.PreferFairness, TaskScheduler.Default).ConfigureAwait(false);
 
                 await ReceivePackagesLoop(cancellationToken).ConfigureAwait(false);
             }
@@ -177,22 +176,6 @@ namespace MQTTnet.Server
             return CompletedTask.Instance;
         }
 
-        async Task HandleIncomingAuthPacket(MqttAuthPacket authPacket)
-        {
-            if (authPacket.ReasonCode != MqttAuthenticateReasonCode.ReAuthenticate)
-            {
-                throw new MqttProtocolViolationException("Clients are only allowed to send AUTH packets after connecting for re authentication.");
-            }
-
-            // We have to handle the re authentication in another task because we rely on the package retrieval.
-            _ = Task.Run(
-                async () =>
-                {
-                    var eventArgs = new ClientReAuthenticatingEventArgs();
-                    await _eventContainer.ClientReAuthenticatingEvent.InvokeAsync(eventArgs);
-                });
-        }
-
         void HandleIncomingPingReqPacket()
         {
             // See: The Server MUST send a PINGRESP packet in response to a PINGREQ packet [MQTT-3.12.4-1].
@@ -453,13 +436,9 @@ namespace MQTTnet.Server
                         DisconnectPacket = disconnectPacket;
                         return;
                     }
-                    else if (currentPacket is MqttAuthPacket authPacket)
-                    {
-                        await HandleIncomingAuthPacket(authPacket);
-                    }
                     else
                     {
-                        throw new MqttProtocolViolationException("Packet not allowed.");
+                        throw new MqttProtocolViolationException("Packet not allowed");
                     }
                 }
             }

Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs

@@ -58,7 +58,7 @@ namespace MQTTnet.Server
             _eventContainer = eventContainer ?? throw new ArgumentNullException(nameof(eventContainer));
         }
 
-        public async Task CloseAllConnectionsAsync()
+        public async Task CloseAllConnections()
         {
             List<MqttClient> connections;
             lock (_clients)
@@ -306,17 +306,17 @@ namespace MQTTnet.Server
             }
         }
 
-        public Task<IList<MqttClientStatus>> GetClientStatusesAsync()
+        public Task<IList<MqttClientStatus>> GetClientsStatus()
         {
             var result = new List<MqttClientStatus>();
 
             lock (_clients)
             {
-                foreach (var connection in _clients.Values)
+                foreach (var client in _clients.Values)
                 {
-                    var clientStatus = new MqttClientStatus(connection)
+                    var clientStatus = new MqttClientStatus(client)
                     {
-                        Session = new MqttSessionStatus(connection.Session)
+                        Session = new MqttSessionStatus(client.Session)
                     };
 
                     result.Add(clientStatus);
@@ -326,7 +326,7 @@ namespace MQTTnet.Server
             return Task.FromResult((IList<MqttClientStatus>)result);
         }
 
-        public Task<IList<MqttSessionStatus>> GetSessionStatusAsync()
+        public Task<IList<MqttSessionStatus>> GetSessionsStatus()
         {
             var result = new List<MqttSessionStatus>();
 
@@ -360,7 +360,7 @@ namespace MQTTnet.Server
                     return;
                 }
 
-                var validatingConnectionEventArgs = await ValidateConnection(connectPacket, channelAdapter, cancellationToken).ConfigureAwait(false);
+                var validatingConnectionEventArgs = await ValidateConnection(connectPacket, channelAdapter).ConfigureAwait(false);
                 var connAckPacket = MqttPacketFactories.ConnAck.Create(validatingConnectionEventArgs);
 
                 if (validatingConnectionEventArgs.ReasonCode != MqttConnectReasonCode.Success)
@@ -377,9 +377,7 @@ namespace MQTTnet.Server
 
                 if (_eventContainer.ClientConnectedEvent.HasHandlers)
                 {
-                    var eventArgs = new ClientConnectedEventArgs(
-                        connectPacket.ClientId,
-                        connectPacket.Username,
+                    var eventArgs = new ClientConnectedEventArgs(connectPacket,
                         channelAdapter.PacketFormatterAdapter.ProtocolVersion,
                         channelAdapter.Endpoint,
                         client.Session.Items);
@@ -397,7 +395,7 @@ namespace MQTTnet.Server
             }
             catch (Exception exception)
             {
-                _logger.Error(exception, $"Error while validating client {channelAdapter.Endpoint}. {exception.Message}");
+                _logger.Error(exception, exception.Message);
             }
             finally
             {
@@ -614,17 +612,19 @@ namespace MQTTnet.Server
                     _sessions[connectPacket.ClientId] = session;
 
                     // Create a new client (always required).
-                    _clients.TryGetValue(connectPacket.ClientId, out oldClient);
-                    if (oldClient != null)
+                    lock (_clients)
                     {
-                        // This will stop the current client from sending and receiving but remains the connection active
-                        // for a later DISCONNECT packet.
-                        oldClient.IsTakenOver = true;
+                        _clients.TryGetValue(connectPacket.ClientId, out oldClient);
+                        if (oldClient != null)
+                        {
+                            // This will stop the current client from sending and receiving but remains the connection active
+                            // for a later DISCONNECT packet.
+                            oldClient.IsTakenOver = true;
+                        }
+
+                        client = CreateClient(connectPacket, channelAdapter, session);
+                        _clients[connectPacket.ClientId] = client;
                     }
-
-                    client = CreateClient(connectPacket, channelAdapter, session);
-
-                    _clients[connectPacket.ClientId] = client;
                 }
                 finally
                 {
@@ -719,11 +719,11 @@ namespace MQTTnet.Server
             return null;
         }
 
-        async Task<ValidatingConnectionEventArgs> ValidateConnection(MqttConnectPacket connectPacket, IMqttChannelAdapter channelAdapter, CancellationToken cancellationToken)
+        async Task<ValidatingConnectionEventArgs> ValidateConnection(MqttConnectPacket connectPacket, IMqttChannelAdapter channelAdapter)
         {
             // TODO: Load session items from persisted sessions in the future.
             var sessionItems = new ConcurrentDictionary<object, object>();
-            var eventArgs = new ValidatingConnectionEventArgs(connectPacket, channelAdapter, sessionItems, cancellationToken);
+            var eventArgs = new ValidatingConnectionEventArgs(connectPacket, channelAdapter, sessionItems);
             await _eventContainer.ValidatingConnectionEvent.InvokeAsync(eventArgs).ConfigureAwait(false);
 
             // Check the client ID and set a random one if supported.

Source/MQTTnet/Server/Internal/MqttServerEventContainer.cs

@@ -17,14 +17,11 @@ namespace MQTTnet.Server
 
         public AsyncEvent<ClientDisconnectedEventArgs> ClientDisconnectedEvent { get; } = new AsyncEvent<ClientDisconnectedEventArgs>();
 
-        public AsyncEvent<ClientReAuthenticatingEventArgs> ClientReAuthenticatingEvent { get; } = new AsyncEvent<ClientReAuthenticatingEventArgs>();
-
         public AsyncEvent<ClientSubscribedTopicEventArgs> ClientSubscribedTopicEvent { get; } = new AsyncEvent<ClientSubscribedTopicEventArgs>();
 
         public AsyncEvent<ClientUnsubscribedTopicEventArgs> ClientUnsubscribedTopicEvent { get; } = new AsyncEvent<ClientUnsubscribedTopicEventArgs>();
 
-        public AsyncEvent<InterceptingClientApplicationMessageEnqueueEventArgs> InterceptingClientEnqueueEvent { get; } =
-            new AsyncEvent<InterceptingClientApplicationMessageEnqueueEventArgs>();
+        public AsyncEvent<InterceptingClientApplicationMessageEnqueueEventArgs> InterceptingClientEnqueueEvent { get; } = new AsyncEvent<InterceptingClientApplicationMessageEnqueueEventArgs>();
 
         public AsyncEvent<InterceptingPacketEventArgs> InterceptingInboundPacketEvent { get; } = new AsyncEvent<InterceptingPacketEventArgs>();
 

Source/MQTTnet/Server/MqttServer.cs

@@ -73,12 +73,6 @@ namespace MQTTnet.Server
             remove => _eventContainer.ClientDisconnectedEvent.RemoveHandler(value);
         }
 
-        public event Func<ClientReAuthenticatingEventArgs, Task> ClientReAuthenticatingAsync
-        {
-            add => _eventContainer.ClientReAuthenticatingEvent.AddHandler(value);
-            remove => _eventContainer.ClientReAuthenticatingEvent.RemoveHandler(value);
-        }
-
         public event Func<ClientSubscribedTopicEventArgs, Task> ClientSubscribedTopicAsync
         {
             add => _eventContainer.ClientSubscribedTopicEvent.AddHandler(value);
@@ -206,7 +200,14 @@ namespace MQTTnet.Server
         {
             ThrowIfNotStarted();
 
-            return _clientSessionsManager.GetClientStatusesAsync();
+            return _clientSessionsManager.GetClientsStatus();
+        }
+
+        public Task<IList<MqttApplicationMessage>> GetRetainedMessagesAsync()
+        {
+            ThrowIfNotStarted();
+
+            return _retainedMessagesManager.GetMessages();
         }
 
         public Task<MqttApplicationMessage> GetRetainedMessageAsync(string topic)
@@ -221,18 +222,11 @@ namespace MQTTnet.Server
             return _retainedMessagesManager.GetMessage(topic);
         }
 
-        public Task<IList<MqttApplicationMessage>> GetRetainedMessagesAsync()
-        {
-            ThrowIfNotStarted();
-
-            return _retainedMessagesManager.GetMessages();
-        }
-
         public Task<IList<MqttSessionStatus>> GetSessionsAsync()
         {
             ThrowIfNotStarted();
 
-            return _clientSessionsManager.GetSessionStatusAsync();
+            return _clientSessionsManager.GetSessionsStatus();
         }
 
         public Task InjectApplicationMessage(InjectedMqttApplicationMessage injectedApplicationMessage, CancellationToken cancellationToken = default)
@@ -298,7 +292,7 @@ namespace MQTTnet.Server
 
                 _cancellationTokenSource.Cancel(false);
 
-                await _clientSessionsManager.CloseAllConnectionsAsync().ConfigureAwait(false);
+                await _clientSessionsManager.CloseAllConnections().ConfigureAwait(false);
 
                 foreach (var adapter in _adapters)
                 {