mbkauthepy 1.6.8

A fully featured, secure, and extensible authentication system for Python Flask applications. Originally ported from the Node.js version to provide multi-language support for full-stack apps.

MBKAUTHEPY

mbkauthepy is a fully featured, secure, and extensible authentication system for Python Flask applications.
Ported from the Node.js version to provide seamless multi-language support for full-stack apps.

---

📚 Table of Contents

• ✨ Features
• 🧠 Multi-language Support
• 📦 Installation
• 🚀 Quickstart
• ⚙️ Configuration (.env)
• 🧩 Middleware & Decorators
• 🧪 API Endpoints
• 🗄️ Database Schema
• 🔐 Security Notes
• 📜 License
• 🙋 Contact & Support

---

✨ Features

Feature	Description
🧠 Multi-language Support	Use in both Python (mbkauthe) and JavaScript (mbkauthe via npm)
🔒 Secure Auth	Session-based authentication with secure cookies and optional 2FA
🧑‍🤝‍🧑 Role-based Access	Decorators for validating roles and permissions on protected routes
🔐 2FA Support	Time-based One-Time Password (TOTP) with pyotp
🔎 reCAPTCHA v2 Support	Protect login routes with Google reCAPTCHA
🍪 Cookie Management	Secure session cookies with custom expiration, domain, etc.
🐘 PostgreSQL Integration	Optimized with connection pooling via psycopg2
🔑 Password Security	Bcrypt hash support (or optional plaintext in dev/test mode)
🧠 Profile Data Access	Built-in helper to fetch user profile details from DB

---

🧠 Multi-language Support

This package is designed to work seamlessly with both Python and JavaScript applications.

• The JavaScript version is available on npm as mbkauthe.
• The Python version is available on PyPI as mbkauthepy.

Repositories:

• Python Version: mbkauthepy GitHub
• JavaScript Version: mbkauthe GitHub

Contact & Contributions:

• Maaz Waheed (Python Version)

  • GitHub: @42Wor
  • Email: [e-mail] / [e-mail]

• Muhammad Bin Khalid (JavaScript Version)

  • GitHub: @MIbnEKhalid
  • For questions or contributions:
    • Support Page: mbktechstudio.com/Support
    • Email: [e-mail] / [e-mail]

Issues / PRs:

We welcome issues and pull requests! Feel free to contribute or ask any questions.

---

Note: This project is developed and maintained by Maaz Waheed and Muhammad Bin Khalid.

📦 Installation

1. Python & Virtual Environment

python -m venv venv
source venv/bin/activate  # Linux/macOS
# .\venv\Scripts\activate  # Windows

2. Install Dependencies

pip install -r requirements.txt

3. Install mbkauthepy

pip install mbkauthepy

---

🚀 Quickstart Example

from flask import Flask, render_template, session
from dotenv import load_dotenv
from mbkauthepy import configure_mbkauthe, validate_session

load_dotenv()

app = Flask(__name__)
app.config['SECRET_KEY'] = 'your-secret-key'

configure_mbkauthe(app)


@app.route('/')
def home():
    return render_template('index.html')


@app.route('/dashboard')
@validate_session
def dashboard():
    user = session['user']
    return f"Welcome {user['username']}!"


if __name__ == '__main__':
    app.run(debug=True)

---

⚙️ Configuration (.env)

FLASK_SECRET_KEY=my-flask-secret

mbkautheVar='{
    "APP_NAME": "MBKAUTH_PYTHON_DEMO",
    "IS_DEPLOYED": "false",
    "LOGIN_DB": "postgresql://username:password@host:port/database",
    "MBKAUTH_TWO_FA_ENABLE": "false",
    "COOKIE_EXPIRE_TIME": "2", # In days
    "DOMAIN": "mbktechstudio.com", # Use your actual domain in production
    "Main_SECRET_TOKEN": "your-secret-token-for-terminate-api", # Added for terminateAllSessions auth
    "loginRedirectURL": "/",
    "EncryptedPassword": "False"
}'

✅ You can override behavior by editing this JSON string directly in .env.

---

🧩 Middleware & Decorators

Decorator	Purpose
@validate_session	Ensures valid session is active
@check_role_permission("Role")	Checks if user has required role
@validate_session_and_role("Role")	Shortcut for validating both
@authenticate_token	Verifies request via API token header

Example:

from src.mbkauthe import validate_session, check_role_permission, validate_session_and_role, authenticate_token


@app.route('/admin')
@validate_session_and_role("SuperAdmin")
def admin_panel():
    return "Welcome to the admin panel"


@app.route('/dashboard')
@validate_session
def dashboard():
    user = session['user']
    return f"Welcome {user['username']}"


@app.route('/secured-admin')
@validate_session_and_role("SuperAdmin")
def secured_admin():
    return "Secured Area"


@app.route('/terminate-sessions')
@authenticate_token
def terminate_sessions():
    return {"success": True}


# Example of fetching user data
data = get_user_data("johndoe", ["FullName", "email"])

---

🧪 API Endpoints

These are available by default after calling configure_mbkauthe(app):

Method	Endpoint	Description
POST	/mbkauthe/api/login	Authenticate and create session
POST	/mbkauthe/api/logout	Terminate current session
POST	/mbkauthe/api/terminateAllSessions	Clears all sessions (admin only)
GET	/mbkauthe/i or /mbkauthe/info or mbkauthe.mbkauthe_info	Current package version or metadata from the installed package
GET	mbkauthe.login_page or /mbkauthe/login	login page in package

---

🗄️ Database Schema

👉 See docs/db.md for schema & setup scripts.

---

🔐 Security Notes

• 🔐 Set EncryptedPassword: "true" for production use.
• ✅ Always use long random SESSION_SECRET_KEY.
• 🔒 Use HTTPS in deployment (IS_DEPLOYED: "true").
• 🚫 Avoid plaintext passwords outside dev/testing.

Note: Encrypted password support is under development. Stay tuned for updates!

---

📜 License

Mozilla Public License 2.0
See LICENSE for full legal text.

---

🙋 Contact & Support

Developed by Maaz Waheed

• GitHub: @42Wor
• Email: [e-mail] / [e-mail]
• Issues / PRs welcome!

---

Would you like me to generate:

• ✅ A requirements.txt
• ✅ The .env template
• ✅ Diagrams (e.g., session flow, DB schema)
• ✅ Frontend login template in HTML?

Let me know which extras you want!