Nexus-plugin-security NPM

nexus-plugin-security

Contents

Introduction
Installation
Example Usage
Upcoming

Introduction

This plugin lock all queries and mutations with a jwt authentication token required in the header using Authoriation='Bearer <myToken>'. You can expose any mutation or query to public with public attribute into field definition.

Installation

npm install nexus-plugin-security

In your app.ts main file, setup the plugin using this code

import { use } from 'nexus'
import { security } from 'nexus-plugin-security'

use(security({
  appSecret: 'my-super-secret',
  verifyOptions: {
    // Please refer to jsonwebtoken package
  },
  signOptions: {
    // Please refer to jsonwebtoken package
  },
  unauthorizedMessage: 'Invalid token',
  authConfig: {
    formatError: ({
      error,
      root,
      args,
      ctx,
      info
    }) => {
      return {
        name: 'Error type name',
        message: 'Custom message',
        stack: 'Error stack (optional)',
      }
    }
  }
}));

Example Usage

If you need to expose a query or mutation:

import { schema } from 'nexus'

schema.mutationType({
  definition(t) {
    t.field('login', {
      type: 'String',
      public: true, // <-- Expose your mutation using public set to true
      args: {
        email: 'String',
        password: 'String',
      },
      resolve(root, args) {
        const { email, password } = args;
        // Your authentication logic process
        return ctx.sign({ email }); // <-- You can sign any payload from context
      }
    })
  }
})

For authentication, use the Authorization="Bearer <token_signed>" in the header of all requests. The payload will be stored in a context attribute named token.

You can add extra auth ACL by using native nexus auth plugin :

Ref: https://www.nexusjs.org/#/components/schema/plugins/field-authorize

t.field('postById', {
  type: Post,
  args: { id: idArg() },
  authorize: (root, args, ctx) => ctx.auth.canViewPost(args.id),
  resolve(root, args, ctx) {
    return ctx.post.byId(args.id)
  },
})