1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.Net.Http.Headers;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Security.Claims;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Threading.Tasks;
using Timeline.Models;
using Timeline.Models.Http;
using Timeline.Services.Token;
using Timeline.Services.User;
namespace Timeline.Auth
{
public static class AuthenticationConstants
{
public const string Scheme = "Bearer";
public const string DisplayName = "My Jwt Auth Scheme";
public const string PermissionClaimName = "Permission";
}
public class MyAuthenticationOptions : AuthenticationSchemeOptions
{
/// <summary>
/// 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 class MyAuthenticationHandler : AuthenticationHandler<MyAuthenticationOptions>
{
private const string TokenErrorCodeKey = "TokenErrorCode";
private static int GetErrorCodeForUserTokenException(UserTokenException e)
{
return e switch
{
UserTokenTimeExpiredException => ErrorCodes.Common.Token.TimeExpired,
UserTokenVersionExpiredException => ErrorCodes.Common.Token.VersionExpired,
UserTokenBadFormatException => ErrorCodes.Common.Token.BadFormat,
UserTokenUserNotExistException => ErrorCodes.Common.Token.UserNotExist,
_ => ErrorCodes.Common.Token.Unknown
};
}
private static string GetTokenErrorMessageFromErrorCode(int errorCode)
{
return errorCode switch
{
ErrorCodes.Common.Token.TimeExpired => Resource.MessageTokenTimeExpired,
ErrorCodes.Common.Token.VersionExpired => Resource.MessageTokenVersionExpired,
ErrorCodes.Common.Token.BadFormat => Resource.MessageTokenBadFormat,
ErrorCodes.Common.Token.UserNotExist => Resource.MessageTokenUserNotExist,
_ => Resource.MessageTokenUnknownError
};
}
private readonly ILogger<MyAuthenticationHandler> _logger;
private readonly IUserTokenManager _userTokenManager;
private readonly IUserPermissionService _userPermissionService;
private readonly IOptionsMonitor<JsonOptions> _jsonOptions;
public MyAuthenticationHandler(IOptionsMonitor<MyAuthenticationOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IUserTokenManager userTokenManager, IUserPermissionService userPermissionService, IOptionsMonitor<JsonOptions> jsonOptions)
: base(options, logger, encoder, clock)
{
_logger = logger.CreateLogger<MyAuthenticationHandler>();
_userTokenManager = userTokenManager;
_userPermissionService = userPermissionService;
_jsonOptions = jsonOptions;
}
// return null if no token is found
private string? ExtractToken()
{
// check the authorization header
string header = Request.Headers[HeaderNames.Authorization];
if (!string.IsNullOrEmpty(header) && header.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase))
{
var token = header["Bearer ".Length..].Trim();
_logger.LogInformation(Resource.LogTokenFoundInHeader, token);
return token;
}
// check the query params
var paramQueryKey = Options.TokenQueryParamKey;
if (!string.IsNullOrEmpty(paramQueryKey))
{
string token = Request.Query[paramQueryKey];
if (!string.IsNullOrEmpty(token))
{
_logger.LogInformation(Resource.LogTokenFoundInQuery, paramQueryKey, token);
return token;
}
}
// not found anywhere then return null
return null;
}
protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
{
var token = ExtractToken();
if (string.IsNullOrEmpty(token))
{
_logger.LogInformation(Resource.LogTokenNotFound);
return AuthenticateResult.NoResult();
}
try
{
var user = await _userTokenManager.VerifyTokenAsync(token);
var identity = new ClaimsIdentity(AuthenticationConstants.Scheme);
identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, user.Id.ToString(CultureInfo.InvariantCulture), ClaimValueTypes.Integer64));
identity.AddClaim(new Claim(identity.NameClaimType, user.Username, ClaimValueTypes.String));
var permissions = await _userPermissionService.GetPermissionsOfUserAsync(user.Id);
identity.AddClaims(permissions.Select(permission => new Claim(AuthenticationConstants.PermissionClaimName, permission.ToString(), ClaimValueTypes.String)));
var principal = new ClaimsPrincipal();
principal.AddIdentity(identity);
return AuthenticateResult.Success(new AuthenticationTicket(principal, AuthenticationConstants.Scheme));
}
catch (UserTokenException e)
{
var errorCode = GetErrorCodeForUserTokenException(e);
_logger.LogInformation(e, Resource.LogTokenValidationFail, GetTokenErrorMessageFromErrorCode(errorCode));
return AuthenticateResult.Fail(e, new AuthenticationProperties(new Dictionary<string, string?>()
{
[TokenErrorCodeKey] = errorCode.ToString(CultureInfo.InvariantCulture)
}));
}
}
protected override async Task HandleChallengeAsync(AuthenticationProperties properties)
{
Response.StatusCode = 401;
CommonResponse body;
if (properties.Items.TryGetValue(TokenErrorCodeKey, out var tokenErrorCode))
{
if (!int.TryParse(tokenErrorCode, out var errorCode))
errorCode = ErrorCodes.Common.Token.Unknown;
body = new CommonResponse(errorCode, GetTokenErrorMessageFromErrorCode(errorCode));
}
else
{
body = new CommonResponse(ErrorCodes.Common.Unauthorized, Resource.MessageNoToken);
}
var bodyData = JsonSerializer.SerializeToUtf8Bytes(body, typeof(CommonResponse), _jsonOptions.CurrentValue.JsonSerializerOptions);
Response.ContentType = MimeTypes.ApplicationJson;
Response.ContentLength = bodyData.Length;
await Response.Body.WriteAsync(bodyData);
}
}
}
|
