using System.Reflection; using System.Security.Claims; using System.Security.Cryptography.X509Certificates; using AspNetCoreRateLimit; using Bit.Core.Entities; using Bit.Core.Enums; using Bit.Core.HostedServices; using Bit.Core.Identity; using Bit.Core.IdentityServer; using Bit.Core.LoginFeatures; using Bit.Core.Models.Business.Tokenables; using Bit.Core.OrganizationFeatures; using Bit.Core.Repositories; using Bit.Core.Resources; using Bit.Core.Services; using Bit.Core.Settings; using Bit.Core.Tokens; using Bit.Core.Utilities; using Bit.Infrastructure.Dapper; using IdentityModel; using IdentityServer4.AccessTokenValidation; using IdentityServer4.Configuration; using Microsoft.AspNetCore.Authentication.Cookies; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.HttpOverrides; using Microsoft.AspNetCore.Identity; using Microsoft.AspNetCore.Mvc.Localization; using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.StackExchangeRedis; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Serilog.Context; using StackExchange.Redis; using NoopRepos = Bit.Core.Repositories.Noop; using Role = Bit.Core.Entities.Role; using TableStorageRepos = Bit.Core.Repositories.TableStorage; namespace Bit.SharedWeb.Utilities; public static class ServiceCollectionExtensions { public static SupportedDatabaseProviders AddDatabaseRepositories(this IServiceCollection services, GlobalSettings globalSettings) { var selectedDatabaseProvider = globalSettings.DatabaseProvider; var provider = SupportedDatabaseProviders.SqlServer; var connectionString = string.Empty; if (!string.IsNullOrWhiteSpace(selectedDatabaseProvider)) { switch (selectedDatabaseProvider.ToLowerInvariant()) { case "postgres": case "postgresql": provider = SupportedDatabaseProviders.Postgres; connectionString = globalSettings.PostgreSql.ConnectionString; break; case "mysql": case "mariadb": provider = SupportedDatabaseProviders.MySql; connectionString = globalSettings.MySql.ConnectionString; break; case "sqlite": provider = SupportedDatabaseProviders.Sqlite; connectionString = globalSettings.Sqlite.ConnectionString; break; case "sqlserver": connectionString = globalSettings.SqlServer.ConnectionString; break; default: break; } } else { // Default to attempting to use SqlServer connection string if globalSettings.DatabaseProvider has no value. connectionString = globalSettings.SqlServer.ConnectionString; } services.SetupEntityFramework(connectionString, provider); if (provider != SupportedDatabaseProviders.SqlServer) { services.AddPasswordManagerEFRepositories(globalSettings.SelfHosted); } else { services.AddDapperRepositories(globalSettings.SelfHosted); } if (globalSettings.SelfHosted) { services.AddSingleton(); services.AddSingleton(); } else { services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); } return provider; } public static void AddBaseServices(this IServiceCollection services, IGlobalSettings globalSettings) { services.AddScoped(); services.AddScoped(); services.AddOrganizationServices(globalSettings); services.AddScoped(); services.AddScoped(); services.AddScoped(); services.AddScoped(); services.AddScoped(); services.AddSingleton(); services.AddSingleton(); services.AddScoped(); services.AddScoped(); services.AddLoginServices(); } public static void AddTokenizers(this IServiceCollection services) { services.AddSingleton>(serviceProvider => new DataProtectorTokenFactory( EmergencyAccessInviteTokenable.ClearTextPrefix, EmergencyAccessInviteTokenable.DataProtectorPurpose, serviceProvider.GetDataProtectionProvider(), serviceProvider.GetRequiredService>>()) ); services.AddSingleton>(serviceProvider => new DataProtectorTokenFactory( HCaptchaTokenable.ClearTextPrefix, HCaptchaTokenable.DataProtectorPurpose, serviceProvider.GetDataProtectionProvider(), serviceProvider.GetRequiredService>>()) ); services.AddSingleton>(serviceProvider => new DataProtectorTokenFactory( SsoTokenable.ClearTextPrefix, SsoTokenable.DataProtectorPurpose, serviceProvider.GetDataProtectionProvider(), serviceProvider.GetRequiredService>>())); } public static void AddDefaultServices(this IServiceCollection services, GlobalSettings globalSettings) { // Required for UserService services.AddWebAuthn(globalSettings); // Required for HTTP calls services.AddHttpClient(); services.AddSingleton(); services.AddSingleton((serviceProvider) => { return new Braintree.BraintreeGateway { Environment = globalSettings.Braintree.Production ? Braintree.Environment.PRODUCTION : Braintree.Environment.SANDBOX, MerchantId = globalSettings.Braintree.MerchantId, PublicKey = globalSettings.Braintree.PublicKey, PrivateKey = globalSettings.Braintree.PrivateKey }; }); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddTokenizers(); if (CoreHelpers.SettingHasValue(globalSettings.ServiceBus.ConnectionString) && CoreHelpers.SettingHasValue(globalSettings.ServiceBus.ApplicationCacheTopicName)) { services.AddSingleton(); } else { services.AddSingleton(); } var awsConfigured = CoreHelpers.SettingHasValue(globalSettings.Amazon?.AccessKeySecret); if (awsConfigured && CoreHelpers.SettingHasValue(globalSettings.Mail?.SendGridApiKey)) { services.AddSingleton(); } else if (awsConfigured) { services.AddSingleton(); } else if (CoreHelpers.SettingHasValue(globalSettings.Mail?.Smtp?.Host)) { services.AddSingleton(); } else { services.AddSingleton(); } services.AddSingleton(); if (globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.PushRelayBaseUri) && globalSettings.Installation?.Id != null && CoreHelpers.SettingHasValue(globalSettings.Installation?.Key)) { services.AddSingleton(); } else if (!globalSettings.SelfHosted) { services.AddSingleton(); } else { services.AddSingleton(); } if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Storage?.ConnectionString)) { services.AddSingleton(); } else if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Amazon?.AccessKeySecret)) { services.AddSingleton(); } else { services.AddSingleton(); } if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Mail.ConnectionString)) { services.AddSingleton(); } else { services.AddSingleton(); } if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString)) { services.AddSingleton(); } else if (globalSettings.SelfHosted) { services.AddSingleton(); } else { services.AddSingleton(); } if (CoreHelpers.SettingHasValue(globalSettings.Attachment.ConnectionString)) { services.AddSingleton(); } else if (CoreHelpers.SettingHasValue(globalSettings.Attachment.BaseDirectory)) { services.AddSingleton(); } else { services.AddSingleton(); } if (CoreHelpers.SettingHasValue(globalSettings.Send.ConnectionString)) { services.AddSingleton(); } else if (CoreHelpers.SettingHasValue(globalSettings.Send.BaseDirectory)) { services.AddSingleton(); } else { services.AddSingleton(); } if (globalSettings.SelfHosted) { services.AddSingleton(); } else { services.AddSingleton(); } if (CoreHelpers.SettingHasValue(globalSettings.Captcha?.HCaptchaSecretKey) && CoreHelpers.SettingHasValue(globalSettings.Captcha?.HCaptchaSiteKey)) { services.AddSingleton(); } else { services.AddSingleton(); } } public static void AddOosServices(this IServiceCollection services) { services.AddScoped(); } public static void AddNoopServices(this IServiceCollection services) { services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); } public static IdentityBuilder AddCustomIdentityServices( this IServiceCollection services, GlobalSettings globalSettings) { services.AddSingleton(); services.Configure(options => options.IterationCount = 100000); services.Configure(options => { options.TokenLifespan = TimeSpan.FromDays(30); }); var identityBuilder = services.AddIdentityWithoutCookieAuth(options => { options.User = new UserOptions { RequireUniqueEmail = true, AllowedUserNameCharacters = null // all }; options.Password = new PasswordOptions { RequireDigit = false, RequireLowercase = false, RequiredLength = 8, RequireNonAlphanumeric = false, RequireUppercase = false }; options.ClaimsIdentity = new ClaimsIdentityOptions { SecurityStampClaimType = Claims.SecurityStamp, UserNameClaimType = JwtClaimTypes.Email, UserIdClaimType = JwtClaimTypes.Subject, }; options.Tokens.ChangeEmailTokenProvider = TokenOptions.DefaultEmailProvider; }); identityBuilder .AddUserStore() .AddRoleStore() .AddTokenProvider>(TokenOptions.DefaultProvider) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.Authenticator)) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.Email)) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.YubiKey)) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.Duo)) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.Remember)) .AddTokenProvider>(TokenOptions.DefaultEmailProvider) .AddTokenProvider( CoreHelpers.CustomProviderName(TwoFactorProviderType.WebAuthn)); return identityBuilder; } public static void AddIdentityAuthenticationServices( this IServiceCollection services, GlobalSettings globalSettings, IWebHostEnvironment environment, Action addAuthorization) { services .AddAuthentication(IdentityServerAuthenticationDefaults.AuthenticationScheme) .AddIdentityServerAuthentication(options => { options.Authority = globalSettings.BaseServiceUri.InternalIdentity; options.RequireHttpsMetadata = !environment.IsDevelopment() && globalSettings.BaseServiceUri.InternalIdentity.StartsWith("https"); options.TokenRetriever = TokenRetrieval.FromAuthorizationHeaderOrQueryString(); options.NameClaimType = ClaimTypes.Email; options.SupportedTokens = SupportedTokens.Jwt; }); if (addAuthorization != null) { services.AddAuthorization(config => { addAuthorization.Invoke(config); }); } if (environment.IsDevelopment()) { Microsoft.IdentityModel.Logging.IdentityModelEventSource.ShowPII = true; } } public static void AddCustomDataProtectionServices( this IServiceCollection services, IWebHostEnvironment env, GlobalSettings globalSettings) { var builder = services.AddDataProtection().SetApplicationName("Bitwarden"); if (env.IsDevelopment()) { return; } if (globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.DataProtection.Directory)) { builder.PersistKeysToFileSystem(new DirectoryInfo(globalSettings.DataProtection.Directory)); } if (!globalSettings.SelfHosted && CoreHelpers.SettingHasValue(globalSettings.Storage?.ConnectionString)) { X509Certificate2 dataProtectionCert = null; if (CoreHelpers.SettingHasValue(globalSettings.DataProtection.CertificateThumbprint)) { dataProtectionCert = CoreHelpers.GetCertificate( globalSettings.DataProtection.CertificateThumbprint); } else if (CoreHelpers.SettingHasValue(globalSettings.DataProtection.CertificatePassword)) { dataProtectionCert = CoreHelpers.GetBlobCertificateAsync(globalSettings.Storage.ConnectionString, "certificates", "dataprotection.pfx", globalSettings.DataProtection.CertificatePassword) .GetAwaiter().GetResult(); } builder .PersistKeysToAzureBlobStorage(globalSettings.Storage.ConnectionString, "aspnet-dataprotection", "keys.xml") .ProtectKeysWithCertificate(dataProtectionCert); } } public static IIdentityServerBuilder AddIdentityServerCertificate( this IIdentityServerBuilder identityServerBuilder, IWebHostEnvironment env, GlobalSettings globalSettings) { var certificate = CoreHelpers.GetIdentityServerCertificate(globalSettings); if (certificate != null) { identityServerBuilder.AddSigningCredential(certificate); } else if (env.IsDevelopment()) { identityServerBuilder.AddDeveloperSigningCredential(false); } else { throw new Exception("No identity certificate to use."); } return identityServerBuilder; } public static GlobalSettings AddGlobalSettingsServices(this IServiceCollection services, IConfiguration configuration, IWebHostEnvironment environment) { var globalSettings = new GlobalSettings(); ConfigurationBinder.Bind(configuration.GetSection("GlobalSettings"), globalSettings); if (environment.IsDevelopment() && configuration.GetValue("developSelfHosted")) { // Override settings with selfHostedOverride settings ConfigurationBinder.Bind(configuration.GetSection("Dev:SelfHostOverride:GlobalSettings"), globalSettings); } services.AddSingleton(s => globalSettings); services.AddSingleton(s => globalSettings); return globalSettings; } public static void UseDefaultMiddleware(this IApplicationBuilder app, IWebHostEnvironment env, GlobalSettings globalSettings) { string GetHeaderValue(HttpContext httpContext, string header) { if (httpContext.Request.Headers.ContainsKey(header)) { return httpContext.Request.Headers[header]; } return null; } // Add version information to response headers app.Use(async (httpContext, next) => { using (LogContext.PushProperty("IPAddress", httpContext.GetIpAddress(globalSettings))) using (LogContext.PushProperty("UserAgent", GetHeaderValue(httpContext, "user-agent"))) using (LogContext.PushProperty("DeviceType", GetHeaderValue(httpContext, "device-type"))) using (LogContext.PushProperty("Origin", GetHeaderValue(httpContext, "origin"))) { httpContext.Response.OnStarting((state) => { httpContext.Response.Headers.Append("Server-Version", AssemblyHelpers.GetVersion()); return Task.FromResult(0); }, null); await next.Invoke(); } }); } public static void UseForwardedHeaders(this IApplicationBuilder app, GlobalSettings globalSettings) { var options = new ForwardedHeadersOptions { ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto }; if (!string.IsNullOrWhiteSpace(globalSettings.KnownProxies)) { var proxies = globalSettings.KnownProxies.Split(','); foreach (var proxy in proxies) { if (System.Net.IPAddress.TryParse(proxy.Trim(), out var ip)) { options.KnownProxies.Add(ip); } } } if (options.KnownProxies.Count > 1) { options.ForwardLimit = null; } app.UseForwardedHeaders(options); } public static void AddCoreLocalizationServices(this IServiceCollection services) { services.AddTransient(); services.AddLocalization(options => options.ResourcesPath = "Resources"); } public static IApplicationBuilder UseCoreLocalization(this IApplicationBuilder app) { var supportedCultures = new[] { "en" }; return app.UseRequestLocalization(options => options .SetDefaultCulture(supportedCultures[0]) .AddSupportedCultures(supportedCultures) .AddSupportedUICultures(supportedCultures)); } public static IMvcBuilder AddViewAndDataAnnotationLocalization(this IMvcBuilder mvc) { mvc.Services.AddTransient(); return mvc.AddViewLocalization(options => options.ResourcesPath = "Resources") .AddDataAnnotationsLocalization(options => options.DataAnnotationLocalizerProvider = (type, factory) => { var assemblyName = new AssemblyName(typeof(SharedResources).GetTypeInfo().Assembly.FullName); return factory.Create("SharedResources", assemblyName.Name); }); } public static IServiceCollection AddDistributedIdentityServices(this IServiceCollection services, GlobalSettings globalSettings) { services.AddOidcStateDataFormatterCache(); services.AddSession(); services.ConfigureApplicationCookie(configure => configure.CookieManager = new DistributedCacheCookieManager()); services.ConfigureExternalCookie(configure => configure.CookieManager = new DistributedCacheCookieManager()); services.AddSingleton>( svcs => new ConfigureOpenIdConnectDistributedOptions( svcs.GetRequiredService(), globalSettings, svcs.GetRequiredService()) ); return services; } public static void AddWebAuthn(this IServiceCollection services, GlobalSettings globalSettings) { services.AddFido2(options => { options.ServerDomain = new Uri(globalSettings.BaseServiceUri.Vault).Host; options.ServerName = "Bitwarden"; options.Origins = new HashSet { globalSettings.BaseServiceUri.Vault, }; options.TimestampDriftTolerance = 300000; }); } /// /// Adds either an in-memory or distributed IP rate limiter depending if a Redis connection string is available. /// /// /// public static void AddIpRateLimiting(this IServiceCollection services, GlobalSettings globalSettings) { services.AddHostedService(); services.AddSingleton(); if (!globalSettings.DistributedIpRateLimiting.Enabled || string.IsNullOrEmpty(globalSettings.Redis.ConnectionString)) { services.AddInMemoryRateLimiting(); } else { // Use memory stores for Ip and Client Policy stores as we don't currently use them // and they add unnecessary Redis network delays checking for policies that don't exist services.AddSingleton(); services.AddSingleton(); // Use a custom Redis processing strategy that skips Ip limiting if Redis is down // Requires a registered IConnectionMultiplexer services.AddSingleton(); } } /// /// Adds an implementation of to the service collection. Uses a memory /// cache if self hosted or no Redis connection string is available in GlobalSettings. /// public static void AddDistributedCache( this IServiceCollection services, GlobalSettings globalSettings) { if (globalSettings.SelfHosted || string.IsNullOrEmpty(globalSettings.Redis.ConnectionString)) { services.AddDistributedMemoryCache(); return; } // Register the IConnectionMultiplexer explicitly so it can be accessed via DI // (e.g. for the IP rate limiting store) services.AddSingleton( _ => ConnectionMultiplexer.Connect(globalSettings.Redis.ConnectionString)); // Explicitly register IDistributedCache to re-use existing IConnectionMultiplexer // to reduce the number of redundant connections to the Redis instance services.AddSingleton(s => { return new RedisCache(new RedisCacheOptions { // Use "ProjectName:" as an instance name to namespace keys and avoid conflicts between projects InstanceName = $"{globalSettings.ProjectName}:", ConnectionMultiplexerFactory = () => Task.FromResult(s.GetRequiredService()) }); }); } }