using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Caching.Memory; using Microsoft.Extensions.Logging; using System; using System.Linq; using System.Threading.Tasks; using Timeline.Entities; using Timeline.Models; using static Timeline.Entities.UserUtility; using static Timeline.Helpers.MyLogHelper; namespace Timeline.Services { public class CreateTokenResult { public string Token { get; set; } public UserInfo User { get; set; } } [Serializable] public class UserNotExistException : Exception { private const string message = "The user does not exist."; public UserNotExistException(string username) : base(FormatLogMessage(message, Pair("Username", username))) { Username = username; } public UserNotExistException(long id) : base(FormatLogMessage(message, Pair("Id", id))) { Id = id; } public UserNotExistException(string message, Exception inner) : base(message, inner) { } protected UserNotExistException( System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) : base(info, context) { } /// /// The username that does not exist. May be null then is not null. /// public string Username { get; private set; } /// /// The id that does not exist. May be null then is not null. /// public long? Id { get; private set; } } [Serializable] public class BadPasswordException : Exception { public BadPasswordException(string badPassword) : base(FormatLogMessage("Password is wrong.", Pair("Bad Password", badPassword))) { Password = badPassword; } public BadPasswordException(string message, Exception inner) : base(message, inner) { } protected BadPasswordException( System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) : base(info, context) { } /// /// The wrong password. /// public string Password { get; private set; } } [Serializable] public class BadTokenVersionException : Exception { public BadTokenVersionException(long tokenVersion, long requiredVersion) : base(FormatLogMessage("Token version is expired.", Pair("Token Version", tokenVersion), Pair("Required Version", requiredVersion))) { TokenVersion = tokenVersion; RequiredVersion = requiredVersion; } public BadTokenVersionException(string message, Exception inner) : base(message, inner) { } protected BadTokenVersionException( System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) : base(info, context) { } /// /// The version in the token. /// public long TokenVersion { get; private set; } /// /// The version required. /// public long RequiredVersion { get; private set; } } public interface IUserService { /// /// Try to anthenticate with the given username and password. /// If success, create a token and return the user info. /// /// The username of the user to anthenticate. /// The password of the user to anthenticate. /// The expired time point. Null then use default. See for what is default. /// An containing the created token and user info. /// Thrown when or is null. /// Thrown when the user with given username does not exist. /// Thrown when password is wrong. Task CreateToken(string username, string password, DateTime? expires = null); /// /// Verify the given token. /// If success, return the user info. /// /// The token to verify. /// The user info specified by the token. /// Thrown when is null. /// Thrown when the token is of bad format. Thrown by . /// Thrown when the user specified by the token does not exist. Usually it has been deleted after the token was issued. /// Thrown when the version in the token is expired. User needs to recreate the token. Task VerifyToken(string token); /// /// Get the user info of given username. /// /// Username of the user. /// The info of the user. Null if the user of given username does not exists. Task GetUser(string username); /// /// List all users. /// /// The user info of users. Task ListUsers(); /// /// Create or modify a user with given username. /// Return if a new user is created. /// Return if a existing user is modified. /// /// Username of user. /// Password of user. /// Whether the user is administrator. /// Return if a new user is created. /// Return if a existing user is modified. /// Thrown when or is null. Task PutUser(string username, string password, bool administrator); /// /// Partially modify a user of given username. /// /// Note that whether actually modified or not, Version of the user will always increase. /// /// Username of the user to modify. Can't be null. /// New password. Null if not modify. /// Whether the user is administrator. Null if not modify. /// Thrown if is null. /// Thrown if the user with given username does not exist. Task PatchUser(string username, string password, bool? administrator); /// /// Delete a user of given username. /// /// Username of thet user to delete. Can't be null. /// Thrown if is null. /// Thrown if the user with given username does not exist. Task DeleteUser(string username); /// /// Try to change a user's password with old password. /// /// The name of user to change password of. /// The user's old password. /// The user's new password. /// Thrown if or or is null. /// Thrown if the user with given username does not exist. /// Thrown if the old password is wrong. Task ChangePassword(string username, string oldPassword, string newPassword); } internal class UserCache { public string Username { get; set; } public bool Administrator { get; set; } public long Version { get; set; } public UserInfo ToUserInfo() { return new UserInfo(Username, Administrator); } } public class UserService : IUserService { private readonly ILogger _logger; private readonly IMemoryCache _memoryCache; private readonly DatabaseContext _databaseContext; private readonly IJwtService _jwtService; private readonly IPasswordService _passwordService; public UserService(ILogger logger, IMemoryCache memoryCache, DatabaseContext databaseContext, IJwtService jwtService, IPasswordService passwordService) { _logger = logger; _memoryCache = memoryCache; _databaseContext = databaseContext; _jwtService = jwtService; _passwordService = passwordService; } private string GenerateCacheKeyByUserId(long id) => $"user:{id}"; private void RemoveCache(long id) { var key = GenerateCacheKeyByUserId(id); _memoryCache.Remove(key); _logger.LogInformation(FormatLogMessage("A cache entry is removed.", Pair("Key", key))); } public async Task CreateToken(string username, string password, DateTime? expires) { if (username == null) throw new ArgumentNullException(nameof(username)); if (password == null) throw new ArgumentNullException(nameof(password)); // We need password info, so always check the database. var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync(); if (user == null) throw new UserNotExistException(username); if (!_passwordService.VerifyPassword(user.EncryptedPassword, password)) throw new BadPasswordException(password); var token = _jwtService.GenerateJwtToken(new TokenInfo { Id = user.Id, Version = user.Version }, expires); return new CreateTokenResult { Token = token, User = CreateUserInfo(user) }; } public async Task VerifyToken(string token) { if (token == null) throw new ArgumentNullException(nameof(token)); TokenInfo tokenInfo; tokenInfo = _jwtService.VerifyJwtToken(token); var id = tokenInfo.Id; var key = GenerateCacheKeyByUserId(id); if (!_memoryCache.TryGetValue(key, out var cache)) { // no cache, check the database var user = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); if (user == null) throw new UserNotExistException(id); // create cache cache = CreateUserCache(user); _memoryCache.CreateEntry(key).SetValue(cache); _logger.LogInformation(FormatLogMessage("A cache entry is created.", Pair("Key", key))); } if (tokenInfo.Version != cache.Version) throw new BadTokenVersionException(tokenInfo.Version, cache.Version); return cache.ToUserInfo(); } public async Task GetUser(string username) { return await _databaseContext.Users .Where(user => user.Name == username) .Select(user => CreateUserInfo(user)) .SingleOrDefaultAsync(); } public async Task ListUsers() { return await _databaseContext.Users .Select(user => CreateUserInfo(user)) .ToArrayAsync(); } public async Task PutUser(string username, string password, bool administrator) { if (username == null) throw new ArgumentNullException(nameof(username)); if (password == null) throw new ArgumentNullException(nameof(password)); var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync(); if (user == null) { var newUser = new User { Name = username, EncryptedPassword = _passwordService.HashPassword(password), RoleString = IsAdminToRoleString(administrator), Version = 0 }; await _databaseContext.AddAsync(newUser); await _databaseContext.SaveChangesAsync(); _logger.LogInformation(FormatLogMessage("A new user entry is added to the database.", Pair("Id", newUser.Id))); return PutResult.Created; } user.EncryptedPassword = _passwordService.HashPassword(password); user.RoleString = IsAdminToRoleString(administrator); user.Version += 1; await _databaseContext.SaveChangesAsync(); _logger.LogInformation(FormatLogMessage("A user entry is updated to the database.", Pair("Id", user.Id))); //clear cache RemoveCache(user.Id); return PutResult.Modified; } public async Task PatchUser(string username, string password, bool? administrator) { if (username == null) throw new ArgumentNullException(nameof(username)); var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync(); if (user == null) throw new UserNotExistException(username); if (password != null) { user.EncryptedPassword = _passwordService.HashPassword(password); } if (administrator != null) { user.RoleString = IsAdminToRoleString(administrator.Value); } user.Version += 1; await _databaseContext.SaveChangesAsync(); _logger.LogInformation(FormatLogMessage("A user entry is updated to the database.", Pair("Id", user.Id))); //clear cache RemoveCache(user.Id); } public async Task DeleteUser(string username) { if (username == null) throw new ArgumentNullException(nameof(username)); var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync(); if (user == null) throw new UserNotExistException(username); _databaseContext.Users.Remove(user); await _databaseContext.SaveChangesAsync(); _logger.LogInformation(FormatLogMessage("A user entry is removed from the database.", Pair("Id", user.Id))); //clear cache RemoveCache(user.Id); } public async Task ChangePassword(string username, string oldPassword, string newPassword) { if (username == null) throw new ArgumentNullException(nameof(username)); if (oldPassword == null) throw new ArgumentNullException(nameof(oldPassword)); if (newPassword == null) throw new ArgumentNullException(nameof(newPassword)); var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync(); if (user == null) throw new UserNotExistException(username); var verifyResult = _passwordService.VerifyPassword(user.EncryptedPassword, oldPassword); if (!verifyResult) throw new BadPasswordException(oldPassword); user.EncryptedPassword = _passwordService.HashPassword(newPassword); user.Version += 1; await _databaseContext.SaveChangesAsync(); //clear cache RemoveCache(user.Id); } } }