-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
IdentityJwtAuthProvider.cs
846 lines (724 loc) · 33.5 KB
/
IdentityJwtAuthProvider.cs
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
using System;
using System.Collections.Generic;
using System.IdentityModel.Tokens.Jwt;
using System.Linq;
using System.Net;
using System.Security.Claims;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Identity;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Microsoft.IdentityModel.Tokens;
using ServiceStack.Host;
using ServiceStack.Text;
using ServiceStack.Text.Pools;
using ServiceStack.Web;
namespace ServiceStack.Auth;
public record UserJwtTokens(string BearerToken, IRequireRefreshToken? RefreshToken);
public interface IIdentityJwtAuthProvider
{
string? AuthenticationScheme { get; }
List<string> DeleteCookiesOnJwtCookies { get; }
JwtBearerOptions? Options { get; }
bool EnableRefreshToken { get; }
bool RequireSecureConnection { get; }
string Audience { get; }
TimeSpan ExpireTokensIn { get; }
Task<List<Claim>> GetUserClaimsAsync(string userName, IRequest? req = null);
string CreateJwtBearerToken(List<Claim> claims, string audience, DateTime expires);
Task<string> CreateBearerTokenAsync(string userName, IRequest? req = null);
Task<UserJwtTokens> CreateBearerAndRefreshTokenAsync(string userName, IRequest? req = null);
Task<string> CreateAccessTokenFromRefreshTokenAsync(string refreshToken, IRequest? req = null);
}
/// <summary>
/// Converts an MVC JwtBearer Cookie into a ServiceStack Session
/// </summary>
public class IdentityJwtAuthProvider<TUser,TKey> :
IdentityAuthProvider<TUser,TKey>, IIdentityJwtAuthProvider, IAuthWithRequest, IAuthResponseFilter
where TKey : IEquatable<TKey>
where TUser : IdentityUser<TKey>, new()
{
public override string Type => "Bearer";
public const string Name = AuthenticateService.JwtProvider;
public const string Realm = "/auth/" + AuthenticateService.JwtProvider;
/// <summary>
/// Default Issuer to use if unspecified
/// </summary>
public string DefaultIssuer { get; set; } = "ssjwt";
/// <summary>
/// Which Hash Algorithm should be used to sign the JWT Token. (default HS256)
/// </summary>
public string HashAlgorithm { get; set; } = SecurityAlgorithms.HmacSha256;
/// <summary>
/// Which JWT Authentication Scheme configuration to use (default Bearer)
/// </summary>
public string AuthenticationScheme { get; }
public AuthenticationScheme? Scheme { get; set; }
/// <summary>
/// The JWT Bearer Options to use (default populated from AuthenticationScheme JwtBearerOptions)
/// </summary>
public JwtBearerOptions Options { get; set; }
/// <summary>
/// The JwtBearerOptions TokenValidationParameters short-hand
/// </summary>
public TokenValidationParameters TokenValidationParameters
{
get => Options.TokenValidationParameters;
set => Options.TokenValidationParameters = value;
}
/// <summary>
/// How long should JWT Tokens be valid for. (default 14 days)
/// </summary>
public TimeSpan ExpireTokensIn { get; set; } = TimeSpan.FromDays(14);
/// <summary>
/// How long should JWT Refresh Tokens be valid for. (default 90 days)
/// </summary>
public TimeSpan ExpireRefreshTokensIn { get; set; } = TimeSpan.FromDays(90);
/// <summary>
/// Convenient overload to initialize ExpireTokensIn with an Integer
/// </summary>
public int ExpireTokensInDays
{
set
{
if (value > 0)
ExpireTokensIn = TimeSpan.FromDays(value);
}
}
/// <summary>
/// Whether to only allow access via Bearer Token from a secure connection (default true)
/// </summary>
public bool RequireSecureConnection { get; set; } = true;
/// <summary>
/// Change resolution for resolving unique jti id for Access Tokens
/// </summary>
public Func<IRequest, string>? ResolveJwtId { get; set; }
/// <summary>
/// Get the next AutoId for usage in jti JWT Access Tokens
/// </summary>
public string NextJwtId() => Interlocked.Increment(ref accessIdCounter).ToString();
private long accessIdCounter;
/// <summary>
/// Whether to enable JWT Refresh Tokens (default TUser : IRequireRefreshToken)
/// </summary>
public bool EnableRefreshToken { get; set; }
/// <summary>
/// Remove Auth Cookies on Authentication
/// </summary>
public List<string> DeleteCookiesOnJwtCookies { get; set; } = [".AspNetCore.Identity.Application"];
/// <summary>
/// Register GetAccessToken Service to enable Refresh Tokens
/// </summary>
public Dictionary<Type, string[]> ServiceRoutes { get; set; } = new();
/// <summary>
/// Register ConvertSessionToTokenService
/// </summary>
public bool IncludeConvertSessionToTokenService { get; set; }
/// <summary>
/// Return Valid Audiences in comma-delimited string
/// </summary>
public string Audience
{
get
{
var audiences = (TokenValidationParameters.ValidAudiences ?? TypeConstants.EmptyStringArray).ToList();
return audiences.Count > 0
? string.Join(',', audiences)
: TokenValidationParameters.ValidAudience;
}
}
public List<(string fieldName, string claimType)> MapIdentityUserToClaims { get; set; } =
[
new(nameof(ClaimTypes.Surname), JwtClaimTypes.FamilyName),
new(nameof(JwtClaimTypes.Email), JwtClaimTypes.Email),
new(nameof(JwtClaimTypes.GivenName), JwtClaimTypes.GivenName),
new(nameof(JwtClaimTypes.FamilyName), JwtClaimTypes.FamilyName),
new(nameof(JwtClaimTypes.Picture), JwtClaimTypes.Picture),
new(nameof(JwtClaimTypes.Locale), JwtClaimTypes.Locale),
new(nameof(JwtClaimTypes.WebSite), JwtClaimTypes.WebSite),
new(nameof(JwtClaimTypes.NickName), JwtClaimTypes.NickName),
new(nameof(JwtClaimTypes.EmailVerified), JwtClaimTypes.EmailVerified),
new(nameof(AuthUserSession.FirstName), JwtClaimTypes.GivenName),
new(nameof(AuthUserSession.LastName), JwtClaimTypes.FamilyName),
new(nameof(AuthUserSession.DisplayName), JwtClaimTypes.Name),
new(nameof(AuthUserSession.ProfileUrl), JwtClaimTypes.Picture),
new(nameof(AuthUserSession.UserAuthName), JwtClaimTypes.PreferredUserName)
];
public List<string> NameClaimFieldNames { get; set; } =
[
nameof(UserAuth.DisplayName),
"Name",
"FullName",
nameof(JwtClaimTypes.GivenName),
nameof(AuthUserSession.FirstName)
];
/// <summary>
/// Customize which claims are included in the JWT Token
/// </summary>
public Action<IRequest, TUser, List<Claim>>? OnTokenCreated { get; set; }
/// <summary>
/// Invoked after Refresh Token is created
/// </summary>
public Action<IRequest, TUser>? OnRefreshTokenCreated { get; set; }
/// <summary>
/// Run custom filter after session is restored from a JWT Token
/// </summary>
public Action<IAuthSession, List<Claim>, IRequest>? OnSessionCreated { get; set; }
#if NET8_0_OR_GREATER
/// <summary>
/// Whether to invalidate Refresh Tokens on Logout (default true)
/// </summary>
public bool InvalidateRefreshTokenOnLogout { get; set; } = true;
/// <summary>
/// How long to extend the expiry of Refresh Tokens after usage (default None)
/// </summary>
public TimeSpan? ExtendRefreshTokenExpiryAfterUsage { get; set; }
#endif
public IdentityJwtAuthProvider(string? authenticationScheme = null)
: base(null, Realm, Name)
{
AuthenticationScheme = authenticationScheme ?? JwtBearerDefaults.AuthenticationScheme;
Options = new JwtBearerOptions();
ResolveJwtId = _ => NextJwtId();
EnableRefreshToken = typeof(TUser).HasInterface(typeof(IRequireRefreshToken));
Label = "JWT";
FormLayout = [
new InputInfo(nameof(IHasBearerToken.BearerToken), Html.Input.Types.Textarea)
{
Label = "JWT",
Placeholder = "JWT Bearer Token",
Required = true,
}
];
}
public override void Register(IAppHost appHost, AuthFeature feature)
{
base.Register(appHost, feature);
var applicationServices = appHost.GetApplicationServices();
var schemeProvider = applicationServices.GetService<IAuthenticationSchemeProvider>();
if (schemeProvider != null)
{
Scheme = schemeProvider.GetSchemeAsync(AuthenticationScheme).Result;
}
var optionsMonitor = applicationServices.GetRequiredService<IOptionsMonitor<JwtBearerOptions>>();
Options = optionsMonitor.Get(AuthenticationScheme);
var cookieOptions = applicationServices.GetService<IOptionsMonitor<CookiePolicyOptions>>()?.Get("");
RequireSecureConnection = cookieOptions?.Secure != CookieSecurePolicy.None;
var tokenParams = Options.TokenValidationParameters;
Options.Events ??= new();
Options.Events.OnMessageReceived = MessageReceivedAsync;
tokenParams.ValidIssuer ??= DefaultIssuer;
tokenParams.IssuerSigningKey ??= new SymmetricSecurityKey(AesUtils.CreateKey());
feature.AuthResponseDecorator = AuthenticateResponseDecorator;
feature.RegisterResponseDecorator = RegisterResponseDecorator;
feature.OnLogoutAsync.Add(OnLogoutAsync);
}
public object AuthenticateResponseDecorator(AuthFilterContext ctx)
{
var req = ctx.AuthService.Request;
if (req.IsInProcessRequest())
return ctx.AuthResponse;
if (ctx.AuthResponse.BearerToken == null)
return ctx.AuthResponse;
req.RemoveSession();
var httpResult = ctx.AuthResponse.ToTokenCookiesHttpResult(req,
IdentityAuth.TokenCookie,
DateTime.UtcNow.Add(ExpireTokensIn),
IdentityAuth.RefreshTokenCookie,
ctx.ReferrerUrl);
DeleteCookiesOnJwtCookies.ForEach(name => httpResult.DeleteCookie(req, name));
return httpResult;
}
public object RegisterResponseDecorator(RegisterFilterContext ctx)
{
var req = ctx.Request;
if (ctx.RegisterResponse.BearerToken == null)
return ctx.RegisterResponse;
var httpResult = ctx.RegisterResponse.ToTokenCookiesHttpResult(req,
IdentityAuth.TokenCookie,
DateTime.UtcNow.Add(ExpireTokensIn),
IdentityAuth.RefreshTokenCookie,
ctx.ReferrerUrl);
DeleteCookiesOnJwtCookies.ForEach(name => httpResult.DeleteCookie(req, name));
return httpResult;
}
public override bool IsAuthorized(IAuthSession session, IAuthTokens tokens, Authenticate? request = null)
{
return session is { FromToken: true, IsAuthenticated: true };
}
public override Task<object> AuthenticateAsync(IServiceBase authService, IAuthSession session, Authenticate request,
CancellationToken token = new())
{
// only allow verification of token
if (!string.IsNullOrEmpty(request.Password) && string.IsNullOrEmpty(request.UserName))
{
var req = authService.Request;
var bearerToken = request.Password;
var principal = new JwtSecurityTokenHandler().ValidateToken(bearerToken,
Options!.TokenValidationParameters, out SecurityToken validatedToken);
var jwtSession = CreateSessionFromClaims(req, principal);
var to = jwtSession.ConvertTo<AuthenticateResponse>();
to.UserId = jwtSession.UserAuthId;
return (to as object).InTask();
}
throw new NotImplementedException("JWT Authenticate() should not be called directly");
}
/// <summary>
/// Populate ServiceStack Session from JWT
/// </summary>
public Task PreAuthenticateAsync(IRequest req, IResponse res)
{
var token = req.GetJwtToken();
if (!string.IsNullOrEmpty(token) &&
!(req.Items.TryGetValue(Keywords.Session, out var oSession) && oSession is IAuthSession { IsAuthenticated: true }))
{
var user = req.GetClaimsPrincipal();
if (!user.IsAuthenticated())
{
user = new JwtSecurityTokenHandler().ValidateToken(token,
Options!.TokenValidationParameters, out SecurityToken validatedToken);
}
var session = CreateSessionFromClaims(req, user);
req.Items[Keywords.Session] = session;
}
return Task.CompletedTask;
}
public async Task MessageReceivedAsync(MessageReceivedContext ctx)
{
var auth = ctx.Request.Headers.Authorization.ToString();
ctx.Token = auth.StartsWith("Bearer ")
? auth.Substring("Bearer ".Length)
: ctx.Request.Cookies.TryGetValue(Keywords.TokenCookie, out var cookieValue)
? cookieValue
: null;
var refreshToken = ctx.Request.Cookies.TryGetValue(Keywords.RefreshTokenCookie, out cookieValue)
? cookieValue
: null;
if (ctx.Token != null || refreshToken != null)
{
bool isValid = false;
if (ctx.Token != null)
{
try
{
var principal = new JwtSecurityTokenHandler().ValidateToken(ctx.Token,
Options!.TokenValidationParameters, out SecurityToken validatedToken);
return;
}
catch (Exception e)
{
Log.ErrorFormat("JWT Identity BearerToken '{0}...' failed: {1}{2}",
ctx.Token.SafeSubstring(0,4), e.Message, refreshToken == null ? "" : ", trying Refresh Token...");
}
}
if (refreshToken != null)
{
var req = ctx.Request.ToRequest(GetType().Name);
try
{
ctx.Token = await CreateAccessTokenFromRefreshTokenAsync(refreshToken, req).ConfigAwait();
ctx.Response.Cookies.Append(Keywords.TokenCookie, ctx.Token, new CookieOptions {
HttpOnly = true,
Secure = RequireSecureConnection,
Expires = DateTime.UtcNow.Add(ExpireTokensIn),
});
}
catch (Exception refreshEx)
{
var errorMsg = string.Format("Failed to create AccessToken from RefreshToken '{0}...': {1}",
refreshToken.SafeSubstring(0,4), refreshEx.Message);
Log.WarnFormat(errorMsg);
ctx.Fail(errorMsg);
ctx.HttpContext.Items[Keywords.ResponseStatus] = new ResponseStatus
{
ErrorCode = nameof(HttpStatusCode.Unauthorized),
Message = errorMsg,
};
}
}
}
}
public virtual IAuthSession CreateSessionFromClaims(IRequest req, ClaimsPrincipal principal)
{
var claims = principal.Claims.ToList();
var sessionId = claims.FirstOrDefault(x => x.Type == "jid")?.Value ?? HostContext.AppHost.CreateSessionId();
var session = SessionFeature.CreateNewSession(req, sessionId);
session.IsAuthenticated = true;
session.AuthProvider = Name;
session.FromToken = true;
var claimMap = new List<KeyValuePair<string, string>>();
claims.Each(x => claimMap.Add(new(x.Type, x.Value)));
session.PopulateFromMap(claimMap);
(session as IAuthSessionExtended)?.PopulateFromClaims(req, principal);
OnSessionCreated?.Invoke(session, claims, req);
HostContext.AppHost.OnSessionFilter(req, session, sessionId);
return session;
}
public virtual async Task ExecuteAsync(AuthFilterContext authContext)
{
var session = authContext.Session;
var authService = authContext.AuthService;
var shouldIgnore = authContext.Request.Dto is IMeta meta && meta.Meta?.TryGetValue(Keywords.Ignore, out var ignore) == true && ignore == "jwt";
var shouldReturnTokens = authContext.DidAuthenticate && !shouldIgnore;
if (shouldReturnTokens && authContext.AuthResponse.BearerToken == null && session.IsAuthenticated)
{
if (authService.Request.AllowConnection(RequireSecureConnection))
{
var req = authContext.Request;
var (user, roles) = await Manager.GetUserAndRolesByNameAsync(session.UserAuthName, authService.Request).ConfigAwait();
var bearerToken = CreateJwtBearerToken(user, roles, req);
authContext.Session.UserAuthId = authContext.AuthResponse.UserId = user.Id.ToString();
authContext.Session.Roles = roles.ToList();
authContext.UserSource = user;
authContext.AuthResponse.BearerToken = bearerToken;
var userRefreshToken = await CreateRefreshTokenAsync(user, authService.Request).ConfigAwait();
if (userRefreshToken != null)
{
authContext.AuthResponse.RefreshToken = userRefreshToken.RefreshToken;
authContext.AuthResponse.RefreshTokenExpiry = userRefreshToken.RefreshTokenExpiry;
}
}
}
}
public async Task<List<Claim>> GetUserClaimsAsync(string userName, IRequest? req = null)
{
var (user, roles) = await Manager.GetUserAndRolesByNameAsync(userName, req).ConfigAwait();
var claims = CreateUserClaims(user, roles);
return claims;
}
public async Task<string> CreateBearerTokenAsync(string userName, IRequest? req = null)
{
var (user, roles) = await Manager.GetUserAndRolesByNameAsync(userName, req).ConfigAwait();
return CreateJwtBearerToken(user, roles, req);
}
public async Task<UserJwtTokens> CreateBearerAndRefreshTokenAsync(string userName, IRequest? req = null)
{
var (user, roles) = await Manager.GetUserAndRolesByNameAsync(userName, req).ConfigAwait();
var jwt = CreateJwtBearerToken(user, roles, req);
if (user is IRequireRefreshToken hasRefreshToken && EnableRefreshToken)
{
if (hasRefreshToken.RefreshToken == null || hasRefreshToken.RefreshTokenExpiry == null || hasRefreshToken.RefreshTokenExpiry < DateTime.UtcNow)
{
hasRefreshToken = (await CreateRefreshTokenAsync(user, req).ConfigAwait())!;
}
return new(jwt, hasRefreshToken);
}
return new(jwt, null);
}
public string CreateJwtBearerToken(TUser user, IEnumerable<string>? roles = null, IRequest? req = null)
{
var claims = CreateUserClaims(user, roles);
if (req != null)
{
var jti = ResolveJwtId?.Invoke(req);
if (jti != null)
claims.Add(new Claim(JwtRegisteredClaimNames.Jti, jti));
OnTokenCreated?.Invoke(req, user, claims);
}
return CreateJwtBearerToken(claims, Audience, DateTime.UtcNow.Add(ExpireTokensIn));
}
public string CreateJwtBearerToken(List<Claim> claims, string audience, DateTime expires)
{
var credentials = new SigningCredentials(TokenValidationParameters.IssuerSigningKey, HashAlgorithm);
var securityToken = new JwtSecurityToken(
issuer: TokenValidationParameters.ValidIssuer,
audience: audience,
expires: expires,
claims: claims,
signingCredentials: credentials
);
var token = new JwtSecurityTokenHandler().WriteToken(securityToken);
return token;
}
public List<Claim> CreateUserClaims(TUser user, IEnumerable<string>? roles = null)
{
var claims = new List<Claim>
{
new(JwtRegisteredClaimNames.Sub, user.Id.ToString()!),
new(JwtClaimTypes.PreferredUserName, user.UserName ?? throw new ArgumentNullException(nameof(user.UserName))),
};
if (NameClaimFieldNames.Count > 0 || MapIdentityUserToClaims.Count > 0)
{
var existingClaimTypes = claims.Select(x => x.Type).ToSet();
var nameClaimType = TokenValidationParameters.NameClaimType ?? ClaimTypes.Name;
var userProps = new Dictionary<string, object?>(user.ToObjectDictionary(), StringComparer.OrdinalIgnoreCase);
foreach (var fieldName in NameClaimFieldNames)
{
if (!userProps.TryGetValue(fieldName, out var fieldValue))
continue;
var valueStr = fieldValue?.ToString();
if (valueStr == null)
continue;
claims.Add(new Claim(nameClaimType, valueStr));
existingClaimTypes.Add(nameClaimType);
}
foreach (var (fieldName, claimType) in MapIdentityUserToClaims)
{
if (existingClaimTypes.Contains(claimType))
continue;
if (!userProps.TryGetValue(fieldName, out var fieldValue))
continue;
var valueStr = fieldValue?.ToString();
if (valueStr == null)
continue;
claims.Add(new Claim(claimType, valueStr));
existingClaimTypes.Add(claimType);
}
}
if (roles != null)
{
var roleClaim = TokenValidationParameters.RoleClaimType ?? ClaimTypes.Role;
foreach (var role in roles)
{
claims.Add(new Claim(roleClaim, role));
}
}
return claims;
}
public Func<string> GenerateRefreshToken { get; set; } = DefaultGenerateRefreshToken;
public static string DefaultGenerateRefreshToken()
{
const int bufferSize = 64;
var buf = BufferPool.GetBuffer(bufferSize);
try
{
var rng = System.Security.Cryptography.RandomNumberGenerator.Create();
rng.GetBytes(buf, 0, bufferSize);
return Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(buf, 0, bufferSize);
}
finally
{
BufferPool.ReleaseBufferToPool(ref buf);
}
}
protected virtual async Task<IRequireRefreshToken?> CreateRefreshTokenAsync(TUser user, IRequest? req = null)
{
#if NET8_0_OR_GREATER
if (!EnableRefreshToken)
return null;
if (user is IRequireRefreshToken requireRefreshToken)
{
requireRefreshToken.RefreshToken = GenerateRefreshToken();
requireRefreshToken.RefreshTokenExpiry = DateTime.UtcNow.Add(ExpireRefreshTokensIn);
if (req != null)
{
OnRefreshTokenCreated?.Invoke(req, user);
}
async Task UpdateUser(DbContext dbContext)
{
var dbUsers = IdentityAuth.ResolveDbUsers<TUser>(dbContext);
await dbUsers.Where(x => x.Id.Equals(user.Id))
.ExecuteUpdateAsync(setters => setters
.SetProperty(x => ((IRequireRefreshToken)x).RefreshToken, requireRefreshToken.RefreshToken)
.SetProperty(x => ((IRequireRefreshToken)x).RefreshTokenExpiry, requireRefreshToken.RefreshTokenExpiry)).ConfigAwait();
}
if (req == null)
{
var scopeFactory = ServiceStackHost.Instance.GetApplicationServices().GetRequiredService<IServiceScopeFactory>();
using var scope = scopeFactory.CreateScope();
await using var dbContext = IdentityAuth.ResolveDbContext<TUser>(scope.ServiceProvider);
await UpdateUser(dbContext).ConfigAwait();
}
else
{
await using var dbContext = IdentityAuth.ResolveDbContext<TUser>(req.GetServiceProvider());
await UpdateUser(dbContext).ConfigAwait();
}
return requireRefreshToken;
}
#else
throw new NotSupportedException("IRequireRefreshToken requires .NET 8.0+");
#endif
return null;
}
public async Task OnLogoutAsync(IRequest req)
{
#if NET8_0_OR_GREATER
var refreshToken = req.GetJwtRefreshToken();
if (InvalidateRefreshTokenOnLogout && refreshToken != null)
{
await using var dbContext = IdentityAuth.ResolveDbContext<TUser>(req.GetServiceProvider());
var dbUsers = IdentityAuth.ResolveDbUsers<TUser>(dbContext);
await dbUsers.Where(x => ((IRequireRefreshToken)x).RefreshToken!.Equals(refreshToken))
.ExecuteUpdateAsync(setters => setters
.SetProperty(x => ((IRequireRefreshToken)x).RefreshToken, null as string)
.SetProperty(x => ((IRequireRefreshToken)x).RefreshTokenExpiry, null as DateTime?)).ConfigAwait();
}
#endif
}
public async Task<string> CreateAccessTokenFromRefreshTokenAsync(string refreshToken, IRequest? req = null)
{
async Task<TUser> GetUser(DbSet<TUser> dbUsers)
{
var now = DateTime.UtcNow;
var user = await dbUsers
.Where(x => ((IRequireRefreshToken)x).RefreshToken == refreshToken)
.SingleOrDefaultAsync();
if (user == null)
throw HttpError.NotFound(ErrorMessages.UserNotExists.Localize(req));
var hasRefreshToken = (IRequireRefreshToken)user;
if (hasRefreshToken.RefreshTokenExpiry == null || now > hasRefreshToken.RefreshTokenExpiry)
throw HttpError.Forbidden(ErrorMessages.RefreshTokenInvalid.Localize(req));
if (user.LockoutEnd != null && user.LockoutEnd > DateTime.UtcNow)
throw new AuthenticationException(ErrorMessages.UserAccountLocked.Localize(req));
return user;
}
async Task UpdateRefreshTokenExpiry(DbSet<TUser> dbUsers)
{
#if NET8_0_OR_GREATER
if (ExtendRefreshTokenExpiryAfterUsage != null)
{
var updatedDate = DateTime.UtcNow.Add(ExtendRefreshTokenExpiryAfterUsage.Value);
await dbUsers.Where(x => ((IRequireRefreshToken)x).RefreshToken!.Equals(refreshToken))
.ExecuteUpdateAsync(setters => setters
.SetProperty(x => ((IRequireRefreshToken)x).RefreshTokenExpiry, updatedDate)).ConfigAwait();
}
#endif
}
if (req == null)
{
var scopeFactory = ServiceStackHost.Instance.GetApplicationServices().GetRequiredService<IServiceScopeFactory>();
using var scope = scopeFactory.CreateScope();
await using var dbContext = IdentityAuth.ResolveDbContext<TUser>(scope.ServiceProvider);
var dbUsers = IdentityAuth.ResolveDbUsers<TUser>(dbContext);
using var userManager = scope.ServiceProvider.GetRequiredService<UserManager<TUser>>();
var user = await GetUser(dbUsers).ConfigAwait();
var roles = await userManager.GetRolesAsync(user).ConfigAwait();
await UpdateRefreshTokenExpiry(dbUsers).ConfigAwait();
return CreateJwtBearerToken(user, roles, req);
}
else
{
var services = req.GetServiceProvider();
await using var dbContext = IdentityAuth.ResolveDbContext<TUser>(services);
var dbUsers = IdentityAuth.ResolveDbUsers<TUser>(dbContext);
var userManager = services.GetRequiredService<UserManager<TUser>>();
var user = await GetUser(dbUsers).ConfigAwait();
var roles = await userManager.GetRolesAsync(user).ConfigAwait();
await UpdateRefreshTokenExpiry(dbUsers).ConfigAwait();
return CreateJwtBearerToken(user, roles, req);
}
}
public async Task ResultFilterAsync(AuthResultContext authContext, CancellationToken token = default)
{
var addJwtCookie = authContext.Result.Cookies.All(x => x.Name != IdentityAuth.TokenCookie);
var addRefreshCookie = authContext.Result.Cookies.All(x => x.Name != IdentityAuth.RefreshTokenCookie) && EnableRefreshToken;
if (addJwtCookie || addRefreshCookie)
{
var (user, roles) = await Manager.GetUserAndRolesByNameAsync(authContext.Session.UserAuthName, authContext.Request).ConfigAwait();
if (addJwtCookie)
{
var accessToken = CreateJwtBearerToken(user, roles, authContext.Request);
await authContext.Request.RemoveSessionAsync(authContext.Session.Id, token);
authContext.Result.AddCookie(authContext.Request,
new Cookie(IdentityAuth.TokenCookie, accessToken, Cookies.RootPath)
{
HttpOnly = true,
Secure = authContext.Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(ExpireTokensIn),
});
}
if (addRefreshCookie)
{
var userRefreshToken = await CreateRefreshTokenAsync(user, authContext.Request).ConfigAwait();
if (userRefreshToken?.RefreshTokenExpiry != null)
{
authContext.Result.AddCookie(authContext.Request,
new Cookie(IdentityAuth.RefreshTokenCookie, userRefreshToken.RefreshToken, Cookies.RootPath)
{
HttpOnly = true,
Secure = authContext.Request.IsSecureConnection,
Expires = userRefreshToken.RefreshTokenExpiry.Value,
});
}
}
DeleteCookiesOnJwtCookies.ForEach(name =>
authContext.Result.DeleteCookie(authContext.Request, name));
}
JwtUtils.NotifyJwtCookiesUsed(authContext.Result);
}
}
[Authenticate]
[DefaultRequest(typeof(ConvertSessionToToken))]
public class ConvertSessionToTokenService(IIdentityJwtAuthProvider jwtAuthProvider) : Service
{
public async Task<object> Any(ConvertSessionToToken request)
{
if (!Request.AllowConnection(jwtAuthProvider.RequireSecureConnection))
throw HttpError.Forbidden(ErrorMessages.JwtRequiresSecureConnection.Localize(Request));
if (Request.ResponseContentType.MatchesContentType(MimeTypes.Html))
Request.ResponseContentType = MimeTypes.Json;
var httpResult = new HttpResult(new ConvertSessionToTokenResponse());
var token = Request.GetJwtToken();
IAuthSession? session = null;
UserJwtTokens? userTokens = null;
var createFromSession = string.IsNullOrEmpty(token);
if (!createFromSession)
{
userTokens = new(token, null);
}
else
{
session = await Request.GetSessionAsync().ConfigAwait();
if (createFromSession)
token = await jwtAuthProvider.CreateBearerTokenAsync(session.UserAuthName, Request).ConfigAwait();
if (!request.PreserveSession)
{
if (session.Id != null)
await Request.RemoveSessionAsync(session.Id).ConfigAwait();
jwtAuthProvider.DeleteCookiesOnJwtCookies.ForEach(name => httpResult.DeleteCookie(Request, name));
if (jwtAuthProvider.EnableRefreshToken)
{
userTokens = await jwtAuthProvider.CreateBearerAndRefreshTokenAsync(session.UserAuthName, Request).ConfigAwait();
}
}
userTokens ??= new(token, null);
}
httpResult.AddCookie(Request,
new Cookie(Keywords.TokenCookie, token, Cookies.RootPath) {
HttpOnly = true,
Secure = Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(jwtAuthProvider.ExpireTokensIn),
});
if (userTokens.RefreshToken is { RefreshTokenExpiry: not null })
{
httpResult.AddCookie(Request,
new Cookie(Keywords.RefreshTokenCookie, token, Cookies.RootPath) {
HttpOnly = true,
Secure = Request.IsSecureConnection,
Expires = userTokens.RefreshToken.RefreshTokenExpiry.Value,
});
}
return httpResult;
}
}
[DefaultRequest(typeof(GetAccessToken))]
public class GetAccessTokenIdentityService(IIdentityJwtAuthProvider jwtAuthProvider) : Service
{
public async Task<object> Any(GetAccessToken request)
{
if (jwtAuthProvider.RequireSecureConnection && !Request.IsSecureConnection)
throw HttpError.Forbidden(ErrorMessages.JwtRequiresSecureConnection.Localize(Request));
var refreshTokenCookie = Request.Cookies.TryGetValue(Keywords.RefreshTokenCookie, out var refTok)
? refTok.Value
: null;
var refreshToken = request.RefreshToken ?? refreshTokenCookie;
if (refreshToken == null)
throw HttpError.Forbidden(ErrorMessages.RefreshTokenInvalid.Localize(Request));
var accessToken = await jwtAuthProvider.CreateAccessTokenFromRefreshTokenAsync(refreshToken, Request).ConfigAwait();
var httpResult = new HttpResult(new GetAccessTokenResponse())
.AddCookie(Request,
new Cookie(Keywords.TokenCookie, accessToken, Cookies.RootPath) {
HttpOnly = true,
Secure = Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(jwtAuthProvider.ExpireTokensIn),
});
return httpResult;
}
}