2.4.5 • Published 6 months ago
saw2auth v2.4.5
my2Auth
The authentification and the role-based authorization
This package provides a convenient way to authentification the users and limit their access by using the role-based authorization in a Nest.js application.
Installation
To install the package, run the following command:
npm install saw2auth@2.4.5
Usage
- Import the
AuthModule
from the package: in your module file of your ressource whish will use it services
import { AuthModule } from 'saw2auth';
- Import the
AuthentificationGuard
from the package: if you want to use only the authentification
in your controller file:
import { AuthentificationGuard } from 'saw2auth';
above your secure route
@UseGuards(AuthentificationGuard)
@Method()
- Import the
AuthentificationGuard
from the package: if you want to use the authentification and the based-role authorization
in your controller file:
import { AuthentificationGuard, Roles, AuthorizationGuard} from 'saw2auth';
make sure that the roles of users is an array attribute of users and are injected in their tokens
above your secure route
@Roles("write", "read")
@UseGuards(AuthentificationGuard, AuthorizationGuard)
@Method()
write
andread
: are roles that the user must have for being able to qwiz this this secure route
Configuration
Before using the package, make sure to configure the settings in your Nest.js application's environment variables. Set the following variables:
ROLES_KEY
: your secret role key.JWT_SECRET
: your jwt secret key.
License
This package is licensed on ISC license