-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathJwtAuthProvider.cs
More file actions
560 lines (463 loc) · 22.4 KB
/
Copy pathJwtAuthProvider.cs
File metadata and controls
560 lines (463 loc) · 22.4 KB
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
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Security.Cryptography;
using System.Threading;
using System.Threading.Tasks;
using ServiceStack.Configuration;
using ServiceStack.Host;
using ServiceStack.Text;
using ServiceStack.Web;
using ServiceStack.Html;
using ServiceStack.Logging;
namespace ServiceStack.Auth
{
/// <summary>
/// Used to Issue and process JWT Tokens and registers ConvertSessionToToken Service to convert Sessions to JWT Tokens
/// </summary>
public class JwtAuthProvider : JwtAuthProviderReader, IAuthResponseFilter
{
/// <summary>
/// Whether to populate the Bearer Token in the AuthenticateResponse
/// </summary>
public bool SetBearerTokenOnAuthenticateResponse { get; set; }
// Max Cookie size ss-tok={Base64 JWT} < 4096
public static int MaxProfileUrlSize { get; set; } = 2800;
public JwtAuthProvider() : this(null) {}
public JwtAuthProvider(IAppSettings appSettings) : base(appSettings)
{
Label = "JWT";
FormLayout = new() {
new InputInfo(nameof(IHasBearerToken.BearerToken), Input.Types.Textarea) {
Label = "JWT",
Placeholder = "JWT Bearer Token",
Required = true,
},
};
}
public override void Init(IAppSettings appSettings = null)
{
this.SetBearerTokenOnAuthenticateResponse = appSettings == null
|| appSettings.Get("jwt.SetBearerTokenOnAuthenticateResponse", true);
ServiceRoutes = new Dictionary<Type, string[]>
{
{ typeof(ConvertSessionToTokenService), new[] { "/session-to-token" } },
{ typeof(GetAccessTokenService), new[] { "/access-token" } },
};
base.Init(appSettings);
}
public async Task ExecuteAsync(AuthFilterContext authContext)
{
var session = authContext.Session;
var authService = authContext.AuthService;
var shouldReturnTokens = authContext.DidAuthenticate;
if (shouldReturnTokens && SetBearerTokenOnAuthenticateResponse && authContext.AuthResponse.BearerToken == null && session.IsAuthenticated)
{
if (!RequireSecureConnection || authService.Request.IsSecureConnection)
{
IEnumerable<string> roles = null, perms = null;
var userRepo = HostContext.AppHost.GetAuthRepositoryAsync(authService.Request);
await using (userRepo as IAsyncDisposable)
{
if (userRepo is IManageRolesAsync manageRoles)
{
var tuple = await manageRoles.GetRolesAndPermissionsAsync(session.UserAuthId).ConfigAwait();
roles = tuple.Item1;
perms = tuple.Item2;
}
}
authContext.AuthResponse.BearerToken = CreateJwtBearerToken(authContext.AuthService.Request, session, roles, perms);
authContext.AuthResponse.RefreshToken = EnableRefreshToken()
? CreateJwtRefreshToken(authService.Request, session.UserAuthId, ExpireRefreshTokensIn)
: null;
}
}
}
public async Task ResultFilterAsync(AuthResultContext authContext, CancellationToken token=default)
{
if (UseTokenCookie && authContext.Result.Cookies.All(x => x.Name != Keywords.TokenCookie))
{
var accessToken = CreateJwtBearerToken(authContext.Request, authContext.Session);
await authContext.Request.RemoveSessionAsync(authContext.Session.Id, token);
authContext.Result.AddCookie(authContext.Request,
new Cookie(Keywords.TokenCookie, accessToken, Cookies.RootPath) {
HttpOnly = true,
Secure = authContext.Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(ExpireTokensIn),
});
}
if (UseTokenCookie && authContext.Result.Cookies.All(x => x.Name != Keywords.RefreshTokenCookie)
&& EnableRefreshToken())
{
var refreshToken = CreateJwtRefreshToken(authContext.Request, authContext.Session.Id, ExpireRefreshTokensIn);
authContext.Result.AddCookie(authContext.Request,
new Cookie(Keywords.RefreshTokenCookie, refreshToken, Cookies.RootPath) {
HttpOnly = true,
Secure = authContext.Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(ExpireRefreshTokensIn),
});
}
JwtUtils.NotifyJwtCookiesUsed(authContext.Result);
}
public Func<byte[], byte[]> GetHashAlgorithm() => GetHashAlgorithm(null);
public Func<byte[], byte[]> GetHashAlgorithm(IRequest req)
{
Func<byte[], byte[]> hashAlgorithm = null;
if (HmacAlgorithms.TryGetValue(HashAlgorithm, out var hmac))
{
var authKey = GetAuthKey(req);
if (authKey == null)
throw new NotSupportedException("AuthKey required to use: " + HashAlgorithm);
hashAlgorithm = data => hmac(authKey, data);
}
if (RsaSignAlgorithms.TryGetValue(HashAlgorithm, out var rsa))
{
var privateKey = GetPrivateKey(req);
if (privateKey == null)
throw new NotSupportedException("PrivateKey required to use: " + HashAlgorithm);
hashAlgorithm = data => rsa(privateKey.Value, data);
}
if (hashAlgorithm == null)
throw new NotSupportedException("Invalid algorithm: " + HashAlgorithm);
return hashAlgorithm;
}
public string CreateJwtBearerToken(IAuthSession session, IEnumerable<string> roles = null, IEnumerable<string> perms = null) =>
CreateJwtBearerToken(null, session, roles, perms);
public string CreateJwtBearerToken(IRequest req, IAuthSession session, IEnumerable<string> roles = null, IEnumerable<string> perms = null)
{
var jwtPayload = CreateJwtPayload(session, Issuer, ExpireTokensIn, Audiences, roles, perms);
var jti = ResolveJwtId != null
? ResolveJwtId(req)
: NextJwtId();
if (jti != null)
jwtPayload[nameof(jti)] = jti;
CreatePayloadFilter?.Invoke(jwtPayload, session);
if (EncryptPayload)
{
var publicKey = GetPublicKey(req);
if (publicKey == null)
throw new NotSupportedException("PublicKey is required to EncryptPayload");
return CreateEncryptedJweToken(jwtPayload, publicKey.Value);
}
var jwtHeader = CreateJwtHeader(HashAlgorithm, GetKeyId(req));
CreateHeaderFilter?.Invoke(jwtHeader, session);
var hashAlgorithm = GetHashAlgorithm(req);
var bearerToken = CreateJwt(jwtHeader, jwtPayload, hashAlgorithm);
return bearerToken;
}
public string CreateJwtRefreshToken(string userId, TimeSpan expireRefreshTokenIn) => CreateJwtRefreshToken(null, userId, expireRefreshTokenIn);
public string CreateJwtRefreshToken(IRequest req, string userId, TimeSpan expireRefreshTokenIn)
{
var jwtHeader = new JsonObject
{
{"typ", "JWTR"}, //RefreshToken
{"alg", HashAlgorithm}
};
var keyId = GetKeyId(req);
if (keyId != null)
jwtHeader["kid"] = keyId;
var now = DateTime.UtcNow;
var jwtPayload = new JsonObject
{
{"sub", userId},
{"iat", ResolveUnixTime(now).ToString()},
{"exp", ResolveUnixTime(now.Add(expireRefreshTokenIn)).ToString()},
};
jwtPayload.SetAudience(Audiences);
var jti = ResolveJwtId != null
? ResolveRefreshJwtId(req)
: NextRefreshJwtId();
if (jti != null)
jwtPayload[nameof(jti)] = jti;
var hashAlgorithm = GetHashAlgorithm(req);
var refreshToken = CreateJwt(jwtHeader, jwtPayload, hashAlgorithm);
return refreshToken;
}
protected virtual bool EnableRefreshToken()
{
var userSessionSource = AuthenticateService.GetUserSessionSourceAsync();
if (userSessionSource != null)
return true;
var authRepo = HostContext.AppHost?.TryResolve<IAuthRepository>();
if (authRepo == null)
return false;
using (authRepo as IDisposable)
{
return authRepo is IUserAuthRepository;
}
}
public static string CreateEncryptedJweToken(JsonObject jwtPayload, RSAParameters publicKey)
{
//From: http://self-issued.info/docs/draft-ietf-jose-json-web-encryption-09.html#RSACBCExample
var jweHeader = new JsonObject
{
{ "alg", "RSA-OAEP" },
{ "enc", "A128CBC-HS256" },
{ "kid", Convert.ToBase64String(publicKey.Modulus).Substring(0,3) },
};
var jweHeaderBase64Url = jweHeader.ToJson().ToUtf8Bytes().ToBase64UrlSafe();
var authKey = new byte[128 / 8];
var cryptKey = new byte[128 / 8];
var cryptAuthKeys256 = AesUtils.CreateKey();
Buffer.BlockCopy(cryptAuthKeys256, 0, authKey, 0, authKey.Length);
Buffer.BlockCopy(cryptAuthKeys256, authKey.Length, cryptKey, 0, cryptKey.Length);
var aes = Aes.Create();
aes.KeySize = 128;
aes.BlockSize = 128;
aes.Mode = CipherMode.CBC;
aes.Padding = PaddingMode.PKCS7;
using (aes)
{
aes.GenerateIV();
var iv = aes.IV;
aes.Key = cryptKey;
var jweEncKey = RsaUtils.Encrypt(cryptAuthKeys256, publicKey, UseRsaKeyLength);
var jweEncKeyBase64Url = jweEncKey.ToBase64UrlSafe();
var ivBase64Url = iv.ToBase64UrlSafe();
var aad = jweHeaderBase64Url + "." + jweEncKeyBase64Url;
var aadBytes = aad.ToUtf8Bytes();
var payloadBytes = jwtPayload.ToJson().ToUtf8Bytes();
using (var cipherStream = MemoryStreamFactory.GetStream())
using (var encrypter = aes.CreateEncryptor(cryptKey, iv))
using (var cryptoStream = new CryptoStream(cipherStream, encrypter, CryptoStreamMode.Write))
using (var writer = new BinaryWriter(cryptoStream))
{
writer.Write(payloadBytes);
cryptoStream.FlushFinalBlock();
using (var hmac = new HMACSHA256(authKey))
using (var encryptedStream = MemoryStreamFactory.GetStream())
using (var bw = new BinaryWriter(encryptedStream))
{
bw.Write(aadBytes);
bw.Write(iv);
bw.Write(cipherStream.GetBuffer(), 0, (int)cipherStream.Length);
bw.Flush();
var tag = hmac.ComputeHash(encryptedStream.GetBuffer(), 0, (int) encryptedStream.Length);
var cipherTextBase64Url = cipherStream.ToBase64UrlSafe();
var tagBase64Url = tag.ToBase64UrlSafe();
var jweToken = jweHeaderBase64Url + "."
+ jweEncKeyBase64Url + "."
+ ivBase64Url + "."
+ cipherTextBase64Url + "."
+ tagBase64Url;
return jweToken;
}
}
}
}
public static string CreateJwt(
JsonObject jwtHeader,
JsonObject jwtPayload,
Func<byte[], byte[]> signData)
{
var headerBytes = jwtHeader.ToJson().ToUtf8Bytes();
var payloadBytes = jwtPayload.ToJson().ToUtf8Bytes();
var base64Header = headerBytes.ToBase64UrlSafe();
var base64Payload = payloadBytes.ToBase64UrlSafe();
var stringToSign = base64Header + "." + base64Payload;
var signature = signData(stringToSign.ToUtf8Bytes());
var bearerToken = base64Header + "." + base64Payload + "." + signature.ToBase64UrlSafe();
return bearerToken;
}
public static JsonObject CreateJwtHeader(string algorithm, string keyId = null)
{
var header = new JsonObject
{
{ "typ", "JWT" },
{ "alg", algorithm }
};
if (keyId != null)
header["kid"] = keyId;
return header;
}
public static JsonObject CreateJwtPayload(
IAuthSession session, string issuer, TimeSpan expireIn,
IEnumerable<string> audiences=null,
IEnumerable<string> roles=null,
IEnumerable<string> permissions =null)
{
var now = DateTime.UtcNow;
var jwtPayload = new JsonObject
{
{"iss", issuer},
{"sub", session.UserAuthId},
{"iat", now.ToUnixTime().ToString()},
{"exp", now.Add(expireIn).ToUnixTime().ToString()},
};
jwtPayload.SetAudience(audiences?.ToList());
if (!string.IsNullOrEmpty(session.Email))
jwtPayload["email"] = session.Email;
if (!string.IsNullOrEmpty(session.FirstName))
jwtPayload["given_name"] = session.FirstName;
if (!string.IsNullOrEmpty(session.LastName))
jwtPayload["family_name"] = session.LastName;
if (!string.IsNullOrEmpty(session.DisplayName))
jwtPayload["name"] = session.DisplayName;
if (!string.IsNullOrEmpty(session.UserName))
jwtPayload["preferred_username"] = session.UserName;
else if (!string.IsNullOrEmpty(session.UserAuthName) && !session.UserAuthName.Contains("@"))
jwtPayload["preferred_username"] = session.UserAuthName;
var profileUrl = session.GetProfileUrl();
if (profileUrl != null && profileUrl != Svg.GetDataUri(Svg.Icons.DefaultProfile))
{
if (profileUrl.Length <= MaxProfileUrlSize)
{
jwtPayload["picture"] = profileUrl;
}
else
{
LogManager.GetLogger(typeof(JwtAuthProvider)).Warn($"User '{session.UserAuthId}' ProfileUrl exceeds max JWT Cookie size, using default profile");
jwtPayload["picture"] = HostContext.GetPlugin<AuthFeature>()?.ProfileImages?.RewriteImageUri(profileUrl);
}
}
var combinedRoles = new List<string>(session.Roles.Safe());
var combinedPerms = new List<string>(session.Permissions.Safe());
roles.Each(x => combinedRoles.AddIfNotExists(x));
permissions.Each(x => combinedPerms.AddIfNotExists(x));
if (combinedRoles.Count > 0)
jwtPayload["roles"] = combinedRoles.ToJson();
if (combinedPerms.Count > 0)
jwtPayload["perms"] = combinedPerms.ToJson();
return jwtPayload;
}
/// <summary>
/// Dump contents of JWT
/// </summary>
public static string Dump(string jwt)
{
if (string.IsNullOrEmpty(jwt))
throw new ArgumentNullException(nameof(jwt));
var parts = jwt.Split('.');
if (parts.Length != 3 && parts.Length != 5)
return "Invalid JWT or JWE";
var sb = StringBuilderCache.Allocate();
var header = JSON.parse(parts[0].FromBase64UrlSafe().FromUtf8Bytes());
sb.AppendLine("Header:");
sb.AppendLine(header.Dump());
var body = JSON.parse(parts[1].FromBase64UrlSafe().FromUtf8Bytes());
sb.AppendLine("Body:");
sb.AppendLine(body.Dump());
return StringBuilderCache.ReturnAndFree(sb);
}
/// <summary>
/// Print Dump contents of JWT to Console
/// </summary>
public static void PrintDump(string jwt) => Console.WriteLine(Dump(jwt));
public override async Task<string> CreateAccessTokenFromRefreshToken(string refreshToken, IRequest req)
{
if (string.IsNullOrEmpty(refreshToken))
throw new ArgumentNullException(nameof(refreshToken));
JsonObject jwtPayload;
try
{
jwtPayload = GetVerifiedJwtPayload(req, refreshToken.Split('.'));
}
catch (ArgumentException)
{
throw;
}
catch (Exception ex)
{
throw new ArgumentException(ex.Message);
}
if (jwtPayload == null)
throw new ArgumentException(ErrorMessages.TokenInvalid.Localize(req));
AssertRefreshJwtPayloadIsValid(jwtPayload);
if (ValidateRefreshToken != null && !ValidateRefreshToken(jwtPayload, req))
throw new ArgumentException(ErrorMessages.RefreshTokenInvalid.Localize(req), nameof(refreshToken));
var userId = jwtPayload["sub"];
var result = await req.GetSessionFromSourceAsync(userId, async (authRepo, userAuth) => {
if (await IsAccountLockedAsync(authRepo, userAuth))
throw new AuthenticationException(ErrorMessages.UserAccountLocked.Localize(req));
}).ConfigAwait();
if (result == null)
throw new NotSupportedException(
"JWT RefreshTokens requires a registered IUserAuthRepository or an AuthProvider implementing IUserSessionSource");
var accessToken = CreateJwtBearerToken(req,
session: result.Session, roles: result.Roles, perms: result.Permissions);
return accessToken;
}
}
[Authenticate]
[DefaultRequest(typeof(ConvertSessionToToken))]
public class ConvertSessionToTokenService : Service
{
public object Any(ConvertSessionToToken request)
{
var jwtAuthProvider = (JwtAuthProvider)AuthenticateService.GetRequiredJwtAuthProvider();
if (jwtAuthProvider.RequireSecureConnection && !Request.IsSecureConnection)
throw HttpError.Forbidden(ErrorMessages.JwtRequiresSecureConnection.Localize(Request));
if (Request.ResponseContentType.MatchesContentType(MimeTypes.Html))
Request.ResponseContentType = MimeTypes.Json;
var token = Request.GetJwtToken();
IAuthSession session = null;
var includeTokensInResponse = jwtAuthProvider.IncludeJwtInConvertSessionToTokenResponse;
var createFromSession = string.IsNullOrEmpty(token);
if (createFromSession || includeTokensInResponse)
{
session = Request.GetSession();
if (createFromSession)
token = jwtAuthProvider.CreateJwtBearerToken(Request, session);
if (!request.PreserveSession)
Request.RemoveSession(session.Id);
}
return new HttpResult(new ConvertSessionToTokenResponse {
AccessToken = includeTokensInResponse
? token
: null,
RefreshToken = createFromSession && includeTokensInResponse && !request.PreserveSession
? jwtAuthProvider.CreateJwtRefreshToken(Request, session.UserAuthId, jwtAuthProvider.ExpireRefreshTokensIn)
: null
}).AddCookie(Request,
new Cookie(Keywords.TokenCookie, token, Cookies.RootPath) {
HttpOnly = true,
Secure = Request.IsSecureConnection,
Expires = DateTime.UtcNow.Add(jwtAuthProvider.ExpireTokensIn),
});
}
}
[DefaultRequest(typeof(GetAccessToken))]
public class GetAccessTokenService : Service
{
public async Task<object> Any(GetAccessToken request)
{
var jwtAuthProvider = (JwtAuthProvider)AuthenticateService.GetRequiredJwtAuthProvider();
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;
var accessToken = await jwtAuthProvider.CreateAccessTokenFromRefreshToken(refreshToken, Request).ConfigAwait();
var response = new GetAccessTokenResponse
{
AccessToken = accessToken
};
// Don't return JWT in Response Body if Refresh Token Cookie was used
if (refreshTokenCookie == null && jwtAuthProvider.UseTokenCookie != true)
return response;
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;
}
}
internal static class JwtAuthProviderUtils
{
internal static void SetAudience(this JsonObject jwtPayload, List<string> audiences)
{
if (audiences?.Count > 0)
{
jwtPayload["aud"] = audiences.Count == 1
? audiences[0]
: audiences.ToJson();
}
}
}
}