Sso user table, model and repo stubbed out (#837)

* Sso user table, model and repo stubbed out

* switch to nullable org id, bigint id

* update GetBySsoUserAsync

* cleanup migrator file

* fix EF user repo

* fix pg repo

* is `IS NULL` checks

* unique indexes

* update migration scripts

* add another unique index

* remove old script

src/Core/Models/Table/SsoUser.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace Bit.Core.Models.Table
+{
+    public class SsoUser : ITableObject<long>
+    {
+        public long Id { get; set; }
+        public Guid UserId { get; set; }
+        public Guid? OrganizationId { get; set; }
+        public string ExternalId { get; set; }
+        public DateTime CreationDate { get; internal set; } = DateTime.UtcNow;
+
+        public void SetNewId()
+        {
+            // nothing - int will be auto-populated
+        }
+    }
+}

src/Core/Repositories/EntityFramework/UserRepository.cs

@@ -8,6 +8,7 @@ using Microsoft.EntityFrameworkCore;
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Extensions.DependencyInjection;
+using Bit.Core.Models.Table;
 
 namespace Bit.Core.Repositories.EntityFramework
 {
@@ -122,5 +123,10 @@ namespace Bit.Core.Repositories.EntityFramework
                 await dbContext.SaveChangesAsync();
             }
         }
+
+        public Task<User> GetBySsoUserAsync(string externalId, Guid? organizationId)
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/Core/Repositories/ISsoUserRepository.cs

@@ -0,0 +1,8 @@
+using Bit.Core.Models.Table;
+
+namespace Bit.Core.Repositories
+{
+    public interface ISsoUserRepository : IRepository<SsoUser, long>
+    {
+    }
+}

src/Core/Repositories/IUserRepository.cs

@@ -9,6 +9,7 @@ namespace Bit.Core.Repositories
     public interface IUserRepository : IRepository<User, Guid>
     {
         Task<User> GetByEmailAsync(string email);
+        Task<User> GetBySsoUserAsync(string externalId, Guid? organizationId);
         Task<UserKdfInformation> GetKdfInformationByEmailAsync(string email);
         Task<ICollection<User>> SearchAsync(string email, int skip, int take);
         Task<ICollection<User>> GetManyByPremiumAsync(bool premium);

src/Core/Repositories/PostgreSql/UserRepository.cs

@@ -155,5 +155,10 @@ namespace Bit.Core.Repositories.PostgreSql
                     commandType: CommandType.StoredProcedure);
             }
         }
+
+        public Task<User> GetBySsoUserAsync(string externalId, Guid? organizationId)
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/Core/Repositories/SqlServer/SsoUserRepository.cs

@@ -0,0 +1,15 @@
+using Bit.Core.Models.Table;
+
+namespace Bit.Core.Repositories.SqlServer
+{
+    public class SsoUserRepository : Repository<SsoUser, long>, ISsoUserRepository
+    {
+        public SsoUserRepository(GlobalSettings globalSettings)
+            : this(globalSettings.SqlServer.ConnectionString, globalSettings.SqlServer.ReadOnlyConnectionString)
+        { }
+
+        public SsoUserRepository(string connectionString, string readOnlyConnectionString)
+            : base(connectionString, readOnlyConnectionString)
+        { }
+    }
+}

src/Core/Repositories/SqlServer/UserRepository.cs

@@ -38,6 +38,19 @@ namespace Bit.Core.Repositories.SqlServer
             }
         }
 
+        public async Task<User> GetBySsoUserAsync(string externalId, Guid? organizationId)
+        {
+            using (var connection = new SqlConnection(ConnectionString))
+            {
+                var results = await connection.QueryAsync<User>(
+                    $"[{Schema}].[{Table}_ReadBySsoUserOrganizationIdExternalId]",
+                    new { OrganizationId = organizationId, ExternalId = externalId },
+                    commandType: CommandType.StoredProcedure);
+
+                return results.SingleOrDefault();
+            }
+        }
+
         public async Task<UserKdfInformation> GetKdfInformationByEmailAsync(string email)
         {
             using (var connection = new SqlConnection(ConnectionString))

src/Core/Utilities/ServiceCollectionExtensions.cs

@@ -74,6 +74,7 @@ namespace Bit.Core.Utilities
                 services.AddSingleton<ITransactionRepository, SqlServerRepos.TransactionRepository>();
                 services.AddSingleton<IPolicyRepository, SqlServerRepos.PolicyRepository>();
                 services.AddSingleton<ISsoConfigRepository, SqlServerRepos.SsoConfigRepository>();
+                services.AddSingleton<ISsoUserRepository, SqlServerRepos.SsoUserRepository>();
             }
 
             if (globalSettings.SelfHosted)

src/Sql/Sql.sqlproj

@@ -269,5 +269,11 @@
     <Build Include="dbo\Stored Procedures\Policy_ReadByUserId.sql" />
     <Build Include="dbo\Stored Procedures\Cipher_Restore.sql" />
     <Build Include="dbo\Stored Procedures\Cipher_SoftDelete.sql" />
+    <Build Include="dbo\Tables\SsoUser.sql" />
+    <Build Include="dbo\Stored Procedures\SsoUser_Delete.sql" />
+    <Build Include="dbo\Stored Procedures\SsoUser_Create.sql" />
+    <Build Include="dbo\Stored Procedures\User_ReadBySsoUserOrganizationIdExternalId.sql" />
+    <Build Include="dbo\Stored Procedures\SsoUser_Update.sql" />
+    <Build Include="dbo\Stored Procedures\SsoUser_ReadById.sql" />
   </ItemGroup>
 </Project>

src/Sql/dbo/Stored Procedures/SsoUser_Create.sql

@@ -0,0 +1,27 @@
+CREATE PROCEDURE [dbo].[SsoUser_Create]
+    @Id BIGINT OUTPUT,
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50),
+    @CreationDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    INSERT INTO [dbo].[SsoUser]
+    (
+        [UserId],
+        [OrganizationId],
+        [ExternalId],
+        [CreationDate]
+    )
+    VALUES
+    (
+        @UserId,
+        @OrganizationId,
+        @ExternalId,
+        @CreationDate
+    )
+
+    SET @Id = SCOPE_IDENTITY();
+END

src/Sql/dbo/Stored Procedures/SsoUser_Delete.sql

@@ -0,0 +1,14 @@
+CREATE PROCEDURE [dbo].[SsoUser_Delete]
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    DELETE
+    FROM
+        [dbo].[SsoUser]
+    WHERE
+        [UserId] = @UserId
+        AND [OrganizationId] = @OrganizationId
+END

src/Sql/dbo/Stored Procedures/SsoUser_ReadById.sql

@@ -0,0 +1,13 @@
+CREATE PROCEDURE [dbo].[SsoUser_ReadById]
+    @Id BIGINT
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    SELECT
+        *
+    FROM
+        [dbo].[SsoUserView]
+    WHERE
+        [Id] = @Id
+END

src/Sql/dbo/Stored Procedures/SsoUser_Update.sql

@@ -0,0 +1,20 @@
+CREATE PROCEDURE [dbo].[SsoUser_Update]
+    @Id BIGINT OUTPUT,
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50),
+    @CreationDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    UPDATE
+        [dbo].[SsoUser]
+    SET
+        [UserId] = @UserId,
+        [OrganizationId] = @OrganizationId,
+        [ExternalId] = @ExternalId,
+        [CreationDate] = @CreationDate
+    WHERE
+        [Id] = @Id
+END

src/Sql/dbo/Stored Procedures/User_ReadBySsoUserOrganizationIdExternalId.sql

@@ -0,0 +1,20 @@
+CREATE PROCEDURE [dbo].[User_ReadBySsoUserOrganizationIdExternalId]
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    SELECT
+        U.*
+    FROM
+        [dbo].[UserView] U
+    INNER JOIN
+        [dbo].[SsoUser] SU ON SU.[UserId] = U.[Id]
+    WHERE
+        (
+            (@OrganizationId IS NULL AND SU.[OrganizationId] IS NULL)
+            OR (@OrganizationId IS NOT NULL AND SU.[OrganizationId] = @OrganizationId)
+        )
+        AND SU.[ExternalId] = @ExternalId
+END

src/Sql/dbo/Tables/SsoUser.sql

@@ -0,0 +1,22 @@
+CREATE TABLE [dbo].[SsoUser] (
+    [Id]                BIGINT           IDENTITY (1, 1) NOT NULL,
+    [UserId]            UNIQUEIDENTIFIER NOT NULL,
+    [OrganizationId]    UNIQUEIDENTIFIER NULL,
+    [ExternalId]        NVARCHAR(50)     NOT NULL,
+    [CreationDate]      DATETIME2 (7)    NOT NULL,
+    CONSTRAINT [PK_SsoUser] PRIMARY KEY CLUSTERED ([Id] ASC),
+    CONSTRAINT [FK_SsoUser_User] FOREIGN KEY ([UserId]) REFERENCES [dbo].[User] ([Id]) ON DELETE CASCADE,
+    CONSTRAINT [FK_SsoUser_Organization] FOREIGN KEY ([OrganizationId]) REFERENCES [dbo].[Organization] ([Id])
+);
+
+
+GO
+CREATE UNIQUE NONCLUSTERED INDEX [IX_SsoUser_OrganizationIdExternalId]
+    ON [dbo].[SsoUser]([OrganizationId] ASC, [ExternalId] ASC)
+    INCLUDE ([UserId]);
+
+GO
+CREATE UNIQUE NONCLUSTERED INDEX [IX_SsoUser_OrganizationIdUserId]
+    ON [dbo].[SsoUser]([OrganizationId] ASC, [UserId] ASC);
+
+

util/Migrator/DbScripts/2020-07-27_00_SsoUser.sql

@@ -0,0 +1,155 @@
+IF OBJECT_ID('[dbo].[SsoUser]') IS NULL
+BEGIN
+    CREATE TABLE [dbo].[SsoUser] (
+        [Id]                BIGINT           IDENTITY (1, 1) NOT NULL,
+        [UserId]            UNIQUEIDENTIFIER NOT NULL,
+        [OrganizationId]    UNIQUEIDENTIFIER NULL,
+        [ExternalId]        NVARCHAR(50)     NOT NULL,
+        [CreationDate]      DATETIME2 (7)    NOT NULL,
+        CONSTRAINT [PK_SsoUser] PRIMARY KEY CLUSTERED ([Id] ASC),
+        CONSTRAINT [FK_SsoUser_User] FOREIGN KEY ([UserId]) REFERENCES [dbo].[User] ([Id]) ON DELETE CASCADE,
+        CONSTRAINT [FK_SsoUser_Organization] FOREIGN KEY ([OrganizationId]) REFERENCES [dbo].[Organization] ([Id])
+    );
+
+    CREATE UNIQUE NONCLUSTERED INDEX [IX_SsoUser_OrganizationIdExternalId]
+        ON [dbo].[SsoUser]([OrganizationId] ASC, [ExternalId] ASC)
+        INCLUDE ([UserId]);
+
+    CREATE UNIQUE NONCLUSTERED INDEX [IX_SsoUser_OrganizationIdUserId]
+        ON [dbo].[SsoUser]([OrganizationId] ASC, [UserId] ASC);
+END
+GO
+
+IF OBJECT_ID('[dbo].[SsoUser_ReadById]') IS NOT NULL
+BEGIN
+    DROP PROCEDURE [dbo].[SsoUser_ReadById]
+END
+GO
+
+CREATE PROCEDURE [dbo].[SsoUser_ReadById]
+    @Id BIGINT
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    SELECT
+        *
+    FROM
+        [dbo].[SsoUserView]
+    WHERE
+        [Id] = @Id
+END
+GO
+
+IF OBJECT_ID('[dbo].[SsoUser_Create]') IS NOT NULL
+BEGIN
+    DROP PROCEDURE [dbo].[SsoUser_Create]
+END
+GO
+
+CREATE PROCEDURE [dbo].[SsoUser_Create]
+    @Id BIGINT OUTPUT,
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50),
+    @CreationDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    INSERT INTO [dbo].[SsoUser]
+    (
+        [UserId],
+        [OrganizationId],
+        [ExternalId],
+        [CreationDate]
+    )
+    VALUES
+    (
+        @UserId,
+        @OrganizationId,
+        @ExternalId,
+        @CreationDate
+    )
+
+    SET @Id = SCOPE_IDENTITY();
+END
+GO
+
+IF OBJECT_ID('[dbo].[SsoUser_Update]') IS NOT NULL
+BEGIN
+    DROP PROCEDURE [dbo].[SsoUser_Update]
+END
+GO
+
+CREATE PROCEDURE [dbo].[SsoUser_Update]
+    @Id BIGINT OUTPUT,
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50),
+    @CreationDate DATETIME2(7)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    UPDATE
+        [dbo].[SsoUser]
+    SET
+        [UserId] = @UserId,
+        [OrganizationId] = @OrganizationId,
+        [ExternalId] = @ExternalId,
+        [CreationDate] = @CreationDate
+    WHERE
+        [Id] = @Id
+END
+GO
+
+IF OBJECT_ID('[dbo].[SsoUser_Delete]') IS NOT NULL
+BEGIN
+    DROP PROCEDURE [dbo].[SsoUser_Delete]
+END
+GO
+
+CREATE PROCEDURE [dbo].[SsoUser_Delete]
+    @UserId UNIQUEIDENTIFIER,
+    @OrganizationId UNIQUEIDENTIFIER
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    DELETE
+    FROM
+        [dbo].[SsoUser]
+    WHERE
+        [UserId] = @UserId
+        AND [OrganizationId] = @OrganizationId
+END
+GO
+
+IF OBJECT_ID('[dbo].[User_ReadBySsoUserOrganizationIdExternalId]') IS NOT NULL
+BEGIN
+    DROP PROCEDURE [dbo].[User_ReadBySsoUserOrganizationIdExternalId]
+END
+GO
+
+CREATE PROCEDURE [dbo].[User_ReadBySsoUserOrganizationIdExternalId]
+    @OrganizationId UNIQUEIDENTIFIER,
+    @ExternalId NVARCHAR(50)
+AS
+BEGIN
+    SET NOCOUNT ON
+
+    SELECT
+        U.*
+    FROM
+        [dbo].[UserView] U
+    INNER JOIN
+        [dbo].[SsoUser] SU ON SU.[UserId] = U.[Id]
+    WHERE
+        (
+            (@OrganizationId IS NULL AND SU.[OrganizationId] IS NULL)
+            OR (@OrganizationId IS NOT NULL AND SU.[OrganizationId] = @OrganizationId)
+        )
+        AND SU.[ExternalId] = @ExternalId
+END
+GO