Authorization

In VitNode we're implementing a simple way to handle authorization.

Protecting routers

To protect routes for controllers you can set isProtect for @Controllers decorator. This will protect all routes in the controller.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

import { Controllers } from 'vitnode-backend/helpers/controller.decorator';
 
@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',

  isProtect: true,
})

Protecting per route

To protect a route (required sign in user), you need to add the @UseGuards(AuthGuard) decorator for user auth or @UseGuards(AdminAuthGuard) decorator for admin auth to the route.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

import { Get, UseGuards } from '@nestjs/common';
import { Controllers } from 'vitnode-backend/helpers/controller.decorator';
import { AuthGuard } from 'vitnode-backend/guards/auth.guard'; 
 
@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',
})
export class ExampleWelcomeController {
  @Get()
  @UseGuards(AuthGuard) 
  getHello(): string {
    return 'Hello World!';
  }
}

Admin

Protecting routers

To protect routes for admin only, you can set isAdmin for @Controllers decorator. This will protect all routes in the controller.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',

  isAdmin: true,
})

[Admin] Protecting per route

To protect a route for admin only, you need to add the @UseGuards(AdminAuthGuard) decorator to the route.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

import { Get, UseGuards } from '@nestjs/common';
import { Controllers } from 'vitnode-backend/helpers/controller.decorator';
import { AdminAuthGuard } from 'vitnode-backend/guards/admin-auth.guard'; 
 
@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',
})
export class ExampleWelcomeController {
  @Get()
  @UseGuards(AdminAuthGuard) 
  getHello(): string {
    return 'Hello World!';
  }
}

When you are using @UseGuards(AuthGuards), @UseGuards(AdminAuthGuards) or @Controllers decorator with isAdmin or isProtect you can get access to the current user in the resolver by using the @CurrentUser() decorator as param route.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

import { Get, UseGuards } from '@nestjs/common';
import { Controllers } from 'vitnode-backend/helpers/controller.decorator';
import { AuthGuard } from 'vitnode-backend/guards/auth.guard'; 
import { CurrentUser } from 'vitnode-backend/helpers/user.decorator'; 
import { User } from 'vitnode-shared/user.dto'; 
 
@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',
})
export class ExampleWelcomeController {
  @Get()
  @UseGuards(AuthGuard) 

  getHello(@CurrentUser() user: User): string {
    return `Hello ${user.name}!`;
  }
}

Optional user data

If you want to make the user data optional, you have to add @OptionalAuth() decorator to the route.

apps/backend/src/plugins/{your_plugin_code}/example.controller.ts

import { Get, UseGuards } from '@nestjs/common';
import { Controllers } from 'vitnode-backend/helpers/controller.decorator';
import { AuthGuard, OptionalAuth } from 'vitnode-backend/guards/auth.guard'; 
import { CurrentUser } from 'vitnode-backend/helpers/user.decorator';
import { User } from 'vitnode-shared/user.dto';
 
@Controllers({
  plugin_name: 'Welcome',
  plugin_code: 'welcome',
  route: 'example',
})
export class ExampleWelcomeController {
  @Get()
  @OptionalAuth() 
  @UseGuards(AuthGuard)

  getHello(@CurrentUser() user?: User): string {
    return `Hello ${user.name}!`;
  }
}

Protecting routers

Protecting per route

Admin

Protecting routers

[Admin] Protecting per route

Current user data

Optional user data

On this page