perimeterx-js-core 0.1.0

package/lib/logger/DefaultLogger.js

@@ -0,0 +1,31 @@
+"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.DefaultLogger = void 0;
+var LoggerBase_1 = require("./LoggerBase");
+var DefaultLogger = /** @class */ (function (_super) {
+    __extends(DefaultLogger, _super);
+    function DefaultLogger(loggerSeverity) {
+        return _super.call(this, loggerSeverity) || this;
+    }
+    DefaultLogger.prototype.log = function (message) {
+        /* eslint-disable no-console */
+        console.log(message);
+    };
+    return DefaultLogger;
+}(LoggerBase_1.LoggerBase));
+exports.DefaultLogger = DefaultLogger;

package/lib/logger/ILogger.d.ts

@@ -0,0 +1,24 @@
+import { LoggerSeverity } from './LoggerSeverity';
+export interface ILogger {
+    /**
+     * @returns LoggerSeverity - The current logger severity.
+     */
+    getLoggerSeverity(): LoggerSeverity;
+    /**
+     * @param loggerSeverity - The desired LoggerSeverity.
+     * @returns void
+     */
+    setLoggerSeverity(loggerSeverity: LoggerSeverity): void;
+    /**
+     * Logs the provided message if the logger's severity supports debug messages.
+     * @param message - The string message to log.
+     * @returns void
+     */
+    debug(message: string): void;
+    /**
+     * Logs the provided message if the logger's severity supports error messages.
+     * @param message - The string message to log.
+     * @returns void
+     */
+    error(message: string): void;
+}

package/lib/logger/ILogger.js

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

package/lib/logger/LoggerBase.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from './ILogger';
+import { LoggerSeverity } from './LoggerSeverity';
+export declare abstract class LoggerBase implements ILogger {
+    private loggerSeverity;
+    protected constructor(loggerSeverity?: LoggerSeverity);
+    protected abstract log(message: string): void;
+    debug(message: string): void;
+    error(message: string): void;
+    getLoggerSeverity(): LoggerSeverity;
+    setLoggerSeverity(loggerSeverity: LoggerSeverity): void;
+}

package/lib/logger/LoggerBase.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerBase = void 0;
+var LoggerSeverity_1 = require("./LoggerSeverity");
+var LoggerBase = /** @class */ (function () {
+    function LoggerBase(loggerSeverity) {
+        if (loggerSeverity === void 0) { loggerSeverity = LoggerSeverity_1.LoggerSeverity.ERROR; }
+        this.loggerSeverity = loggerSeverity;
+    }
+    LoggerBase.prototype.debug = function (message) {
+        if (this.loggerSeverity === LoggerSeverity_1.LoggerSeverity.DEBUG) {
+            this.log(message);
+        }
+    };
+    LoggerBase.prototype.error = function (message) {
+        if (this.loggerSeverity !== LoggerSeverity_1.LoggerSeverity.NONE) {
+            this.log(message);
+        }
+    };
+    LoggerBase.prototype.getLoggerSeverity = function () {
+        return this.loggerSeverity;
+    };
+    LoggerBase.prototype.setLoggerSeverity = function (loggerSeverity) {
+        this.loggerSeverity = loggerSeverity;
+    };
+    return LoggerBase;
+}());
+exports.LoggerBase = LoggerBase;

package/lib/logger/LoggerSeverity.d.ts

@@ -0,0 +1,5 @@
+export declare enum LoggerSeverity {
+    NONE = "none",
+    ERROR = "error",
+    DEBUG = "debug"
+}

package/lib/logger/LoggerSeverity.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerSeverity = void 0;
+var LoggerSeverity;
+(function (LoggerSeverity) {
+    LoggerSeverity["NONE"] = "none";
+    LoggerSeverity["ERROR"] = "error";
+    LoggerSeverity["DEBUG"] = "debug";
+})(LoggerSeverity = exports.LoggerSeverity || (exports.LoggerSeverity = {}));

package/lib/logger/index.d.ts

@@ -0,0 +1,4 @@
+export { ILogger } from './ILogger';
+export { LoggerBase } from './LoggerBase';
+export { DefaultLogger } from './DefaultLogger';
+export { LoggerSeverity } from './LoggerSeverity';

package/lib/logger/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerSeverity = exports.DefaultLogger = exports.LoggerBase = void 0;
+var LoggerBase_1 = require("./LoggerBase");
+Object.defineProperty(exports, "LoggerBase", { enumerable: true, get: function () { return LoggerBase_1.LoggerBase; } });
+var DefaultLogger_1 = require("./DefaultLogger");
+Object.defineProperty(exports, "DefaultLogger", { enumerable: true, get: function () { return DefaultLogger_1.DefaultLogger; } });
+var LoggerSeverity_1 = require("./LoggerSeverity");
+Object.defineProperty(exports, "LoggerSeverity", { enumerable: true, get: function () { return LoggerSeverity_1.LoggerSeverity; } });

package/lib/pxde/DefaultDataEnrichment.d.ts

@@ -0,0 +1,14 @@
+import { IDataEnrichment } from './IDataEnrichment';
+import { IConfiguration } from '../config';
+import { IContext } from '../context';
+import { IBase64Utils, IHashUtils } from '../utils';
+export declare class DefaultDataEnrichment implements IDataEnrichment {
+    private readonly config;
+    private readonly base64Utils;
+    private readonly hashUtils;
+    constructor(config: IConfiguration, base64Utils: IBase64Utils, hashUtils: IHashUtils);
+    handlePxde(context: IContext): Promise<void>;
+    private parsePxde;
+    private verifyPxdeHmac;
+    private parsePxdePayload;
+}

package/lib/pxde/DefaultDataEnrichment.js

@@ -0,0 +1,133 @@
+"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.DefaultDataEnrichment = void 0;
+var utils_1 = require("../utils");
+var constants_1 = require("./constants");
+var DefaultDataEnrichment = /** @class */ (function () {
+    function DefaultDataEnrichment(config, base64Utils, hashUtils) {
+        this.config = config;
+        this.base64Utils = base64Utils;
+        this.hashUtils = hashUtils;
+    }
+    DefaultDataEnrichment.prototype.handlePxde = function (context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var pxdeCookie, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 3, , 4]);
+                        pxdeCookie = context.requestData.cookies[utils_1.PXDE_COOKIE_NAME];
+                        if (!pxdeCookie) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.parsePxde(pxdeCookie, context)];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [3 /*break*/, 4];
+                    case 3:
+                        e_1 = _a.sent();
+                        this.config.logger.debug("unable to parse pxde cookie - ".concat(e_1));
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultDataEnrichment.prototype.parsePxde = function (pxdeCookie, context) {
+        return __awaiter(this, void 0, void 0, function () {
+            var pxdeParts, hmac, encodedPayload, _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        pxdeParts = pxdeCookie.split(constants_1.PXDE_COOKIE_DELIMITER);
+                        if (pxdeParts.length !== constants_1.PXDE_COOKIE_PARTS_COUNT) {
+                            this.config.logger.debug("malformed pxde cookie: ".concat(pxdeCookie));
+                            return [2 /*return*/];
+                        }
+                        hmac = pxdeParts[constants_1.PXDE_HMAC_INDEX];
+                        encodedPayload = pxdeParts[constants_1.PXDE_PAYLOAD_INDEX];
+                        if (!hmac || !encodedPayload) {
+                            this.config.logger.debug("malformed pxde cookie: hmac: ".concat(hmac, ", payload: ").concat(encodedPayload));
+                            return [2 /*return*/];
+                        }
+                        _a = context;
+                        return [4 /*yield*/, this.verifyPxdeHmac(hmac, encodedPayload)];
+                    case 1:
+                        _a.pxdeVerified = _c.sent();
+                        _b = context;
+                        return [4 /*yield*/, this.parsePxdePayload(encodedPayload)];
+                    case 2:
+                        _b.pxde = _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DefaultDataEnrichment.prototype.verifyPxdeHmac = function (givenHmac, encodedPayload) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                try {
+                    return [2 /*return*/, givenHmac === this.hashUtils.createHmac(utils_1.Algorithm.SHA256, encodedPayload, this.config.cookieSecret)];
+                }
+                catch (e) {
+                    this.config.logger.debug("failed verifying pxde hmac: ".concat(e));
+                    return [2 /*return*/, false];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    DefaultDataEnrichment.prototype.parsePxdePayload = function (encodedPayload) {
+        return __awaiter(this, void 0, void 0, function () {
+            var decodedPayload;
+            return __generator(this, function (_a) {
+                try {
+                    decodedPayload = this.base64Utils.base64Decode(encodedPayload);
+                    return [2 /*return*/, JSON.parse(decodedPayload)];
+                }
+                catch (e) {
+                    this.config.logger.debug("failed parsing pxde payload: ".concat(e));
+                    return [2 /*return*/, null];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    return DefaultDataEnrichment;
+}());
+exports.DefaultDataEnrichment = DefaultDataEnrichment;

package/lib/pxde/IDataEnrichment.d.ts

@@ -0,0 +1,9 @@
+import { IContext } from '../context/IContext';
+export interface IDataEnrichment {
+    /**
+     * If the PXDE cookie is present on the request, parses it and enriches the context with its contents.
+     * @param context - The request context.
+     * @returns Promise<void>
+     */
+    handlePxde(context: IContext): Promise<void>;
+}

package/lib/pxde/IDataEnrichment.js

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

package/lib/pxde/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const PXDE_HMAC_INDEX = 0;
+export declare const PXDE_PAYLOAD_INDEX = 1;
+export declare const PXDE_COOKIE_PARTS_COUNT = 2;
+export declare const PXDE_COOKIE_DELIMITER = ":";

package/lib/pxde/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PXDE_COOKIE_DELIMITER = exports.PXDE_COOKIE_PARTS_COUNT = exports.PXDE_PAYLOAD_INDEX = exports.PXDE_HMAC_INDEX = void 0;
+exports.PXDE_HMAC_INDEX = 0;
+exports.PXDE_PAYLOAD_INDEX = 1;
+exports.PXDE_COOKIE_PARTS_COUNT = 2;
+exports.PXDE_COOKIE_DELIMITER = ':';

package/lib/pxde/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export { PXDE } from './model/PXDE';
+export { IDataEnrichment } from './IDataEnrichment';
+export { DefaultDataEnrichment } from './DefaultDataEnrichment';

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

package/lib/pxde/model/PXDE.d.ts

@@ -0,0 +1,9 @@
+export declare type PXDE = {
+    timestamp: number;
+    f_kb: number;
+    f_type?: string;
+    f_id?: string;
+    f_origin?: string;
+    ipc_id: string[];
+    breached_account?: number;
+};

package/lib/pxde/model/PXDE.js

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

package/lib/pxhd/PXHDUtils.d.ts

@@ -0,0 +1,8 @@
+import { IHttpResponse } from '../http';
+import { IContext } from '../context';
+export declare namespace PXHDUtils {
+    const PXHD_SAMESITE_VALUE = "Lax";
+    const PXHD_PATH_VALUE = "/";
+    const addPxhdToResponse: (context: IContext, httpResponse: IHttpResponse) => IHttpResponse;
+    const getPxhdCookieValue: (pxhdValue: string) => string;
+}

package/lib/pxhd/PXHDUtils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PXHDUtils = void 0;
+var http_1 = require("../http");
+var utils_1 = require("../utils");
+var PXHDUtils;
+(function (PXHDUtils) {
+    PXHDUtils.PXHD_SAMESITE_VALUE = 'Lax';
+    PXHDUtils.PXHD_PATH_VALUE = '/';
+    PXHDUtils.addPxhdToResponse = function (context, httpResponse) {
+        if (context === null || context === void 0 ? void 0 : context.pxhd) {
+            var setPxhdCookie = PXHDUtils.getPxhdCookieValue(context.pxhd);
+            httpResponse.headers.append(http_1.SET_COOKIE_HEADER_NAME, setPxhdCookie);
+        }
+        return httpResponse;
+    };
+    PXHDUtils.getPxhdCookieValue = function (pxhdValue) {
+        return "".concat(utils_1.PXHD_COOKIE_NAME, "=").concat(pxhdValue, "; path=").concat(PXHDUtils.PXHD_PATH_VALUE, "; SameSite=").concat(PXHDUtils.PXHD_SAMESITE_VALUE);
+    };
+})(PXHDUtils = exports.PXHDUtils || (exports.PXHDUtils = {}));

package/lib/pxhd/index.d.ts

@@ -0,0 +1 @@
+export { PXHDUtils } from './PXHDUtils';

package/lib/pxhd/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PXHDUtils = void 0;
+var PXHDUtils_1 = require("./PXHDUtils");
+Object.defineProperty(exports, "PXHDUtils", { enumerable: true, get: function () { return PXHDUtils_1.PXHDUtils; } });

package/lib/risk_api/PostRiskApiClient.d.ts

@@ -0,0 +1,27 @@
+import { IContext } from '../context';
+import { IConfiguration } from '../config';
+import { IHttpClient } from '../http';
+import { IScoreRetriever } from '../utils';
+import { IRiskResponseHandler } from './risk_response_handler/IRiskResponseHandler';
+import { RiskResponseV2 } from './model/RiskResponseV2';
+import { RiskResponseV3 } from './model/RiskResponseV3';
+export declare class PostRiskApiClient<RiskResponseType extends RiskResponseV2 | RiskResponseV3> implements IScoreRetriever {
+    private readonly config;
+    private readonly httpClient;
+    private readonly s2sErrorHandler;
+    private readonly riskResponseHandler;
+    constructor(config: IConfiguration, httpClient: IHttpClient, riskResponseHandler: IRiskResponseHandler<RiskResponseType>);
+    shouldRetrieveScore(context: IContext): boolean;
+    private unsetScoreFields;
+    retrieveScore(context: IContext): Promise<boolean>;
+    private createRiskActivity;
+    private addOptionalRiskFields;
+    private addOptionalRiskFieldsToRoot;
+    private addOptionalRiskFieldsToAdditional;
+    private addCustomParamsToAdditional;
+    private addCookieRiskFieldsToAdditional;
+    private formatRiskHeadersField;
+    private sendRiskActivity;
+    private getRiskUrl;
+    private getRiskHeaders;
+}