mbkauth

mbkAuth

Table of Contents

• Introduction
• Features
• Installation
• Usage
  • Basic Setup
• API Endpoints
  • Login
  • Logout
  • Terminate All Sessions
• Database Structure
• License
• Contact & Support

mbkAuth is a reusable authentication system for Node.js applications, designed to simplify session management, user authentication, and role-based access control. It integrates seamlessly with PostgreSQL and supports features like Two-Factor Authentication (2FA), session restoration, and reCAPTCHA verification.

Features

• Session Management: Secure session handling using express-session and connect-pg-simple.
• Role-Based Access Control: Validate user roles and permissions with ease.
• Two-Factor Authentication (2FA): Optional 2FA support for enhanced security.
• reCAPTCHA Integration: Protect login endpoints with Google reCAPTCHA.
• Cookie Management: Configurable cookie expiration and domain settings.
• PostgreSQL Integration: Uses a connection pool for efficient database interactions.

Installation

Install the package via npm:

npm install mbkauth

Usage

Basic Setup

• Import and configure the router in your Express application:

import express from "express";
import mbkAuthRouter from "mbkauth";

const app = express();

app.use(mbkAuthRouter);

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

• Ensure your ``.env` file is properly configured. Refer to the Configuration Guide(env.md) for details.

Example .env file:

RECAPTCHA_SECRET_KEY=your-recaptcha-secret-key
SESSION_SECRET_KEY=your-session-secret-key
LOGIN_DB=postgres://username:password@host:port/database
DOMAIN=yourdomain.com
IS_DEPLOYED=true
MBKAUTH_TWO_FA_ENABLE=false
COOKIE_EXPIRE_TIME=2

API Endpoints

Login

POST /api/mbkauth/login

• Request Body:

  • username: User's username.
  • password: User's password.
  • token: (Optional) 2FA token.
  • recaptcha: reCAPTCHA response.

• Response:

  • 200: Login successful.
  • 400: Missing or invalid input.
  • 401: Unauthorized (e.g., invalid credentials or 2FA token).
  • 500: Internal server error.

Logout

POST /api/mbkauth/logout

• Response:
  • 200: Login successful.
  • 400: User not logged in.
  • 500: Internal server error.

Terminate All Sessions

POST /api/mbkauth/terminateAllSessions

• Authentication: Requires a valid Main_SECRET_TOKEN in the Authorization header.
• Response:
  • 200: All sessions terminated successfully.
  • 500: Internal server error.

Database Structure

This project utilizes three primary tables:

• User: Stores the main user information.
• sess: Contains session-related data for users.
• TwoFA: Saves the Two-Factor Authentication (2FA) secrets for users.

For detailed information about table columns, schema, and queries to create these tables, refer to the Database Guide (docs/db.md).

License

This project is licensed under the Mozilla Public License 2.0. See the LICENSE file for details.

Contact & Support

For questions or contributions, please contact Muhammad Bin Khalid at mbktechstudio.com/Support, [e-mail] or chmuhammadbinkhalid28.com.

Developed by Muhammad Bin Khalid