@financialforcedev/orizuru-auth
Version:
Salesforce authentication for Heroku Node applications.
108 lines • 13.2 kB
JavaScript
;
/*
* Copyright (c) 2019, FinancialForce.com, inc
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - Neither the name of the FinancialForce.com, inc nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
/**
* @module middleware/identity
*/
const axios_1 = __importDefault(require("axios"));
const __1 = require("../..");
const accessToken_1 = require("./common/accessToken");
const fail_1 = require("./common/fail");
/**
* Returns an express middleware that uses the [Identity URL](https://help.salesforce.com/articleView?id=remoteaccess_using_openid.htm)
* to retrieve information about the current Salesforce user.
*
* This can be used in tandem with the **auth callback** middleware to retrieve the user information with the granted access token.
*
* @fires EVENT_USER_IDENTITY_RETRIEVED
* @param app The Orizuru server instance.
* @returns An express middleware that retrieves the identity information.
*/
function createMiddleware(app) {
return async function retrieveIdentityInformation(req, res, next) {
try {
const identityUrl = validateRequest(req);
const identityResponse = await axios_1.default.get(identityUrl, {
headers: {
Authorization: req.headers.authorization
}
});
setIdentityInformation(app, req, identityResponse.data);
next();
}
catch (error) {
fail_1.fail(app, error, req, res, next);
}
};
}
exports.createMiddleware = createMiddleware;
/**
* Validate the request.
*
* @param req The HTTP request.
* @returns The Identity URL.
*/
function validateRequest(req) {
accessToken_1.extractAccessToken(req);
if (!req.orizuru) {
throw new Error('Missing required object parameter: orizuru.');
}
if (!req.orizuru.salesforce) {
throw new Error('Missing required object parameter: orizuru[salesforce].');
}
const salesforce = req.orizuru.salesforce;
if (!salesforce.userInfo) {
throw new Error('Missing required object parameter: orizuru[salesforce][userInfo].');
}
const userInfo = salesforce.userInfo;
if (!userInfo.url) {
throw new Error('Missing required string parameter: orizuru[salesforce][userInfo][url].');
}
if (userInfo.validated === false) {
throw new Error('The Identity URL must be validated.');
}
if (!userInfo.validated) {
throw new Error('Missing required string parameter: orizuru[salesforce][userInfo][validated].');
}
return userInfo.url;
}
/**
* Sets the identity information in the Orizuru context and emits a user identity
* retrieved event.
*
* @param app The Orizuru server instance.
* @param req The HTTP request.
* @param identity The Salesforce Identity.
*/
function setIdentityInformation(app, req, identity) {
req.orizuru.salesforce.identity = identity;
app.emit(__1.EVENT_USER_IDENTITY_RETRIEVED, `Identity information retrieved for user (${identity.username}) [${req.ip}].`);
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../../../src/index/middleware/identity.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;;;;AAEH;;GAEG;AAEH,kDAAwD;AAIxD,6BAA0E;AAC1E,sDAA0D;AAC1D,wCAAqC;AAErC;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,GAAoB;IAEpD,OAAO,KAAK,UAAU,2BAA2B,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QAEhG,IAAI;YAEH,MAAM,WAAW,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;YAEzC,MAAM,gBAAgB,GAAsC,MAAM,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE;gBACxF,OAAO,EAAE;oBACR,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa;iBACxC;aACD,CAAC,CAAC;YAEH,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAExD,IAAI,EAAE,CAAC;SAEP;QAAC,OAAO,KAAK,EAAE;YACf,WAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;SACjC;IAEF,CAAC,CAAC;AAEH,CAAC;AAxBD,4CAwBC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,GAAY;IAEpC,gCAAkB,CAAC,GAAG,CAAC,CAAC;IAExB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;KAC/D;IAED,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC3E;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC;IAC1C,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;KACrF;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;IACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;KAC1F;IAED,IAAI,QAAQ,CAAC,SAAS,KAAK,KAAK,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACvD;IAED,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;KAChG;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC;AAErB,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,GAAoB,EAAE,GAAY,EAAE,QAA4B;IAE/F,GAAG,CAAC,OAAQ,CAAC,UAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE7C,GAAG,CAAC,IAAI,CAAC,iCAA6B,EAAE,4CAA4C,QAAQ,CAAC,QAAQ,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AAExH,CAAC","sourcesContent":["/*\n * Copyright (c) 2019, FinancialForce.com, inc\n * All rights reserved.\n *\n * Redistribution and use in source and binary forms, with or without modification,\n *   are permitted provided that the following conditions are met:\n *\n * - Redistributions of source code must retain the above copyright notice,\n *      this list of conditions and the following disclaimer.\n * - Redistributions in binary form must reproduce the above copyright notice,\n *      this list of conditions and the following disclaimer in the documentation\n *      and/or other materials provided with the distribution.\n * - Neither the name of the FinancialForce.com, inc nor the names of its contributors\n *      may be used to endorse or promote products derived from this software without\n *      specific prior written permission.\n *\n * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\n *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL\n *  THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\n *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n *  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n */\n\n/**\n * @module middleware/identity\n */\n\nimport { AxiosResponse, default as axios } from 'axios';\n\nimport { NextFunction, Request, RequestHandler, Response } from '@financialforcedev/orizuru';\n\nimport { EVENT_USER_IDENTITY_RETRIEVED, SalesforceIdentity } from '../..';\nimport { extractAccessToken } from './common/accessToken';\nimport { fail } from './common/fail';\n\n/**\n * Returns an express middleware that uses the [Identity URL](https://help.salesforce.com/articleView?id=remoteaccess_using_openid.htm)\n * to retrieve information about the current Salesforce user.\n *\n * This can be used in tandem with the **auth callback** middleware to retrieve the user information with the granted access token.\n *\n * @fires EVENT_USER_IDENTITY_RETRIEVED\n * @param app The Orizuru server instance.\n * @returns An express middleware that retrieves the identity information.\n */\nexport function createMiddleware(app: Orizuru.IServer): RequestHandler {\n\n\treturn async function retrieveIdentityInformation(req: Request, res: Response, next: NextFunction) {\n\n\t\ttry {\n\n\t\t\tconst identityUrl = validateRequest(req);\n\n\t\t\tconst identityResponse: AxiosResponse<SalesforceIdentity> = await axios.get(identityUrl, {\n\t\t\t\theaders: {\n\t\t\t\t\tAuthorization: req.headers.authorization\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tsetIdentityInformation(app, req, identityResponse.data);\n\n\t\t\tnext();\n\n\t\t} catch (error) {\n\t\t\tfail(app, error, req, res, next);\n\t\t}\n\n\t};\n\n}\n\n/**\n * Validate the request.\n *\n * @param req The HTTP request.\n * @returns The Identity URL.\n */\nfunction validateRequest(req: Request) {\n\n\textractAccessToken(req);\n\n\tif (!req.orizuru) {\n\t\tthrow new Error('Missing required object parameter: orizuru.');\n\t}\n\n\tif (!req.orizuru.salesforce) {\n\t\tthrow new Error('Missing required object parameter: orizuru[salesforce].');\n\t}\n\n\tconst salesforce = req.orizuru.salesforce;\n\tif (!salesforce.userInfo) {\n\t\tthrow new Error('Missing required object parameter: orizuru[salesforce][userInfo].');\n\t}\n\n\tconst userInfo = salesforce.userInfo;\n\tif (!userInfo.url) {\n\t\tthrow new Error('Missing required string parameter: orizuru[salesforce][userInfo][url].');\n\t}\n\n\tif (userInfo.validated === false) {\n\t\tthrow new Error('The Identity URL must be validated.');\n\t}\n\n\tif (!userInfo.validated) {\n\t\tthrow new Error('Missing required string parameter: orizuru[salesforce][userInfo][validated].');\n\t}\n\n\treturn userInfo.url;\n\n}\n\n/**\n * Sets the identity information in the Orizuru context and emits a user identity\n * retrieved event.\n *\n * @param app The Orizuru server instance.\n * @param req The HTTP request.\n * @param identity The Salesforce Identity.\n */\nfunction setIdentityInformation(app: Orizuru.IServer, req: Request, identity: SalesforceIdentity) {\n\n\treq.orizuru!.salesforce!.identity = identity;\n\n\tapp.emit(EVENT_USER_IDENTITY_RETRIEVED, `Identity information retrieved for user (${identity.username}) [${req.ip}].`);\n\n}\n"]}