platform/README.md

31 lines
1.1 KiB
Markdown
Raw Normal View History

2016-05-02 23:39:57 +00:00
# angel_auth
2016-11-23 20:37:40 +00:00
2017-04-26 13:59:27 +00:00
[![version 1.0.4](https://img.shields.io/badge/version-1.0.4-brightgreen.svg)](https://pub.dartlang.org/packages/angel_auth)
2016-11-23 20:37:40 +00:00
![build status](https://travis-ci.org/angel-dart/auth.svg?branch=master)
2016-05-02 23:39:57 +00:00
A complete authentication plugin for Angel. Inspired by Passport.
2016-09-21 06:19:52 +00:00
# Documentation
2016-11-23 20:37:40 +00:00
[Click here](https://github.com/angel-dart/auth/wiki).
2016-09-21 06:19:52 +00:00
# Supported Strategies
2016-12-03 18:23:11 +00:00
* Local (with and without Basic Auth)
2017-02-28 22:16:25 +00:00
# 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
2017-04-12 12:01:42 +00:00
auth.authenticate('facebook', new AngelAuthOptions(callback: confirmPopupAuthentication()));
2017-02-28 22:16:25 +00:00
```
2017-04-12 12:03:31 +00:00
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
});
```