Nefarious Planetary Meddling

    passport-identityua

    1.0.6 • Public • Published

    passport-identityua

    npm Build Status Coverage Status Codacy Badge Code Climate Dependencies

    Passport strategy for authenticating with IdentityUA using the OAuth 1.0a API.

    This module lets you authenticate using Universal User from University of Aveiro (UA) in your Node.js applications.

    Install

    $ npm install passport-identityua
    

    Usage

    Configure Strategy

    The IdentityUA authentication strategy authenticates users using a Universal User UA account and OAuth tokens. The strategy requires a verify callback, which receives the access token and corresponding secret as arguments, as well as profile which contains the authenticated user's UA profile. The verify callback must call done providing a user to complete authentication.

    In order to identify your application to IdentityUA, specify the consumer key, consumer secret, callback URL and scope within options. The consumer key and secret are obtained by creating an application at IdentityUA site.

    passport.use(new IdentityUaStrategy({
        consumerKey: IDENTITYUA_CONSUMER_KEY,
        consumerSecret: IDENTITYUA_CONSUMER_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/ua/callback"
      },
      function(token, tokenSecret, profile, done) {
        User.findOrCreate({ id: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));
    

    NOT READY

    The following example demonstrastes the right usage of the scope, but be warned this still does not work as expected.

    passport.use(new IdentityUaStrategy({
        consumerKey: IDENTITYUA_CONSUMER_KEY,
        consumerSecret: IDENTITYUA_CONSUMER_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/ua/callback",
        scope: ['uu', 'name']
      },
      function(token, tokenSecret, profile, done) {
        User.findOrCreate({ id: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));
    

    Authenticate Requests

    Use passport.authenticate(), specifying the 'identityua' strategy, to authenticate requests.

    For example, as route middleware in an Express application:

    app.get('/auth/ua',
      passport.authenticate('identityua'));
    
    app.get('/auth/ua/callback', 
      passport.authenticate('identityua', { failureRedirect: '/login' }),
      function(req, res) {
        // Successful authentication, redirect home.
        res.redirect('/');
      });
    

    Tests

    $ npm install
    $ npm test
    

    TODO

    • Fix scope bug
    • Fix "Strategy parsing error from access token endpoint parsing error should error" test (it's hardcoded to pass)
    • Enable to parse XML and JSON by choice on parse function on profile.js

    Credits

    License

    The MIT License

    Copyright (c) 2015 Jared Hanson <http://jaredhanson.net/>

    Install

    npm i passport-identityua

    DownloadsWeekly Downloads

    1

    Version

    1.0.6

    License

    MIT

    Last publish

    Collaborators

    • poliveira89