@zanix/server-auth
v2.0.0
Published
ZanixJS Framework API Server Authentication
Downloads
12
Readme
@zanix/server-auth
Table of Contents
Introduction
@zanix/server-auth
provides authentication decorators and JWT support, allowing seamless integration of authentication mechanisms within Node.js applications. It also introduces functionality for cyclical toggling of JWT signing keys with customizable expiration settings.
Installation
To install @zanix/server-auth
in your project, use the following command:
npm install @zanix/server-auth
Usage
Utilize the provided AuthDecorators
and Setup
classes to incorporate authentication decorators and manage JWT tokens within your application.
@zanix/server-auth
utilizes the following environment variables:
ZANIX_JWT_KMA: JWT Keys Max AGE. Time format:
M
(months),d
(days),h
(hours, default). Default value:12M
. To disable this expiration, set it toInf
or-1
.ZANIX_JWT_KTCD: Key Toggle Cycle Duration. Time format:
M
(months),d
(days),h
(hours, default). Default value:30d
. This value is limited to 3 times the value of ZANIX_JWT_KMA to avoid session loss.ZANIX_JWT_KFCT: JWT Maximum number of Keys For Cyclical Toggling. Default value:
3
. Note: TheExpiresIn
time for a generated token is limited to a quarter of ZANIX_JWT_KMA to avoid session loss.
Support and Contributions
If you encounter any issues or have suggestions for improvements, please submit them in the issue tracker.
Contributions to enhance the functionality or resolve issues are welcomed via pull requests. Ensure adherence to code standards and include appropriate test coverage.
License
This module is open-source and released under the MIT License. You are free to modify and distribute it as per the terms of the license.
Authors ✨
- Ismael Calle Marulanda @iscam2216