Add support for EdgeModules (#98)

* support edge modules * adding tests --------- Co-authored-by: rido-min <[email protected]>
iotmodels · Mar 6, 2023 · 2500b79 · 2500b79
1 parent 610a3a4
commit 2500b79
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 12 deletions.
diff --git a/samples/iothub-sample/Device.cs b/samples/iothub-sample/Device.cs
@@ -23,7 +23,7 @@ public Device(ILogger<Device> logger, IConfiguration configuration)
 
     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
     {
-        var connectionSettings = new ConnectionSettings(_configuration.GetConnectionString("cs"));
+        var connectionSettings = new ConnectionSettings(_configuration.GetConnectionString("csme"));
         _logger.LogWarning("Connecting to: {connectionSettings}", connectionSettings);
 
         var client = new HubMqttClient(await HubDpsFactory.CreateFromConnectionSettingsAsync(connectionSettings, stoppingToken));

diff --git a/src/MQTTnet.Extensions.MultiCloud/Connections/SasAuth.cs b/src/MQTTnet.Extensions.MultiCloud/Connections/SasAuth.cs
@@ -5,8 +5,18 @@ namespace MQTTnet.Extensions.MultiCloud.Connections;
 internal class SasAuth
 {
     private const string apiversion_2020_09_30 = "2020-09-30";
-    internal static string GetUserName(string hostName, string deviceId, string modelId = "") =>
-        $"{hostName}/{deviceId}/?api-version={apiversion_2020_09_30}&model-id={modelId}";
+    internal static string GetUserName(string hostName, string deviceId, string modelId = "", string gatewayHostName = "")
+    {
+        if (string.IsNullOrEmpty(gatewayHostName))
+        {
+            return $"{hostName}/{deviceId}/?api-version={apiversion_2020_09_30}&model-id={modelId}";
+        }
+        else
+        {
+            return $"{gatewayHostName}/{deviceId}/?api-version={apiversion_2020_09_30}&model-id={modelId}";
+        }
+
+    }
 
     internal static string Sign(string requestString, string key)
     {
@@ -21,10 +31,10 @@ internal static string CreateSasToken(string resource, string sasKey, int minute
         return $"SharedAccessSignature sr={resource}&sig={sig}&se={expiry}";
     }
 
-    internal static (string username, string password) GenerateHubSasCredentials(string hostName, string deviceId, string sasKey, string audience, string modelId, int minutes = 60)
+    internal static (string username, string password) GenerateHubSasCredentials(string hostName, string deviceId, string sasKey, string audience, string modelId, int minutes = 60, string gatewayHostName = "")
     {
-        string user = GetUserName(hostName, deviceId, modelId);
-        string pwd = CreateSasToken($"{audience}/devices/{deviceId}", sasKey, minutes);
+        string user = GetUserName(hostName, deviceId, modelId, gatewayHostName);
+        string pwd = CreateSasToken(audience, sasKey, minutes);
         return (user, pwd);
     }
 

diff --git a/src/MQTTnet.Extensions.MultiCloud/Connections/WithAzureIoTHubCredentials.cs b/src/MQTTnet.Extensions.MultiCloud/Connections/WithAzureIoTHubCredentials.cs
@@ -11,10 +11,15 @@ internal static MqttClientOptionsBuilder WithAzureIoTHubCredentials(this MqttCli
         string? hostName = cs!.HostName!;
         if (!string.IsNullOrEmpty(cs.GatewayHostName))
         {
-            hostName = cs.GatewayHostName;
+            //hostName = cs.GatewayHostName;
+            builder.WithTcpServer(cs.GatewayHostName, cs.TcpPort);
         }
+        else
+        {
+            builder.WithTcpServer(hostName, cs.TcpPort);
+        }    
+
 
-        builder.WithTcpServer(hostName, cs.TcpPort);
         if (cs?.Auth == AuthType.Sas)
         {
             if (string.IsNullOrEmpty(cs.ModuleId))
@@ -27,7 +32,7 @@ internal static MqttClientOptionsBuilder WithAzureIoTHubCredentials(this MqttCli
             }
 
             builder.WithTlsSettings(cs);
-            return builder.WithAzureIoTHubCredentialsSas(hostName, cs.DeviceId!, cs.ModuleId!, cs.HostName!, cs.SharedAccessKey!, cs.ModelId!, cs.SasMinutes);
+            return builder.WithAzureIoTHubCredentialsSas(hostName, cs.DeviceId!, cs.ModuleId!, cs.HostName!, cs.SharedAccessKey!, cs.ModelId!, cs.SasMinutes, cs.GatewayHostName!);
         }
         else if (cs?.Auth == AuthType.X509)
         {
@@ -54,14 +59,17 @@ internal static MqttClientOptionsBuilder WithAzureIoTHubCredentials(this MqttCli
         }
     }
 
-    public static MqttClientOptionsBuilder WithAzureIoTHubCredentialsSas(this MqttClientOptionsBuilder builder, string hostName, string deviceId, string moduleId, string audience, string sasKey, string modelId, int sasMinutes)
+    public static MqttClientOptionsBuilder WithAzureIoTHubCredentialsSas(this MqttClientOptionsBuilder builder, string hostName, string deviceId, string moduleId, string audience, string sasKey, string modelId, int sasMinutes, string gatewayHostName)
     {
         string target = deviceId;
         if (!string.IsNullOrEmpty(moduleId))
         {
             target = $"{deviceId}/{moduleId}";
+            audience = $"{hostName}/devices/{deviceId}/modules/{moduleId}";
         }
-        (string username, string password) = SasAuth.GenerateHubSasCredentials(hostName, target, sasKey, audience, modelId, sasMinutes);
+
+
+        (string username, string password) = SasAuth.GenerateHubSasCredentials(hostName, target, sasKey, audience, modelId, sasMinutes, gatewayHostName);
         builder.WithCredentials(username, password);
         return builder;
     }

diff --git a/tests/MQTTnet.Extensions.MultiCloud.IntegrationTests/IoTHubConnectionFixture.cs b/tests/MQTTnet.Extensions.MultiCloud.IntegrationTests/IoTHubConnectionFixture.cs
@@ -95,5 +95,24 @@ public async Task ModuleCert()
             Assert.True(client.IsConnected);
             await client.DisconnectAsync();
         }
+
+        [Fact(Skip ="Required edgeHub-local")]
+        public async Task ModuleSasUsingEdgeHub()
+        {
+            var cs = new ConnectionSettings()
+            {
+                HostName = "rido-edges.azure-devices.net",
+                DeviceId = "riduntu22",
+                ModuleId = "MyFilterModule",
+                SharedAccessKey = "xidAoWNigrri7dAV/NynNFvOCTTgyTjlUIGoHI6wxyk=",
+                GatewayHostName = "localhost"
+            };
+            var connAck = await client!.ConnectAsync(new MqttClientOptionsBuilder()
+                .WithConnectionSettings(cs)
+                .Build());
+            Assert.Equal(MqttClientConnectResultCode.Success, connAck.ResultCode);
+            Assert.True(client.IsConnected);
+            await client.DisconnectAsync();
+        }
     }
 }
diff --git a/tests/MQTTnet.Extensions.MultiCloud.UnitTests/BirthConventionFixture.cs b/tests/MQTTnet.Extensions.MultiCloud.UnitTests/BirthConventionFixture.cs
@@ -11,7 +11,7 @@ public void CanDeserialize()
             //var json = @"{""model-id"":""dtmi:rido:pnp:memmon;1"",""when"":""2022-09-11T16:28:38.1615346-07:00"",""status"":""offline""}";
             var json = @"{""model-id"":""dtmi:rido:pnp:sensehat;1"",""when"":""2023-02-08T08:39:40.9008917+00:00"",""status"":""online""}";
             BirthConvention.BirthMessage bm = Json.FromString<BirthConvention.BirthMessage>(json)!;
-            Assert.Equal(BirthConvention.ConnectionStatus.offline, bm.ConnectionStatus);
+            Assert.Equal(BirthConvention.ConnectionStatus.online, bm.ConnectionStatus);
         }
     }
 }