[PM-5216] User and Organization Duo Request and Response Model refactor (#4126)

* inital changes * add provider GatewayType migrations * db provider migrations * removed duo migrations added v2 metadata to duo response * removed helper scripts * remove signature from org duo * added backward compatibility for Duo v2 * added tests for duo request + response models * refactors to TwoFactorController * updated test methods to be compartmentalized by usage * fix organization add duo * Assert.Empty() fix for validator
2025-06-30 15:42:48 -05:00 · 2024-06-05 11:42:02 -07:00
parent a0a7654077
commit 97b3f3e7ee
19 changed files with 8504 additions and 55 deletions
--- a/test/Api.Test/Auth/Models/Response/OrganizationTwoFactorDuoResponseModelTests.cs
+++ b/test/Api.Test/Auth/Models/Response/OrganizationTwoFactorDuoResponseModelTests.cs
@ -0,0 +1,107 @@
+
+using Bit.Api.Auth.Models.Response.TwoFactor;
+using Bit.Core.AdminConsole.Entities;
+using Bit.Test.Common.AutoFixture.Attributes;
+using Xunit;
+
+namespace Bit.Api.Test.Auth.Models.Response;
+
+public class OrganizationTwoFactorDuoResponseModelTests
+{
+    [Theory]
+    [BitAutoData]
+    public void Organization_WithDuoV4_ShouldBuildModel(Organization organization)
+    {
+        // Arrange
+        organization.TwoFactorProviders = GetTwoFactorOrganizationDuoV4ProvidersJson();
+
+        // Act
+        var model = new TwoFactorDuoResponseModel(organization);
+
+        // Assert if v4 data Ikey and Skey are set to clientId and clientSecret
+        Assert.NotNull(model);
+        Assert.Equal("clientId", model.ClientId);
+        Assert.Equal("clientSecret", model.ClientSecret);
+        Assert.Equal("clientId", model.IntegrationKey);
+        Assert.Equal("clientSecret", model.SecretKey);
+    }
+
+    [Theory]
+    [BitAutoData]
+    public void Organization_WithDuoV2_ShouldBuildModel(Organization organization)
+    {
+        // Arrange
+        organization.TwoFactorProviders = GetTwoFactorOrganizationDuoV2ProvidersJson();
+
+        // Act
+        var model = new TwoFactorDuoResponseModel(organization);
+
+        // Assert if only v2 data clientId and clientSecret are set to Ikey and Sk
+        Assert.NotNull(model);
+        Assert.Equal("IKey", model.ClientId);
+        Assert.Equal("SKey", model.ClientSecret);
+        Assert.Equal("IKey", model.IntegrationKey);
+        Assert.Equal("SKey", model.SecretKey);
+    }
+
+    [Theory]
+    [BitAutoData]
+    public void Organization_WithDuo_ShouldBuildModel(Organization organization)
+    {
+        // Arrange
+        organization.TwoFactorProviders = GetTwoFactorOrganizationDuoProvidersJson();
+
+        // Act
+        var model = new TwoFactorDuoResponseModel(organization);
+
+        /// Assert Even if both versions are present priority is given to v4 data
+        Assert.NotNull(model);
+        Assert.Equal("clientId", model.ClientId);
+        Assert.Equal("clientSecret", model.ClientSecret);
+        Assert.Equal("clientId", model.IntegrationKey);
+        Assert.Equal("clientSecret", model.SecretKey);
+    }
+
+    [Theory]
+    [BitAutoData]
+    public void Organization_WithDuoEmpty_ShouldFail(Organization organization)
+    {
+        // Arrange
+        organization.TwoFactorProviders = "{\"6\" : {}}";
+
+        // Act
+        var model = new TwoFactorDuoResponseModel(organization);
+
+        /// Assert
+        Assert.False(model.Enabled);
+    }
+
+    [Theory]
+    [BitAutoData]
+    public void Organization_WithTwoFactorProvidersNull_ShouldFail(Organization organization)
+    {
+        // Arrange
+        organization.TwoFactorProviders = "{\"6\" : {}}";
+
+        // Act
+        var model = new TwoFactorDuoResponseModel(organization);
+
+        /// Assert
+        Assert.False(model.Enabled);
+    }
+
+    private string GetTwoFactorOrganizationDuoProvidersJson()
+    {
+        return "{\"6\":{\"Enabled\":true,\"MetaData\":{\"SKey\":\"SKey\",\"IKey\":\"IKey\",\"ClientSecret\":\"clientSecret\",\"ClientId\":\"clientId\",\"Host\":\"example.com\"}}}";
+    }
+
+    private string GetTwoFactorOrganizationDuoV4ProvidersJson()
+    {
+        return "{\"6\":{\"Enabled\":true,\"MetaData\":{\"ClientSecret\":\"clientSecret\",\"ClientId\":\"clientId\",\"Host\":\"example.com\"}}}";
+    }
+
+    private string GetTwoFactorOrganizationDuoV2ProvidersJson()
+    {
+        return "{\"6\":{\"Enabled\":true,\"MetaData\":{\"SKey\":\"SKey\",\"IKey\":\"IKey\",\"Host\":\"example.com\"}}}";
+    }
+}