https://github.com/oauth-everything/passport-fimfiction

A Passport strategy for authenticating with https://www.fimfiction.net/
https://github.com/oauth-everything/passport-fimfiction

Last synced: about 1 month ago
JSON representation

A Passport strategy for authenticating with https://www.fimfiction.net/

• Host: GitHub
• URL: https://github.com/oauth-everything/passport-fimfiction
• Owner: oauth-everything
• License: mpl-2.0
• Created: 2019-09-07T17:29:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T13:27:10.000Z (almost 3 years ago)
• Last Synced: 2024-11-15T18:46:18.132Z (about 2 months ago)
• Language: TypeScript
• Size: 49.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
@oauth-everything/passport-fimfiction

=====================================

A [Passport](http://passportjs.org/) strategy for authenticating with

[Fimfiction](https://www.fimfiction.net/) using OAuth 2.0 and the Fimfiction API.

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

By plugging into Passport, Fimfiction authentication can be easily and

unobtrusively integrated into any application or framework that supports

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

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

## Install

```bash

$ npm install @oauth-everything/passport-fimfiction

```

#### Configure Strategy

The Fimfiction authentication strategy authenticates users using a Fimfiction

account and OAuth 2.0 tokens.  The app 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

Fimfiction profile.  The `verify` callback must call `cb` providing a user to

complete authentication.

```ts

passport.use(new Strategy(

    {

        clientID: FIMFICTION_APP_ID,

        clientSecret: FIMFICTION_APP_SECRET,

        callbackURL: "http://localhost:3000/auth/fimfiction/callback"

    },

    (accessToken: string, refreshToken: string, profile: Profile, cb: VerifyCallback) => {

    User.findOrCreate({ fimfictionId: profile.id }, (err: Error, user: User) => {

            return cb(err, user);

        });

    }

));

```

#### Authenticate Requests

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

authenticate requests.

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

application:

```javascript

app.get('/auth/fimfiction',

  passport.authenticate('fimfiction'));

app.get('/auth/fimfiction/callback',

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

  function(req, res) {

    // Successful authentication, redirect home.

    res.redirect('/');

  });

```

## License

[The MPL v2 License](https://opensource.org/licenses/MPL-2.0)