https://github.com/ornicar/passport-lichess

GitHub authentication strategy for Lichess and Node.js.
https://github.com/ornicar/passport-lichess

Last synced: 9 days ago
JSON representation

GitHub authentication strategy for Lichess and Node.js.

• Host: GitHub
• URL: https://github.com/ornicar/passport-lichess
• Owner: ornicar
• License: mit
• Created: 2018-04-29T16:30:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-15T21:38:49.000Z (almost 2 years ago)
• Last Synced: 2024-10-08T05:51:51.613Z (29 days ago)
• Language: JavaScript
• Homepage: https://lichess.org/api
• Size: 48.8 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# passport-lichess

[![npm](https://img.shields.io/npm/v/passport-lichess)](https://www.npmjs.com/package/passport-lichess)

[Passport](http://passportjs.org/) strategy for authenticating with [Lichess](https://lichess.org)

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](http://www.senchalabs.org/connect/)-style middleware, including

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

## Install

```bash

$ 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.

```js

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](http://expressjs.com/)

application:

```js

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](http://expressjs.com/) web framework can

refer to an [example](https://github.com/passport/express-4.x-facebook-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](https://github.com/jaredhanson/passport-github).