Passport.js integration in NestJS

Introduction

Passport.js helps you add login and user verification easily. It works with NestJS to keep your app safe.

You want users to log in with username and password.

You want to allow login using social accounts like Google or Facebook.

You need to protect certain parts of your app so only logged-in users can access.

You want to manage user sessions or tokens securely.

You want a simple way to add many login methods without much code.

Syntax

NestJS

import { PassportModule } from '@nestjs/passport';

@Module({
  imports: [PassportModule.register({ defaultStrategy: 'local' })],
  providers: [AuthService, LocalStrategy],
  controllers: [AuthController],
})
export class AuthModule {}

Use PassportModule.register() to set default login strategy.

Provide strategy classes like LocalStrategy to define how login works.

Examples

This defines a local login strategy checking username and password.

NestJS

import { Injectable, UnauthorizedException } from '@nestjs/common';
import { PassportStrategy } from '@nestjs/passport';
import { Strategy } from 'passport-local';

@Injectable()
export class LocalStrategy extends PassportStrategy(Strategy) {
  constructor(private authService: AuthService) {
    super();
  }

  async validate(username: string, password: string): Promise<any> {
    const user = await this.authService.validateUser(username, password);
    if (!user) {
      throw new UnauthorizedException();
    }
    return user;
  }
}

This controller uses the local strategy to protect the login route.

NestJS

import { Controller, Post, UseGuards, Request } from '@nestjs/common';
import { AuthGuard } from '@nestjs/passport';

@Controller('auth')
export class AuthController {
  @UseGuards(AuthGuard('local'))
  @Post('login')
  async login(@Request() req) {
    return req.user;
  }
}

Sample Program

This example shows a simple NestJS module using Passport.js local strategy. It checks username and password from a fixed list and returns the user if valid. The login route is protected and returns user info on success.

NestJS

import { Module, Injectable, Controller, Post, UseGuards, Request } from '@nestjs/common';
import { PassportModule } from '@nestjs/passport';
import { PassportStrategy } from '@nestjs/passport';
import { Strategy } from 'passport-local';
import { AuthGuard } from '@nestjs/passport';
import { UnauthorizedException } from '@nestjs/common';

@Injectable()
class AuthService {
  private users = [{ username: 'john', password: 'changeme' }];

  async validateUser(username: string, password: string): Promise<any> {
    const user = this.users.find(u => u.username === username && u.password === password);
    return user ? { username: user.username } : null;
  }
}

@Injectable()
class LocalStrategy extends PassportStrategy(Strategy) {
  constructor(private authService: AuthService) {
    super();
  }

  async validate(username: string, password: string): Promise<any> {
    const user = await this.authService.validateUser(username, password);
    if (!user) {
      throw new UnauthorizedException();
    }
    return user;
  }
}

@Controller('auth')
class AuthController {
  @UseGuards(AuthGuard('local'))
  @Post('login')
  login(@Request() req) {
    return req.user;
  }
}

@Module({
  imports: [PassportModule.register({ defaultStrategy: 'local' })],
  providers: [AuthService, LocalStrategy],
  controllers: [AuthController],
})
export class AuthModule {}

Important Notes

Always handle errors like unauthorized access to keep your app safe.

Use HTTPS in production to protect user credentials during login.

Passport.js supports many strategies; you can add social logins easily.

Summary

Passport.js helps add login and user verification in NestJS apps.

Define strategies to control how users log in.

Protect routes using guards that check user login status.

Practice

1. What is the main purpose of integrating Passport.js in a NestJS application?

easy

A. To handle user authentication and login strategies

B. To manage database connections

C. To style the frontend components

D. To optimize server performance

Solution

1. Step 1: Understand Passport.js role

   Passport.js is a library designed to handle user authentication in Node.js applications.

2. Step 2: Connect Passport.js with NestJS

   In NestJS, Passport.js is used to define login strategies and verify users securely.

3. Final Answer:

   To handle user authentication and login strategies -> Option A

4. Quick Check:

   Passport.js = Authentication [OK]

Hint: Passport.js is for login and user verification [OK]

Common Mistakes:

• Confusing Passport.js with database tools
• Thinking Passport.js styles UI
• Assuming Passport.js improves server speed

2. Which of the following is the correct way to apply a Passport.js local strategy in a NestJS controller?

easy

A. @UseGuards('local')

B. @UseGuards(LocalStrategy)

C. @UseGuards(AuthGuard('local'))

D. @UseGuards(PassportLocal)

Solution

1. Step 1: Recall NestJS guard syntax

   Passport strategies are applied using AuthGuard with the strategy name as a string.

2. Step 2: Match correct syntax

   The correct syntax is @UseGuards(AuthGuard('local')) to apply the local strategy guard.

3. Final Answer:

   @UseGuards(AuthGuard('local')) -> Option C

4. Quick Check:

   UseGuards with AuthGuard('strategy') [OK]

Hint: Use AuthGuard with strategy name string [OK]

Common Mistakes:

• Passing strategy class instead of string
• Omitting AuthGuard wrapper
• Using incorrect decorator syntax

3. Given this NestJS Passport.js setup, what will be the output when a user with correct credentials logs in?

async validate(username: string, password: string) {
  if (username === 'user' && password === 'pass') {
    return { userId: 1, username };
  }
  return null;
}

medium

A. Returns undefined

B. Throws an error

C. Returns null always

D. Returns user object { userId: 1, username: 'user' }

Solution

1. Step 1: Analyze validate method logic

   The method checks if username is 'user' and password is 'pass'. If yes, it returns a user object.

2. Step 2: Determine output for correct credentials

   For correct credentials, it returns { userId: 1, username } which is { userId: 1, username: 'user' }.

3. Final Answer:

   Returns user object { userId: 1, username: 'user' } -> Option D

4. Quick Check:

   Correct credentials return user object [OK]

Hint: Correct credentials return user object, else null [OK]

Common Mistakes:

• Assuming it throws error on failure
• Confusing null with undefined
• Ignoring the return statement

4. Identify the error in this NestJS Passport.js guard usage:

@UseGuards(AuthGuard(LocalStrategy))
@Get('profile')
getProfile() {
  return 'User Profile';
}

medium

A. AuthGuard should receive strategy name as string, not class

B. Missing @Controller decorator

C. getProfile method must be async

D. AuthGuard cannot be used with @Get

Solution

1. Step 1: Check AuthGuard parameter

   AuthGuard expects a string with the strategy name, e.g., 'local', not the strategy class.

2. Step 2: Confirm correct usage

   Correct usage is @UseGuards(AuthGuard('local')), passing the strategy name as a string.

3. Final Answer:

   AuthGuard should receive strategy name as string, not class -> Option A

4. Quick Check:

   AuthGuard('strategyName') not class [OK]

Hint: Pass strategy name string to AuthGuard [OK]

Common Mistakes:

• Passing strategy class instead of string
• Forgetting to import AuthGuard
• Assuming method must be async

5. You want to protect a NestJS route so only logged-in users can access it using Passport.js. Which combination correctly sets this up?

1. Create a JWT strategy class
2. Use @UseGuards(AuthGuard('jwt')) on the route
3. Implement validate() method in strategy
4. Call AuthGuard('local') on the route

Which steps should you follow?

hard

A. All steps 1, 2, 3, and 4

B. Steps 1, 2, and 3 only

C. Steps 1 and 4 only

D. Steps 2 and 4 only

Solution

1. Step 1: Understand JWT strategy usage

   To protect routes with JWT, create a JWT strategy and implement validate() to verify tokens.

2. Step 2: Apply AuthGuard with 'jwt'

   Use @UseGuards(AuthGuard('jwt')) on routes to enforce JWT authentication.

3. Step 3: Exclude local strategy for JWT protection

   Using AuthGuard('local') is for login, not for protecting routes after login.

4. Final Answer:

   Steps 1, 2, and 3 only -> Option B

5. Quick Check:

   JWT strategy + AuthGuard('jwt') + validate() [OK]

Hint: Use JWT strategy and AuthGuard('jwt') to protect routes [OK]

Common Mistakes:

• Using local strategy guard to protect routes
• Skipping validate() method in strategy
• Applying AuthGuard without strategy name