Home

Welcome to the nestjs-firebase-auth Wiki

nestjs-firebase-auth is a comprehensive library for integrating Firebase Authentication into your NestJS applications. It simplifies the process of verifying Firebase ID tokens, managing user roles, and protecting your routes with easy-to-use decorators.

✨ Key Features

• Easy Integration: Seamlessly integrates with NestJS using a dynamic module.
• Role-Based Access Control (RBAC): Protect routes based on user roles (e.g., ADMIN, USER).
• Policy-Based Authorization (ABAC): Enforce contextual rules, like resource ownership, with your own policy handlers. See Authorization-Policies.
• Claim-Based Authorization (Fine-Grained): Require every one of a set of fine-grained claims, distinct from roles. See Authorization-Claims.
• Complex Examples: Worked examples combining roles, claims, and policies on the same route. See Complex Examples.
• Custom Claims: Easily manage and verify custom claims on Firebase users.
• Decorators: Clean and expressive decorators like @Auth, @Roles, @Policies, and @FirebaseUser.
• Flexible Configuration: Supports both synchronous and asynchronous configuration.

---

🏠 Overview

• Home

🚀 Getting Started

• Installation
• Configuration

🛠 Usage

• Basic Usage
• Advanced Usage
• Decorators
• Policies (ABAC)
• Claims (Fine-Grained)
• Complex Examples

📚 Guides

• Migrations

🫂 Community

• Contributing