https://github.com/springrole/passport-yoti

https://github.com/springrole/passport-yoti

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/springrole/passport-yoti
• Owner: SpringRole
• License: mit
• Created: 2018-07-18T05:26:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-07-20T14:08:44.000Z (almost 8 years ago)
• Last Synced: 2025-07-18T11:48:56.038Z (12 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# passport-yoti

[Passport](http://passportjs.org/) strategy for authenticating with [Yoti](https://www.yoti.com/)

This module lets you authenticate using Yoti in your Node.js applications.

By plugging into Passport, Yoti authentication can be easily and

unobtrusively integrated into any application or framework that supports

[Connect](http://www.senchalabs.org/connect/)-style middleware, including

[Express](http://expressjs.com/).

## Install

    $ npm install passport-yoti

## Usage

#### Configure Strategy

The Civic authentication strategy authenticates users using a Civic

app.  The strategy requires a `verify` callback, which

accepts these credentials and calls `done` providing a user, as well as

`options` specifying a appId, prvKey, and appSecret.

    passport.use(new YotiStrategy({

        clientSdkId: 'your sdk id',

        prvKey: fs.readFileSync(/keys/your-application-pem-file.pem)

      },

      function(profile, done) {

        User.findOrCreate({ userId: profile.userId }, function (err, user) {

          return done(err, user);

        });

      }

    ));

#### Parameters

The verify callback can be supplied with the `request` object by setting

the `passReqToCallback` option to true, and changing callback arguments

accordingly.

    passport.use(new YotiStrategy({

        clientSdkId: 'your sdk id',

        prvKey: fs.readFileSync(/keys/your-application-pem-file.pem)

        passReqToCallback: true

      },

      function(req, profile, done) {

        // request object is now first argument

        // ...

      }

    ));

#### Authenticate Requests

Use `passport.authenticate()`, specifying the `'yoti'` strategy, to

authenticate requests.

For example, as route middleware in an [Express](http://expressjs.com/)

application:

    app.get('/auth/yoti',

      passport.authenticate('yoti'));

    app.get('/auth/yoti',

      passport.authenticate('yoti', { failureRedirect: '/login' }),

      function(req, res) {

        // Successful authentication, redirect home.

        res.redirect('/');

      });

## Credits

  - [Vinay Agarwal](http://github.com/vinay035)

  - [Kartik Mandaville](http://github.com/kar2905)

## License

[The MIT License](http://opensource.org/licenses/MIT)