From 2c4752f4ace1c5013254b5030cffa86bcc32430a Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Tue, 28 Jul 2020 10:03:09 -0400 Subject: [PATCH] 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 | 18 ++ .../EntityFramework/UserRepository.cs | 6 + src/Core/Repositories/ISsoUserRepository.cs | 8 + src/Core/Repositories/IUserRepository.cs | 1 + .../Repositories/PostgreSql/UserRepository.cs | 5 + .../SqlServer/SsoUserRepository.cs | 15 ++ .../Repositories/SqlServer/UserRepository.cs | 13 ++ .../Utilities/ServiceCollectionExtensions.cs | 1 + src/Sql/Sql.sqlproj | 6 + .../dbo/Stored Procedures/SsoUser_Create.sql | 27 +++ .../dbo/Stored Procedures/SsoUser_Delete.sql | 14 ++ .../Stored Procedures/SsoUser_ReadById.sql | 13 ++ .../dbo/Stored Procedures/SsoUser_Update.sql | 20 +++ ..._ReadBySsoUserOrganizationIdExternalId.sql | 20 +++ src/Sql/dbo/Tables/SsoUser.sql | 22 +++ .../DbScripts/2020-07-27_00_SsoUser.sql | 155 ++++++++++++++++++ 16 files changed, 344 insertions(+) create mode 100644 src/Core/Models/Table/SsoUser.cs create mode 100644 src/Core/Repositories/ISsoUserRepository.cs create mode 100644 src/Core/Repositories/SqlServer/SsoUserRepository.cs create mode 100644 src/Sql/dbo/Stored Procedures/SsoUser_Create.sql create mode 100644 src/Sql/dbo/Stored Procedures/SsoUser_Delete.sql create mode 100644 src/Sql/dbo/Stored Procedures/SsoUser_ReadById.sql create mode 100644 src/Sql/dbo/Stored Procedures/SsoUser_Update.sql create mode 100644 src/Sql/dbo/Stored Procedures/User_ReadBySsoUserOrganizationIdExternalId.sql create mode 100644 src/Sql/dbo/Tables/SsoUser.sql create mode 100644 util/Migrator/DbScripts/2020-07-27_00_SsoUser.sql diff --git a/src/Core/Models/Table/SsoUser.cs b/src/Core/Models/Table/SsoUser.cs new file mode 100644 index 0000000000..da4e38528e --- /dev/null +++ b/src/Core/Models/Table/SsoUser.cs @@ -0,0 +1,18 @@ +using System; + +namespace Bit.Core.Models.Table +{ + public class SsoUser : ITableObject + { + 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 + } + } +} diff --git a/src/Core/Repositories/EntityFramework/UserRepository.cs b/src/Core/Repositories/EntityFramework/UserRepository.cs index 4d19428bdc..936ab975b1 100644 --- a/src/Core/Repositories/EntityFramework/UserRepository.cs +++ b/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 GetBySsoUserAsync(string externalId, Guid? organizationId) + { + throw new NotImplementedException(); + } } } diff --git a/src/Core/Repositories/ISsoUserRepository.cs b/src/Core/Repositories/ISsoUserRepository.cs new file mode 100644 index 0000000000..6a3f0bee27 --- /dev/null +++ b/src/Core/Repositories/ISsoUserRepository.cs @@ -0,0 +1,8 @@ +using Bit.Core.Models.Table; + +namespace Bit.Core.Repositories +{ + public interface ISsoUserRepository : IRepository + { + } +} diff --git a/src/Core/Repositories/IUserRepository.cs b/src/Core/Repositories/IUserRepository.cs index 61c57a3af2..46f7523025 100644 --- a/src/Core/Repositories/IUserRepository.cs +++ b/src/Core/Repositories/IUserRepository.cs @@ -9,6 +9,7 @@ namespace Bit.Core.Repositories public interface IUserRepository : IRepository { Task GetByEmailAsync(string email); + Task GetBySsoUserAsync(string externalId, Guid? organizationId); Task GetKdfInformationByEmailAsync(string email); Task> SearchAsync(string email, int skip, int take); Task> GetManyByPremiumAsync(bool premium); diff --git a/src/Core/Repositories/PostgreSql/UserRepository.cs b/src/Core/Repositories/PostgreSql/UserRepository.cs index f65b80dff5..02df0938e5 100644 --- a/src/Core/Repositories/PostgreSql/UserRepository.cs +++ b/src/Core/Repositories/PostgreSql/UserRepository.cs @@ -155,5 +155,10 @@ namespace Bit.Core.Repositories.PostgreSql commandType: CommandType.StoredProcedure); } } + + public Task GetBySsoUserAsync(string externalId, Guid? organizationId) + { + throw new NotImplementedException(); + } } } diff --git a/src/Core/Repositories/SqlServer/SsoUserRepository.cs b/src/Core/Repositories/SqlServer/SsoUserRepository.cs new file mode 100644 index 0000000000..007fbcaf81 --- /dev/null +++ b/src/Core/Repositories/SqlServer/SsoUserRepository.cs @@ -0,0 +1,15 @@ +using Bit.Core.Models.Table; + +namespace Bit.Core.Repositories.SqlServer +{ + public class SsoUserRepository : Repository, ISsoUserRepository + { + public SsoUserRepository(GlobalSettings globalSettings) + : this(globalSettings.SqlServer.ConnectionString, globalSettings.SqlServer.ReadOnlyConnectionString) + { } + + public SsoUserRepository(string connectionString, string readOnlyConnectionString) + : base(connectionString, readOnlyConnectionString) + { } + } +} diff --git a/src/Core/Repositories/SqlServer/UserRepository.cs b/src/Core/Repositories/SqlServer/UserRepository.cs index 43a0c19911..e02c11e59e 100644 --- a/src/Core/Repositories/SqlServer/UserRepository.cs +++ b/src/Core/Repositories/SqlServer/UserRepository.cs @@ -38,6 +38,19 @@ namespace Bit.Core.Repositories.SqlServer } } + public async Task GetBySsoUserAsync(string externalId, Guid? organizationId) + { + using (var connection = new SqlConnection(ConnectionString)) + { + var results = await connection.QueryAsync( + $"[{Schema}].[{Table}_ReadBySsoUserOrganizationIdExternalId]", + new { OrganizationId = organizationId, ExternalId = externalId }, + commandType: CommandType.StoredProcedure); + + return results.SingleOrDefault(); + } + } + public async Task GetKdfInformationByEmailAsync(string email) { using (var connection = new SqlConnection(ConnectionString)) diff --git a/src/Core/Utilities/ServiceCollectionExtensions.cs b/src/Core/Utilities/ServiceCollectionExtensions.cs index bb3485a15f..4ffa54b862 100644 --- a/src/Core/Utilities/ServiceCollectionExtensions.cs +++ b/src/Core/Utilities/ServiceCollectionExtensions.cs @@ -74,6 +74,7 @@ namespace Bit.Core.Utilities services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); + services.AddSingleton(); } if (globalSettings.SelfHosted) diff --git a/src/Sql/Sql.sqlproj b/src/Sql/Sql.sqlproj index 1fcaf8afa4..ee4fd6978e 100644 --- a/src/Sql/Sql.sqlproj +++ b/src/Sql/Sql.sqlproj @@ -269,5 +269,11 @@ + + + + + + \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/SsoUser_Create.sql b/src/Sql/dbo/Stored Procedures/SsoUser_Create.sql new file mode 100644 index 0000000000..6979a10ae2 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/SsoUser_Delete.sql b/src/Sql/dbo/Stored Procedures/SsoUser_Delete.sql new file mode 100644 index 0000000000..77fb74c50e --- /dev/null +++ b/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 \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/SsoUser_ReadById.sql b/src/Sql/dbo/Stored Procedures/SsoUser_ReadById.sql new file mode 100644 index 0000000000..fbca19bf15 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/SsoUser_Update.sql b/src/Sql/dbo/Stored Procedures/SsoUser_Update.sql new file mode 100644 index 0000000000..facbc44572 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/User_ReadBySsoUserOrganizationIdExternalId.sql b/src/Sql/dbo/Stored Procedures/User_ReadBySsoUserOrganizationIdExternalId.sql new file mode 100644 index 0000000000..cb1644c9df --- /dev/null +++ b/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 \ No newline at end of file diff --git a/src/Sql/dbo/Tables/SsoUser.sql b/src/Sql/dbo/Tables/SsoUser.sql new file mode 100644 index 0000000000..f6477f56c2 --- /dev/null +++ b/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); + + diff --git a/util/Migrator/DbScripts/2020-07-27_00_SsoUser.sql b/util/Migrator/DbScripts/2020-07-27_00_SsoUser.sql new file mode 100644 index 0000000000..9f15a9e221 --- /dev/null +++ b/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