Add Support to JWT Authentication

README.md

@@ -68,6 +68,7 @@ Follow the instructions in the [Prerequisites](#magic_wand-prerequisites) to con
 | Scenario | Description | dotnet | C | python | go |
 | -------- | ------------|--------|---|------- | -- |
 | [Getting Started](./scenarios/getting_started/) | This quick start scenario simulates basic MQTT tasks.| ✓| ✓| ✓| ✓ |
+| [JWT Authentication](./scenarios/jwt_authentication/)  | This is a quick start scenario that authenticates to Azure Event Grid using Json Web Tokens (JWT) |  ✓| soon| soon| soon |
 | [Telemetry](./scenarios/telemetry/)  | This scenario simulates multiple clients (the producers) sending data to a different set of topics to be consumed by a single application (the consumer). | ✓| ✓| ✓| soon | 
 | [Command](./scenarios/command/)  | This scenario simulates the request-response messaging pattern using MQTT v5.  | ✓| ✓ | soon | soon |
 | [Alert](./scenarios/alert/)  | This scenario simulates a fan-out use case where multiple clients receive a singlemessage from the same topic.  |  ✓| soon| soon| soon |

Samples.sln

@@ -33,6 +33,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "command_client", "scenarios
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "command_server", "scenarios\command\dotnet\command_server\command_server.csproj", "{02032E52-AF7C-4EA2-A6A9-18AF88346B1E}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "jwt_authentication", "scenarios\jwt_authentication\dotnet\jwt_authentication\jwt_authentication.csproj", "{58C793B7-59BD-455E-AA8B-D23A8AB49EBC}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -83,6 +85,10 @@ Global
 		{02032E52-AF7C-4EA2-A6A9-18AF88346B1E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{02032E52-AF7C-4EA2-A6A9-18AF88346B1E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{02032E52-AF7C-4EA2-A6A9-18AF88346B1E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{58C793B7-59BD-455E-AA8B-D23A8AB49EBC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{58C793B7-59BD-455E-AA8B-D23A8AB49EBC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{58C793B7-59BD-455E-AA8B-D23A8AB49EBC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{58C793B7-59BD-455E-AA8B-D23A8AB49EBC}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

mqttclients/dotnet/MQTTnet.Client.Extensions.Tests/MqttConnectionSettingsFixture.cs

@@ -1,144 +1,144 @@
-namespace MQTTnet.Extensions.MultiCloud.UnitTests;
-
-public class MqttConnectionSettingsFixture
-{
-    [Fact]
-    public void DefaultValues()
-    {
-        var dcs = new MqttConnectionSettings("localhost");
-        Assert.Equal("localhost", dcs.HostName);
-        Assert.Equal(30, dcs.KeepAliveInSeconds);
-        Assert.Equal(AuthType.Basic, dcs.Auth);
-        Assert.Equal(8883, dcs.TcpPort);
-        Assert.False(dcs.DisableCrl);
-        Assert.True(dcs.UseTls);
-        Assert.Equal("HostName=localhost;TcpPort=8883;CleanSession=True;KeepAliveInSeconds=30;UseTls=True;Auth=Basic", dcs.ToString());
-    }
-
-    [Fact]
-    public void ParseConnectionString()
-    {
-        string cs = "HostName=<hostname>;ClientId=<clientId>";
-        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
-        Assert.Equal("<hostname>", dcs.HostName);
-        Assert.Equal("<clientId>", dcs.ClientId);
-    }
-
-    [Fact]
-    public void InvalidValuesDontUseDefaults()
-    {
-        string cs = "HostName=<hostname>;KeepAliveInSeconds=invalid_string";
-        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
-        Assert.Equal("<hostname>", dcs.HostName);
-        Assert.Equal(30, dcs.KeepAliveInSeconds);
-    }
-
-
-    [Fact]
-    public void ParseConnectionStringWithDefaultValues()
-    {
-        string cs = "HostName=<hubname>.azure-devices.net";
-        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
-        Assert.Equal("<hubname>.azure-devices.net", dcs.HostName);
-        Assert.Equal(30, dcs.KeepAliveInSeconds);
-        Assert.Equal(8883, dcs.TcpPort);
-        Assert.Empty(dcs.ClientId!);
-        Assert.True(dcs.UseTls);
-        Assert.False(dcs.DisableCrl);
-    }
-
-    [Fact]
-    public void ParseConnectionStringWithAllValues()
-    {
-        string cs = """
-                     HostName=<hubname>.azure-devices.net;
-                     ClientId=<ClientId>;
-                     CertFile=<certFile>;
-                     KeyFile=<keyFile>;
-                     TcpPort=1234;
-                     UseTls=false;
-                     CaFile=<path>;
-                     DisableCrl=true;
-                     UserName=<usr>;
-                     Password=<pwd>
-                     """.ReplaceLineEndings(String.Empty);
-
-        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
-        Assert.Equal("<hubname>.azure-devices.net", dcs.HostName);
-        Assert.Equal("<ClientId>", dcs.ClientId);
-        Assert.Equal("<certFile>", dcs.CertFile);
-        Assert.Equal("<keyFile>", dcs.KeyFile);
-        Assert.Equal(1234, dcs.TcpPort);
-        Assert.False(dcs.UseTls);
-        Assert.Equal("<path>", dcs.CaFile);
-        Assert.True(dcs.DisableCrl);
-        Assert.Equal("<usr>", dcs.Username);
-        Assert.Equal("<pwd>", dcs.Password);
-    }
-
-    [Fact]
-    public void ToStringReturnConnectionString()
-    {
-        MqttConnectionSettings dcs = new("h");
-        string expected = "HostName=h;TcpPort=8883;CleanSession=True;KeepAliveInSeconds=30;UseTls=True;Auth=Basic";
-        Assert.Equal(expected, dcs.ToString());
-    }
-
-    [Fact]
-    public void CreateFromEnvFile_WithAllSettings()
-    {
-        var cs = MqttConnectionSettings.CreateFromEnvVars("all_settings.txt");
-        Assert.Equal("localhost", cs.HostName);
-        Assert.Equal(2883, cs.TcpPort);
-        Assert.False(cs.UseTls);
-        Assert.False(cs.CleanSession);
-        Assert.Equal(32, cs.KeepAliveInSeconds);
-        Assert.Equal("sample_client", cs.ClientId);
-        Assert.Equal("sample_user", cs.Username);
-        Assert.Equal("foo", cs.Password);
-        Assert.Equal("ca.pem", cs.CaFile);
-        Assert.Equal("cert.pem", cs.CertFile);
-        Assert.Equal("cert.key", cs.KeyFile);
-        Assert.Equal("bar", cs.KeyFilePassword);
-        RemoveTestEnvVars("all_settings.txt");
-    }
-
-    [Fact]
+namespace MQTTnet.Extensions.MultiCloud.UnitTests;
+
+public class MqttConnectionSettingsFixture
+{
+    [Fact]
+    public void DefaultValues()
+    {
+        var dcs = new MqttConnectionSettings("localhost");
+        Assert.Equal("localhost", dcs.HostName);
+        Assert.Equal(30, dcs.KeepAliveInSeconds);
+        Assert.Equal(AuthType.Basic, dcs.Auth);
+        Assert.Equal(8883, dcs.TcpPort);
+        Assert.False(dcs.DisableCrl);
+        Assert.True(dcs.UseTls);
+        Assert.Equal("HostName=localhost;TcpPort=8883;CleanSession=True;KeepAliveInSeconds=30;UseTls=True;Auth=Basic", dcs.ToString());
+    }
+
+    [Fact]
+    public void ParseConnectionString()
+    {
+        string cs = "HostName=<hostname>;ClientId=<clientId>";
+        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
+        Assert.Equal("<hostname>", dcs.HostName);
+        Assert.Equal("<clientId>", dcs.ClientId);
+    }
+
+    [Fact]
+    public void InvalidValuesDontUseDefaults()
+    {
+        string cs = "HostName=<hostname>;KeepAliveInSeconds=invalid_string";
+        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
+        Assert.Equal("<hostname>", dcs.HostName);
+        Assert.Equal(30, dcs.KeepAliveInSeconds);
+    }
+
+
+    [Fact]
+    public void ParseConnectionStringWithDefaultValues()
+    {
+        string cs = "HostName=<hubname>.azure-devices.net";
+        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
+        Assert.Equal("<hubname>.azure-devices.net", dcs.HostName);
+        Assert.Equal(30, dcs.KeepAliveInSeconds);
+        Assert.Equal(8883, dcs.TcpPort);
+        Assert.Empty(dcs.ClientId!);
+        Assert.True(dcs.UseTls);
+        Assert.False(dcs.DisableCrl);
+    }
+
+    [Fact]
+    public void ParseConnectionStringWithAllValues()
+    {
+        string cs = """
+                     HostName=<hubname>.azure-devices.net;
+                     ClientId=<ClientId>;
+                     CertFile=<certFile>;
+                     KeyFile=<keyFile>;
+                     TcpPort=1234;
+                     UseTls=false;
+                     CaFile=<path>;
+                     DisableCrl=true;
+                     UserName=<usr>;
+                     Password=<pwd>
+                     """.ReplaceLineEndings(String.Empty);
+
+        MqttConnectionSettings dcs = MqttConnectionSettings.FromConnectionString(cs);
+        Assert.Equal("<hubname>.azure-devices.net", dcs.HostName);
+        Assert.Equal("<ClientId>", dcs.ClientId);
+        Assert.Equal("<certFile>", dcs.CertFile);
+        Assert.Equal("<keyFile>", dcs.KeyFile);
+        Assert.Equal(1234, dcs.TcpPort);
+        Assert.False(dcs.UseTls);
+        Assert.Equal("<path>", dcs.CaFile);
+        Assert.True(dcs.DisableCrl);
+        Assert.Equal("<usr>", dcs.Username);
+        Assert.Equal("<pwd>", dcs.Password);
+    }
+
+    [Fact]
+    public void ToStringReturnConnectionString()
+    {
+        MqttConnectionSettings dcs = new("h");
+        string expected = "HostName=h;TcpPort=8883;CleanSession=True;KeepAliveInSeconds=30;UseTls=True;Auth=Basic";
+        Assert.Equal(expected, dcs.ToString());
+    }
+
+    [Fact]
+    public void CreateFromEnvFile_WithAllSettings()
+    {
+        var cs = MqttConnectionSettings.CreateFromEnvVars("all_settings.txt");
+        Assert.Equal("localhost", cs.HostName);
+        Assert.Equal(2883, cs.TcpPort);
+        Assert.False(cs.UseTls);
+        Assert.False(cs.CleanSession);
+        Assert.Equal(32, cs.KeepAliveInSeconds);
+        Assert.Equal("sample_client", cs.ClientId);
+        Assert.Equal("sample_user", cs.Username);
+        Assert.Equal("foo", cs.Password);
+        Assert.Equal("ca.pem", cs.CaFile);
+        Assert.Equal("cert.pem", cs.CertFile);
+        Assert.Equal("cert.key", cs.KeyFile);
+        Assert.Equal("bar", cs.KeyFilePassword);
+        RemoveTestEnvVars("all_settings.txt");
+    }
+
+    [Fact]
     public void CreateFromEnvFile_WithInvalidTypes()
     {
         Action act = () => MqttConnectionSettings.CreateFromEnvVars("invalid_type_settings.txt");
         Assert.Throws<ArgumentException>(act);
-    }
-
-    [Fact]
-    public void CreateFromEnvFile_Defaults()
-    {
-        var cs = MqttConnectionSettings.CreateFromEnvVars("min_settings.txt");
-        Assert.Equal("localhost", cs.HostName);
-        Assert.Equal(8883, cs.TcpPort);
-        Assert.True(cs.UseTls);
-        Assert.False(cs.CleanSession);
-        Assert.Equal(30, cs.KeepAliveInSeconds);
-        Assert.Empty(cs.ClientId!);
-        Assert.Empty(cs.Username!);
-        Assert.Empty(cs.Password!);
-        Assert.Empty(cs.CaFile!);
-        Assert.Empty(cs.CertFile!);
-        Assert.Empty(cs.KeyFile!);
-        Assert.Empty(cs.KeyFilePassword!);
-    }
-
-    private void RemoveTestEnvVars(string envFile)
-    {
-        foreach (var line in File.ReadAllLines(envFile))
-        {
-            var parts = line.Split('=', StringSplitOptions.RemoveEmptyEntries);
-            if (parts.Length != 2)
-            {
-                continue;
-            }
-
-            Environment.SetEnvironmentVariable(parts[0], null);
-        }
-    }
-}
+    }
+
+    [Fact]
+    public void CreateFromEnvFile_Defaults()
+    {
+        var cs = MqttConnectionSettings.CreateFromEnvVars("min_settings.txt");
+        Assert.Equal("localhost", cs.HostName);
+        Assert.Equal(8883, cs.TcpPort);
+        Assert.True(cs.UseTls);
+        Assert.False(cs.CleanSession);
+        Assert.Equal(30, cs.KeepAliveInSeconds);
+        Assert.Empty(cs.ClientId!);
+        Assert.Empty(cs.Username!);
+        Assert.Empty(cs.Password!);
+        Assert.Empty(cs.CaFile!);
+        Assert.Empty(cs.CertFile!);
+        Assert.Empty(cs.KeyFile!);
+        Assert.Empty(cs.KeyFilePassword!);
+    }
+
+    private void RemoveTestEnvVars(string envFile)
+    {
+        foreach (var line in File.ReadAllLines(envFile))
+        {
+            var parts = line.Split('=', StringSplitOptions.RemoveEmptyEntries);
+            if (parts.Length != 2)
+            {
+                continue;
+            }
+
+            Environment.SetEnvironmentVariable(parts[0], null);
+        }
+    }
+}

mqttclients/dotnet/MQTTnet.Client.Extensions/MQTTnet.Client.Extensions.csproj

@@ -5,7 +5,8 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
-	<ItemGroup>
-		<PackageReference Include="MQTTnet" Version="4.3.2.930" />
-	</ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="MQTTnet" Version="4.3.2.930" />
+  </ItemGroup>
 </Project>

mqttclients/dotnet/MQTTnet.Client.Extensions/WithJWT.cs

@@ -0,0 +1,40 @@
+using System.Diagnostics;
+
+namespace MQTTnet.Client.Extensions
+{
+    public static partial class MqttNetExtensions
+    {
+        static Func<byte[]> _getTokenCallBack = null!;
+        static Timer _refreshTimer = null!;
+
+
+        public static MqttClientOptionsBuilder WithJWT(this MqttClientOptionsBuilder builder, MqttConnectionSettings cs, Func<byte[]> getTokenCallBack, IMqttClient mqttClient, TimeSpan refreshPeriod)
+        {
+            _getTokenCallBack = getTokenCallBack;
+
+            builder
+                .WithConnectionSettings(cs)
+                .WithAuthentication("OAUTH2-JWT", getTokenCallBack());
+
+            _refreshTimer = new Timer(RefreshToken, mqttClient, 0, Convert.ToInt32(refreshPeriod.TotalMilliseconds));
+            return builder;
+        }
+
+        static void RefreshToken(object? state)
+        {
+            IMqttClient mqttClient = (MqttClient)state!;
+            if (mqttClient.IsConnected)
+            {
+                Task.Run(async () =>
+                {
+                    await mqttClient.SendExtendedAuthenticationExchangeDataAsync(
+                        new MqttExtendedAuthenticationExchangeData()
+                        {
+                            AuthenticationData = _getTokenCallBack(),
+                            ReasonCode = MQTTnet.Protocol.MqttAuthenticateReasonCode.ReAuthenticate
+                        });
+                });
+            }
+        }
+    }
+}