Families for enterprise/split up organization sponsorship service (#1875)

* Split OrganizationSponsorshipService into commands

* Use tokenable for token validation

* Use interfaces to set up for DI

* Use commands over services

* Move service tests to command tests

* Value types can't be null

* Run dotnet format

* Update src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/CancelSponsorshipCommand.cs

Co-authored-by: Justin Baur <admin@justinbaur.com>

* Fix controller tests

* Split create and send sponsorships

* Split up create sponsorship

* Add self hosted commands to dependency injection

* Add field to store cloud billing sync key on self host instances

* Fix typo

* Fix data protector purpose of sponsorship offers

* Split cloud and selfhosted sponsorship offer tokenable

* Generate offer from self hosted with all necessary auth data

* Add Required properties to constructor

* Split up cancel sponsorship command

* Split revoke sponsorship command between cloud and self hosted

* Fix/f4e multiple sponsorships (#1838)

* Use sponosorship from validate to redeem

* Update tests

* Format

* Remove sponsorship service

* Run dotnet format

* Fix self hosted only controller attribute

* Clean up file structure and fixes

* Remove unneeded tokenables

* Remove obsolete commands

* Do not require file/class prefix if unnecessary

* Update Organizaiton sprocs

* Remove unnecessary models

* Fix tests

* Generalize LicenseService path calculation

Use async file read and deserialization

* Use interfaces for testability

* Remove unused usings

* Correct test direction

* Test license reading

* remove unused usings

* Format

Co-authored-by: Justin Baur <admin@justinbaur.com>

Author: MGibson1

src/Api/Controllers/OrganizationSponsorshipsController.cs

@@ -21,10 +21,10 @@ public class OrganizationSponsorshipsController : Controller
         private readonly IOrganizationRepository _organizationRepository;
         private readonly IOrganizationUserRepository _organizationUserRepository;
         private readonly IValidateRedemptionTokenCommand _validateRedemptionTokenCommand;
-        private readonly IOfferSponsorshipCommand _offerSponsorshipCommand;
-        private readonly IResendSponsorshipOfferCommand _resendSponsorshipOfferCommand;
+        private readonly ICreateSponsorshipCommand _createSponsorshipCommand;
+        private readonly ISendSponsorshipOfferCommand _sendSponsorshipOfferCommand;
         private readonly ISetUpSponsorshipCommand _setUpSponsorshipCommand;
-        private readonly IRevokeSponsorshipCommand _revokeSponsorshipCommand;
+        private readonly ICloudRevokeSponsorshipCommand _revokeSponsorshipCommand;
         private readonly IRemoveSponsorshipCommand _removeSponsorshipCommand;
         private readonly ICurrentContext _currentContext;
         private readonly IUserService _userService;
@@ -34,10 +34,10 @@ public OrganizationSponsorshipsController(
             IOrganizationRepository organizationRepository,
             IOrganizationUserRepository organizationUserRepository,
             IValidateRedemptionTokenCommand validateRedemptionTokenCommand,
-            IOfferSponsorshipCommand offerSponsorshipCommand,
-            IResendSponsorshipOfferCommand resendSponsorshipOfferCommand,
+            ICreateSponsorshipCommand offerSponsorshipCommand,
+            ISendSponsorshipOfferCommand sendSponsorshipOfferCommand,
             ISetUpSponsorshipCommand setUpSponsorshipCommand,
-            IRevokeSponsorshipCommand revokeSponsorshipCommand,
+            ICloudRevokeSponsorshipCommand revokeSponsorshipCommand,
             IRemoveSponsorshipCommand removeSponsorshipCommand,
             IUserService userService,
             ICurrentContext currentContext)
@@ -46,8 +46,8 @@ public OrganizationSponsorshipsController(
             _organizationRepository = organizationRepository;
             _organizationUserRepository = organizationUserRepository;
             _validateRedemptionTokenCommand = validateRedemptionTokenCommand;
-            _offerSponsorshipCommand = offerSponsorshipCommand;
-            _resendSponsorshipOfferCommand = resendSponsorshipOfferCommand;
+            _createSponsorshipCommand = offerSponsorshipCommand;
+            _sendSponsorshipOfferCommand = sendSponsorshipOfferCommand;
             _setUpSponsorshipCommand = setUpSponsorshipCommand;
             _revokeSponsorshipCommand = revokeSponsorshipCommand;
             _removeSponsorshipCommand = removeSponsorshipCommand;
@@ -59,11 +59,11 @@ public OrganizationSponsorshipsController(
         [SelfHosted(NotSelfHostedOnly = true)]
         public async Task CreateSponsorship(Guid sponsoringOrgId, [FromBody] OrganizationSponsorshipRequestModel model)
         {
-            await _offerSponsorshipCommand.OfferSponsorshipAsync(
+            var sponsorship = await _createSponsorshipCommand.CreateSponsorshipAsync(
                 await _organizationRepository.GetByIdAsync(sponsoringOrgId),
                 await _organizationUserRepository.GetByOrganizationAsync(sponsoringOrgId, _currentContext.UserId ?? default),
-                model.PlanSponsorshipType, model.SponsoredEmail, model.FriendlyName,
-                (await CurrentUser).Email);
+                model.PlanSponsorshipType, model.SponsoredEmail, model.FriendlyName);
+            await _sendSponsorshipOfferCommand.SendSponsorshipOfferAsync(sponsorship, (await CurrentUser).Email);
         }
 
         [HttpPost("{sponsoringOrgId}/families-for-enterprise/resend")]
@@ -73,7 +73,7 @@ public async Task ResendSponsorshipOffer(Guid sponsoringOrgId)
             var sponsoringOrgUser = await _organizationUserRepository
                 .GetByOrganizationAsync(sponsoringOrgId, _currentContext.UserId ?? default);
 
-            await _resendSponsorshipOfferCommand.ResendSponsorshipOfferAsync(
+            await _sendSponsorshipOfferCommand.SendSponsorshipOfferAsync(
                 await _organizationRepository.GetByIdAsync(sponsoringOrgId),
                 sponsoringOrgUser,
                 await _organizationSponsorshipRepository

src/Api/Controllers/SelfHosted/SelfHostedOrganizationSponsorshipsController.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Threading.Tasks;
+using Bit.Api.Models.Request.Organizations;
+using Bit.Core.Context;
+using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Interfaces;
+using Bit.Core.Repositories;
+using Bit.Core.Utilities;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Bit.Api.Controllers.SelfHosted
+{
+    [Route("organization/sponsorship/self-hosted")]
+    [Authorize("Application")]
+    [SelfHosted(SelfHostedOnly = true)]
+    public class SelfHostedOrganizationSponsorshipsController : Controller
+    {
+        private readonly IOrganizationRepository _organizationRepository;
+        private readonly IOrganizationUserRepository _organizationUserRepository;
+        private readonly IOrganizationSponsorshipRepository _organizationSponsorshipRepository;
+        private readonly ICreateSponsorshipCommand _offerSponsorshipCommand;
+        private readonly ISelfHostedRevokeSponsorshipCommand _revokeSponsorshipCommand;
+        private readonly ICurrentContext _currentContext;
+
+        public SelfHostedOrganizationSponsorshipsController(
+            ICreateSponsorshipCommand offerSponsorshipCommand,
+            ISelfHostedRevokeSponsorshipCommand revokeSponsorshipCommand,
+            IOrganizationRepository organizationRepository,
+            IOrganizationSponsorshipRepository organizationSponsorshipRepository,
+            IOrganizationUserRepository organizationUserRepository,
+            ICurrentContext currentContext
+        )
+        {
+            _offerSponsorshipCommand = offerSponsorshipCommand;
+            _revokeSponsorshipCommand = revokeSponsorshipCommand;
+            _organizationRepository = organizationRepository;
+            _organizationSponsorshipRepository = organizationSponsorshipRepository;
+            _organizationUserRepository = organizationUserRepository;
+            _currentContext = currentContext;
+        }
+
+        [HttpPost("{sponsoringOrgId}/families-for-enterprise")]
+        public async Task CreateSponsorship(Guid sponsoringOrgId, [FromBody] OrganizationSponsorshipRequestModel model)
+        {
+            await _offerSponsorshipCommand.CreateSponsorshipAsync(
+                await _organizationRepository.GetByIdAsync(sponsoringOrgId),
+                await _organizationUserRepository.GetByOrganizationAsync(sponsoringOrgId, _currentContext.UserId ?? default),
+                model.PlanSponsorshipType, model.SponsoredEmail, model.FriendlyName);
+        }
+
+        [HttpDelete("{sponsoringOrgId}")]
+        [HttpPost("{sponsoringOrgId}/delete")]
+        public async Task RevokeSponsorship(Guid sponsoringOrganizationId)
+        {
+            var orgUser = await _organizationUserRepository.GetByOrganizationAsync(sponsoringOrganizationId, _currentContext.UserId ?? default);
+
+            var existingOrgSponsorship = await _organizationSponsorshipRepository
+                .GetBySponsoringOrganizationUserIdAsync(orgUser.Id);
+
+            await _revokeSponsorshipCommand.RevokeSponsorshipAsync(existingOrgSponsorship);
+        }
+    }
+}

src/Core/Entities/Organization.cs

@@ -70,6 +70,8 @@ public class Organization : ITableObject<Guid>, ISubscriber, IStorable, IStorabl
         public DateTime RevisionDate { get; set; } = DateTime.UtcNow;
         public int? MaxAutoscaleSeats { get; set; } = null;
         public DateTime? OwnersNotifiedOfAutoscaling { get; set; } = null;
+        [MaxLength(30)]
+        public string CloudBillingSyncKey { get; set; }
 
         public void SetNewId()
         {

src/Core/Models/Business/OrganizationLicense.cs

@@ -209,7 +209,7 @@ public bool CanUse(IGlobalSettings globalSettings)
             }
         }
 
-        public bool VerifyData(Organization organization, GlobalSettings globalSettings)
+        public bool VerifyData(Organization organization, IGlobalSettings globalSettings)
         {
             if (Issued > DateTime.UtcNow || Expires < DateTime.UtcNow)
             {

src/Core/Models/Business/Tokenables/OrganizationSponsorshipOfferTokenable.cs

@@ -9,27 +9,23 @@ namespace Bit.Core.Models.Business.Tokenables
     public class OrganizationSponsorshipOfferTokenable : Tokenable
     {
         public const string ClearTextPrefix = "BWOrganizationSponsorship_";
-        public const string DataProtectorPurpose = "EmergencyAccessServiceDataProtector";
+        public const string DataProtectorPurpose = "OrganizationSponsorshipDataProtector";
         public const string TokenIdentifier = "OrganizationSponsorshipOfferToken";
         public string Identifier { get; set; } = TokenIdentifier;
         public Guid Id { get; set; }
         public PlanSponsorshipType SponsorshipType { get; set; }
         public string Email { get; set; }
 
-        public override bool Valid => Identifier == TokenIdentifier && Id != default &&
-            !string.IsNullOrWhiteSpace(Email);
+        public override bool Valid => !string.IsNullOrWhiteSpace(Email) &&
+            Identifier == TokenIdentifier &&
+            Id != default;
+
 
         [JsonConstructor]
         public OrganizationSponsorshipOfferTokenable() { }
 
         public OrganizationSponsorshipOfferTokenable(OrganizationSponsorship sponsorship)
         {
-            if (sponsorship.Id == default)
-            {
-                throw new ArgumentException("Invalid OrganizationSponsorship to create a token, Id is required", nameof(sponsorship));
-            }
-            Id = sponsorship.Id;
-
             if (string.IsNullOrWhiteSpace(sponsorship.OfferedToEmail))
             {
                 throw new ArgumentException("Invalid OrganizationSponsorship to create a token, OfferedToEmail is required", nameof(sponsorship));
@@ -41,13 +37,19 @@ public OrganizationSponsorshipOfferTokenable(OrganizationSponsorship sponsorship
                 throw new ArgumentException("Invalid OrganizationSponsorship to create a token, PlanSponsorshipType is required", nameof(sponsorship));
             }
             SponsorshipType = sponsorship.PlanSponsorshipType.Value;
+
+            if (sponsorship.Id == default)
+            {
+                throw new ArgumentException("Invalid OrganizationSponsorship to create a token, Id is required", nameof(sponsorship));
+            }
+            Id = sponsorship.Id;
         }
 
         public bool IsValid(OrganizationSponsorship sponsorship, string currentUserEmail) =>
             sponsorship != null &&
-            Id == sponsorship.Id &&
             sponsorship.PlanSponsorshipType.HasValue &&
             SponsorshipType == sponsorship.PlanSponsorshipType.Value &&
+            Id == sponsorship.Id &&
             !string.IsNullOrWhiteSpace(sponsorship.OfferedToEmail) &&
             Email.Equals(currentUserEmail, StringComparison.InvariantCultureIgnoreCase) &&
             Email.Equals(sponsorship.OfferedToEmail, StringComparison.InvariantCultureIgnoreCase);

src/Core/OrganizationFeatures/OrganizationServiceCollectionExtensions.cs

@@ -1,7 +1,10 @@
 using Bit.Core.Models.Business.Tokenables;
 using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise;
+using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Cloud;
 using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Interfaces;
+using Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.SelfHosted;
 using Bit.Core.Services;
+using Bit.Core.Settings;
 using Bit.Core.Tokens;
 using Microsoft.AspNetCore.DataProtection;
 using Microsoft.Extensions.DependencyInjection;
@@ -19,12 +22,19 @@ public static void AddOrganizationServices(this IServiceCollection services)
 
         private static void AddOrganizationSponsorshipCommands(this IServiceCollection services)
         {
-            services.AddScoped<IOfferSponsorshipCommand, OfferSponsorshipCommand>();
+            services.AddScoped<ICreateSponsorshipCommand, CreateSponsorshipCommand>();
+
             services.AddScoped<IRemoveSponsorshipCommand, RemoveSponsorshipCommand>();
-            services.AddScoped<IResendSponsorshipOfferCommand, ResendSponsorshipOfferCommand>();
-            services.AddScoped<IRevokeSponsorshipCommand, RevokeSponsorshipCommand>();
+
+            services.AddScoped<ISendSponsorshipOfferCommand, SendSponsorshipOfferCommand>();
+
+            services.AddScoped<ICloudRevokeSponsorshipCommand, CloudRevokeSponsorshipCommand>();
+            services.AddScoped<ISelfHostedRevokeSponsorshipCommand, SelfHostedRevokeSponsorshipCommand>();
+
             services.AddScoped<ISetUpSponsorshipCommand, SetUpSponsorshipCommand>();
+
             services.AddScoped<IValidateRedemptionTokenCommand, ValidateRedemptionTokenCommand>();
+
             services.AddScoped<IValidateSponsorshipCommand, ValidateSponsorshipCommand>();
         }
 

src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/CancelSponsorshipCommand.cs

@@ -5,36 +5,20 @@
 
 namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise
 {
-    public abstract class CancelSponsorshipCommand
+    public class CancelSponsorshipCommand
     {
         protected readonly IOrganizationSponsorshipRepository _organizationSponsorshipRepository;
         protected readonly IOrganizationRepository _organizationRepository;
-        private readonly IPaymentService _paymentService;
-        private readonly IMailService _mailService;
 
         public CancelSponsorshipCommand(IOrganizationSponsorshipRepository organizationSponsorshipRepository,
-            IOrganizationRepository organizationRepository,
-            IPaymentService paymentService,
-            IMailService mailService)
+            IOrganizationRepository organizationRepository)
         {
             _organizationSponsorshipRepository = organizationSponsorshipRepository;
             _organizationRepository = organizationRepository;
-            _paymentService = paymentService;
-            _mailService = mailService;
         }
 
-        protected async Task CancelSponsorshipAsync(Organization sponsoredOrganization, OrganizationSponsorship sponsorship = null)
+        protected virtual async Task CancelSponsorshipAsync(OrganizationSponsorship sponsorship = null)
         {
-            if (sponsoredOrganization != null)
-            {
-                await _paymentService.RemoveOrganizationSponsorshipAsync(sponsoredOrganization, sponsorship);
-                await _organizationRepository.UpsertAsync(sponsoredOrganization);
-
-                await _mailService.SendFamiliesForEnterpriseSponsorshipRevertingEmailAsync(
-                    sponsoredOrganization.BillingEmailAddress(),
-                    sponsoredOrganization.Name);
-            }
-
             if (sponsorship == null)
             {
                 return;

src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/CloudCancelSponsorshipCommand.cs

@@ -0,0 +1,37 @@
+using System.Threading.Tasks;
+using Bit.Core.Entities;
+using Bit.Core.Repositories;
+using Bit.Core.Services;
+
+namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Cloud
+{
+    public abstract class CloudCancelSponsorshipCommand : CancelSponsorshipCommand
+    {
+        private readonly IPaymentService _paymentService;
+        private readonly IMailService _mailService;
+
+        public CloudCancelSponsorshipCommand(IOrganizationSponsorshipRepository organizationSponsorshipRepository,
+            IOrganizationRepository organizationRepository,
+            IPaymentService paymentService,
+            IMailService mailService) : base(organizationSponsorshipRepository, organizationRepository)
+        {
+            _paymentService = paymentService;
+            _mailService = mailService;
+        }
+
+
+        protected async Task CancelSponsorshipAsync(Organization sponsoredOrganization, OrganizationSponsorship sponsorship = null)
+        {
+            if (sponsoredOrganization != null)
+            {
+                await _paymentService.RemoveOrganizationSponsorshipAsync(sponsoredOrganization, sponsorship);
+                await _organizationRepository.UpsertAsync(sponsoredOrganization);
+
+                await _mailService.SendFamiliesForEnterpriseSponsorshipRevertingEmailAsync(
+                    sponsoredOrganization.BillingEmailAddress(),
+                    sponsoredOrganization.Name);
+            }
+            await base.CancelSponsorshipAsync(sponsorship);
+        }
+    }
+}

src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/RevokeSponsorshipCommand.cs renamed to src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/CloudRevokeSponsorshipCommand.cs

@@ -5,11 +5,11 @@
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 
-namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise
+namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Cloud
 {
-    public class RevokeSponsorshipCommand : CancelSponsorshipCommand, IRevokeSponsorshipCommand
+    public class CloudRevokeSponsorshipCommand : CloudCancelSponsorshipCommand, ICloudRevokeSponsorshipCommand
     {
-        public RevokeSponsorshipCommand(
+        public CloudRevokeSponsorshipCommand(
             IOrganizationSponsorshipRepository organizationSponsorshipRepository,
             IOrganizationRepository organizationRepository,
             IPaymentService paymentService,
@@ -26,7 +26,7 @@ public async Task RevokeSponsorshipAsync(Organization sponsoredOrg, Organization
 
             if (sponsorship.SponsoredOrganizationId == null)
             {
-                await CancelSponsorshipAsync(null, sponsorship);
+                await CancelSponsorshipAsync(sponsorship);
                 return;
             }
 

src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/RemoveSponsorshipCommand.cs renamed to src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/RemoveSponsorshipCommand.cs

@@ -5,9 +5,9 @@
 using Bit.Core.Repositories;
 using Bit.Core.Services;
 
-namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise
+namespace Bit.Core.OrganizationFeatures.OrganizationSponsorships.FamiliesForEnterprise.Cloud
 {
-    public class RemoveSponsorshipCommand : CancelSponsorshipCommand, IRemoveSponsorshipCommand
+    public class RemoveSponsorshipCommand : CloudCancelSponsorshipCommand, IRemoveSponsorshipCommand
     {
         public RemoveSponsorshipCommand(
             IOrganizationSponsorshipRepository organizationSponsorshipRepository,