Hapi-auth-fb NPM

hapi-auth-fb

Hapi JS plugin that allows "plug-and-play" Facebook authentication in Hapi routes.

NOTE: hapi-auth-fb version 1.x and above are NOT compatible with hapi version 16.x and below. hapi-auth-fb version 1.x works ONLY with hapi versions 17.x and above. if you need support for hapi version 16.x please use hapi-auth-fb version 0.1.3

NOTE: This README assumes that you know the basics of Facebook's OAuth 2 implementation. Perhaps I'll add a bit of a tutorial later, but for now there are many tutorials out there about how to set up a basic Facebook web app, it's not hard, basically you need to:

Set up a Facebook app in their developer portal
Get your client id and client secret from the Facebook development portal once you set up your app.
Give Facebook the domain of your app (you can use localhost in during development).
Give Facebook the URL of your application.

hapi-auth-fb is a typical auth strategy/scheme hapi plugin, meaning that once a user is logged-in their credentials are available in all secured routes via the request.auth.credentials object, so you can do anything with that information. Here's the basic flow when a user requests an endpoint that is secured:

The plugin sees if the user is already authenticated, if they are, they go right to the requested route (with request.auth.credentials fully set, BTW).
If the user has not already authenticated the user will be redirected to a Facebook login page, once they log in they will be asked if they give you app permission to use the things that you're asking for (see the scope option in the options section below). If they authorize your app they will be redirected back to the originally requested route in your app.
The originally requested route will now have full access, through the request.auth.credentials object, to all of the fields that you requested access to (see the fields option in the options section below). Simple as that.

Installation

npm install --save hapi-auth-fb

Usage

'use strict'

const Hapi = require('hapi')
const hapiAuthFb = require('hapi-auth-fb')

const server = Hapi.server({
  host: 'localhost',
  port: 8000
})

!async function () {
  await server.register({
    plugin: hapiAuthFb,
    options: {
      client_id: '',
      client_secret: '',
      // optional
      success: function (credentials) {
        console.log(credentials)
      },
      // optional
      transformer: async function (credentials) {
        credentials.email = credentials.email.toUpperCase()
        return credentials
      }
    }
  })
  server.auth.strategy('facebook', 'facebook')
  await server.route({
    method: 'GET',
    path: '/secure',
    config: {
      auth: 'facebook'
    },
    handler: async function (req, h) {
      // hapi-auth-fb will set req.auth.credentials to that which was returned by Facebook
      const credentials = req.auth.credentials
      return credentials
    }
  })
  await server.route({
    method: 'GET',
    path: '/insecure',
    handler: async function (req, h) {
      return '/insecure'
    }
  })
  await server.start()
}()
  .then(function () {
    console.log('Server running at:', server.info.uri)
  })
  .catch(function (err) {
    console.error(err.message)
    console.error(err.stack)
    process.exit(1)
  })

Options

Options exist!

Required Options

The only "it won't work without them" options are client_id and client_secret.

Optional Options

fields - a string of comma-separated strings that tells the Facebook API what fields to give you about a user once they are authenticated. By default fields is first_name,last_name,short_name,email,id. These fields become request.auth.credentials in your routes. hapi-auth-fb hits Facebook's User API endpoint once authenticated, so the available fields are listed in the User API's documentation.
scope - a string of comma-separated strings that represent the permissions that you're asking the user for. public_profile,email by default, see Facebook's permissions reference for all available options.
version - a string that determines which version of Facebook's API you want to use, 2.10 by default.
success - a function with the signature [async] function(object) (where object is the information that you requested in fields). This function is called upon successful authentication with Facebook, so this is useful for things like persisting user information, it does not have any impact on the plugin itself, it's meant for your purposes.
transformer - a function with the signature [async] function(object) (where object is the information that you requested in fields) that returns the object that you want to become request.auth.credentials. Unlike the function assigned to success, the results of this function call will have an impact on the plugin, namely whatever the function returns will be that which is used to create request.auth.credentials.
error - a function with signature [async] function(error) that is called if any errors are encountered during the internal operations of the plugin.
handlerPath - a string that is the endpoint that Facebook redirects to after successful authentication. A user will be immediately redirected to the originally requested endpoint, so at most a user might see this URL for a few milliseconds, changing it is merely a cosmetic concern. By default it's a random string.
loginSuccessRedirectPath - a string, by default hapi-auth-fb will redirect to the originally requested route after successful authentication, you can override that here, if you'd like user to be redirected somewhere else, like /profile, for example
yar - an object that is passed to yar (the plugin that hapi-auth-fb uses for session management). See https://github.com/charlesread/hapi-auth-fb/blob/master/lib/options.js for defaults. Be careful.