Auth-lib-silver NPM

Auth Lib Silver

An authentication library for NestJS applications using Local and JWT strategies.

Description

This library provides a robust and customizable authentication solution for NestJS applications. With support for local authentication (username and password) and JWT-based authentication, it helps developers integrate secure authentication into their projects with ease.

Installation

To install the library, run the following command:

npm install auth-lib-poc

Configuration

Before using the library, ensure you have the following environment variables set up in your .env file:

JWT_SECRET: A secret key used to sign and verify JWT tokens.
JWT_EXPIRATION: Token expiration time (e.g., 60s, 15m, 1h, etc.).
FAKE_USER_USERNAME: Username for the fake user used in testing.
FAKE_USER_PASSWORD: Password for the fake user used in testing.

Example .env file:

JWT_SECRET=yourSecretKeyHere
JWT_EXPIRATION=60s
FAKE_USER_USERNAME=user
FAKE_USER_PASSWORD=password

Usage

Import the Auth Module

First, import the AuthModule into your application's main module:

import { Module } from '@nestjs/common';
import { AuthModule } from 'auth-lib-poc';

@Module({
    imports: [AuthModule],
})
export class AppModule {}

Local Authentication

The library includes a local authentication strategy using a username and password.

Example Usage

To authenticate a user using the local strategy, you can use the built-in guards:

import { Controller, Post, UseGuards, Request } from '@nestjs/common';
import { AuthGuard } from '@nestjs/passport';
import { AuthService } from 'auth-lib-poc';

@Controller('auth')
export class AuthController {
    constructor(private readonly authService: AuthService) {}

    @UseGuards(AuthGuard('local'))
    @Post('login')
    async login(@Request() req) {
        return this.authService.login(req.user);
    }
}

JWT Authentication

JWT is used to secure routes after a user has been authenticated.

Example Usage

To protect routes using JWT authentication, apply the AuthGuard to your route handlers:

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

@Controller('profile')
export class ProfileController {
    @UseGuards(AuthGuard('jwt'))
    @Get()
    getProfile(@Request() req) {
        return req.user;
    }
}

Customization

You can customize the authentication logic by extending or modifying the provided services and strategies. This includes:

Customizing user validation logic in AuthService.
Modifying JWT payload and options.
Extending or replacing guards for specific routes.

Environment Variables

Ensure to configure your environment variables as shown in the example above. This is crucial for security and functionality.

Example Application

Below is a basic example of how you might set up an application using this library:

import { Module } from '@nestjs/common';
import { AuthModule } from 'auth-lib-poc';
import { AppController } from './app.controller';

@Module({
    imports: [AuthModule],
    controllers: [AppController],
})
export class AppModule {}