Skip to content

alexkeramidas/passport-authentiq

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

passport-authentiq

Passport strategy for authenticating with AuthentiqID using the OAuth 2.0 API.

This module lets you authenticate using AuthentiqID in your Node.js applications. By plugging into Passport, AuthentiqID authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-authentiqid

Usage

Create an Application

Before using passport-authentiqid, you must register an application with Authentiq. If you have not already done so, a new application can be created at developer applications. Your application will be issued a client ID and client secret, which need to be provided to the strategy. You will also need to configure a callback URL which matches the route in your application.

Configure Strategy

The AuthentiqID authentication strategy authenticates users that use the AuthentiqID mobile application. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token. The verify callback must call cb providing a user to complete authentication.

var AuthentiqIDStrategy = require('passport-authentiqid').Strategy;

passport.use(new AuthentiqIDStrategy({
    clientID: AUTHENTIQ_CLIENT_ID,
    clientSecret: AUTHENTIQ_CLIENT_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/authentiq/callback"
  },
  function(accessToken, refreshToken, profile, cb) {
    User.findOrCreate({ authentiqId: profile.id }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/auth/authentiq',
  passport.authenticate('authentiq'));

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

Examples

Contributing

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

$ make test

Coverage

$ make test-cov
$ make view-cov

License

The MIT License

Copyright (c) 2017 Authentiq

About

Authentiq implementation for passport JS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published