platform/packages/auth
2021-04-10 19:23:57 +08:00
..
.idea Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
example Migrated angel_auth to NNBD 2021-03-21 07:51:20 +08:00
lib Migrated angel_configuration 2021-04-10 19:23:57 +08:00
test Migrated angel_configuration 2021-04-10 19:23:57 +08:00
.gitignore Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
.travis.yml Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
analysis_options.yaml Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
CHANGELOG.md Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
LICENSE Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00
pubspec.yaml Migrated angel_auth to NNBD 2021-03-21 07:51:20 +08:00
README.md Add 'packages/auth/' from commit '1274ad6b0d9c288ab5366e8f3f977e50418166af' 2020-02-15 18:28:27 -05:00

angel_auth

Pub build status

A complete authentication plugin for Angel. Inspired by Passport.

Wiki

Click here.

Bundled Strategies

  • Local (with and without Basic Auth)
  • Find other strategies (Twitter, Google, OAuth2, etc.) on Pub!!!

Example

Ensure you have read the wiki.

configureServer(Angel app) async {
  var auth = AngelAuth<User>();
  auth.serializer = ...;
  auth.deserializer = ...;
  auth.strategies['local'] = LocalAuthStrategy(...);
  
  // POST route to handle username+password
  app.post('/local', auth.authenticate('local'));

  // Using Angel's asynchronous injections, we can parse the JWT
  // on demand. It won't be parsed until we check.
  app.get('/profile', ioc((User user) {
    print(user.description);
  }));
  
  // Use a comma to try multiple strategies!!!
  //
  // Each strategy is run sequentially. If one succeeds, the loop ends.
  // Authentication failures will just cause the loop to continue.
  // 
  // If the last strategy throws an authentication failure, then
  // a `401 Not Authenticated` is thrown.
  var chainedHandler = auth.authenticate(
    ['basic','facebook'],
    authOptions
  );
  
  // Apply angel_auth-specific configuration.
  await app.configure(auth.configureServer);
}

Default Authentication Callback

A frequent use case within SPA's is opening OAuth login endpoints in a separate window. angel_client provides a facility for this, which works perfectly with the default callback provided in this package.

configureServer(Angel app) async {
  var handler = auth.authenticate(
    'facebook',
    AngelAuthOptions(callback: confirmPopupAuthentication()));
  app.get('/auth/facebook', handler);
  
  // Use a comma to try multiple strategies!!!
  //
  // Each strategy is run sequentially. If one succeeds, the loop ends.
  // Authentication failures will just cause the loop to continue.
  // 
  // If the last strategy throws an authentication failure, then
  // a `401 Not Authenticated` is thrown.
  var chainedHandler = auth.authenticate(
    ['basic','facebook'],
    authOptions
  );
}

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:

app.authenticateViaPopup('/auth/google').listen((jwt) {
  // Do something with the JWT
});