import 'dart:async'; import 'dart:io'; import 'dart:math' as Math; import 'package:angel_framework/angel_framework.dart'; import 'package:crypto/crypto.dart'; import 'middleware/require_auth.dart'; import 'auth_token.dart'; import 'defs.dart'; import 'options.dart'; import 'strategy.dart'; /// Handles authentication within an Angel application. class AngelAuth extends AngelPlugin { Hmac _hs256; num _jwtLifeSpan; final StreamController _onLogin = new StreamController(), _onLogout = new StreamController(); Math.Random _random = new Math.Random.secure(); final RegExp _rgxBearer = new RegExp(r"^Bearer"); /// If `true` (default), then JWT's will be stored and retrieved from a `token` cookie. final bool allowCookie; /// If `true` (default), then users can include a JWT in the query string as `token`. final bool allowTokenInQuery; /// The name to register [requireAuth] as. Default: `auth`. String middlewareName; bool debug; /// If `true` (default), then JWT's will be considered invalid if used from a different IP than the first user's it was issued to. /// /// This is a security provision. Even if a user's JWT is stolen, a remote attacker will not be able to impersonate anyone. bool enforceIp; /// The endpoint to mount [reviveJwt] at. If `null`, then no revival route is mounted. Default: `/auth/token`. String reviveTokenEndpoint; /// A set of [AuthStrategy] instances used to authenticate users. List strategies = []; /// Serializes a user into a unique identifier associated only with one identity. UserSerializer serializer; /// Deserializes a unique identifier into its associated identity. In most cases, this is a user object or model instance. UserDeserializer deserializer; /// Fires the result of [deserializer] whenever a user signs in to the application. Stream get onLogin => _onLogin.stream; /// Fires `req.user`, which is usually the result of [deserializer], whenever a user signs out of the application. Stream get onLogout => _onLogout.stream; /// The [Hmac] being used to encode JWT's. Hmac get hmac => _hs256; String _randomString( {int length: 32, String validChars: "ABCDEFHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_"}) { var chars = []; while (chars.length < length) chars.add(_random.nextInt(validChars.length)); return new String.fromCharCodes(chars); } AngelAuth( {String jwtKey, num jwtLifeSpan, this.allowCookie: true, this.allowTokenInQuery: true, this.debug: false, this.enforceIp: true, this.middlewareName: 'auth', this.reviveTokenEndpoint: "/auth/token"}) : super() { _hs256 = new Hmac(sha256, (jwtKey ?? _randomString()).codeUnits); _jwtLifeSpan = jwtLifeSpan ?? -1; } @override call(Angel app) async { if (serializer == null) throw new StateError( 'An `AngelAuth` plug-in was called without its `serializer` being set. All authentication will fail.'); if (deserializer == null) throw new StateError( 'An `AngelAuth` plug-in was called without its `deserializer` being set. All authentication will fail.'); app.container.singleton(this); if (runtimeType != AngelAuth) app.container.singleton(this, as: AngelAuth); app.before.add(decodeJwt); app.registerMiddleware(middlewareName, requireAuth); if (reviveTokenEndpoint != null) { app.post(reviveTokenEndpoint, reviveJwt); } app.justBeforeStop.add((_) { _onLogin.close(); }); } void _apply(RequestContext req, AuthToken token, user) { req ..inject(AuthToken, req.properties['token'] = token) ..inject(user.runtimeType, req.properties["user"] = user); } /// A middleware that decodes a JWT from a request, and injects a corresponding user. decodeJwt(RequestContext req, ResponseContext res) async { if (req.method == "POST" && req.path == reviveTokenEndpoint) { // Shouldn't block invalid JWT if we are reviving it if (debug) print('Token revival endpoint accessed.'); return await reviveJwt(req, res); } if (debug) { print('Enforcing JWT authentication...'); } String jwt = getJwt(req); if (debug) { print('Found JWT: $jwt'); } if (jwt != null) { var token = new AuthToken.validate(jwt, _hs256); if (debug) { print('Decoded auth token: ${token.toJson()}'); } if (enforceIp) { if (debug) { print('Token IP: ${token.ipAddress}. Current request sent from: ${req .ip}'); } if (req.ip != null && req.ip != token.ipAddress) throw new AngelHttpException.forbidden( message: "JWT cannot be accessed from this IP address."); } if (token.lifeSpan > -1) { if (debug) { print("Making sure this token hasn't already expired..."); } token.issuedAt.add(new Duration(milliseconds: token.lifeSpan)); if (!token.issuedAt.isAfter(new DateTime.now())) throw new AngelHttpException.forbidden(message: "Expired JWT."); } else if (debug) { print('This token has an infinite life span.'); } if (debug) { print('Now deserializing from this userId: ${token.userId}'); } final user = await deserializer(token.userId); _apply(req, token, user); } return true; } /// Retrieves a JWT from a request, if any was sent at all. getJwt(RequestContext req) { if (debug) { print('Attempting to parse JWT'); } if (req.headers.value("Authorization") != null) { if (debug) { print('Found Auth header'); } final authHeader = req.headers.value("Authorization"); // Allow Basic auth to fall through if (_rgxBearer.hasMatch(authHeader)) return authHeader.replaceAll(_rgxBearer, "").trim(); } else if (allowCookie && req.cookies.any((cookie) => cookie.name == "token")) { if (debug) print('Request has "token" cookie...'); return req.cookies.firstWhere((cookie) => cookie.name == "token").value; } else if (allowTokenInQuery && req.query['token'] is String) { return req.query['token']; } return null; } /// Attempts to revive an expired (or still alive) JWT. reviveJwt(RequestContext req, ResponseContext res) async { try { if (debug) print('Attempting to revive JWT...'); var jwt = getJwt(req); if (jwt == null) { var body = await req.lazyBody(); jwt = body['token']; } if (debug) print('Found JWT: $jwt'); if (jwt == null) { throw new AngelHttpException.forbidden(message: "No JWT provided"); } else { var token = new AuthToken.validate(jwt, _hs256); if (debug) print('Validated and deserialized: $token'); if (enforceIp) { if (debug) print( 'Token IP: ${token.ipAddress}. Current request sent from: ${req .ip}'); if (req.ip != token.ipAddress) throw new AngelHttpException.forbidden( message: "JWT cannot be accessed from this IP address."); } if (token.lifeSpan > -1) { if (debug) { print('Checking if token has expired... Life span is ${token .lifeSpan}'); } token.issuedAt.add(new Duration(milliseconds: token.lifeSpan)); if (!token.issuedAt.isAfter(new DateTime.now())) { print( 'Token has indeed expired! Resetting assignment date to current timestamp...'); // Extend its lifespan by changing iat token.issuedAt = new DateTime.now(); } else if (debug) { print('Token has not expired yet.'); } } else if (debug) { print('This token never expires, so it is still valid.'); } if (debug) { print('Final, valid token: ${token.toJson()}'); } if (allowCookie) res.cookies.add(new Cookie('token', token.serialize(_hs256))); final data = await deserializer(token.userId); return {'data': data, 'token': token.serialize(_hs256)}; } } catch (e, st) { if (debug) { print('An error occurred while reviving this token.'); print(e); print(st); } if (e is AngelHttpException) rethrow; throw new AngelHttpException.badRequest(message: "Malformed JWT"); } } /// Attempts to authenticate a user using one or more strategies. /// /// [type] is a comma-separated list of strategy names to try. /// /// If a strategy returns `null` or `false`, either the next one is tried, /// or a `401 Not Authenticated` is thrown, if it is the last one. /// /// Any other result is considered an authenticated user, and terminates the loop. authenticate(String type, [AngelAuthOptions options]) { return (RequestContext req, ResponseContext res) async { var names = type .split(',') .map((s) => s.trim()) .where((String s) => s.isNotEmpty) .toList(); for (int i = 0; i < names.length; i++) { var name = names[i]; AuthStrategy strategy = strategies.firstWhere( (AuthStrategy x) => x.name == name, orElse: () => throw new ArgumentError('No strategy "$name" found.')); var result = await strategy.authenticate(req, res, options); if (result == true) return result; else if (result != false) { var userId = await serializer(result); // Create JWT var token = new AuthToken( userId: userId, lifeSpan: _jwtLifeSpan, ipAddress: req.ip); var jwt = token.serialize(_hs256); if (options?.tokenCallback != null) { var r = await options.tokenCallback( req, res, token, req.properties["user"] = result); if (r != null) return r; } _apply(req, token, result); if (allowCookie) res.cookies.add(new Cookie("token", jwt)); if (options?.callback != null) { return await options.callback(req, res, jwt); } if (options?.successRedirect?.isNotEmpty == true) { res.redirect(options.successRedirect, code: HttpStatus.OK); return false; } else if (options?.canRespondWithJson != false && req.headers.value("accept") != null && (req.headers.value("accept").contains("application/json") || req.headers.value("accept").contains("*/*") || req.headers.value("accept").contains("application/*"))) { var user = await deserializer(await serializer(result)); _onLogin.add(user); return {"data": user, "token": jwt}; } return true; } else { if (i < names.length - 1) continue; // Check if not redirect if (res.statusCode == 301 || res.statusCode == 302 || res.headers.containsKey(HttpHeaders.LOCATION)) return false; else throw new AngelHttpException.notAuthenticated(); } } }; } /// Log a user in on-demand. Future login(AuthToken token, RequestContext req, ResponseContext res) async { var user = await deserializer(token.userId); _apply(req, token, user); _onLogin.add(user); if (allowCookie) res.cookies.add(new Cookie('token', token.serialize(_hs256))); } /// Log a user in on-demand. Future loginById(userId, RequestContext req, ResponseContext res) async { var user = await deserializer(userId); var token = new AuthToken( userId: userId, lifeSpan: _jwtLifeSpan, ipAddress: req.ip); _apply(req, token, user); _onLogin.add(user); if (allowCookie) res.cookies.add(new Cookie('token', token.serialize(_hs256))); } /// Log an authenticated user out. logout([AngelAuthOptions options]) { return (RequestContext req, ResponseContext res) async { for (AuthStrategy strategy in strategies) { if (!(await strategy.canLogout(req, res))) { if (options != null && options.failureRedirect != null && options.failureRedirect.isNotEmpty) { return res.redirect(options.failureRedirect); } return false; } } var user = req.grab('user'); if (user != null) _onLogout.add(user); req.injections..remove(AuthToken)..remove('user'); req.properties.remove('user'); if (allowCookie == true) res.cookies.removeWhere((cookie) => cookie.name == "token"); if (options != null && options.successRedirect != null && options.successRedirect.isNotEmpty) { return res.redirect(options.successRedirect); } return true; }; } }