mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2025-01-19 13:43:46 +01:00
6290b0f3bf
* Users list: Cleanups * Policies: Flip registration settings * Policies: Add RequireUserApproval setting * Add approval to user * Require approval on login and for API key * API handling * AccountController cleanups * Test fix * Apply suggestions from code review Co-authored-by: Nicolas Dorier <nicolas.dorier@gmail.com> * Add missing imports * Communicate login requirements to user on account creation * Add login requirements to basic auth handler * Cleanups and test fix * Encapsulate approval logic in user service and log approval changes * Send follow up "Account approved" email Closes #5656. * Add notification for admins * Fix creating a user via the admin view * Update list: Unify flags into status column, add approve action * Adjust "Resend email" wording * Incorporate feedback from code review * Remove duplicate test server policy reset --------- Co-authored-by: Nicolas Dorier <nicolas.dorier@gmail.com>
253 lines
9.7 KiB
C#
253 lines
9.7 KiB
C#
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Linq;
|
|
using System.Threading.Tasks;
|
|
using BTCPayServer;
|
|
using BTCPayServer.Client.Models;
|
|
using BTCPayServer.Data;
|
|
using BTCPayServer.Events;
|
|
using BTCPayServer.Services.Stores;
|
|
using BTCPayServer.Storage.Services;
|
|
using Microsoft.AspNetCore.Identity;
|
|
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging;
|
|
|
|
namespace BTCPayServer.Services
|
|
{
|
|
public class UserService
|
|
{
|
|
private readonly IServiceProvider _serviceProvider;
|
|
private readonly StoredFileRepository _storedFileRepository;
|
|
private readonly FileService _fileService;
|
|
private readonly StoreRepository _storeRepository;
|
|
private readonly EventAggregator _eventAggregator;
|
|
private readonly ApplicationDbContextFactory _applicationDbContextFactory;
|
|
private readonly ILogger<UserService> _logger;
|
|
|
|
public UserService(
|
|
IServiceProvider serviceProvider,
|
|
StoredFileRepository storedFileRepository,
|
|
FileService fileService,
|
|
EventAggregator eventAggregator,
|
|
StoreRepository storeRepository,
|
|
ApplicationDbContextFactory applicationDbContextFactory,
|
|
ILogger<UserService> logger)
|
|
{
|
|
_serviceProvider = serviceProvider;
|
|
_storedFileRepository = storedFileRepository;
|
|
_fileService = fileService;
|
|
_eventAggregator = eventAggregator;
|
|
_storeRepository = storeRepository;
|
|
_applicationDbContextFactory = applicationDbContextFactory;
|
|
_logger = logger;
|
|
}
|
|
|
|
public async Task<List<ApplicationUserData>> GetUsersWithRoles()
|
|
{
|
|
await using var context = _applicationDbContextFactory.CreateContext();
|
|
return await (context.Users.Select(p => FromModel(p, p.UserRoles.Join(context.Roles, userRole => userRole.RoleId, role => role.Id,
|
|
(userRole, role) => role.Name).ToArray()))).ToListAsync();
|
|
}
|
|
|
|
public static ApplicationUserData FromModel(ApplicationUser data, string?[] roles)
|
|
{
|
|
return new ApplicationUserData
|
|
{
|
|
Id = data.Id,
|
|
Email = data.Email,
|
|
EmailConfirmed = data.EmailConfirmed,
|
|
RequiresEmailConfirmation = data.RequiresEmailConfirmation,
|
|
Approved = data.Approved,
|
|
RequiresApproval = data.RequiresApproval,
|
|
Created = data.Created,
|
|
Roles = roles,
|
|
Disabled = data.LockoutEnabled && data.LockoutEnd is not null && DateTimeOffset.UtcNow < data.LockoutEnd.Value.UtcDateTime
|
|
};
|
|
}
|
|
|
|
private static bool IsEmailConfirmed(ApplicationUser user)
|
|
{
|
|
return user.EmailConfirmed || !user.RequiresEmailConfirmation;
|
|
}
|
|
|
|
private static bool IsApproved(ApplicationUser user)
|
|
{
|
|
return user.Approved || !user.RequiresApproval;
|
|
}
|
|
|
|
private static bool IsDisabled(ApplicationUser user)
|
|
{
|
|
return user.LockoutEnabled && user.LockoutEnd is not null &&
|
|
DateTimeOffset.UtcNow < user.LockoutEnd.Value.UtcDateTime;
|
|
}
|
|
|
|
public static bool TryCanLogin([NotNullWhen(true)] ApplicationUser? user, [MaybeNullWhen(true)] out string error)
|
|
{
|
|
error = null;
|
|
if (user == null)
|
|
{
|
|
error = "Invalid login attempt.";
|
|
return false;
|
|
}
|
|
if (!IsEmailConfirmed(user))
|
|
{
|
|
error = "You must have a confirmed email to log in.";
|
|
return false;
|
|
}
|
|
if (!IsApproved(user))
|
|
{
|
|
error = "Your user account requires approval by an admin before you can log in.";
|
|
return false;
|
|
}
|
|
if (IsDisabled(user))
|
|
{
|
|
error = "Your user account is currently disabled.";
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public async Task<bool> SetUserApproval(string userId, bool approved, Uri requestUri)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
var user = await userManager.FindByIdAsync(userId);
|
|
if (user is null || !user.RequiresApproval || user.Approved == approved)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
user.Approved = approved;
|
|
var succeeded = await userManager.UpdateAsync(user) is { Succeeded: true };
|
|
if (succeeded)
|
|
{
|
|
_logger.LogInformation("User {UserId} is now {Status}", user.Id, approved ? "approved" : "unapproved");
|
|
_eventAggregator.Publish(new UserApprovedEvent { User = user, Approved = approved, RequestUri = requestUri });
|
|
}
|
|
else
|
|
{
|
|
_logger.LogError("Failed to {Action} user {UserId}", approved ? "approve" : "unapprove", user.Id);
|
|
}
|
|
|
|
return succeeded;
|
|
}
|
|
|
|
public async Task<bool?> ToggleUser(string userId, DateTimeOffset? lockedOutDeadline)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
var user = await userManager.FindByIdAsync(userId);
|
|
if (user is null)
|
|
{
|
|
return null;
|
|
}
|
|
if (lockedOutDeadline is not null)
|
|
{
|
|
await userManager.SetLockoutEnabledAsync(user, true);
|
|
}
|
|
|
|
var res = await userManager.SetLockoutEndDateAsync(user, lockedOutDeadline);
|
|
if (res.Succeeded)
|
|
{
|
|
_logger.LogInformation($"User {user.Id} is now {(lockedOutDeadline is null ? "unlocked" : "locked")}");
|
|
}
|
|
else
|
|
{
|
|
_logger.LogError($"Failed to set lockout for user {user.Id}");
|
|
}
|
|
|
|
return res.Succeeded;
|
|
}
|
|
|
|
public async Task<bool> IsAdminUser(string userId)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
return Roles.HasServerAdmin(await userManager.GetRolesAsync(new ApplicationUser() { Id = userId }));
|
|
}
|
|
|
|
public async Task<bool> IsAdminUser(ApplicationUser user)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
return Roles.HasServerAdmin(await userManager.GetRolesAsync(user));
|
|
}
|
|
|
|
public async Task<bool> SetAdminUser(string userId, bool enableAdmin)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
var user = await userManager.FindByIdAsync(userId);
|
|
if (user is null)
|
|
return false;
|
|
IdentityResult res;
|
|
if (enableAdmin)
|
|
{
|
|
res = await userManager.AddToRoleAsync(user, Roles.ServerAdmin);
|
|
}
|
|
else
|
|
{
|
|
res = await userManager.RemoveFromRoleAsync(user, Roles.ServerAdmin);
|
|
}
|
|
|
|
if (res.Succeeded)
|
|
{
|
|
_logger.LogInformation($"Successfully set admin status for user {user.Id}");
|
|
}
|
|
else
|
|
{
|
|
_logger.LogError($"Error setting admin status for user {user.Id}");
|
|
}
|
|
|
|
return res.Succeeded;
|
|
}
|
|
|
|
public async Task DeleteUserAndAssociatedData(ApplicationUser user)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
|
|
var userId = user.Id;
|
|
var files = await _storedFileRepository.GetFiles(new StoredFileRepository.FilesQuery()
|
|
{
|
|
UserIds = new[] { userId },
|
|
});
|
|
|
|
await Task.WhenAll(files.Select(file => _fileService.RemoveFile(file.Id, userId)));
|
|
|
|
user = (await userManager.FindByIdAsync(userId))!;
|
|
if (user is null)
|
|
return;
|
|
var res = await userManager.DeleteAsync(user);
|
|
if (res.Succeeded)
|
|
{
|
|
_logger.LogInformation($"User {user.Id} was successfully deleted");
|
|
}
|
|
else
|
|
{
|
|
_logger.LogError($"Failed to delete user {user.Id}");
|
|
}
|
|
}
|
|
|
|
public async Task<bool> IsUserTheOnlyOneAdmin(ApplicationUser user)
|
|
{
|
|
using var scope = _serviceProvider.CreateScope();
|
|
var userManager = scope.ServiceProvider.GetRequiredService<UserManager<ApplicationUser>>();
|
|
var roles = await userManager.GetRolesAsync(user);
|
|
if (!Roles.HasServerAdmin(roles))
|
|
{
|
|
return false;
|
|
}
|
|
var adminUsers = await userManager.GetUsersInRoleAsync(Roles.ServerAdmin);
|
|
var enabledAdminUsers = adminUsers
|
|
.Where(applicationUser => !IsDisabled(applicationUser) && IsApproved(applicationUser))
|
|
.Select(applicationUser => applicationUser.Id).ToList();
|
|
|
|
return enabledAdminUsers.Count == 1 && enabledAdminUsers.Contains(user.Id);
|
|
}
|
|
}
|
|
}
|