angel_auth 1.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 86

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 = new AngelAuth();
  auth.serializer = ...;
  auth.deserializer = ...;
  auth.strategies.add(new LocalAuthStrategy(...));
  
  // POST route to handle username+password
  app.post('/local', auth.authenticate('local'));
  
  // 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);
  
  // Middleware to decode JWT's...
  app.use(auth.decodeJwt);
}

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',
    new 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
});

1.2.0

  • Deprecate requireAuth, in favor of requireAuthentication.
  • Allow configuring of the userKey.
  • Deprecate middlewareName.

1.1.1+6

  • Fix a small logic bug that prevented LocalAuthStrategy from correctly propagating the authenticated user when using Basic auth.

1.1.1+5

  • Prevent duplication of cookies.
  • Regenerate the JWT if tokenCallback is called.

1.1.1+4

  • Patched logout to properly erase cookies
  • Fixed checking of expired tokens.

1.1.1+3

  • authenticate returns the current user, if one is present.

1.1.1+2

  • _apply now always sends a token cookie.

1.1.1+1

  • Update protectCookie to only send maxAge when it is not -1.

1.1.1

  • Added protectCookie, to better protect data sent in cookies.

1.1.0+2

  • LocalAuthStrategy returns true on Basic authentication.

1.1.0+1

  • Modified LocalAuthStrategy's handling of Basic authentication.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  angel_auth: ^1.2.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:angel_auth/angel_auth.dart';
  
Version Uploaded Documentation Archive
1.2.0 Jul 12, 2018 Go to the documentation of angel_auth 1.2.0 Download angel_auth 1.2.0 archive
1.1.1+6 Jul 10, 2018 Go to the documentation of angel_auth 1.1.1+6 Download angel_auth 1.1.1+6 archive
1.1.1+5 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1+5 Download angel_auth 1.1.1+5 archive
1.1.1+4 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1+4 Download angel_auth 1.1.1+4 archive
1.1.1+3 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1+3 Download angel_auth 1.1.1+3 archive
1.1.1+2 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1+2 Download angel_auth 1.1.1+2 archive
1.1.1+1 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1+1 Download angel_auth 1.1.1+1 archive
1.1.1 Jun 27, 2018 Go to the documentation of angel_auth 1.1.1 Download angel_auth 1.1.1 archive
1.1.0+2 Dec 21, 2017 Go to the documentation of angel_auth 1.1.0+2 Download angel_auth 1.1.0+2 archive
1.1.0+1 Dec 21, 2017 Go to the documentation of angel_auth 1.1.0+1 Download angel_auth 1.1.0+1 archive

All 39 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
79
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
86
Learn more about scoring.

We analyzed this package on Aug 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because angel_framework >=0.0.0-dev.1 <1.1.3 requires SDK version <2.0.0 and angel_framework >=1.1.3 depends on random_string ^0.0.1, angel_framework >=0.0.0-dev.1 requires random_string ^0.0.1.
 So, because every version of random_string requires SDK version >=1.0.0 <2.0.0 and angel_auth depends on angel_framework ^1.1.0-alpha, version solving failed.

Fix platform conflicts.

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

The description is too short.

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example.

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use angel_auth.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <3.0.0