This package has been deprecated

Author message:

outdated

fastify-oauth2-multi

fastify-oauth2

THIS IS CLONE FROM: 'fastify-oauth2' with support for multiple strategies based on PR #34 which still is neither accepted nor rejected thus not merged.

Wrap around simple-oauth2 library.

Install

npm i --save fastify-oauth2

Usage

const fastify = require('fastify')({ logger: { level: 'trace' } })
const oauthPlugin = require('fastify-oauth2')


fastify.register(oauthPlugin, {
  name: 'facebookOAuth2',
  credentials: {
    client: {
      id: '<CLIENT_ID>',
      secret: '<CLIENT_SECRET>'
    },
    auth: oauthPlugin.FACEBOOK_CONFIGURATION
  },
  // register a fastify url to start the redirect flow
  startRedirectPath: '/login/facebook',
  // facebook redirect here after the user login
  callbackUri: 'http://localhost:3000/login/facebook/callback'
})

fastify.get('/login/facebook/callback', async function (request, reply) {
  const token = await this.facebookOAuth2.getAccessTokenFromAuthorizationCodeFlow(request)

  console.log(token.access_token)

  // if later you need to refresh the token you can use
  // const newToken = await this.getNewAccessTokenUsingRefreshToken(token.refresh_token)

  reply.send({ access_token: token.access_token })
})

Preset configurations

You can choose some default setup to assign to auth option.

• FACEBOOK_CONFIGURATION
• GITHUB_CONFIGURATION
• LINKEDIN_CONFIGURATION
• GOOGLE_CONFIGURATION
• MICROSOFT_CONFIGURATION
• VKONTAKTE_CONFIGURATION
• SPOTIFY_CONFIGURATION

Custom configuration

Of course you can set the OAUTH endpoints by yourself if a preset is not in our module:

fastify.register(oauthPlugin, {
  name: 'customOauth2',
  credentials: {
    client: {
      id: '<CLIENT_ID>',
      secret: '<CLIENT_SECRET>'
    },
    auth: {
      authorizeHost: 'https://my-site.com',
      authorizePath: '/authorize',
      tokenHost: 'https://token.my-site.com',
      tokenPath: '/api/token'
    }
  },
  startRedirectPath: '/login',
  callbackUri: 'http://localhost:3000/login/callback'
})

Example

See the example/ folder for more example.

Reference

This fastify plugin decorates the fastify instance with the simple-oauth2 instance.

Utilities

This fastify plugin adds 2 utility decorators to your fastify instance:

• getAccessTokenFromAuthorizationCodeFlow(request, callback): A function that uses the Authorization code flow to fetch an OAuth2 token using the data in the last request of the flow. If the callback is not passed it will return a promise. The object resulting from the callback call or the promise resolution is a token response object containing the following keys:
  • access_token
  • refresh_token (optional, only if the offline scope was originally requested)
  • token_type (generally 'bearer')
  • expires_in (number of seconds for the token to expire, e.g. 240000)
• getNewAccessTokenUsingRefreshToken(refreshToken, params, callback): A function that takes a refresh token and retrieves a new token response object. This is generally useful with background processing workers to re-issue a new token when the original token has expired. The params argument is optional and it's an object that can be used to pass in extra parameters to the refresh request (e.g. a stricter set of scopes). If the callback is not passed this function will return a promise. The object resulting from the callback call or the promise resolution is a new token response object (see fields above).

License

Licensed under MIT.

NB: See simple-oauth2 license too