[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/Request/OrganizationTwoFactorDuoRequestModelTests.cs
+++ b/test/Api.Test/Auth/Models/Request/OrganizationTwoFactorDuoRequestModelTests.cs
@ -0,0 +1,121 @@
+using Bit.Api.Auth.Models.Request;
+using Bit.Core.AdminConsole.Entities;
+using Bit.Core.Auth.Enums;
+using Bit.Core.Auth.Models;
+using Xunit;
+
+namespace Bit.Api.Test.Auth.Models.Request;
+
+public class OrganizationTwoFactorDuoRequestModelTests
+{
+
+    [Fact]
+    public void ShouldAddOrUpdateTwoFactorProvider_WhenExistingProviderDoesNotExist()
+    {
+        // Arrange
+        var existingOrg = new Organization();
+        var model = new UpdateTwoFactorDuoRequestModel
+        {
+            ClientId = "clientId",
+            ClientSecret = "clientSecret",
+            IntegrationKey = "integrationKey",
+            SecretKey = "secretKey",
+            Host = "example.com"
+        };
+
+        // Act
+        var result = model.ToOrganization(existingOrg);
+
+        // Assert
+        Assert.True(result.GetTwoFactorProviders().ContainsKey(TwoFactorProviderType.OrganizationDuo));
+        Assert.Equal("clientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientId"]);
+        Assert.Equal("clientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientSecret"]);
+        Assert.Equal("clientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["IKey"]);
+        Assert.Equal("clientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["SKey"]);
+        Assert.Equal("example.com", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["Host"]);
+        Assert.True(result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].Enabled);
+    }
+
+    [Fact]
+    public void ShouldUpdateTwoFactorProvider_WhenExistingProviderExists()
+    {
+        // Arrange
+        var existingOrg = new Organization();
+        existingOrg.SetTwoFactorProviders(new Dictionary<TwoFactorProviderType, TwoFactorProvider>
+        {
+            { TwoFactorProviderType.OrganizationDuo, new TwoFactorProvider() }
+        });
+        var model = new UpdateTwoFactorDuoRequestModel
+        {
+            ClientId = "newClientId",
+            ClientSecret = "newClientSecret",
+            IntegrationKey = "newIntegrationKey",
+            SecretKey = "newSecretKey",
+            Host = "newExample.com"
+        };
+
+        // Act
+        var result = model.ToOrganization(existingOrg);
+
+        // Assert
+        Assert.True(result.GetTwoFactorProviders().ContainsKey(TwoFactorProviderType.OrganizationDuo));
+        Assert.Equal("newClientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientId"]);
+        Assert.Equal("newClientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientSecret"]);
+        Assert.Equal("newClientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["IKey"]);
+        Assert.Equal("newClientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["SKey"]);
+        Assert.Equal("newExample.com", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["Host"]);
+        Assert.True(result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].Enabled);
+    }
+
+    [Fact]
+    public void DuoV2ParamsSync_WhenExistingProviderDoesNotExist()
+    {
+        // Arrange
+        var existingOrg = new Organization();
+        var model = new UpdateTwoFactorDuoRequestModel
+        {
+            IntegrationKey = "integrationKey",
+            SecretKey = "secretKey",
+            Host = "example.com"
+        };
+
+        // Act
+        var result = model.ToOrganization(existingOrg);
+
+        // Assert
+        // IKey and SKey should be the same as ClientId and ClientSecret
+        Assert.True(result.GetTwoFactorProviders().ContainsKey(TwoFactorProviderType.OrganizationDuo));
+        Assert.Equal("integrationKey", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientId"]);
+        Assert.Equal("secretKey", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientSecret"]);
+        Assert.Equal("integrationKey", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["IKey"]);
+        Assert.Equal("secretKey", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["SKey"]);
+        Assert.Equal("example.com", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["Host"]);
+        Assert.True(result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].Enabled);
+    }
+
+    [Fact]
+    public void DuoV4ParamsSync_WhenExistingProviderDoesNotExist()
+    {
+        // Arrange
+        var existingOrg = new Organization();
+        var model = new UpdateTwoFactorDuoRequestModel
+        {
+            ClientId = "clientId",
+            ClientSecret = "clientSecret",
+            Host = "example.com"
+        };
+
+        // Act
+        var result = model.ToOrganization(existingOrg);
+
+        // Assert
+        // IKey and SKey should be the same as ClientId and ClientSecret
+        Assert.True(result.GetTwoFactorProviders().ContainsKey(TwoFactorProviderType.OrganizationDuo));
+        Assert.Equal("clientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientId"]);
+        Assert.Equal("clientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["ClientSecret"]);
+        Assert.Equal("clientId", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["IKey"]);
+        Assert.Equal("clientSecret", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["SKey"]);
+        Assert.Equal("example.com", result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].MetaData["Host"]);
+        Assert.True(result.GetTwoFactorProviders()[TwoFactorProviderType.OrganizationDuo].Enabled);
+    }
+}