125 lines
4.2 KiB
Dart
125 lines
4.2 KiB
Dart
library angel_auth_oauth2;
|
|
|
|
import 'dart:async';
|
|
import 'package:angel_auth/angel_auth.dart';
|
|
import 'package:angel_framework/angel_framework.dart';
|
|
import 'package:angel_validate/angel_validate.dart';
|
|
import 'package:http_parser/http_parser.dart';
|
|
import 'package:oauth2/oauth2.dart' as oauth2;
|
|
|
|
final Validator OAUTH2_OPTIONS_SCHEMA = new Validator({
|
|
'key*': isString,
|
|
'secret*': isString,
|
|
'authorizationEndpoint*': anyOf(isString, const TypeMatcher<Uri>()),
|
|
'tokenEndpoint*': anyOf(isString, const TypeMatcher<Uri>()),
|
|
'callback*': isString,
|
|
'scopes': const TypeMatcher<Iterable<String>>()
|
|
}, defaultValues: {
|
|
'scopes': <String>[]
|
|
}, customErrorMessages: {
|
|
'scopes': "'scopes' must be an Iterable of strings. You provided: {{value}}"
|
|
});
|
|
|
|
/// Holds credentials and also specifies the means of authenticating users against a remote server.
|
|
class AngelAuthOAuth2Options {
|
|
/// Your application's client key or client ID, registered with the remote server.
|
|
final String key;
|
|
|
|
/// Your application's client secret, registered with the remote server.
|
|
final String secret;
|
|
|
|
/// The remote endpoint that prompts external users for authentication credentials.
|
|
final String authorizationEndpoint;
|
|
|
|
/// The remote endpoint that exchanges auth codes for access tokens.
|
|
final String tokenEndpoint;
|
|
|
|
/// The callback URL that the OAuth2 server should redirect authenticated users to.
|
|
final String callback;
|
|
|
|
/// Used to split application scopes. Defaults to `' '`.
|
|
final String delimiter;
|
|
final Iterable<String> scopes;
|
|
|
|
final Map<String, String> Function(MediaType, String) getParameters;
|
|
|
|
const AngelAuthOAuth2Options(
|
|
{this.key,
|
|
this.secret,
|
|
this.authorizationEndpoint,
|
|
this.tokenEndpoint,
|
|
this.callback,
|
|
this.delimiter: ' ',
|
|
this.scopes: const [],
|
|
this.getParameters});
|
|
|
|
factory AngelAuthOAuth2Options.fromJson(Map json) =>
|
|
new AngelAuthOAuth2Options(
|
|
key: json['key'] as String,
|
|
secret: json['secret'] as String,
|
|
authorizationEndpoint: json['authorizationEndpoint'] as String,
|
|
tokenEndpoint: json['tokenEndpoint'] as String,
|
|
callback: json['callback'] as String,
|
|
scopes: (json['scopes'] as Iterable)?.cast<String>()?.toList() ??
|
|
<String>[]);
|
|
|
|
Map<String, dynamic> toJson() {
|
|
return {
|
|
'key': key,
|
|
'secret': secret,
|
|
'authorizationEndpoint': authorizationEndpoint,
|
|
'tokenEndpoint': tokenEndpoint,
|
|
'callback': callback,
|
|
'scopes': scopes.toList()
|
|
};
|
|
}
|
|
}
|
|
|
|
class OAuth2Strategy<User> implements AuthStrategy<User> {
|
|
final FutureOr<User> Function(oauth2.Client) verifier;
|
|
|
|
AngelAuthOAuth2Options _options;
|
|
|
|
/// [options] can be either a `Map` or an instance of [AngelAuthOAuth2Options].
|
|
OAuth2Strategy(options, this.verifier) {
|
|
if (options is AngelAuthOAuth2Options)
|
|
_options = options;
|
|
else if (options is Map)
|
|
_options = new AngelAuthOAuth2Options.fromJson(
|
|
OAUTH2_OPTIONS_SCHEMA.enforce(options));
|
|
else
|
|
throw new ArgumentError('Invalid OAuth2 options: $options');
|
|
}
|
|
|
|
oauth2.AuthorizationCodeGrant createGrant() =>
|
|
new oauth2.AuthorizationCodeGrant(
|
|
_options.key,
|
|
Uri.parse(_options.authorizationEndpoint),
|
|
Uri.parse(_options.tokenEndpoint),
|
|
secret: _options.secret,
|
|
delimiter: _options.delimiter ?? ' ',
|
|
getParameters: _options.getParameters);
|
|
|
|
@override
|
|
FutureOr<User> authenticate(RequestContext req, ResponseContext res,
|
|
[AngelAuthOptions<User> options]) async {
|
|
if (options != null) return authenticateCallback(req, res, options);
|
|
|
|
var grant = createGrant();
|
|
res.redirect(grant
|
|
.getAuthorizationUrl(Uri.parse(_options.callback),
|
|
scopes: _options.scopes)
|
|
.toString());
|
|
return null;
|
|
}
|
|
|
|
Future<User> authenticateCallback(RequestContext req, ResponseContext res,
|
|
[AngelAuthOptions options]) async {
|
|
var grant = createGrant();
|
|
await grant.getAuthorizationUrl(Uri.parse(_options.callback),
|
|
scopes: _options.scopes);
|
|
var client =
|
|
await grant.handleAuthorizationResponse(req.uri.queryParameters);
|
|
return await verifier(client);
|
|
}
|
|
}
|