ornicar / passport-lichess

GitHub authentication strategy for Lichess and Node.js.

passport-lichess

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

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

Install

$ npm install passport-lichess

Usage

Configure Strategy

The Lichess authentication strategy authenticates users using a Lichess account and OAuth 2.0 tokens. 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 and optional refresh token, as well as profile which contains the authenticated user's Lichess profile. The verify callback must call cb providing a user to complete authentication.

var LichessStrategy = require('passport-lichess').Strategy;

passport.use(
  new LichessStrategy(
    {
      clientID: 'arbitrary-unique-id',
      callbackURL: 'http://127.0.0.1:3000/auth/lichess/callback',
    },
    function (accessToken, refreshToken, profile, cb) {
      User.findOrCreate({ lichessId: profile.id }, function (err, user) {
        return cb(err, user);
      });
    }
  )
);

Authenticate Requests

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

For example, as route middleware in an Express application:

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

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

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications. The example shows how to authenticate users using Facebook. However, because both Facebook and Lichess use OAuth 2.0, the code is similar. Simply replace references to Facebook with corresponding references to Lichess.

Credits

This library is a based on Jared Hanson's passport-github.