perimeterx-js-core 0.8.0 → 0.10.0

package/lib/cjs/activities/utils.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toHeaderEntryArray = exports.createAdditionalS2SActivityDetails = exports.createBlockActivityDetails = exports.createPageRequestedActivityDetails = exports.addResponseDataToAsyncActivityCommonDetails = exports.addRiskApiDataToAsyncActivityCommonDetails = exports.addTokenDataToDetails = exports.addRequestDataToDetails = exports.addServerDataToDetails = exports.addTlsDataToDetails = exports.addProductDataToDetails = exports.addCustomParametersToDetails = exports.addConfigDataToDetails = exports.addRootContextDataToDetails = exports.createCommonActivityDetails = exports.createAsyncActivityCommonDetails = exports.createActivityDetails = exports.createAsyncActivity = void 0;
+var utils_1 = require("../utils");
+var products_1 = require("../products");
+var blocker_1 = require("../blocker");
+var action_1 = require("../action");
+var ActivityType_1 = require("./ActivityType");
+var risk_token_1 = require("../risk_token");
+var createAsyncActivity = function (activityType, config, context) {
+    var _a;
+    return {
+        type: activityType,
+        px_app_id: config.appId,
+        url: context.requestData.rawUrl,
+        headers: activityType !== ActivityType_1.ActivityType.ADDITIONAL_S2S
+            ? (0, exports.toHeaderEntryArray)((0, utils_1.removeSensitiveHeaders)(context.requestData.headers, config.sensitiveHeaders))
+            : undefined,
+        pxhd: (_a = context.pxhd) === null || _a === void 0 ? void 0 : _a.value,
+        socket_ip: context.requestData.ip,
+        timestamp: Date.now(),
+        vid: context.vid,
+        details: (0, exports.createActivityDetails)(activityType, config, context),
+    };
+};
+exports.createAsyncActivity = createAsyncActivity;
+var createActivityDetails = function (activityType, config, context) {
+    var commonActivityDetails = (0, exports.createCommonActivityDetails)(config, context);
+    var commonAsyncActivityDetails = (0, exports.createAsyncActivityCommonDetails)(context);
+    var specificActivityDetails = {};
+    switch (activityType) {
+        case ActivityType_1.ActivityType.PAGE_REQUESTED:
+            specificActivityDetails = (0, exports.createPageRequestedActivityDetails)(context);
+            break;
+        case ActivityType_1.ActivityType.BLOCK:
+            specificActivityDetails = (0, exports.createBlockActivityDetails)(context);
+            break;
+        case ActivityType_1.ActivityType.ADDITIONAL_S2S:
+            specificActivityDetails = (0, exports.createAdditionalS2SActivityDetails)(config, context);
+            break;
+    }
+    return Object.assign(commonActivityDetails, commonAsyncActivityDetails, specificActivityDetails);
+};
+exports.createActivityDetails = createActivityDetails;
+var createAsyncActivityCommonDetails = function (context) {
+    var details = {
+        client_uuid: context.uuid,
+    };
+    (0, exports.addRiskApiDataToAsyncActivityCommonDetails)(details, context);
+    (0, exports.addResponseDataToAsyncActivityCommonDetails)(details, context);
+    return details;
+};
+exports.createAsyncActivityCommonDetails = createAsyncActivityCommonDetails;
+var createCommonActivityDetails = function (config, context) {
+    var _a;
+    var details = {
+        module_version: config.moduleVersion,
+        // Note: risk_mode currently reflects only Bot Defender mode
+        risk_mode: ((_a = context.productData.bd) === null || _a === void 0 ? void 0 : _a.isMonitoredRequest) ? utils_1.ModuleMode.MONITOR : utils_1.ModuleMode.ACTIVE_BLOCKING,
+    };
+    (0, exports.addConfigDataToDetails)(details, config);
+    (0, exports.addRootContextDataToDetails)(details, context);
+    (0, exports.addRequestDataToDetails)(details, context.requestData);
+    (0, exports.addTokenDataToDetails)(details, context.tokenData);
+    (0, exports.addProductDataToDetails)(details, context.productData);
+    (0, exports.addServerDataToDetails)(details, context.serverData);
+    (0, exports.addTlsDataToDetails)(details, context.tlsData);
+    (0, exports.addCustomParametersToDetails)(details, context.customParameters);
+    return details;
+};
+exports.createCommonActivityDetails = createCommonActivityDetails;
+var addRootContextDataToDetails = function (details, context) {
+    (0, utils_1.transferExistingProperties)(context, details, {
+        requestId: 'request_id',
+        tokenOrigin: 'cookie_origin',
+        vidSource: 'enforcer_vid_source',
+        graphqlData: 'graphql_operations',
+    });
+};
+exports.addRootContextDataToDetails = addRootContextDataToDetails;
+var addConfigDataToDetails = function (details, config) {
+    if (config.remoteConfigVersion) {
+        details.remote_config_version = config.remoteConfigVersion;
+    }
+};
+exports.addConfigDataToDetails = addConfigDataToDetails;
+var addCustomParametersToDetails = function (details, customParameters) {
+    if (customParameters) {
+        Object.assign(details, customParameters);
+    }
+};
+exports.addCustomParametersToDetails = addCustomParametersToDetails;
+var addProductDataToDetails = function (details, productData) {
+    (0, utils_1.transferExistingProperties)(productData.ad, details, {
+        appUserId: 'app_user_id',
+        additionalFields: 'jwt_additional_fields',
+        crossTabSession: 'cross_tab_session',
+    });
+    (0, utils_1.transferExistingProperties)(productData.ci, details, {
+        hashedUsername: 'user',
+        hashedPassword: 'pass',
+        ciVersion: 'ci_version',
+        ssoStep: 'sso_step',
+    });
+};
+exports.addProductDataToDetails = addProductDataToDetails;
+var addTlsDataToDetails = function (details, tlsData) {
+    (0, utils_1.transferExistingProperties)(tlsData, details, {
+        tlsProtocol: 'tls_protocol',
+        tlsServer: 'tls_server',
+        tlsCipher: 'tls_cipher',
+        tlsCiphersSha: 'tls_ciphers_sha',
+        tlsExtensionSha: 'tls_extension_sha',
+        tlsPreferredCiphers: 'tls_preferred_ciphers',
+        tlsJa3Fingerprint: 'tls_ja3_fingerprint',
+    });
+};
+exports.addTlsDataToDetails = addTlsDataToDetails;
+var addServerDataToDetails = function (details, serverData) {
+    (0, utils_1.transferExistingProperties)(serverData, details, {
+        region: 'server_info_region',
+        datacenter: 'server_info_datacenter',
+    });
+};
+exports.addServerDataToDetails = addServerDataToDetails;
+var addRequestDataToDetails = function (details, requestData) {
+    (0, utils_1.transferExistingProperties)(requestData, details, {
+        httpVersion: 'http_version',
+        method: 'http_method',
+        requestCookieNames: 'request_cookie_names',
+    });
+};
+exports.addRequestDataToDetails = addRequestDataToDetails;
+var addTokenDataToDetails = function (details, _a) {
+    var token = _a.token, mobileData = _a.mobileData;
+    if (token) {
+        if (token.isValid()) {
+            details.px_cookie = token.getPayloadString();
+            details.px_cookie_hmac = token.hmac;
+        }
+        else {
+            details.px_orig_cookie = token.getTokenString();
+        }
+    }
+    if (mobileData) {
+        (0, utils_1.transferExistingProperties)(mobileData, details, {
+            originalToken: 'original_token',
+            decodedOriginalToken: 'px_decoded_original_token',
+        });
+        if (mobileData.originalTokenParseResult === risk_token_1.TokenParseResult.DECRYPTION_FAILED) {
+            details.original_token_error = 'cookie_decryption_failed';
+        }
+        else if (mobileData.originalTokenParseResult === risk_token_1.TokenParseResult.VALIDATION_FAILED) {
+            details.original_token_error = 'cookie_validation_failed';
+        }
+    }
+};
+exports.addTokenDataToDetails = addTokenDataToDetails;
+var addRiskApiDataToAsyncActivityCommonDetails = function (details, context) {
+    var _a;
+    (0, utils_1.transferExistingProperties)(context.riskApiData, details, {
+        riskRtt: 'risk_rtt',
+        s2sCallReason: 's2s_call_reason',
+    });
+    if ((_a = context.riskApiData.riskResponse) === null || _a === void 0 ? void 0 : _a.additionalRiskInfo) {
+        details.additional_risk_info = context.riskApiData.riskResponse.additionalRiskInfo;
+    }
+    if (context.productData[products_1.ProductName.CREDENTIAL_INTELLIGENCE]) {
+        details.credentials_compromised = context.productData[products_1.ProductName.CREDENTIAL_INTELLIGENCE].isCompromised;
+    }
+};
+exports.addRiskApiDataToAsyncActivityCommonDetails = addRiskApiDataToAsyncActivityCommonDetails;
+var addResponseDataToAsyncActivityCommonDetails = function (details, context) {
+    (0, utils_1.transferExistingProperties)(context.response, details, {
+        status: 'http_status_code',
+    });
+};
+exports.addResponseDataToAsyncActivityCommonDetails = addResponseDataToAsyncActivityCommonDetails;
+var createPageRequestedActivityDetails = function (context) {
+    var details = {};
+    details.pass_reason = Object.values(context.reasons)
+        .filter(function (x) { return x; })
+        .join(', ');
+    (0, utils_1.transferExistingProperties)(context.riskApiData, details, {
+        errorReason: 's2s_error_reason',
+        errorHttpStatus: 's2s_error_http_status',
+        errorMessage: 'error_message',
+    });
+    return details;
+};
+exports.createPageRequestedActivityDetails = createPageRequestedActivityDetails;
+var createBlockActivityDetails = function (context) {
+    var _a;
+    var details = {};
+    var blockingProduct = blocker_1.BLOCK_ACTION_TO_PRODUCT_MAP.get(context.blockAction);
+    details.block_reason = (_a = context.reasons) === null || _a === void 0 ? void 0 : _a[blockingProduct];
+    details.simulated_block = context.action === action_1.Action.SIMULATED_BLOCK;
+    (0, utils_1.transferExistingProperties)(context, details, {
+        blockAction: 'block_action',
+        score: 'block_score',
+    });
+    return details;
+};
+exports.createBlockActivityDetails = createBlockActivityDetails;
+var createAdditionalS2SActivityDetails = function (_a, _b) {
+    var ciSendRawUsernameOnAdditionalS2SActivity = _a.ciSendRawUsernameOnAdditionalS2SActivity;
+    var productData = _b.productData;
+    var _c = productData.ci, rawUsername = _c.rawUsername, isCompromised = _c.isCompromised, isLoginSuccessful = _c.isLoginSuccessful;
+    var details = { login_successful: isLoginSuccessful };
+    if (isCompromised &&
+        ciSendRawUsernameOnAdditionalS2SActivity &&
+        (isLoginSuccessful || typeof isLoginSuccessful !== 'boolean')) {
+        details.raw_username = rawUsername;
+    }
+    return details;
+};
+exports.createAdditionalS2SActivityDetails = createAdditionalS2SActivityDetails;
+var toHeaderEntryArray = function (headers) {
+    return Object.entries(headers).flatMap(function (_a) {
+        var key = _a[0], values = _a[1];
+        return values.map(function (value) { return ({
+            name: key,
+            value: value,
+        }); });
+    });
+};
+exports.toHeaderEntryArray = toHeaderEntryArray;

package/lib/cjs/additional_activity_handler/AdditionalActivityHandler.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/additional_activity_handler/AdditionalActivityHandlerUtils.js

@@ -0,0 +1,65 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdditionalActivityHandlerUtils = void 0;
+var AdditionalActivityHandlerUtils;
+(function (AdditionalActivityHandlerUtils) {
+    var _this = this;
+    AdditionalActivityHandlerUtils.invokeAdditionalActivityHandler = function (config, context) { return __awaiter(_this, void 0, void 0, function () {
+        var e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!(config.additionalActivityHandler && typeof config.additionalActivityHandler === 'function')) return [3 /*break*/, 4];
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    config.logger.debug('calling additional activity handler');
+                    return [4 /*yield*/, config.additionalActivityHandler(config.toParams(), context, context.requestData.request.getUnderlyingRequest())];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    e_1 = _a.sent();
+                    config.logger.error("caught additional activity handler error - ".concat(e_1));
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); };
+})(AdditionalActivityHandlerUtils || (exports.AdditionalActivityHandlerUtils = AdditionalActivityHandlerUtils = {}));

package/lib/cjs/additional_activity_handler/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AdditionalActivityHandler"), exports);
+__exportStar(require("./AdditionalActivityHandlerUtils"), exports);

package/lib/cjs/blocker/BlockAction.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockAction = void 0;
+var BlockAction;
+(function (BlockAction) {
+    BlockAction["CAPTCHA"] = "c";
+    BlockAction["RATE_LIMIT"] = "r";
+    BlockAction["CHALLENGE"] = "j";
+})(BlockAction || (exports.BlockAction = BlockAction = {}));

package/lib/cjs/blocker/BlockActionToProductMap.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLOCK_ACTION_TO_PRODUCT_MAP = void 0;
+var products_1 = require("../products");
+var BlockAction_1 = require("./BlockAction");
+exports.BLOCK_ACTION_TO_PRODUCT_MAP = new Map([
+    [BlockAction_1.BlockAction.CAPTCHA, products_1.ProductName.BOT_DEFENDER],
+    [BlockAction_1.BlockAction.RATE_LIMIT, products_1.ProductName.BOT_DEFENDER],
+    [BlockAction_1.BlockAction.CHALLENGE, products_1.ProductName.BOT_DEFENDER],
+]);

package/lib/cjs/blocker/BlockActionToWordMap.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLOCK_ACTION_TO_WORD_MAP = void 0;
+var BlockAction_1 = require("./BlockAction");
+exports.BLOCK_ACTION_TO_WORD_MAP = new Map([
+    [BlockAction_1.BlockAction.CAPTCHA, 'captcha'],
+    [BlockAction_1.BlockAction.RATE_LIMIT, 'ratelimit'],
+    [BlockAction_1.BlockAction.CHALLENGE, 'challenge'],
+]);

package/lib/cjs/blocker/IBlocker.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/blocker/IConditionalBlocker.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/blocker/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IConditionalBlocker"), exports);
+__exportStar(require("./IBlocker"), exports);
+__exportStar(require("./BlockAction"), exports);
+__exportStar(require("./BlockActionToProductMap"), exports);
+__exportStar(require("./BlockActionToWordMap"), exports);