@loopback/authentication-passport/dist/strategy-adapter.js

A package creating adapters between the passport module and @loopback/authentication

"use strict";
// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
// Node module: @loopback/authentication-passport
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
Object.defineProperty(exports, "__esModule", { value: true });
exports.StrategyAdapter = void 0;
const rest_1 = require("@loopback/rest");
const passportRequestMixin = require('passport/lib/http/request');
/**
 * Adapter class to invoke passport-strategy
 *   1. provides express dependencies to the passport strategies
 *   2. provides shimming of requests for passport authentication
 *   3. provides life-cycle similar to express to the passport-strategy
 *   4. provides state methods to the strategy instance
 * see: https://github.com/jaredhanson/passport
 */
class StrategyAdapter {
    /**
     * @param strategy instance of a class which implements a
     * {@link http://passportjs.org/ | passport-strategy}.
     */
    constructor(strategy, name, 
    // The default user profile factory that takes in a user and returns a user profile
    userProfileFactory = (u) => {
        return u;
    }) {
        this.strategy = strategy;
        this.name = name;
        this.userProfileFactory = userProfileFactory;
    }
    /**
     * The function to invoke the contained passport strategy.
     *     1. Create an instance of the strategy
     *     2. add success and failure state handlers
     *     3. authenticate using the strategy
     * @param request The incoming request.
     * @param options Options passed through to strategy.authenticate.
     */
    authenticate(request, options) {
        const userProfileFactory = this.userProfileFactory;
        return new Promise((resolve, reject) => {
            // mix-in passport additions like req.logIn and req.logOut
            for (const key in passportRequestMixin) {
                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                request[key] = passportRequestMixin[key];
            }
            // create a prototype chain of an instance of a passport strategy
            const strategy = Object.create(this.strategy);
            // add success state handler to strategy instance.
            // as a generic adapter, it is agnostic of the type of
            // the custom user, so loosen the type restriction here
            // to be `unknown`
            strategy.success = function (user) {
                const userProfile = userProfileFactory(user);
                resolve(userProfile);
            };
            // add failure state handler to strategy instance
            strategy.fail = function (challenge) {
                reject(new rest_1.HttpErrors.Unauthorized(challenge));
            };
            // add error state handler to strategy instance
            strategy.error = function (error) {
                reject(new rest_1.HttpErrors.InternalServerError(error));
            };
            // handle redirection for oauth2 authorization flows
            strategy.redirect = function (url, status) {
                // resolve with redirect options
                // the controller configured with the oauth2 strategy will have to handle actual redirection
                const redirectOptions = new rest_1.RedirectRoute('', url, status);
                resolve(redirectOptions);
            };
            // authenticate
            strategy.authenticate(request, options);
        });
    }
}
exports.StrategyAdapter = StrategyAdapter;
//# sourceMappingURL=strategy-adapter.js.map