Secure Firebase Cloud Functions for Authenticated Users

Run HTTP and Database Cloud Functions when a user is logged-in 810 words.

Jeff Delaney avatar
By
Created
Last Updated
Slack
#firebase #security #pro

Learn more in the Cloud Functions Master Course.

In this lesson, I will show you how to run Firebase Cloud Functions ONLY when users are authenticated with a valid user ID.

Endpoint security is critical - especially if using a paid 3rd party API like SendGrid or Twilio. There are certain situations where only want a function to run if the user is currently authenticated. For example, you may have a function that sends transactional email to a user via SendGrid. If this function is left insecure, any old troll can send cURL requests to your endpoint and cause you to rack up fees with your email service provider. There are two ways to address this issue and I will cover both:

  1. Method 1 - Secure Database Triggers
  2. Method 2 - Secure HTTPS Triggers

Method 1 - Database Trigger with Backend Rules

Thanks to Firebase, locking down database cloud functions for authenticated users is very simple. In my opinion, this is a superior way to keep cloud functions secure by user, but may not be practical in all cases.

database.rules.json

First, we create a database rule that limits the action to an authenticated user’s specific user ID. This will ensure that only the Firebase account admin or user with that UID can modify that node.

  "users": {
     "$uid": {
        ".write": "auth.uid === $uid",
      }
    },

Cloud Function index.js

Next, we run a cloud function that is triggered on the secured node. Firebase will block any updates to a node that is not owned by that user, so we are guaranteed a secure function invocation based on the underlying Firebase architecture.

const functions = require('firebase-functions');

exports.secureDatabase = functions.database

    .ref('/users/{userId}/friends')
    .onCreate(event => {
    
        const data = event.after.val();
        const userId  = event.params.userId;
        
        // Hypothetical send transactional email to user
        return sendEmailToUser('You have a new friend!');

})

Now if you try to update data on this node without being logged in with a matching UID, you will get the following error in the console and the cloud function will never run.

Permission denied with firebase database rules

Permission denied with firebase database rules

Method 2 - HTTP Trigger with CORs and Token Decoding

It is not always feasible to use database triggers, so how do we secure an HTTP Firebase Cloud Function? The answer is to decode an authentication token header in the cloud function environment.

A secure endpoint on Firebase cloud functions

Google has put together an example of an authorized endpoint in the cloud functions samples repo. I have modified the function to my own preferences and added a way to trigger it with the Angular HTTP module.

HTTP Cloud Function that Validates Auth Data

Here’s what’s going on step-by-step.

  1. Request is received at endpoint
  2. Wrap the request in CORS
  3. Validate request has Authorization header
  4. Decode the auth token in header (this is the current user)
  5. See if current user UID === requested resource UID.
const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp();

const cors = require('cors')({ origin: true });


exports.secureEndpoint = functions.https.onRequest((req, res) => {

    cors( req, res, () => { 


        let requestedUid = req.body.uid     // resource the user is requsting to modify
        let authToken = validateHeader(req) // current user encrypted
        
        if (!authToken) {
            return res.status(403).send('Unuthorized! Missing auth token!')
        }
            
        return decodeAuthToken(authToken)
                    .then(uid => {
                        if (uid === requestedUid) {
                            // Safe to do something important here
                            res.status(200).send('Looks good!')
                        } else {
                            res.status(403).send('Unauthorized to edit other user data')
                        }
        })
                    .catch(err => console.log(err))

    });
});


// 1. Helper to validate auth header is present
function validateHeader(req) {
    if ( req.headers.authorization && req.headers.authorization.startsWith('Bearer ') ) {
        console.log('auth header found')
        return req.headers.authorization.split('Bearer ')[1]
    }
}

// 2. Helper to decode token to firebase UID (returns promise)
function decodeAuthToken(authToken) {
    return admin.auth()
                .verifyIdToken(authToken)
                .then(decodedToken => {
                    // decode the current user's auth token
                    return decodedToken.uid;
                })
}

Make the HTTP Call in Angular

Naturally, we are going to make the HTTP call with Angular, but you could also do with with vanilla JS.

If you send the request with myUID, assuming you send your current auth uid, you should get a 200 response back from the cloud function. Sending any other UID will result in a 403 unauthorized error.

import { Component } from '@angular/core';
import { AngularFireDatabase } from 'angularfire2/database';
import * as firebase from 'firebase/app';

import { Http, Headers } from '@angular/http';
import 'rxjs/add/operator/toPromise';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss']
})

export class AppComponent {


  constructor(private db: AngularFireDatabase, private http: Http) { }

  postRequest() {
    const url = 'https://your-firebase-project.cloudfunctions.net/secureEndpoint';

    firebase.auth().currentUser.getIdToken()
            .then(authToken => {
              const headers = new Headers({'Authorization': 'Bearer ' + authToken });

              const myUID    = { uid: 'current-user-uid' };    // success 200 response
              const notMyUID = { uid: 'some-other-user-uid' }; // error 403 response

              return this.http.post(url, myUID, { headers: headers }).toPromise()
            })
            .then(res => console.log(res))
    }

}

Then try the request out via an HTML button:

<button (click)="postRequest()">
  POST to Secure HTTP Endpoint
</button>

That’s it for secure Firebase Cloud Function endpoints.

Learn more in the Cloud Functions Master Course.

In this lesson, I will show you how to run Firebase Cloud Functions ONLY when users are authenticated with a valid user ID.

Endpoint security is critical - especially if using a paid 3rd party API like SendGrid or Twilio. There are certain situations where only want a function to run if the user is currently authenticated. For example, you may have a function that sends transactional email to a user via SendGrid. If this function is left insecure, any old troll can send cURL requests to your endpoint and cause you to rack up fees with your email service provider. There are two ways to address this issue and I will cover both:

  1. Method 1 - Secure Database Triggers
  2. Method 2 - Secure HTTPS Triggers

Method 1 - Database Trigger with Backend …

Upgrade to PRO for the Full Lesson

Monthly

$25/month
  • Unlimited access to PRO courses
  • Cancel anytime
  • Slack #pro-member invite
  • AngularFirebase Survival Guide Book
  • No ads

Quarterly

$50/3mo
  • All monthly tier benefits
  • 💰 33.33% discount
  • 🔥 Free Sticker

Lifetime

$300/one-time
  • All monthly tier Benefits
  • 💸 One-time payment
  • 👕 Free Commemorative T-Shirt

You must be logged in to view this content.

Questions?

Ask questions via GitHub below OR chat on Slack #questions