perimeterx-js-core 0.8.0 → 0.10.0

package/README.md

@@ -60,7 +60,7 @@ your enforcer's configuration setup.
 `IConfiguration` - Represents the enforcer configuration and is required to construct most other components
 in this library.
 
-`StaticConfigurationBase` - An implementation of the above interface that validates provided configurations and merges
+`ConfigurationBase` - An implementation of the above interface that validates provided configurations and merges
 them with default ones.
 
 `DefaultConfigurations` - A static object complete with all default enforcer configurations.

package/lib/cjs/action/Action.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Action = void 0;
+var Action;
+(function (Action) {
+    Action["PASS_REQUEST"] = "pass_request";
+    Action["TRIGGER_RISK_API"] = "trigger_risk_api";
+    Action["SIMULATED_BLOCK"] = "simulated_block";
+    Action["BLOCK"] = "block";
+})(Action || (exports.Action = Action = {}));

package/lib/cjs/action/ActionData.js

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

package/lib/cjs/action/ActionPriorityOrder.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTION_PRIORITY_ORDER = void 0;
+var Action_1 = require("./Action");
+exports.ACTION_PRIORITY_ORDER = [
+    Action_1.Action.BLOCK,
+    Action_1.Action.SIMULATED_BLOCK,
+    Action_1.Action.TRIGGER_RISK_API,
+    Action_1.Action.PASS_REQUEST,
+];

package/lib/cjs/action/Decision.js

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

package/lib/cjs/action/ProductAction.js

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

package/lib/cjs/action/index.js

@@ -0,0 +1,22 @@
+"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("./Action"), exports);
+__exportStar(require("./ActionData"), exports);
+__exportStar(require("./ActionPriorityOrder"), exports);
+__exportStar(require("./Decision"), exports);
+__exportStar(require("./ProductAction"), exports);
+__exportStar(require("./utils"), exports);

package/lib/cjs/action/utils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDecisionFromActions = exports.getProductActions = exports.getDecisionFromContext = void 0;
+var Action_1 = require("./Action");
+var ActionPriorityOrder_1 = require("./ActionPriorityOrder");
+var getDecisionFromContext = function (context) {
+    return (0, exports.getDecisionFromActions)((0, exports.getProductActions)(context));
+};
+exports.getDecisionFromContext = getDecisionFromContext;
+var getProductActions = function (context) {
+    return Object.entries(context.productData)
+        .filter(function (_a) {
+        var _ = _a[0], data = _a[1];
+        return (data === null || data === void 0 ? void 0 : data.action) != null && (data === null || data === void 0 ? void 0 : data.reason) != null;
+    })
+        .map(function (_a) {
+        var productName = _a[0], data = _a[1];
+        return ({
+            action: data.action,
+            reason: data.reason,
+            productName: productName,
+        });
+    });
+};
+exports.getProductActions = getProductActions;
+var getDecisionFromActions = function (productActions) {
+    return createDecision(reduce(productActions));
+};
+exports.getDecisionFromActions = getDecisionFromActions;
+var reduce = function (actions) {
+    return actions.reduce(function (tally, _a) {
+        var action = _a.action, reason = _a.reason, productName = _a.productName;
+        if (!tally[action]) {
+            tally[action] = {};
+        }
+        tally[action][productName] = reason;
+        return tally;
+    }, {});
+};
+var createDecision = function (tally) {
+    for (var _i = 0, ACTION_PRIORITY_ORDER_1 = ActionPriorityOrder_1.ACTION_PRIORITY_ORDER; _i < ACTION_PRIORITY_ORDER_1.length; _i++) {
+        var action = ACTION_PRIORITY_ORDER_1[_i];
+        if (tally[action]) {
+            return { action: action, reasons: tally[action] };
+        }
+    }
+    return { action: Action_1.Action.PASS_REQUEST };
+};

package/lib/cjs/activities/ActivityType.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityType = void 0;
+var ActivityType;
+(function (ActivityType) {
+    ActivityType["PAGE_REQUESTED"] = "page_requested";
+    ActivityType["BLOCK"] = "block";
+    ActivityType["ADDITIONAL_S2S"] = "additional_s2s";
+    ActivityType["ENFORCER_TELEMETRY"] = "enforcer_telemetry";
+})(ActivityType || (exports.ActivityType = ActivityType = {}));

package/lib/cjs/activities/HttpActivityClient.js

@@ -0,0 +1,121 @@
+"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.HttpActivityClient = void 0;
+var action_1 = require("../action");
+var http_1 = require("../http");
+var utils_1 = require("../utils");
+var ActivityType_1 = require("./ActivityType");
+var utils_2 = require("./utils");
+var constants_1 = require("./constants");
+var HttpActivityClient = /** @class */ (function () {
+    function HttpActivityClient(config, httpClient) {
+        this.config = config;
+        this.httpClient = httpClient;
+    }
+    HttpActivityClient.prototype.sendActivities = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var activities, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        activities = this.createActivities(context);
+                        return [4 /*yield*/, this.postActivities(activities)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                    case 2:
+                        e_1 = _a.sent();
+                        this.config.logger.error("unable to send activities - ".concat(e_1));
+                        return [2 /*return*/, false];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    HttpActivityClient.prototype.createActivities = function (context) {
+        var activities = [];
+        if (context.action === action_1.Action.BLOCK || context.action === action_1.Action.SIMULATED_BLOCK) {
+            activities.push((0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.BLOCK, this.config, context));
+        }
+        else if (context.action === action_1.Action.PASS_REQUEST) {
+            activities.push((0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.PAGE_REQUESTED, this.config, context));
+            if (context.productData.ci && this.config.ciAutomaticAdditionalS2SEnabled) {
+                activities.push((0, utils_2.createAsyncActivity)(ActivityType_1.ActivityType.ADDITIONAL_S2S, this.config, context));
+            }
+        }
+        return activities.map(this.finalizeActivity);
+    };
+    /**
+     * Allows for expansions or alterations to the async activity if needed.
+     * @param activity
+     * @returns AsyncActivity
+     * @protected
+     */
+    HttpActivityClient.prototype.finalizeActivity = function (activity) {
+        return activity;
+    };
+    HttpActivityClient.prototype.postActivities = function (activities) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, method, headers, body, req, res;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        url = "".concat(this.config.backendCollectorUrl).concat(constants_1.ACTIVITIES_ENDPOINT);
+                        method = http_1.HttpMethod.POST;
+                        headers = (_a = {},
+                            _a[http_1.CONTENT_TYPE_HEADER_NAME] = [http_1.ContentType.APPLICATION_JSON],
+                            _a[http_1.AUTHORIZATION_HEADER_NAME] = [(0, utils_1.getAuthorizationHeader)(this.config.authToken)],
+                            _a);
+                        body = activities.length === 1 ? JSON.stringify(activities[0]) : JSON.stringify(activities);
+                        this.config.logger.debug("sending ".concat(activities.map(function (_a) {
+                            var type = _a.type;
+                            return "".concat(type, " activity");
+                        }).join(', '), " to ").concat(url));
+                        req = new http_1.OutgoingRequestImpl({ url: url, method: method, headers: headers, body: body });
+                        return [4 /*yield*/, this.httpClient.send(req)];
+                    case 1:
+                        res = _b.sent();
+                        return [2 /*return*/, (res === null || res === void 0 ? void 0 : res.status) === 200];
+                }
+            });
+        });
+    };
+    return HttpActivityClient;
+}());
+exports.HttpActivityClient = HttpActivityClient;

package/lib/cjs/activities/HttpBatchedActivityClient.js

@@ -0,0 +1,137 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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.HttpBatchedActivityClient = void 0;
+var HttpActivityClient_1 = require("./HttpActivityClient");
+var HttpBatchedActivityClient = /** @class */ (function (_super) {
+    __extends(HttpBatchedActivityClient, _super);
+    function HttpBatchedActivityClient(config, httpClient) {
+        var _this = _super.call(this, config, httpClient) || this;
+        _this.buffer = [];
+        _this.batchSize = config.maxActivityBatchSize;
+        _this.timeoutMs = config.activityBatchTimeoutMs;
+        _this.maxBufferSize = _this.batchSize * 2;
+        _this.startTimer();
+        return _this;
+    }
+    HttpBatchedActivityClient.prototype.stop = function () {
+        this.stopTimer();
+    };
+    HttpBatchedActivityClient.prototype.postActivities = function (activities) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.addToBuffer(activities);
+                return [2 /*return*/, this.shouldFlush() ? this.triggerFlush() : true];
+            });
+        });
+    };
+    HttpBatchedActivityClient.prototype.addToBuffer = function (activities) {
+        this.buffer = activities.concat(this.buffer);
+        if (this.buffer.length > this.maxBufferSize) {
+            this.buffer = this.buffer.slice(0, this.maxBufferSize);
+        }
+    };
+    HttpBatchedActivityClient.prototype.shouldFlush = function () {
+        return this.buffer.length >= this.batchSize;
+    };
+    HttpBatchedActivityClient.prototype.triggerFlush = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var sentSuccessfully, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        this.stopTimer();
+                        _a = this.buffer.length > 0;
+                        if (!_a) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.flush()];
+                    case 1:
+                        _a = (_b.sent());
+                        _b.label = 2;
+                    case 2:
+                        sentSuccessfully = _a;
+                        this.startTimer();
+                        return [2 /*return*/, sentSuccessfully];
+                }
+            });
+        });
+    };
+    HttpBatchedActivityClient.prototype.flush = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var sentSuccessfully;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, _super.prototype.postActivities.call(this, this.buffer)];
+                    case 1:
+                        sentSuccessfully = _a.sent();
+                        if (sentSuccessfully) {
+                            this.clear();
+                        }
+                        return [2 /*return*/, sentSuccessfully];
+                }
+            });
+        });
+    };
+    HttpBatchedActivityClient.prototype.clear = function () {
+        this.buffer = [];
+    };
+    HttpBatchedActivityClient.prototype.startTimer = function () {
+        var _this = this;
+        this.timeoutId = setTimeout(function () { return _this.triggerFlush(); }, this.timeoutMs);
+    };
+    HttpBatchedActivityClient.prototype.stopTimer = function () {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = null;
+    };
+    return HttpBatchedActivityClient;
+}(HttpActivityClient_1.HttpActivityClient));
+exports.HttpBatchedActivityClient = HttpBatchedActivityClient;

package/lib/cjs/activities/IActivityClient.js

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

package/lib/cjs/activities/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTIVITIES_ENDPOINT = void 0;
+exports.ACTIVITIES_ENDPOINT = '/api/v1/collector/s2s';

package/lib/cjs/activities/index.js

@@ -0,0 +1,23 @@
+"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("./IActivityClient"), exports);
+__exportStar(require("./ActivityType"), exports);
+__exportStar(require("./HttpActivityClient"), exports);
+__exportStar(require("./HttpBatchedActivityClient"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./constants"), exports);

package/lib/cjs/activities/model/AsyncActivity.js

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

package/lib/cjs/activities/model/AsyncActivityDetails.js

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

package/lib/cjs/activities/model/CommonActivityDetails.js

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

package/lib/cjs/activities/model/HeaderEntry.js

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

package/lib/cjs/activities/model/index.js

@@ -0,0 +1,20 @@
+"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("./AsyncActivity"), exports);
+__exportStar(require("./AsyncActivityDetails"), exports);
+__exportStar(require("./HeaderEntry"), exports);
+__exportStar(require("./CommonActivityDetails"), exports);