platform/README.md
thosakwe b00329f632 +1
2017-04-26 10:04:45 -04:00

30 lines
1.1 KiB
Markdown

# angel_auth
[![version 1.0.4+1](https://img.shields.io/badge/version-1.0.4+1-brightgreen.svg)](https://pub.dartlang.org/packages/angel_auth)
![build status](https://travis-ci.org/angel-dart/auth.svg?branch=master)
A complete authentication plugin for Angel. Inspired by Passport.
# Documentation
[Click here](https://github.com/angel-dart/auth/wiki).
# Supported Strategies
* Local (with and without Basic Auth)
# Default Authentication Callback
A frequent use case within SPA's is opening OAuth login endpoints in a separate window.
[`angel_client`](https://github.com/angel-dart/client)
provides a facility for this, which works perfectly with the default callback provided
in this package.
```dart
auth.authenticate('facebook', new AngelAuthOptions(callback: confirmPopupAuthentication()));
```
This renders a simple HTML page that fires the user's JWT as a `token` event in `window.opener`.
`angel_client` [exposes this as a Stream](https://github.com/angel-dart/client#authentication):
```dart
app.authenticateViaPopup('/auth/google').listen((jwt) {
// Do something with the JWT
});
```