perimeterx-js-core 0.1.0

package/lib/risk_token/token/v3/DefaultBotDefenderTokenV3.js

@@ -0,0 +1,231 @@
+"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 (_) 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.DefaultBotDefenderTokenV3 = void 0;
+var utils_1 = require("../../../utils");
+var constants_1 = require("../../constants");
+var TokenSignField_1 = require("./TokenSignField");
+var BotDefenderTokenBase_1 = require("../BotDefenderTokenBase");
+var DefaultBotDefenderTokenV3 = /** @class */ (function (_super) {
+    __extends(DefaultBotDefenderTokenV3, _super);
+    function DefaultBotDefenderTokenV3(config, cookieString, cipherUtils, hashUtils) {
+        var _this = _super.call(this, config, cookieString) || this;
+        _this.logger = config.logger;
+        _this.maxIterations = config.riskCookieMaxIterations;
+        _this.minIterations = config.riskCookieMinIterations;
+        _this.blockingScore = config.blockingScore;
+        _this.cookieString = cookieString;
+        _this.cipherUtils = cipherUtils;
+        _this.hashUtils = hashUtils;
+        return _this;
+    }
+    DefaultBotDefenderTokenV3.prototype.decrypt = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data, salt, iterations, encryptedCookie, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        data = this.cookieString.split(constants_1.COOKIE_SPLIT_DELIMITER);
+                        if (data.length !== constants_1.COOKIE_V3_PARTS_COUNT) {
+                            return [2 /*return*/, null];
+                        }
+                        this.hash = data[constants_1.COOKIE_V3_HMAC_INDEX];
+                        salt = data[constants_1.COOKIE_V3_SALT_INDEX];
+                        iterations = parseInt
+                            ? parseInt(data[constants_1.COOKIE_V3_ITERATIONS_INDEX])
+                            : Number(data[constants_1.COOKIE_V3_ITERATIONS_INDEX]);
+                        encryptedCookie = data[constants_1.COOKIE_V3_PAYLOAD_INDEX];
+                        if (!iterations || iterations > this.maxIterations || iterations < this.minIterations) {
+                            return [2 /*return*/, null];
+                        }
+                        if (!salt || typeof salt !== 'string' || salt.length > constants_1.COOKIE_V3_MAXIMUM_SALT_LENGTH) {
+                            return [2 /*return*/, null];
+                        }
+                        if (!encryptedCookie || typeof encryptedCookie !== 'string') {
+                            return [2 /*return*/, null];
+                        }
+                        return [4 /*yield*/, this.decryptPayload(encryptedCookie, salt, iterations)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                    case 2:
+                        e_1 = _a.sent();
+                        this.logger.debug("cookie v3 decryption failed: ".concat(e_1));
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/, null];
+                }
+            });
+        });
+    };
+    DefaultBotDefenderTokenV3.prototype.decryptPayload = function (encryptedCookie, salt, iterations) {
+        return __awaiter(this, void 0, void 0, function () {
+            var decryptedCookie, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.cipherUtils.pbkdf2Decrypt(this.cookieSecret, encryptedCookie, iterations, salt)];
+                    case 1:
+                        decryptedCookie = _a.sent();
+                        if (!decryptedCookie) {
+                            return [2 /*return*/, null];
+                        }
+                        return [2 /*return*/, JSON.parse(decryptedCookie)];
+                    case 2:
+                        e_2 = _a.sent();
+                        this.logger.debug("error decrypting cookie v3: ".concat(e_2));
+                        return [2 /*return*/, null];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultBotDefenderTokenV3.prototype.validate = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var signedFields, payload, hash;
+            return __generator(this, function (_a) {
+                try {
+                    signedFields = this.getSignedWithFields(context);
+                    payload = "".concat(this.cookieString).concat(signedFields.join(''));
+                    hash = this.hashUtils.createHmac(utils_1.Algorithm.SHA256, payload, this.cookieSecret);
+                    return [2 /*return*/, hash === this.hmac];
+                }
+                catch (e) {
+                    this.logger.debug("error validating cookie v3: ".concat(e));
+                    return [2 /*return*/, false];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    DefaultBotDefenderTokenV3.prototype.getSignedWithFields = function (context) {
+        var _this = this;
+        var _a;
+        if (context.isMobile) {
+            return [];
+        }
+        else if ((_a = this.payload) === null || _a === void 0 ? void 0 : _a.x) {
+            return this.payload.x.split('').map(function (char) { return _this.getSignedWithField(char, context); });
+        }
+        else {
+            return [context.requestData.userAgent];
+        }
+    };
+    DefaultBotDefenderTokenV3.prototype.getSignedWithField = function (char, _a) {
+        var requestData = _a.requestData;
+        switch (char) {
+            case TokenSignField_1.TokenSignField.SOCKET_IP:
+                return requestData.ip;
+            case TokenSignField_1.TokenSignField.USER_AGENT:
+                return requestData.userAgent;
+            default:
+                return '';
+        }
+    };
+    DefaultBotDefenderTokenV3.prototype.isExpired = function () {
+        var _a;
+        return Date.now() > ((_a = this.payload) === null || _a === void 0 ? void 0 : _a.t);
+    };
+    DefaultBotDefenderTokenV3.prototype.isHighScore = function () {
+        var _a;
+        return ((_a = this.payload) === null || _a === void 0 ? void 0 : _a.s) >= this.blockingScore;
+    };
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "timestamp", {
+        get: function () {
+            var _a;
+            return (_a = this.payload) === null || _a === void 0 ? void 0 : _a.t;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "uuid", {
+        get: function () {
+            var _a;
+            return (_a = this.payload) === null || _a === void 0 ? void 0 : _a.u;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "vid", {
+        get: function () {
+            var _a;
+            return (_a = this.payload) === null || _a === void 0 ? void 0 : _a.v;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "score", {
+        get: function () {
+            var _a;
+            return (_a = this.payload) === null || _a === void 0 ? void 0 : _a.s;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "action", {
+        get: function () {
+            var _a;
+            return (_a = this.payload) === null || _a === void 0 ? void 0 : _a.a;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DefaultBotDefenderTokenV3.prototype, "hmac", {
+        get: function () {
+            return this.hash;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return DefaultBotDefenderTokenV3;
+}(BotDefenderTokenBase_1.BotDefenderTokenBase));
+exports.DefaultBotDefenderTokenV3 = DefaultBotDefenderTokenV3;

package/lib/risk_token/token/v3/TokenSignField.d.ts

@@ -0,0 +1,4 @@
+export declare enum TokenSignField {
+    SOCKET_IP = "s",
+    USER_AGENT = "u"
+}

package/lib/risk_token/token/v3/TokenSignField.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenSignField = void 0;
+var TokenSignField;
+(function (TokenSignField) {
+    TokenSignField["SOCKET_IP"] = "s";
+    TokenSignField["USER_AGENT"] = "u";
+})(TokenSignField = exports.TokenSignField || (exports.TokenSignField = {}));

package/lib/risk_token/utils.d.ts

@@ -0,0 +1,2 @@
+import { TokenVersion } from './TokenVersion';
+export declare const convertMobileTokenVersionToCookieName: (tokenVersion: TokenVersion) => string;

package/lib/risk_token/utils.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertMobileTokenVersionToCookieName = void 0;
+var constants_1 = require("./constants");
+var TokenVersion_1 = require("./TokenVersion");
+var convertMobileTokenVersionToCookieName = function (tokenVersion) {
+    switch (tokenVersion) {
+        case TokenVersion_1.TokenVersion.V2:
+            return constants_1.COOKIE_V2_NAME;
+        case TokenVersion_1.TokenVersion.V3:
+            return constants_1.COOKIE_V3_NAME;
+        default:
+            return '';
+    }
+};
+exports.convertMobileTokenVersionToCookieName = convertMobileTokenVersionToCookieName;

package/lib/telemetry/DefaultTelemetry.d.ts

@@ -0,0 +1,19 @@
+import { IConfiguration } from '../config';
+import { IContext } from '../context';
+import { IHttpClient } from '../http';
+import { IBase64Utils, IHashUtils } from '../utils';
+import { ITelemetry } from './ITelemetry';
+export declare class DefaultTelemetry implements ITelemetry {
+    private readonly config;
+    private readonly httpClient;
+    private readonly base64Utils;
+    private readonly hashUtils;
+    constructor(config: IConfiguration, httpClient: IHttpClient, base64Utils: IBase64Utils, hashUtils: IHashUtils);
+    isValidTelemetryRequest(context: IContext): Promise<boolean>;
+    sendTelemetry(context: IContext): Promise<void>;
+    private getTelemetryHeader;
+    private isTelemetryHeaderValid;
+    private sendTelemetryActivity;
+    private createTelemetryRequest;
+    private createTelemetryActivity;
+}

package/lib/telemetry/DefaultTelemetry.js

@@ -0,0 +1,176 @@
+"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 (_) 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.DefaultTelemetry = void 0;
+var http_1 = require("../http");
+var activities_1 = require("../activities");
+var utils_1 = require("../utils");
+var constants_1 = require("./constants");
+var DefaultTelemetry = /** @class */ (function () {
+    function DefaultTelemetry(config, httpClient, base64Utils, hashUtils) {
+        this.config = config;
+        this.httpClient = httpClient;
+        this.base64Utils = base64Utils;
+        this.hashUtils = hashUtils;
+    }
+    DefaultTelemetry.prototype.isValidTelemetryRequest = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var telemetryHeader, _a, e_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 3, , 4]);
+                        telemetryHeader = this.getTelemetryHeader(context);
+                        _a = !!telemetryHeader;
+                        if (!_a) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.isTelemetryHeaderValid(telemetryHeader)];
+                    case 1:
+                        _a = (_b.sent());
+                        _b.label = 2;
+                    case 2: return [2 /*return*/, _a];
+                    case 3:
+                        e_1 = _b.sent();
+                        this.config.logger.debug("error validating telemetry - ".concat(e_1));
+                        return [2 /*return*/, false];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultTelemetry.prototype.sendTelemetry = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.sendTelemetryActivity(context)];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_2 = _a.sent();
+                        this.config.logger.debug("error sending telemetry - ".concat(e_2));
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultTelemetry.prototype.getTelemetryHeader = function (context) {
+        var _a;
+        return ((_a = context.requestData.headers.get(constants_1.TELEMETRY_HEADER_NAME)) === null || _a === void 0 ? void 0 : _a[0]) || '';
+    };
+    DefaultTelemetry.prototype.isTelemetryHeaderValid = function (headerValue) {
+        return __awaiter(this, void 0, void 0, function () {
+            var decodedValue, splitValue, timestamp, givenHmac, calculatedHmac, curUnixTime, timestampNumber;
+            return __generator(this, function (_a) {
+                this.config.logger.debug('received command to send enforcer telemetry');
+                decodedValue = this.base64Utils.base64Decode(headerValue);
+                splitValue = decodedValue.split(constants_1.TELEMETRY_HEADER_DELIMITER);
+                if (splitValue.length !== constants_1.TELEMETRY_HEADER_PART_COUNT) {
+                    this.config.logger.debug("malformed ".concat(constants_1.TELEMETRY_HEADER_NAME, " header: ").concat(decodedValue));
+                    return [2 /*return*/, false];
+                }
+                timestamp = splitValue[constants_1.TELEMETRY_HEADER_TIMESTAMP_INDEX];
+                givenHmac = splitValue[constants_1.TELEMETRY_HEADER_HMAC_INDEX];
+                calculatedHmac = this.hashUtils.createHmac(utils_1.Algorithm.SHA256, timestamp, this.config.cookieSecret);
+                if (givenHmac !== calculatedHmac) {
+                    this.config.logger.debug("".concat(constants_1.TELEMETRY_HEADER_NAME, " hmac validation failed. original hmac: ").concat(givenHmac, ", timestamp: ").concat(timestamp, "."));
+                    return [2 /*return*/, false];
+                }
+                curUnixTime = +new Date();
+                timestampNumber = parseInt ? parseInt(timestamp) : Number(timestamp);
+                if (isNaN(timestampNumber) || timestampNumber < curUnixTime) {
+                    this.config.logger.debug("".concat(constants_1.TELEMETRY_HEADER_NAME, " timestamp expired: ").concat(timestamp, " < ").concat(curUnixTime));
+                    return [2 /*return*/, false];
+                }
+                return [2 /*return*/, true];
+            });
+        });
+    };
+    DefaultTelemetry.prototype.sendTelemetryActivity = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var telemetryRequest;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        telemetryRequest = this.createTelemetryRequest(context);
+                        this.config.logger.debug("sending telemetry to ".concat(telemetryRequest.url));
+                        return [4 /*yield*/, this.httpClient.send(telemetryRequest)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultTelemetry.prototype.createTelemetryRequest = function (context) {
+        var _a;
+        var url = "".concat(this.config.backendScoreApiUrl).concat(constants_1.TELEMETRY_ENDPOINT);
+        var method = http_1.HttpMethod.POST;
+        var 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);
+        var activity = this.createTelemetryActivity(context);
+        return new http_1.DefaultHttpRequest(url, { method: method, headers: headers, body: JSON.stringify(activity) });
+    };
+    DefaultTelemetry.prototype.createTelemetryActivity = function (context) {
+        var SENSITIVE_CONFIG_FIELDS = ['px_auth_token', 'px_cookie_secret'];
+        var config = this.config.toParams();
+        config = (0, utils_1.removeSensitiveFields)(config, SENSITIVE_CONFIG_FIELDS);
+        var activity = {
+            type: activities_1.ActivityType.ENFORCER_TELEMETRY,
+            timestamp: Date.now(),
+            px_app_id: this.config.appId,
+            details: {
+                update_reason: constants_1.TELEMETRY_UPDATE_REASON,
+                module_version: this.config.moduleVersion,
+                enforcer_configs: config,
+            },
+        };
+        (0, utils_1.transferExistingProperties)(context.serverData, activity.details, {
+            osName: 'os_name',
+            nodeName: 'node_name',
+        });
+        return activity;
+    };
+    return DefaultTelemetry;
+}());
+exports.DefaultTelemetry = DefaultTelemetry;

package/lib/telemetry/ITelemetry.d.ts

@@ -0,0 +1,13 @@
+import { IContext } from '../context';
+export interface ITelemetry {
+    /**
+     * @param context - The request context.
+     * @returns Promise<boolean> - A Promise resolving to a boolean that indicates whether the request is a valid telemetry request.
+     */
+    isValidTelemetryRequest(context: IContext): Promise<boolean>;
+    /**
+     * @param context - The request context.
+     * @returns void
+     */
+    sendTelemetry(context: IContext): Promise<void>;
+}

package/lib/telemetry/ITelemetry.js

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

package/lib/telemetry/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const TELEMETRY_HEADER_DELIMITER = ":";
+export declare const TELEMETRY_HEADER_TIMESTAMP_INDEX = 0;
+export declare const TELEMETRY_HEADER_HMAC_INDEX = 1;
+export declare const TELEMETRY_HEADER_PART_COUNT = 2;
+export declare const TELEMETRY_HEADER_NAME = "x-px-enforcer-telemetry";
+export declare const TELEMETRY_ENDPOINT = "/api/v2/risk/telemetry";
+export declare const TELEMETRY_UPDATE_REASON = "command";

package/lib/telemetry/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TELEMETRY_UPDATE_REASON = exports.TELEMETRY_ENDPOINT = exports.TELEMETRY_HEADER_NAME = exports.TELEMETRY_HEADER_PART_COUNT = exports.TELEMETRY_HEADER_HMAC_INDEX = exports.TELEMETRY_HEADER_TIMESTAMP_INDEX = exports.TELEMETRY_HEADER_DELIMITER = void 0;
+exports.TELEMETRY_HEADER_DELIMITER = ':';
+exports.TELEMETRY_HEADER_TIMESTAMP_INDEX = 0;
+exports.TELEMETRY_HEADER_HMAC_INDEX = 1;
+exports.TELEMETRY_HEADER_PART_COUNT = 2;
+exports.TELEMETRY_HEADER_NAME = 'x-px-enforcer-telemetry';
+exports.TELEMETRY_ENDPOINT = '/api/v2/risk/telemetry';
+exports.TELEMETRY_UPDATE_REASON = 'command';

package/lib/telemetry/index.d.ts

@@ -0,0 +1,4 @@
+export { ITelemetry } from './ITelemetry';
+export { DefaultTelemetry } from './DefaultTelemetry';
+export { TelemetryActivity } from './model/TelemetryActivity';
+export * from './constants';

package/lib/telemetry/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 });
+exports.DefaultTelemetry = void 0;
+var DefaultTelemetry_1 = require("./DefaultTelemetry");
+Object.defineProperty(exports, "DefaultTelemetry", { enumerable: true, get: function () { return DefaultTelemetry_1.DefaultTelemetry; } });
+__exportStar(require("./constants"), exports);

package/lib/telemetry/model/TelemetryActivity.d.ts

@@ -0,0 +1,15 @@
+import { ActivityType } from '../../activities';
+import { ConfigurationParams } from '../../config';
+export declare type TelemetryActivityDetails = {
+    enforcer_configs: ConfigurationParams;
+    module_version: string;
+    update_reason: 'command';
+    node_name?: string;
+    os_name?: string;
+};
+export declare type TelemetryActivity = {
+    type: ActivityType.ENFORCER_TELEMETRY;
+    timestamp: number;
+    px_app_id: string;
+    details: TelemetryActivityDetails;
+};

package/lib/telemetry/model/TelemetryActivity.js

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

package/lib/utils/Algorithm.d.ts

@@ -0,0 +1,4 @@
+export declare enum Algorithm {
+    SHA256 = "sha256",
+    AES_CBC = "aes_cbc"
+}

package/lib/utils/Algorithm.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Algorithm = void 0;
+var Algorithm;
+(function (Algorithm) {
+    Algorithm["SHA256"] = "sha256";
+    Algorithm["AES_CBC"] = "aes_cbc";
+})(Algorithm = exports.Algorithm || (exports.Algorithm = {}));

package/lib/utils/EnforcerException.d.ts

@@ -0,0 +1,3 @@
+export declare class EnforcerException extends Error {
+    constructor(message: string);
+}

package/lib/utils/EnforcerException.js

@@ -0,0 +1,26 @@
+"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 __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnforcerException = void 0;
+var EnforcerException = /** @class */ (function (_super) {
+    __extends(EnforcerException, _super);
+    function EnforcerException(message) {
+        return _super.call(this, "enforcer exception - ".concat(message)) || this;
+    }
+    return EnforcerException;
+}(Error));
+exports.EnforcerException = EnforcerException;

package/lib/utils/IScoreRetriever.d.ts

@@ -0,0 +1,14 @@
+import { IContext } from '../context/IContext';
+export interface IScoreRetriever {
+    /**
+     * @param context - The request context.
+     * @returns boolean - Whether or not the score retriever should attempt to retrieve the risk score.
+     */
+    shouldRetrieveScore(context: IContext): boolean;
+    /**
+     * @param context - The request context.
+     * @returns Promise<boolean> - A Promise resolving to whether or not the score was retrieved successfully. If so,
+     * the function should set the score property of the context to the retrieved value.
+     */
+    retrieveScore(context: IContext): Promise<boolean>;
+}

package/lib/utils/IScoreRetriever.js

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

package/lib/utils/ModuleMode.d.ts

@@ -0,0 +1,4 @@
+export declare enum ModuleMode {
+    MONITOR = "monitor",
+    ACTIVE_BLOCKING = "active_blocking"
+}

package/lib/utils/ModuleMode.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleMode = void 0;
+var ModuleMode;
+(function (ModuleMode) {
+    ModuleMode["MONITOR"] = "monitor";
+    ModuleMode["ACTIVE_BLOCKING"] = "active_blocking";
+})(ModuleMode = exports.ModuleMode || (exports.ModuleMode = {}));

package/lib/utils/PassReason.d.ts

@@ -0,0 +1,6 @@
+export declare enum PassReason {
+    COOKIE = "cookie",
+    S2S = "s2s",
+    S2S_ERROR = "s2s_error",
+    S2S_TIMEOUT = "s2s_timeout"
+}

package/lib/utils/PassReason.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PassReason = void 0;
+var PassReason;
+(function (PassReason) {
+    PassReason["COOKIE"] = "cookie";
+    PassReason["S2S"] = "s2s";
+    PassReason["S2S_ERROR"] = "s2s_error";
+    PassReason["S2S_TIMEOUT"] = "s2s_timeout";
+})(PassReason = exports.PassReason || (exports.PassReason = {}));