bch-api/dist/middleware/auth.js

/*
  Handle authorization for bypassing rate limits.

  This file uses the passport npm library to check the header of each REST API
  call for the prescence of a Basic authorization header:
  https://en.wikipedia.org/wiki/Basic_access_authentication

  If the header is found and validated, the req.locals.proLimit Boolean value
  is set and passed to the route-ratelimits.ts middleware.
*/
"use strict";
var passport = require("passport");
var BasicStrategy = require("passport-http").BasicStrategy;
var AnonymousStrategy = require("passport-anonymous");
var wlogger = require("../util/winston-logging");
// Used for debugging and iterrogating JS objects.
var util = require("util");
util.inspect.defaultOptions = { depth: 1 };
var _this;
// Set default rate limit value for testing
var PRO_PASSes = process.env.PRO_PASS ? process.env.PRO_PASS : "BITBOX";
// Convert the pro-tier password string into an array split by ':'.
var PRO_PASS = PRO_PASSes.split(":");
//wlogger.verbose(`PRO_PASS set to: ${PRO_PASS}`)
// Auth Middleware
var AuthMW = /** @class */ (function () {
    function AuthMW() {
        _this = this;
        // Initialize passport for 'anonymous' authentication.
        /*
        passport.use(
          new AnonymousStrategy({ passReqToCallback: true }, function(
            req,
            username,
            password,
            done
          ) {
            console.log(`anonymous auth handler triggered.`)
          })
        )
        */
        passport.use(new AnonymousStrategy());
        // Initialize passport for 'basic' authentication.
        passport.use(new BasicStrategy({ passReqToCallback: true }, function (req, username, password, done) {
            //console.log(`req: ${util.inspect(req)}`)
            //console.log(`username: ${username}`)
            //console.log(`password: ${password}`)
            // Create the req.locals property if it does not yet exist.
            if (!req.locals)
                req.locals = {};
            // Set pro-tier rate limit to flag to false by default.
            req.locals.proLimit = false;
            // Evaluate the username and password and set the rate limit accordingly.
            //if (username === "BITBOX" && password === PRO_PASS) {
            if (username === "BITBOX") {
                for (var i = 0; i < PRO_PASS.length; i++) {
                    var thisPass = PRO_PASS[i];
                    if (password === thisPass) {
                        wlogger.verbose(req.url + " called by " + password.slice(0, 6));
                        // Success
                        req.locals.proLimit = true;
                        break;
                    }
                }
            }
            //console.log(`req.locals: ${util.inspect(req.locals)}`)
            return done(null, true);
        }));
    }
    // Middleware called by the route.
    AuthMW.prototype.mw = function () {
        return passport.authenticate(["basic", "anonymous"], {
            session: false
        });
    };
    return AuthMW;
}());
module.exports = AuthMW;