@enkeldigital/firebase-authentication

Plugin to use with this library to integrate with firebase authentication.

Installation

1npm install @enkeldigital/firebase-authentication
2
3# Depends on this too
4npm install create-express-auth-middleware

Example

View samples folder for more specific examples

1. Make a API call from client using this example to include an Authorization header

   Authorization: Bearer <your-client-token>
   

2. If an API call is made with a valid token, you can access the decoded token object from request

   1const app = require("express")();
   2const { create_authn_middleware, create_authz_middleware } = require("create-express-auth-middleware");
   3const firebaseAuthentication = require("@enkeldigital/firebase-authentication");
   4const { auth } = require("@enkeldigital/firebase-admin");
   5
   6// Make all routes in this express app to be authentication protected.
   7// Meaning all routes defined later can only be called if a valid JWT is provided.
   8// This DOES NOT mean that routes are fully protected yet,
   9// as you need to ensure users have sufficient permission to access APIs using authorization middleware.
   10app.use(create_authn_middleware(firebaseAuthentication(auth)));
   11
   12// The actual route that requires both authentication and authorization to run.
   13app.get(
   14    "/data/:userID",
   15
   16    // Add authorization middleware to ensure users can only access their own data
   17    // Checks that the specified userID in the URL matches user's own userID value in their 'DecodedIdToken'
   18    // The 'jwt' property is set by the authentication middleware that is registered above
   19    create_authz_middleware((req) => req.jwt.userID === req.params.userID),
   20
   21    // This request handler will only run if both predicate above returns true!
   22    (req, res) => res.status(200).json({ data: "Protected user data" })
   23);

3. If authentication failed, you get a 401 code with the following response by default

   1{ "ok": false, "error": "Authentication Failed" }

4. If authorization failed, you get a 403 code with the following response by default

   1{ "ok": false, "error": "Authorization Failed" }

License and Author

This project is made available under MIT LICENSE and written by JJ