grant-koa

What is grant-koa?

The grant-koa npm package is a middleware for Koa that simplifies OAuth integration. It allows developers to easily set up OAuth providers and handle authentication flows in their Koa applications.

What are grant-koa's main functionalities?

OAuth Provider Configuration

This code sample demonstrates how to configure the grant-koa middleware with a Google OAuth provider. It sets up the necessary session management and initializes Grant with the required OAuth provider settings.

const Koa = require('koa');
const session = require('koa-session');
const Grant = require('grant-koa');

const app = new Koa();
app.keys = ['some secret hurr'];
app.use(session(app));

const grant = new Grant({
  defaults: {
    protocol: 'http',
    host: 'localhost:3000',
    transport: 'session',
    state: true
  },
  google: {
    key: 'YOUR_GOOGLE_CLIENT_ID',
    secret: 'YOUR_GOOGLE_CLIENT_SECRET',
    scope: ['profile', 'email'],
    callback: '/handle_google_callback'
  }
});

app.use(grant);

app.listen(3000);

Handling OAuth Callbacks

This code sample shows how to handle the OAuth callback in a Koa application. After the user is authenticated by Google, the access token is retrieved from the session and can be used to fetch user data.

app.use(async (ctx, next) => {
  if (ctx.path === '/handle_google_callback') {
    const { access_token } = ctx.session.grant.response;
    // Use the access token to fetch user data from Google
    ctx.body = `Access Token: ${access_token}`;
  } else {
    await next();
  }
});

Other packages similar to grant-koa

passport

Passport is a popular authentication middleware for Node.js. It supports a wide range of authentication strategies, including OAuth. Unlike grant-koa, which is specifically designed for Koa, Passport can be used with various frameworks like Express and Koa.

simple-oauth2

Simple OAuth2 is a library for integrating OAuth2 authentication in Node.js applications. It provides a straightforward API for obtaining access tokens and refreshing them. While it is not a middleware like grant-koa, it can be used in conjunction with Koa to handle OAuth flows.

koa-passport

Koa-Passport is a Koa-specific wrapper for Passport. It allows developers to use Passport's wide range of authentication strategies within Koa applications. It provides similar functionality to grant-koa but with the added flexibility of Passport's extensive strategy support.

README

grant-koa

Koa handler for Grant OAuth Proxy

Changelog

v5.4.8 (2020/11/17)

• Fix: Type definitions for TypeScript