Added UserName property to various Server EventArgs. (#2123)

* Added UserName property to various Server EventArgs.

* InjectedMqttApplicationMessage: Add SenderUserName property.

* Reformat code

* Reformat code

---------

Co-authored-by: christian <6939810+chkr1011@users.noreply.github.com>

Source/MQTTnet.Server/Events/ClientAcknowledgedPublishPacketEventArgs.cs

@@ -10,9 +10,10 @@ namespace MQTTnet.Server
 {
     public sealed class ClientAcknowledgedPublishPacketEventArgs : EventArgs
     {
-        public ClientAcknowledgedPublishPacketEventArgs(string clientId, IDictionary sessionItems, MqttPublishPacket publishPacket, MqttPacketWithIdentifier acknowledgePacket)
+        public ClientAcknowledgedPublishPacketEventArgs(string clientId, string userName, IDictionary sessionItems, MqttPublishPacket publishPacket, MqttPacketWithIdentifier acknowledgePacket)
         {
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
+            UserName = userName;
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
             PublishPacket = publishPacket ?? throw new ArgumentNullException(nameof(publishPacket));
             AcknowledgePacket = acknowledgePacket ?? throw new ArgumentNullException(nameof(acknowledgePacket));
@@ -28,6 +29,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets whether the PUBLISH packet is fully acknowledged. This is the case for PUBACK (QoS 1) and PUBCOMP (QoS 2.
         /// </summary>

Source/MQTTnet.Server/Events/ClientConnectedEventArgs.cs

@@ -6,6 +6,7 @@ using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Net;
+using System.Text;
 using MQTTnet.Formatter;
 using MQTTnet.Packets;
 
@@ -56,6 +57,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string UserName => _connectPacket.Username;
 
+        /// <summary>
+        ///     Gets the password of the connected client.
+        /// </summary>
+        public string Password => Encoding.UTF8.GetString(_connectPacket.Password.AsSpan());
+
         /// <summary>
         ///     Gets the user properties sent by the client.
         ///     <remarks>MQTT 5.0.0+ feature.</remarks>

Source/MQTTnet.Server/Events/ClientDisconnectedEventArgs.cs

@@ -6,6 +6,7 @@ using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Net;
+using System.Text;
 using MQTTnet.Packets;
 using MQTTnet.Protocol;
 
@@ -13,20 +14,21 @@ namespace MQTTnet.Server
 {
     public sealed class ClientDisconnectedEventArgs : EventArgs
     {
+        readonly MqttConnectPacket _connectPacket;
         readonly MqttDisconnectPacket _disconnectPacket;
 
         public ClientDisconnectedEventArgs(
-            string clientId,
+            MqttConnectPacket connectPacket,
             MqttDisconnectPacket disconnectPacket,
             MqttClientDisconnectType disconnectType,
             EndPoint remoteEndPoint,
             IDictionary sessionItems)
         {
-            ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
             DisconnectType = disconnectType;
             RemoteEndPoint = remoteEndPoint;
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
 
+            _connectPacket = connectPacket;
             // The DISCONNECT packet can be null in case of a non clean disconnect or session takeover.
             _disconnectPacket = disconnectPacket;
         }
@@ -35,7 +37,17 @@ namespace MQTTnet.Server
         ///     Gets the client identifier.
         ///     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 user name of the client.
+        /// </summary>
+        public string UserName => _connectPacket.Username;
+
+        /// <summary>
+        ///     Gets the password of the client.
+        /// </summary>
+        public string Password => Encoding.UTF8.GetString(_connectPacket.Password.AsSpan());
 
         public MqttClientDisconnectType DisconnectType { get; }
 

Source/MQTTnet.Server/Events/ClientSubscribedTopicEventArgs.cs

@@ -10,9 +10,10 @@ namespace MQTTnet.Server
 {
     public sealed class ClientSubscribedTopicEventArgs : EventArgs
     {
-        public ClientSubscribedTopicEventArgs(string clientId, MqttTopicFilter topicFilter, IDictionary sessionItems)
+        public ClientSubscribedTopicEventArgs(string clientId, string userName, MqttTopicFilter topicFilter, IDictionary sessionItems)
         {
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
+            UserName = userName;
             TopicFilter = topicFilter ?? throw new ArgumentNullException(nameof(topicFilter));
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
         }
@@ -23,6 +24,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets or sets a key/value collection that can be used to share data within the scope of this session.
         /// </summary>

Source/MQTTnet.Server/Events/ClientUnsubscribedTopicEventArgs.cs

@@ -9,9 +9,10 @@ namespace MQTTnet.Server
 {
     public sealed class ClientUnsubscribedTopicEventArgs : EventArgs
     {
-        public ClientUnsubscribedTopicEventArgs(string clientId, string topicFilter, IDictionary sessionItems)
+        public ClientUnsubscribedTopicEventArgs(string clientId, string userName, string topicFilter, IDictionary sessionItems)
         {
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
+            UserName = userName;
             TopicFilter = topicFilter ?? throw new ArgumentNullException(nameof(topicFilter));
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
         }
@@ -22,6 +23,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets or sets a key/value collection that can be used to share data within the scope of this session.
         /// </summary>

Source/MQTTnet.Server/Events/InterceptingPacketEventArgs.cs

@@ -12,10 +12,11 @@ namespace MQTTnet.Server
 {
     public sealed class InterceptingPacketEventArgs : EventArgs
     {
-        public InterceptingPacketEventArgs(CancellationToken cancellationToken, string clientId, EndPoint remoteEndPoint, MqttPacket packet, IDictionary sessionItems)
+        public InterceptingPacketEventArgs(CancellationToken cancellationToken, string clientId, string userName, EndPoint remoteEndPoint, MqttPacket packet, IDictionary sessionItems)
         {
             CancellationToken = cancellationToken;
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
+            UserName = userName;
             RemoteEndPoint = remoteEndPoint;
             Packet = packet ?? throw new ArgumentNullException(nameof(packet));
             SessionItems = sessionItems;
@@ -32,6 +33,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets the endpoint of the sending or receiving client.
         /// </summary>

Source/MQTTnet.Server/Events/InterceptingPublishEventArgs.cs

@@ -10,11 +10,12 @@ namespace MQTTnet.Server
 {
     public sealed class InterceptingPublishEventArgs : EventArgs
     {
-        public InterceptingPublishEventArgs(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken, string clientId, IDictionary sessionItems)
+        public InterceptingPublishEventArgs(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken, string clientId, string userName, IDictionary sessionItems)
         {
             ApplicationMessage = applicationMessage ?? throw new ArgumentNullException(nameof(applicationMessage));
             CancellationToken = cancellationToken;
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
+            UserName = userName;
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
         }
 
@@ -31,6 +32,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         public bool CloseConnection { get; set; }
 
         /// <summary>

Source/MQTTnet.Server/Events/InterceptingSubscriptionEventArgs.cs

@@ -15,12 +15,14 @@ namespace MQTTnet.Server
         public InterceptingSubscriptionEventArgs(
             CancellationToken cancellationToken,
             string clientId,
+            string userName,
             MqttSessionStatus session,
             MqttTopicFilter topicFilter,
             List<MqttUserProperty> userProperties)
         {
             CancellationToken = cancellationToken;
             ClientId = clientId;
+            UserName = userName;
             Session = session;
             TopicFilter = topicFilter;
             UserProperties = userProperties;
@@ -37,6 +39,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets or sets whether the broker should close the client connection.
         /// </summary>

Source/MQTTnet.Server/Events/InterceptingUnsubscriptionEventArgs.cs

@@ -12,10 +12,11 @@ namespace MQTTnet.Server
 {
     public sealed class InterceptingUnsubscriptionEventArgs : EventArgs
     {
-        public InterceptingUnsubscriptionEventArgs(CancellationToken cancellationToken, string clientId, IDictionary sessionItems, string topic, List<MqttUserProperty> userProperties)
+        public InterceptingUnsubscriptionEventArgs(CancellationToken cancellationToken, string clientId, string userName, IDictionary sessionItems, string topic, List<MqttUserProperty> userProperties)
         {
             CancellationToken = cancellationToken;
             ClientId = clientId;
+            UserName = userName;
             SessionItems = sessionItems;
             Topic = topic;
             UserProperties = userProperties;
@@ -32,6 +33,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string ClientId { get; }
 
+        /// <summary>
+        /// Gets the user name of the client.
+        /// </summary>
+        public string UserName { get; } 
+
         /// <summary>
         ///     Gets or sets whether the broker should close the client connection.
         /// </summary>

Source/MQTTnet.Server/Events/SessionDeletedEventArgs.cs

@@ -9,9 +9,10 @@ namespace MQTTnet.Server
 {
     public sealed class SessionDeletedEventArgs : EventArgs
     {
-        public SessionDeletedEventArgs(string id, IDictionary sessionItems)
+        public SessionDeletedEventArgs(string id, string userName, IDictionary sessionItems)
         {
             Id = id ?? throw new ArgumentNullException(nameof(id));
+            UserName = userName;
             SessionItems = sessionItems ?? throw new ArgumentNullException(nameof(sessionItems));
         }
 
@@ -20,6 +21,11 @@ namespace MQTTnet.Server
         /// </summary>
         public string Id { get; }
 
+        /// <summary>
+        /// Gets the user name of the session.
+        /// </summary>
+        public string UserName { get; }
+
         /// <summary>
         ///     Gets or sets a key/value collection that can be used to share data within the scope of this session.
         /// </summary>