From eb50fc7ad1252d0e397e969e1a7eb33720150b00 Mon Sep 17 00:00:00 2001
From: 杨宇千 <crupest@outlook.com>
Date: Sat, 20 Jul 2019 19:01:35 +0800
Subject: Write a custom authenticate handler.

---
 Timeline/Startup.cs | 33 +++++++++++----------------------
 1 file changed, 11 insertions(+), 22 deletions(-)

(limited to 'Timeline/Startup.cs')

diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs
index acabe55c..a865f366 100644
--- a/Timeline/Startup.cs
+++ b/Timeline/Startup.cs
@@ -10,6 +10,7 @@ using Microsoft.Extensions.DependencyInjection;
 using Microsoft.IdentityModel.Tokens;
 using System.Text;
 using System.Threading.Tasks;
+using Timeline.Authenticate;
 using Timeline.Configs;
 using Timeline.Formatters;
 using Timeline.Models;
@@ -53,28 +54,16 @@ namespace Timeline
             var jwtConfig = Configuration.GetSection(nameof(JwtConfig)).Get<JwtConfig>();
 
             services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
-                .AddJwtBearer(o =>
-                {
-                    o.Events = new JwtBearerEvents
-                    {
-                        OnMessageReceived = delegate (MessageReceivedContext context)
-                        {
-                            context.Request.Query.TryGetValue("token", out var value);
-                            if (value.Count == 1)
-                            {
-                                context.Token = value[0];
-                            }
-                            return Task.CompletedTask;
-                        }
-                    };
-                    o.TokenValidationParameters.ValidateIssuer = true;
-                    o.TokenValidationParameters.ValidateAudience = true;
-                    o.TokenValidationParameters.ValidateIssuerSigningKey = true;
-                    o.TokenValidationParameters.ValidateLifetime = true;
-                    o.TokenValidationParameters.ValidIssuer = jwtConfig.Issuer;
-                    o.TokenValidationParameters.ValidAudience = jwtConfig.Audience;
-                    o.TokenValidationParameters.IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(jwtConfig.SigningKey));
-                });
+                .AddScheme<AuthOptions, AuthHandler>(AuthConstants.Scheme, AuthConstants.DisplayName, o =>
+                 {
+                     o.TokenValidationParameters.ValidateIssuer = true;
+                     o.TokenValidationParameters.ValidateAudience = true;
+                     o.TokenValidationParameters.ValidateIssuerSigningKey = true;
+                     o.TokenValidationParameters.ValidateLifetime = true;
+                     o.TokenValidationParameters.ValidIssuer = jwtConfig.Issuer;
+                     o.TokenValidationParameters.ValidAudience = jwtConfig.Audience;
+                     o.TokenValidationParameters.IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(jwtConfig.SigningKey));
+                 });
 
             services.AddScoped<IUserService, UserService>();
             services.AddScoped<IJwtService, JwtService>();
-- 
cgit v1.2.3


From 79fcf66b157f38199771d30c0fd0cedbfbc786f2 Mon Sep 17 00:00:00 2001
From: 杨宇千 <crupest@outlook.com>
Date: Sun, 21 Jul 2019 22:58:27 +0800
Subject: WIP: change UserService.

---
 Timeline/Controllers/TokenController.cs |   2 +-
 Timeline/Entities/UserInfo.cs           |   4 -
 Timeline/Entities/UserUtility.cs        |  14 ++-
 Timeline/Services/JwtService.cs         |  29 +++---
 Timeline/Services/UserService.cs        | 174 ++++++++++++++++++++++++++------
 Timeline/Startup.cs                     |   3 +-
 6 files changed, 172 insertions(+), 54 deletions(-)

(limited to 'Timeline/Startup.cs')

diff --git a/Timeline/Controllers/TokenController.cs b/Timeline/Controllers/TokenController.cs
index 0be5fb2f..cb4408cd 100644
--- a/Timeline/Controllers/TokenController.cs
+++ b/Timeline/Controllers/TokenController.cs
@@ -46,7 +46,7 @@ namespace Timeline.Controllers
             {
                 Success = true,
                 Token = result.Token,
-                UserInfo = result.UserInfo
+                UserInfo = result.User
             });
         }
 
diff --git a/Timeline/Entities/UserInfo.cs b/Timeline/Entities/UserInfo.cs
index bb56df9d..9a82c991 100644
--- a/Timeline/Entities/UserInfo.cs
+++ b/Timeline/Entities/UserInfo.cs
@@ -1,7 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
 namespace Timeline.Entities
 {
     public sealed class UserInfo
diff --git a/Timeline/Entities/UserUtility.cs b/Timeline/Entities/UserUtility.cs
index 9a272948..1de7ac7d 100644
--- a/Timeline/Entities/UserUtility.cs
+++ b/Timeline/Entities/UserUtility.cs
@@ -2,6 +2,7 @@ using System;
 using System.Linq;
 using Timeline.Entities;
 using Timeline.Models;
+using Timeline.Services;
 
 namespace Timeline.Entities
 {
@@ -38,12 +39,23 @@ namespace Timeline.Entities
             return RoleArrayToRoleString(IsAdminToRoleArray(isAdmin));
         }
 
+        public static bool RoleStringToIsAdmin(string roleString)
+        {
+            return RoleArrayToIsAdmin(RoleStringToRoleArray(roleString));
+        }
+
         public static UserInfo CreateUserInfo(User user)
         {
             if (user == null)
                 throw new ArgumentNullException(nameof(user));
-            return new UserInfo(user.Name, RoleArrayToIsAdmin(RoleStringToRoleArray(user.RoleString)));
+            return new UserInfo(user.Name, RoleStringToIsAdmin(user.RoleString));
         }
 
+        internal static UserCache CreateUserCache(User user)
+        {
+            if (user == null)
+                throw new ArgumentNullException(nameof(user));
+            return new UserCache { Username = user.Name, IsAdmin = RoleStringToIsAdmin(user.RoleString), Version = user.Version };
+        }
     }
 }
diff --git a/Timeline/Services/JwtService.cs b/Timeline/Services/JwtService.cs
index e7f5690d..b070ad62 100644
--- a/Timeline/Services/JwtService.cs
+++ b/Timeline/Services/JwtService.cs
@@ -11,7 +11,7 @@ namespace Timeline.Services
 {
     public class TokenInfo
     {
-        public string Name { get; set; }
+        public long Id { get; set; }
         public long Version { get; set; }
     }
 
@@ -34,6 +34,7 @@ namespace Timeline.Services
         /// <param name="tokenInfo">The info to generate token.</param>
         /// <param name="expires">The expire time. If null then use current time with offset in config.</param>
         /// <returns>Return the generated token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="tokenInfo"/> is null.</exception>
         string GenerateJwtToken(TokenInfo tokenInfo, DateTime? expires = null);
 
         /// <summary>
@@ -41,7 +42,8 @@ namespace Timeline.Services
         /// Return null is <paramref name="token"/> is null.
         /// </summary>
         /// <param name="token">The token string to verify.</param>
-        /// <returns>Return null if <paramref name="token"/> is null. Return the saved info otherwise.</returns>
+        /// <returns>Return the saved info in token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
         /// <exception cref="JwtTokenVerifyException">Thrown when the token is invalid.</exception>
         TokenInfo VerifyJwtToken(string token);
 
@@ -53,25 +55,21 @@ namespace Timeline.Services
 
         private readonly IOptionsMonitor<JwtConfig> _jwtConfig;
         private readonly JwtSecurityTokenHandler _tokenHandler = new JwtSecurityTokenHandler();
-        private readonly ILogger<JwtService> _logger;
 
-        public JwtService(IOptionsMonitor<JwtConfig> jwtConfig, ILogger<JwtService> logger)
+        public JwtService(IOptionsMonitor<JwtConfig> jwtConfig)
         {
             _jwtConfig = jwtConfig;
-            _logger = logger;
         }
 
         public string GenerateJwtToken(TokenInfo tokenInfo, DateTime? expires = null)
         {
             if (tokenInfo == null)
                 throw new ArgumentNullException(nameof(tokenInfo));
-            if (tokenInfo.Name == null)
-                throw new ArgumentException("Name of token info is null.", nameof(tokenInfo));
 
             var config = _jwtConfig.CurrentValue;
 
             var identity = new ClaimsIdentity();
-            identity.AddClaim(new Claim(identity.NameClaimType, tokenInfo.Name));
+            identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, tokenInfo.Id.ToString(), ClaimValueTypes.Integer64));
             identity.AddClaim(new Claim(VersionClaimType, tokenInfo.Version.ToString(), ClaimValueTypes.Integer64));
 
             var tokenDescriptor = new SecurityTokenDescriptor()
@@ -95,7 +93,7 @@ namespace Timeline.Services
         public TokenInfo VerifyJwtToken(string token)
         {
             if (token == null)
-                return null;
+                throw new ArgumentNullException(nameof(token));
 
             var config = _jwtConfig.CurrentValue;
             try
@@ -111,6 +109,12 @@ namespace Timeline.Services
                     IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(config.SigningKey))
                 }, out _);
 
+                var idClaim = principal.FindFirstValue(ClaimTypes.NameIdentifier);
+                if (idClaim == null)
+                    throw new JwtTokenVerifyException("Id claim does not exist.");
+                if (!long.TryParse(idClaim, out var id))
+                    throw new JwtTokenVerifyException("Can't convert id claim into a integer number.");
+
                 var versionClaim = principal.FindFirstValue(VersionClaimType);
                 if (versionClaim == null)
                     throw new JwtTokenVerifyException("Version claim does not exist.");
@@ -119,7 +123,7 @@ namespace Timeline.Services
 
                 return new TokenInfo
                 {
-                    Name = principal.Identity.Name,
+                    Id = id,
                     Version = version
                 };
             }
@@ -127,11 +131,6 @@ namespace Timeline.Services
             {
                 throw new JwtTokenVerifyException("Validate token failed caused by a SecurityTokenException. See inner exception.", e);
             }
-            catch (ArgumentException e) // This usually means code logic error.
-            {
-                _logger.LogError(e, "Arguments passed to ValidateToken are bad.");
-                throw e;
-            }
         }
     }
 }
diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs
index 9fe9e08f..49c9747d 100644
--- a/Timeline/Services/UserService.cs
+++ b/Timeline/Services/UserService.cs
@@ -1,4 +1,5 @@
 using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Logging;
 using System;
 using System.Linq;
@@ -12,7 +13,41 @@ namespace Timeline.Services
     public class CreateTokenResult
     {
         public string Token { get; set; }
-        public UserInfo UserInfo { get; set; }
+        public UserInfo User { get; set; }
+    }
+
+    [Serializable]
+    public class UserNotExistException : Exception
+    {
+        public UserNotExistException(): base("The user does not exist.") { }
+        public UserNotExistException(string message) : base(message) { }
+        public UserNotExistException(string message, Exception inner) : base(message, inner) { }
+        protected UserNotExistException(
+          System.Runtime.Serialization.SerializationInfo info,
+          System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
+    }
+
+    [Serializable]
+    public class BadPasswordException : Exception
+    {
+        public BadPasswordException(): base("Password is wrong.") { }
+        public BadPasswordException(string message) : base(message) { }
+        public BadPasswordException(string message, Exception inner) : base(message, inner) { }
+        protected BadPasswordException(
+          System.Runtime.Serialization.SerializationInfo info,
+          System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
+    }
+
+
+    [Serializable]
+    public class BadTokenVersionException : Exception
+    {
+        public BadTokenVersionException(): base("Token version is expired.") { }
+        public BadTokenVersionException(string message) : base(message) { }
+        public BadTokenVersionException(string message, Exception inner) : base(message, inner) { }
+        protected BadTokenVersionException(
+          System.Runtime.Serialization.SerializationInfo info,
+          System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
     }
 
     public enum PutUserResult
@@ -85,9 +120,12 @@ namespace Timeline.Services
         /// Try to anthenticate with the given username and password.
         /// If success, create a token and return the user info.
         /// </summary>
-        /// <param name="username">The username of the user to be anthenticated.</param>
-        /// <param name="password">The password of the user to be anthenticated.</param>
-        /// <returns>Return null if anthentication failed. An <see cref="CreateTokenResult"/> containing the created token and user info if anthentication succeeded.</returns>
+        /// <param name="username">The username of the user to anthenticate.</param>
+        /// <param name="password">The password of the user to anthenticate.</param>
+        /// <returns>An <see cref="CreateTokenResult"/> containing the created token and user info.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="username"/> or <paramref name="password"/> is null.</exception>
+        /// <exception cref="UserNotExistException">Thrown when the user with given username does not exist.</exception>
+        /// <exception cref="BadPasswordException">Thrown when password is wrong.</exception>
         Task<CreateTokenResult> CreateToken(string username, string password);
 
         /// <summary>
@@ -95,7 +133,11 @@ namespace Timeline.Services
         /// If success, return the user info.
         /// </summary>
         /// <param name="token">The token to verify.</param>
-        /// <returns>Return null if verification failed. The user info if verification succeeded.</returns>
+        /// <returns>The user info specified by the token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
+        /// <exception cref="JwtTokenVerifyException">Thrown when the token is of bad format. Thrown by <see cref="JwtService.VerifyJwtToken(string)"/>.</exception>
+        /// <exception cref="UserNotExistException">Thrown when the user specified by the token does not exist. Usually it has been deleted after the token was issued.</exception>
+        /// <exception cref="BadTokenVersionException">Thrown when the version in the token is expired. User needs to recreate the token.</exception>
         Task<UserInfo> VerifyToken(string token);
 
         /// <summary>
@@ -173,67 +215,122 @@ namespace Timeline.Services
         Task<PutAvatarResult> PutAvatar(string username, byte[] data, string mimeType);
     }
 
+    internal class UserCache
+    {
+        public string Username { get; set; }
+        public bool IsAdmin { get; set; }
+        public long Version { get; set; }
+
+        public UserInfo ToUserInfo()
+        {
+            return new UserInfo(Username, IsAdmin);
+        }
+    }
+
     public class UserService : IUserService
     {
         private readonly ILogger<UserService> _logger;
+
+        private readonly IMemoryCache _memoryCache;
         private readonly DatabaseContext _databaseContext;
+
         private readonly IJwtService _jwtService;
         private readonly IPasswordService _passwordService;
         private readonly IQCloudCosService _cosService;
 
-        public UserService(ILogger<UserService> logger, DatabaseContext databaseContext, IJwtService jwtService, IPasswordService passwordService, IQCloudCosService cosService)
+        public UserService(ILogger<UserService> logger, IMemoryCache memoryCache, DatabaseContext databaseContext, IJwtService jwtService, IPasswordService passwordService, IQCloudCosService cosService)
         {
             _logger = logger;
+            _memoryCache = memoryCache;
             _databaseContext = databaseContext;
             _jwtService = jwtService;
             _passwordService = passwordService;
             _cosService = cosService;
         }
 
+        private string GenerateCacheKeyByUserId(long id) => $"user:{id}";
+
+        private void RemoveCache(long id)
+        {
+            _memoryCache.Remove(GenerateCacheKeyByUserId(id));
+        }
+
         public async Task<CreateTokenResult> CreateToken(string username, string password)
         {
+            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)
             {
-                _logger.LogInformation($"Create token failed with invalid username. Username = {username} Password = {password} .");
-                return null;
+                var e = new UserNotExistException();
+                _logger.LogInformation(e, $"Create token failed. Reason: invalid username. Username = {username} Password = {password} .");
+                throw e;
             }
 
-            var verifyResult = _passwordService.VerifyPassword(user.EncryptedPassword, password);
-
-            if (verifyResult)
+            if (!_passwordService.VerifyPassword(user.EncryptedPassword, password))
             {
-                var roles = RoleStringToRoleArray(user.RoleString);
-                var token = _jwtService.GenerateJwtToken(new TokenInfo
-                {
-                    Name = username,
-                    Roles = roles
-                });
-                return new CreateTokenResult
-                {
-                    Token = token,
-                    UserInfo = new UserInfo(username, RoleArrayToIsAdmin(roles))
-                };
+                var e = new BadPasswordException();
+                _logger.LogInformation(e, $"Create token failed. Reason: invalid password. Username = {username} Password = {password} .");
+                throw e;
             }
-            else
+
+            var token = _jwtService.GenerateJwtToken(new TokenInfo
             {
-                _logger.LogInformation($"Create token failed with invalid password. Username = {username} Password = {password} .");
-                return null;
-            }
+                Id = user.Id,
+                Version = user.Version
+            });
+            return new CreateTokenResult
+            {
+                Token = token,
+                User = CreateUserInfo(user)
+            };
         }
 
         public async Task<UserInfo> VerifyToken(string token)
         {
-            var tokenInfo = _jwtService.VerifyJwtToken(token);
+            TokenInfo tokenInfo;
+            try
+            {
+                tokenInfo = _jwtService.VerifyJwtToken(token);
+            }
+            catch (JwtTokenVerifyException e)
+            {
+                _logger.LogInformation(e, $"Verify token falied. Reason: invalid token. Token: {token} .");
+                throw e;
+            }
 
-            if (tokenInfo == null)
+            var id = tokenInfo.Id;
+            var key = GenerateCacheKeyByUserId(id);
+            if (!_memoryCache.TryGetValue<UserCache>(key, out var cache))
             {
-                _logger.LogInformation($"Verify token falied. Reason: invalid token. Token: {token} .");
-                return null;
+                // no cache, check the database
+                var user = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync();
+
+                if (user == null)
+                {
+                    var e = new UserNotExistException();
+                    _logger.LogInformation(e, $"Verify token falied. Reason: invalid id. Token: {token} Id: {id}.");
+                    throw e;
+                }
+
+                // create cache
+                cache = CreateUserCache(user);
+                _memoryCache.CreateEntry(key).SetValue(cache);
             }
 
-            return await Task.FromResult(new UserInfo(tokenInfo.Name, RoleArrayToIsAdmin(tokenInfo.Roles)));
+            if (tokenInfo.Version != cache.Version)
+            {
+                var e = new BadTokenVersionException();
+                _logger.LogInformation(e, $"Verify token falied. Reason: invalid version. Token: {token} Id: {id} Username: {cache.Username} Version: {tokenInfo.Version} Version in cache: {cache.Version}.");
+                throw e;
+            }
+
+            return cache.ToUserInfo();
         }
 
         public async Task<UserInfo> GetUser(string username)
@@ -261,7 +358,8 @@ namespace Timeline.Services
                 {
                     Name = username,
                     EncryptedPassword = _passwordService.HashPassword(password),
-                    RoleString = IsAdminToRoleString(isAdmin)
+                    RoleString = IsAdminToRoleString(isAdmin),
+                    Version = 0
                 });
                 await _databaseContext.SaveChangesAsync();
                 return PutUserResult.Created;
@@ -269,8 +367,12 @@ namespace Timeline.Services
 
             user.EncryptedPassword = _passwordService.HashPassword(password);
             user.RoleString = IsAdminToRoleString(isAdmin);
+            user.Version += 1;
             await _databaseContext.SaveChangesAsync();
 
+            //clear cache
+            RemoveCache(user.Id);
+
             return PutUserResult.Modified;
         }
 
@@ -298,6 +400,8 @@ namespace Timeline.Services
             if (modified)
             {
                 await _databaseContext.SaveChangesAsync();
+                //clear cache
+                RemoveCache(user.Id);
             }
 
             return PatchUserResult.Success;
@@ -314,6 +418,9 @@ namespace Timeline.Services
 
             _databaseContext.Users.Remove(user);
             await _databaseContext.SaveChangesAsync();
+            //clear cache
+            RemoveCache(user.Id);
+
             return DeleteUserResult.Deleted;
         }
 
@@ -329,6 +436,9 @@ namespace Timeline.Services
 
             user.EncryptedPassword = _passwordService.HashPassword(newPassword);
             await _databaseContext.SaveChangesAsync();
+            //clear cache
+            RemoveCache(user.Id);
+
             return ChangePasswordResult.Success;
         }
 
diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs
index a865f366..83170c43 100644
--- a/Timeline/Startup.cs
+++ b/Timeline/Startup.cs
@@ -9,7 +9,6 @@ using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.IdentityModel.Tokens;
 using System.Text;
-using System.Threading.Tasks;
 using Timeline.Authenticate;
 using Timeline.Configs;
 using Timeline.Formatters;
@@ -87,6 +86,8 @@ namespace Timeline
 
             services.Configure<QCloudCosConfig>(Configuration.GetSection(nameof(QCloudCosConfig)));
             services.AddSingleton<IQCloudCosService, QCloudCosService>();
+
+            services.AddMemoryCache();
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
-- 
cgit v1.2.3


From 35300c1b1ce6377393d4c9353416daae23b6d17c Mon Sep 17 00:00:00 2001
From: 杨宇千 <crupest@outlook.com>
Date: Sun, 21 Jul 2019 23:28:21 +0800
Subject: WIP: change auth handler.

---
 Timeline/Authenticate/AuthHandler.cs | 29 ++++++++++++++++-------------
 Timeline/Startup.cs                  | 13 +------------
 2 files changed, 17 insertions(+), 25 deletions(-)

(limited to 'Timeline/Startup.cs')

diff --git a/Timeline/Authenticate/AuthHandler.cs b/Timeline/Authenticate/AuthHandler.cs
index 63442481..80bbaf14 100644
--- a/Timeline/Authenticate/AuthHandler.cs
+++ b/Timeline/Authenticate/AuthHandler.cs
@@ -1,12 +1,13 @@
 using Microsoft.AspNetCore.Authentication;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-using Microsoft.IdentityModel.Tokens;
 using Microsoft.Net.Http.Headers;
 using System;
-using System.IdentityModel.Tokens.Jwt;
+using System.Linq;
+using System.Security.Claims;
 using System.Text.Encodings.Web;
 using System.Threading.Tasks;
+using Timeline.Services;
 
 namespace Timeline.Authenticate
 {
@@ -22,18 +23,18 @@ namespace Timeline.Authenticate
         /// The query param key to search for token. If null then query params are not searched for token. Default to <c>"token"</c>.
         /// </summary>
         public string TokenQueryParamKey { get; set; } = "token";
-
-        public TokenValidationParameters TokenValidationParameters { get; set; } = new TokenValidationParameters();
     }
 
     class AuthHandler : AuthenticationHandler<AuthOptions>
     {
         private readonly ILogger<AuthHandler> _logger;
+        private readonly IUserService _userService;
 
-        public AuthHandler(IOptionsMonitor<AuthOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)
+        public AuthHandler(IOptionsMonitor<AuthOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IUserService userService)
             : base(options, logger, encoder, clock)
         {
             _logger = logger.CreateLogger<AuthHandler>();
+            _userService = userService;
         }
 
         // return null if no token is found
@@ -73,22 +74,24 @@ namespace Timeline.Authenticate
                 return AuthenticateResult.NoResult();
             }
 
-            var handler = new JwtSecurityTokenHandler();
             try
             {
-                var principal = handler.ValidateToken(token, Options.TokenValidationParameters, out var validatedToken);
+                var userInfo = await _userService.VerifyToken(token);
+
+                var identity = new ClaimsIdentity();
+                identity.AddClaim(new Claim(identity.NameClaimType, userInfo.Username, ClaimValueTypes.String));
+                identity.AddClaims(Entities.UserUtility.IsAdminToRoleArray(userInfo.IsAdmin).Select(role => new Claim(identity.RoleClaimType, role, ClaimValueTypes.String)));
+
+                var principal = new ClaimsPrincipal();
+                principal.AddIdentity(identity);
+
                 return AuthenticateResult.Success(new AuthenticationTicket(principal, AuthConstants.Scheme));
             }
-            catch (SecurityTokenException e)
+            catch (Exception e)
             {
                 _logger.LogInformation(e, "A jwt token validation failed.");
                 return AuthenticateResult.Fail(e);
             }
-            catch (Exception e)
-            {
-                _logger.LogError(e, "Arguments passed to the JwtSecurityTokenHandler.ValidateToken are bad.");
-                throw e;
-            }
         }
     }
 }
diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs
index 83170c43..374b918a 100644
--- a/Timeline/Startup.cs
+++ b/Timeline/Startup.cs
@@ -7,8 +7,6 @@ using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Diagnostics;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.IdentityModel.Tokens;
-using System.Text;
 using Timeline.Authenticate;
 using Timeline.Configs;
 using Timeline.Formatters;
@@ -53,16 +51,7 @@ namespace Timeline
             var jwtConfig = Configuration.GetSection(nameof(JwtConfig)).Get<JwtConfig>();
 
             services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
-                .AddScheme<AuthOptions, AuthHandler>(AuthConstants.Scheme, AuthConstants.DisplayName, o =>
-                 {
-                     o.TokenValidationParameters.ValidateIssuer = true;
-                     o.TokenValidationParameters.ValidateAudience = true;
-                     o.TokenValidationParameters.ValidateIssuerSigningKey = true;
-                     o.TokenValidationParameters.ValidateLifetime = true;
-                     o.TokenValidationParameters.ValidIssuer = jwtConfig.Issuer;
-                     o.TokenValidationParameters.ValidAudience = jwtConfig.Audience;
-                     o.TokenValidationParameters.IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(jwtConfig.SigningKey));
-                 });
+                .AddScheme<AuthOptions, AuthHandler>(AuthConstants.Scheme, AuthConstants.DisplayName, o => { });
 
             services.AddScoped<IUserService, UserService>();
             services.AddScoped<IJwtService, JwtService>();
-- 
cgit v1.2.3


From d088a03986713a71e274fc16144ca42b7f020e3f Mon Sep 17 00:00:00 2001
From: 杨宇千 <crupest@outlook.com>
Date: Tue, 23 Jul 2019 16:47:53 +0800
Subject: WIP: Develop UserService. Remove unused components.

---
 Timeline/Configs/JwtConfig.cs               |   4 +-
 Timeline/Entities/PutResult.cs              |  17 +++
 Timeline/Entities/UserUtility.cs            |   1 -
 Timeline/Formatters/StringInputFormatter.cs |  29 ----
 Timeline/Services/JwtService.cs             |   3 +-
 Timeline/Services/QCloudCosService.cs       |   1 -
 Timeline/Services/UserService.cs            | 204 +++++++---------------------
 Timeline/Startup.cs                         |  12 +-
 8 files changed, 72 insertions(+), 199 deletions(-)
 create mode 100644 Timeline/Entities/PutResult.cs
 delete mode 100644 Timeline/Formatters/StringInputFormatter.cs

(limited to 'Timeline/Startup.cs')

diff --git a/Timeline/Configs/JwtConfig.cs b/Timeline/Configs/JwtConfig.cs
index 1b395650..4d5ef97f 100644
--- a/Timeline/Configs/JwtConfig.cs
+++ b/Timeline/Configs/JwtConfig.cs
@@ -8,8 +8,8 @@ namespace Timeline.Configs
 
         /// <summary>
         /// Set the default value of expire offset of jwt token.
-        /// Unit is second. Default is 3600 seconds, aka 1 hour.
+        /// Unit is second. Default is 3600 * 24 seconds, aka 1 day.
         /// </summary>
-        public long DefaultExpireOffset { get; set; } = 3600;
+        public long DefaultExpireOffset { get; set; } = 3600 * 24;
     }
 }
diff --git a/Timeline/Entities/PutResult.cs b/Timeline/Entities/PutResult.cs
new file mode 100644
index 00000000..4ed48572
--- /dev/null
+++ b/Timeline/Entities/PutResult.cs
@@ -0,0 +1,17 @@
+namespace Timeline.Entities
+{
+    /// <summary>
+    /// Represents the result of a "put" operation.
+    /// </summary>
+    public enum PutResult
+    {
+        /// <summary>
+        /// Indicates the item did not exist and now is created.
+        /// </summary>
+        Created,
+        /// <summary>
+        /// Indicates the item exists already and is modified.
+        /// </summary>
+        Modified
+    }
+}
diff --git a/Timeline/Entities/UserUtility.cs b/Timeline/Entities/UserUtility.cs
index 1de7ac7d..c8e82fba 100644
--- a/Timeline/Entities/UserUtility.cs
+++ b/Timeline/Entities/UserUtility.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Linq;
-using Timeline.Entities;
 using Timeline.Models;
 using Timeline.Services;
 
diff --git a/Timeline/Formatters/StringInputFormatter.cs b/Timeline/Formatters/StringInputFormatter.cs
deleted file mode 100644
index ca9216d7..00000000
--- a/Timeline/Formatters/StringInputFormatter.cs
+++ /dev/null
@@ -1,29 +0,0 @@
-using Microsoft.AspNetCore.Mvc.Formatters;
-using Microsoft.Net.Http.Headers;
-using System.IO;
-using System.Text;
-using System.Threading.Tasks;
-
-namespace Timeline.Formatters
-{
-    public class StringInputFormatter : TextInputFormatter
-    {
-        public StringInputFormatter()
-        {
-            SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/plain"));
-
-            SupportedEncodings.Add(Encoding.UTF8);
-            SupportedEncodings.Add(Encoding.Unicode);
-        }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context, Encoding effectiveEncoding)
-        {
-            var request = context.HttpContext.Request;
-            using (var reader = new StreamReader(request.Body, effectiveEncoding))
-            {
-                var stringContent = reader.ReadToEnd();
-                return InputFormatterResult.SuccessAsync(stringContent);
-            }
-        }
-    }
-}
diff --git a/Timeline/Services/JwtService.cs b/Timeline/Services/JwtService.cs
index b070ad62..f721971b 100644
--- a/Timeline/Services/JwtService.cs
+++ b/Timeline/Services/JwtService.cs
@@ -1,5 +1,4 @@
-using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Options;
 using Microsoft.IdentityModel.Tokens;
 using System;
 using System.IdentityModel.Tokens.Jwt;
diff --git a/Timeline/Services/QCloudCosService.cs b/Timeline/Services/QCloudCosService.cs
index b37631e5..748173c4 100644
--- a/Timeline/Services/QCloudCosService.cs
+++ b/Timeline/Services/QCloudCosService.cs
@@ -6,7 +6,6 @@ using System.Diagnostics;
 using System.Linq;
 using System.Net;
 using System.Net.Http;
-using System.Net.Http.Headers;
 using System.Security.Cryptography;
 using System.Text;
 using System.Text.RegularExpressions;
diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs
index 49c9747d..ec8e5091 100644
--- a/Timeline/Services/UserService.cs
+++ b/Timeline/Services/UserService.cs
@@ -50,70 +50,6 @@ namespace Timeline.Services
           System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
     }
 
-    public enum PutUserResult
-    {
-        /// <summary>
-        /// A new user is created.
-        /// </summary>
-        Created,
-        /// <summary>
-        /// A existing user is modified.
-        /// </summary>
-        Modified
-    }
-
-    public enum PatchUserResult
-    {
-        /// <summary>
-        /// Succeed to modify user.
-        /// </summary>
-        Success,
-        /// <summary>
-        /// A user of given username does not exist.
-        /// </summary>
-        NotExists
-    }
-
-    public enum DeleteUserResult
-    {
-        /// <summary>
-        /// A existing user is deleted.
-        /// </summary>
-        Deleted,
-        /// <summary>
-        /// A user of given username does not exist.
-        /// </summary>
-        NotExists
-    }
-
-    public enum ChangePasswordResult
-    {
-        /// <summary>
-        /// Success to change password.
-        /// </summary>
-        Success,
-        /// <summary>
-        /// The user does not exists.
-        /// </summary>
-        NotExists,
-        /// <summary>
-        /// Old password is wrong.
-        /// </summary>
-        BadOldPassword
-    }
-
-    public enum PutAvatarResult
-    {
-        /// <summary>
-        /// Success to upload avatar.
-        /// </summary>
-        Success,
-        /// <summary>
-        /// The user does not exists.
-        /// </summary>
-        UserNotExists
-    }
-
     public interface IUserService
     {
         /// <summary>
@@ -160,31 +96,29 @@ namespace Timeline.Services
         /// </summary>
         /// <param name="username">Username of user.</param>
         /// <param name="password">Password of user.</param>
-        /// <param name="roles">Array of roles of user.</param>
-        /// <returns>Return <see cref="PutUserResult.Created"/> if a new user is created.
-        /// Return <see cref="PutUserResult.Modified"/> if a existing user is modified.</returns>
-        Task<PutUserResult> PutUser(string username, string password, bool isAdmin);
+        /// <param name="isAdmin">Whether the user is administrator.</param>
+        /// <returns>Return <see cref="PutResult.Created"/> if a new user is created.
+        /// Return <see cref="PutResult.Modified"/> if a existing user is modified.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="username"/> or <paramref name="password"/> is null.</exception>
+        Task<PutResult> PutUser(string username, string password, bool isAdmin);
 
         /// <summary>
-        /// Partially modify a use of given username.
+        /// Partially modify a user of given username.
         /// </summary>
-        /// <param name="username">Username of the user to modify.</param>
-        /// <param name="password">New password. If not modify, then null.</param>
-        /// <param name="roles">New roles. If not modify, then null.</param>
-        /// <returns>Return <see cref="PatchUserResult.Success"/> if modification succeeds.
-        /// Return <see cref="PatchUserResult.NotExists"/> if the user of given username doesn't exist.</returns>
-        Task<PatchUserResult> PatchUser(string username, string password, bool? isAdmin);
+        /// <param name="username">Username of the user to modify. Can't be null.</param>
+        /// <param name="password">New password. Null if not modify.</param>
+        /// <param name="isAdmin">Whether the user is administrator. Null if not modify.</param>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="username"/> is null.</exception>
+        /// <exception cref="UserNotExistException">Thrown if the user with given username does not exist.</exception>
+        Task PatchUser(string username, string password, bool? isAdmin);
 
         /// <summary>
         /// Delete a user of given username.
-        /// Return <see cref="DeleteUserResult.Deleted"/> if the user is deleted.
-        /// Return <see cref="DeleteUserResult.NotExists"/> if the user of given username
-        /// does not exist.
         /// </summary>
-        /// <param name="username">Username of thet user to delete.</param>
-        /// <returns><see cref="DeleteUserResult.Deleted"/> if the user is deleted.
-        /// <see cref="DeleteUserResult.NotExists"/> if the user doesn't exist.</returns>
-        Task<DeleteUserResult> DeleteUser(string username);
+        /// <param name="username">Username of thet user to delete. Can't be null.</param>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="username"/> is null.</exception>
+        /// <exception cref="UserNotExistException">Thrown if the user with given username does not exist.</exception>
+        Task DeleteUser(string username);
 
         /// <summary>
         /// Try to change a user's password with old password.
@@ -192,27 +126,10 @@ namespace Timeline.Services
         /// <param name="username">The name of user to change password of.</param>
         /// <param name="oldPassword">The user's old password.</param>
         /// <param name="newPassword">The user's new password.</param>
-        /// <returns><see cref="ChangePasswordResult.Success"/> if success.
-        /// <see cref="ChangePasswordResult.NotExists"/> if user does not exist.
-        /// <see cref="ChangePasswordResult.BadOldPassword"/> if old password is wrong.</returns>
-        Task<ChangePasswordResult> ChangePassword(string username, string oldPassword, string newPassword);
-
-        /// <summary>
-        /// Get the true avatar url of a user.
-        /// </summary>
-        /// <param name="username">The name of user.</param>
-        /// <returns>The url if user exists. Null if user does not exist.</returns>
-        Task<string> GetAvatarUrl(string username);
-
-        /// <summary>
-        /// Put a avatar of a user.
-        /// </summary>
-        /// <param name="username">The name of user.</param>
-        /// <param name="data">The data of avatar image.</param>
-        /// <param name="mimeType">The mime type of the image.</param>
-        /// <returns>Return <see cref="PutAvatarResult.Success"/> if success.
-        /// Return <see cref="PutAvatarResult.UserNotExists"/> if user does not exist.</returns>
-        Task<PutAvatarResult> PutAvatar(string username, byte[] data, string mimeType);
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="username"/> or <paramref name="oldPassword"/> or <paramref name="newPassword"/> is null.</exception>
+        /// <exception cref="UserNotExistException">Thrown if the user with given username does not exist.</exception>
+        /// <exception cref="BadPasswordException">Thrown if the old password is wrong.</exception>
+        Task ChangePassword(string username, string oldPassword, string newPassword);
     }
 
     internal class UserCache
@@ -348,8 +265,13 @@ namespace Timeline.Services
                 .ToArrayAsync();
         }
 
-        public async Task<PutUserResult> PutUser(string username, string password, bool isAdmin)
+        public async Task<PutResult> PutUser(string username, string password, bool isAdmin)
         {
+            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)
@@ -362,7 +284,7 @@ namespace Timeline.Services
                     Version = 0
                 });
                 await _databaseContext.SaveChangesAsync();
-                return PutUserResult.Created;
+                return PutResult.Created;
             }
 
             user.EncryptedPassword = _passwordService.HashPassword(password);
@@ -373,15 +295,17 @@ namespace Timeline.Services
             //clear cache
             RemoveCache(user.Id);
 
-            return PutUserResult.Modified;
+            return PutResult.Modified;
         }
 
-        public async Task<PatchUserResult> PatchUser(string username, string password, bool? isAdmin)
+        public async Task PatchUser(string username, string password, bool? isAdmin)
         {
-            var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
+            if (username == null)
+                throw new ArgumentNullException(nameof(username));
 
+            var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
             if (user == null)
-                return PatchUserResult.NotExists;
+                throw new UserNotExistException();
 
             bool modified = false;
 
@@ -399,78 +323,50 @@ namespace Timeline.Services
 
             if (modified)
             {
+                user.Version += 1;
                 await _databaseContext.SaveChangesAsync();
                 //clear cache
                 RemoveCache(user.Id);
             }
-
-            return PatchUserResult.Success;
         }
 
-        public async Task<DeleteUserResult> DeleteUser(string username)
+        public async Task DeleteUser(string username)
         {
-            var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
+            if (username == null)
+                throw new ArgumentNullException(nameof(username));
 
+            var user = await _databaseContext.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
             if (user == null)
-            {
-                return DeleteUserResult.NotExists;
-            }
+                throw new UserNotExistException();
 
             _databaseContext.Users.Remove(user);
             await _databaseContext.SaveChangesAsync();
             //clear cache
             RemoveCache(user.Id);
-
-            return DeleteUserResult.Deleted;
         }
 
-        public async Task<ChangePasswordResult> ChangePassword(string username, string oldPassword, string newPassword)
+        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)
-                return ChangePasswordResult.NotExists;
+                throw new UserNotExistException();
 
             var verifyResult = _passwordService.VerifyPassword(user.EncryptedPassword, oldPassword);
             if (!verifyResult)
-                return ChangePasswordResult.BadOldPassword;
+                throw new BadPasswordException();
 
             user.EncryptedPassword = _passwordService.HashPassword(newPassword);
+            user.Version += 1;
             await _databaseContext.SaveChangesAsync();
             //clear cache
             RemoveCache(user.Id);
-
-            return ChangePasswordResult.Success;
-        }
-
-        public async Task<string> GetAvatarUrl(string username)
-        {
-            if (username == null)
-                throw new ArgumentNullException(nameof(username));
-
-            if ((await GetUser(username)) == null)
-                return null;
-
-            var exists = await _cosService.IsObjectExists("avatar", username);
-            if (exists)
-                return _cosService.GenerateObjectGetUrl("avatar", username);
-            else
-                return _cosService.GenerateObjectGetUrl("avatar", "__default");
-        }
-
-        public async Task<PutAvatarResult> PutAvatar(string username, byte[] data, string mimeType)
-        {
-            if (username == null)
-                throw new ArgumentNullException(nameof(username));
-            if (data == null)
-                throw new ArgumentNullException(nameof(data));
-            if (mimeType == null)
-                throw new ArgumentNullException(nameof(mimeType));
-
-            if ((await GetUser(username)) == null)
-                return PutAvatarResult.UserNotExists;
-
-            await _cosService.PutObject("avatar", username, data, mimeType);
-            return PutAvatarResult.Success;
         }
     }
 }
diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs
index 374b918a..a6965190 100644
--- a/Timeline/Startup.cs
+++ b/Timeline/Startup.cs
@@ -1,4 +1,3 @@
-using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.HttpOverrides;
@@ -9,7 +8,6 @@ using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Timeline.Authenticate;
 using Timeline.Configs;
-using Timeline.Formatters;
 using Timeline.Models;
 using Timeline.Services;
 
@@ -31,10 +29,7 @@ namespace Timeline
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices(IServiceCollection services)
         {
-            services.AddMvc(options =>
-            {
-                options.InputFormatters.Add(new StringInputFormatter());
-            }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
+            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
 
             services.AddCors(options =>
             {
@@ -50,7 +45,7 @@ namespace Timeline
             services.Configure<JwtConfig>(Configuration.GetSection(nameof(JwtConfig)));
             var jwtConfig = Configuration.GetSection(nameof(JwtConfig)).Get<JwtConfig>();
 
-            services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
+            services.AddAuthentication(AuthConstants.Scheme)
                 .AddScheme<AuthOptions, AuthHandler>(AuthConstants.Scheme, AuthConstants.DisplayName, o => { });
 
             services.AddScoped<IUserService, UserService>();
@@ -73,9 +68,6 @@ namespace Timeline
 
             services.AddHttpClient();
 
-            services.Configure<QCloudCosConfig>(Configuration.GetSection(nameof(QCloudCosConfig)));
-            services.AddSingleton<IQCloudCosService, QCloudCosService>();
-
             services.AddMemoryCache();
         }
 
-- 
cgit v1.2.3