rawfishindustries-firebase-auth
v1.1.4
Published
Firebase authentication package
Downloads
34
Readme
Firebase Admin Authentication Middleware
Firebase Admin Authentication Middleware is a Node.js library designed to simplify Firebase authentication in Express.js applications. It provides a middleware that can be easily integrated into your routes to handle user authentication using Firebase.
Installation
npm install rawfishindustries-firebase-auth
Usage
Importing and initialize library
import AuthService from 'rawfishindustries-firebase-auth';
// Initialize an instance of AuthService
AuthService.initialize(
'your-firebase-project-id',
'your-firebase-client-email',
'your-firebase-private-key',
true, // Enable caching (default is true)
{ host: 'your-redis-host', port: 6379 }, // Redis connection parameters
'your-firebase-database-url' // Optional: Firebase database URL
);
const authService = AuthService.getInstance()
Middleware usage
// Use the middleware in your Express route
app.get('/protected-route', authService.verifyMiddleware, (req, res) => {
// Access protected resources here
res.send('Authenticated user!');
});
Configuration options
- projectId (string): The ID of your Firebase project.
- clientEmail (string): The client email associated with your Firebase project.
- privateKey (string): The private key associated with your Firebase project.
- enableCache (boolean, optional): Whether to enable caching. Defaults to true.
- redisConnection (RedisConnection): The connection parameters for Redis.
- databaseUrl (string, optional): The URL of your Firebase Realtime Database.
Features
- Firebase Authentication: Automatically verifies Firebase authentication tokens.
- Caching: Optionally cache decoded tokens in Redis to reduce the load on Firebase servers.
- Middleware: Easily integrate the middleware into your Express routes for authentication.
License
This library is licensed under the MIT License.