Neolithic Programming Machine

    passport-openidconnect

    0.1.1 • Public • Published

    passport-openidconnect

    Passport strategy for authenticating with OpenID Connect.

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

    Install

    $ npm install passport-openidconnect

    Usage

    Configure

    The OpenID Connect authentication strategy authenticates users using their account at an OpenID Provider (OP). The strategy needs to be configured with the provider's endpoints, as well as a client ID and secret that has been issued by the provider to the app. Consult the provider's documentation for the locations of these endpoints and instructions on how to register a client.

    The strategy takes a verify function as an argument, which accepts issuer and profile as arguments. When authenticating a request, the strategy uses the OpenID Connect protocol to obtain this information via a sequence of redirects and back-channel HTTP requests to the OP.

    The verify function is responsible for determining the user to which the account at the OP belongs. In cases where the account is logging in for the first time, a user account is typically created automatically. Because the verify function is supplied by the application, the app is free to use any database of its choosing. The example below illustrates usage of a SQL database.

    var OpenIDConnectStrategy = require('passport-openidconnect');
    
    passport.use(new OpenIDConnectStrategy({
        issuer: 'https://server.example.com',
        authorizationURL: 'https://server.example.com/authorize',
        tokenURL: 'https://server.example.com/token',
        userInfoURL: 'https://server.example.com/userinfo',
        clientID: process.env['CLIENT_ID'],
        clientSecret: process.env['CLIENT_SECRET'],
        callbackURL: 'https://client.example.org/cb'
      },
      function verify(issuer, profile, cb) {
        db.get('SELECT * FROM federated_credentials WHERE provider = ? AND subject = ?', [
          issuer,
          profile.id
        ], function(err, cred) {
          if (err) { return cb(err); }
          if (!cred) {
            // The account at the OpenID Provider (OP) has not logged in to this app
            // before.  Create a new user account and associate it with the account
            // at the OP.
            db.run('INSERT INTO users (name) VALUES (?)', [
              profile.displayName
            ], function(err) {
              if (err) { return cb(err); }
              
              var id = this.lastID;
              db.run('INSERT INTO federated_credentials (user_id, provider, subject) VALUES (?, ?, ?)', [
                id,
                issuer,
                profile.id
              ], function(err) {
                if (err) { return cb(err); }
                var user = {
                  id: id.toString(),
                  name: profile.displayName
                };
                return cb(null, user);
              });
            });
          } else {
            // The account at the OpenID Provider has previously logged in to the
            // app.  Get the user account associated with the account at the OP and
            // log the user in.
            db.get('SELECT * FROM users WHERE id = ?', [ cred.user_id ], function(err, user) {
              if (err) { return cb(err); }
              if (!user) { return cb(null, false); }
              return cb(null, user);
            });
          }
        }
      })
    ));

    Routes

    Two routes are needed in order to allow users to log in with their account at an OP. The first route redirects the user to the OP, where they will authenticate:

    app.get('/login', passport.authenticate('openidconnect'));

    The second route processes the authentication response and logs the user in, when the OP redirects the user back to the app:

    app.get('/cb',
      passport.authenticate('openidconnect', { failureRedirect: '/login', failureMessage: true }),
      function(req, res) {
        res.redirect('/');
      });

    License

    The MIT License

    Copyright (c) 2011-2021 Jared Hanson <https://www.jaredhanson.me/>

    Install

    npm i passport-openidconnect

    DownloadsWeekly Downloads

    14,812

    Version

    0.1.1

    License

    MIT

    Unpacked Size

    37.4 kB

    Total Files

    13

    Last publish

    Collaborators

    • jaredhanson