[SM-678] ClientSecret migration (#2943)

* Init ClientSecret migration

* Fix unit tests

* Move to src/Sql/dbo_future

* Formatting changes

* Update migration date for next release

* Swap to just executing sp_refreshview

* Fix formatting

* Add EF Migrations

* Rename to ClientSecretHash

* Fix unit test

* EF column rename

* Batch the migration

* Fix formatting

* Add deprecation notice to property

* Move data migration

* Swap to CREATE OR ALTER

util/Migrator/DbScripts/2023-05-16_00_ClientSecretHash.sql

@@ -0,0 +1,72 @@
+IF COL_LENGTH('[dbo].[ApiKey]', 'ClientSecretHash') IS NULL
+BEGIN
+  ALTER TABLE [dbo].[ApiKey]
+  ADD [ClientSecretHash] VARCHAR(128);
+END
+GO
+
+-- Refresh views
+IF OBJECT_ID('[dbo].[ApiKeyDetailsView]') IS NOT NULL
+    BEGIN
+        EXECUTE sp_refreshview N'[dbo].[ApiKeyDetailsView]';
+    END
+GO
+
+IF OBJECT_ID('[dbo].[ApiKeyView]') IS NOT NULL
+    BEGIN
+        EXECUTE sp_refreshview N'[dbo].[ApiKeyView]';
+    END
+GO
+
+CREATE OR ALTER PROCEDURE [dbo].[ApiKey_Create]
+    @Id UNIQUEIDENTIFIER OUTPUT,
+    @ServiceAccountId UNIQUEIDENTIFIER,
+    @Name VARCHAR(200),
+    @ClientSecret VARCHAR(30) = 'migrated', -- Deprecated as of 2023-05-17
+    @ClientSecretHash VARCHAR(128) = NULL,
+    @Scope NVARCHAR(4000),
+    @EncryptedPayload NVARCHAR(4000),
+    @Key VARCHAR(MAX),
+    @ExpireAt DATETIME2(7),
+    @CreationDate DATETIME2(7),
+    @RevisionDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    IF (@ClientSecretHash IS NULL)
+    BEGIN
+      DECLARE @hb VARBINARY(128) = HASHBYTES('SHA2_256', @ClientSecret);
+      SET @ClientSecretHash = CAST(N'' as xml).value('xs:base64Binary(sql:variable("@hb"))', 'VARCHAR(128)');
+    END
+
+    INSERT INTO [dbo].[ApiKey] 
+    (
+        [Id],
+        [ServiceAccountId],
+        [Name],
+        [ClientSecret],
+        [ClientSecretHash],
+        [Scope],
+        [EncryptedPayload],
+        [Key],
+        [ExpireAt],
+        [CreationDate],
+        [RevisionDate]
+    )
+    VALUES 
+    (
+        @Id,
+        @ServiceAccountId,
+        @Name,
+        @ClientSecret,
+        @ClientSecretHash,
+        @Scope,
+        @EncryptedPayload,
+        @Key,
+        @ExpireAt,
+        @CreationDate,
+        @RevisionDate
+    )
+END
+GO

util/Migrator/DbScripts_data_migration/2023-05-16_00_ClientSecretHashDataMigration.sql

@@ -0,0 +1,42 @@
+/*
+This is the data migration script for the client secret hash updates.
+The initial migration util/Migrator/DbScripts/2023-05-16_00_ClientSecretHash.sql should be run prior.
+The final migration is in util/Migrator/DbScripts_future/2023-06-FutureMigration.sql.
+*/
+IF COL_LENGTH('[dbo].[ApiKey]', 'ClientSecretHash') IS NOT NULL AND COL_LENGTH('[dbo].[ApiKey]', 'ClientSecret')  IS NOT NULL
+BEGIN
+
+  -- Add index
+  IF NOT EXISTS(SELECT name FROM sys.indexes WHERE name = 'IX_ApiKey_ClientSecretHash')
+  BEGIN
+   CREATE NONCLUSTERED INDEX [IX_ApiKey_ClientSecretHash] 
+   ON [dbo].[ApiKey]([ClientSecretHash] ASC)
+   WITH (ONLINE = ON)
+  END
+
+  -- Data Migration
+  DECLARE @BatchSize INT = 10000
+  WHILE @BatchSize > 0
+  BEGIN
+    BEGIN TRANSACTION Migrate_ClientSecretHash
+
+    UPDATE TOP(@BatchSize) [dbo].[ApiKey]
+    SET ClientSecretHash = (
+        SELECT CAST(N'' AS XML).value('xs:base64Binary(sql:column("HASH"))', 'VARCHAR(128)')
+        FROM (
+            SELECT HASHBYTES('SHA2_256', [ClientSecret]) AS HASH
+            ) SRC
+        )
+    WHERE [ClientSecretHash] IS NULL
+
+    SET @BatchSize = @@ROWCOUNT
+    
+    COMMIT TRANSACTION Migrate_ClientSecretHash
+  END
+
+  -- Drop index
+  DROP INDEX IF EXISTS [IX_ApiKey_ClientSecretHash]
+      ON [dbo].[ApiKey];
+
+END
+GO

util/Migrator/DbScripts_future/2023-06-FutureMigration.sql

@@ -0,0 +1,65 @@
+-- Remove Column
+IF COL_LENGTH('[dbo].[ApiKey]', 'ClientSecret') IS NOT NULL
+BEGIN
+    ALTER TABLE
+        [dbo].[ApiKey]
+    DROP COLUMN
+        [ClientSecret]
+END
+GO
+
+-- Refresh views
+IF OBJECT_ID('[dbo].[ApiKeyDetailsView]') IS NOT NULL
+    BEGIN
+        EXECUTE sp_refreshview N'[dbo].[ApiKeyDetailsView]';
+    END
+GO
+
+IF OBJECT_ID('[dbo].[ApiKeyView]') IS NOT NULL
+    BEGIN
+        EXECUTE sp_refreshview N'[dbo].[ApiKeyView]';
+    END
+GO
+
+CREATE OR ALTER PROCEDURE [dbo].[ApiKey_Create]
+    @Id UNIQUEIDENTIFIER OUTPUT,
+    @ServiceAccountId UNIQUEIDENTIFIER,
+    @Name VARCHAR(200),
+    @ClientSecretHash VARCHAR(128),
+    @Scope NVARCHAR(4000),
+    @EncryptedPayload NVARCHAR(4000),
+    @Key VARCHAR(MAX),
+    @ExpireAt DATETIME2(7),
+    @CreationDate DATETIME2(7),
+    @RevisionDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    INSERT INTO [dbo].[ApiKey] 
+    (
+        [Id],
+        [ServiceAccountId],
+        [Name],
+        [ClientSecretHash],
+        [Scope],
+        [EncryptedPayload],
+        [Key],
+        [ExpireAt],
+        [CreationDate],
+        [RevisionDate]
+    )
+    VALUES 
+    (
+        @Id,
+        @ServiceAccountId,
+        @Name,
+        @ClientSecretHash,
+        @Scope,
+        @EncryptedPayload,
+        @Key,
+        @ExpireAt,
+        @CreationDate,
+        @RevisionDate
+    )
+END