Merge pull request #176 from PerimeterX/dev

Dev

Author: ori-gold-px

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] - 2021-09-26
+
+### Changed
+
+-   Configuration changes to match [Enforcer Spec v1.0.0](https://github.com/PerimeterX/px-enforcer-spec)
+
 ## [2.13.1] - 2021-07-04
 
 ### Added

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 PerimeterX
+Copyright (c) 2021 PerimeterX
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,7 +6,7 @@
 [PerimeterX](http://www.perimeterx.com) Shared base for NodeJS enforcers
 =============================================================
 
-> Latest stable version: [v2.13.1](https://www.npmjs.com/package/perimeterx-node-core)
+> Latest stable version: [v3.0.0](https://www.npmjs.com/package/perimeterx-node-core)
 
 This is a shared base implementation for PerimeterX Express enforcer and future NodeJS enforcers. For a fully functioning implementation example, see the [Node-Express enforcer](https://github.com/PerimeterX/perimeterx-node-express/) implementation.
 
@@ -30,7 +30,7 @@ Table of Contents
 To integrate this module into an enforcer, users should initialize the enforcer.
 ```javascript
 function initPXModule(params, client) {
-    params.moduleVersion = '<your module version>';
+    params.px_module_version = '<your module version>';
     enforcer = new PxEnforcer(params, client);
     //if dynamic configurations is configured
     if (enforcer.config.conf.DYNAMIC_CONFIGURATIONS) {
@@ -63,21 +63,23 @@ function pxMiddleware(req, res, next) {
 
 Extend the `PxClient` class to send activities to PerimeterX.
 ```javascript
-const PxClient = require('perimeterx-node-core').PxClient;
+const { PxClient } = require('perimeterx-node-core');
+
 class MyClient extends PxClient {
     init(config) {
         setInterval(() => {
             this.submitActivities(config);
         }, 1000);
     }
 }
-module.exports = PxExpressClient;
+
+module.exports = { MyClient };
 ```
 
 Make sure to pass the client instance when initializing the enforcer.
 ```javascript
 function initPXModule(params) {
-    params.moduleVersion = '<your module version>';
+    params.px_module_version = '<your module version>';
     const pxClient = new MyClient();
     enforcer = new PxEnforcer(params, pxClient);
     //if dynamic configurations is configured

index.js

@@ -1,4 +1,4 @@
-/** Copyright © 2017 PerimeterX, Inc.
+/** Copyright © 2021 PerimeterX, Inc.
 
  ** Permission is hereby granted, free of charge, to any
  ** person obtaining a copy of this software and associated

lib/configloader.js

@@ -1,4 +1,6 @@
 const request = require('./request');
+const { ModuleMode } = require('./enums/ModuleMode');
+const { LoggerSeverity } = require('./enums/LoggerSeverity');
 
 class ConfigLoader {
 
@@ -37,13 +39,13 @@ class ConfigLoader {
                 this.config.COOKIE_SECRET_KEY = body.cookieKey;
                 this.config.PX_APP_ID = body.appId;
                 this.config.BLOCKING_SCORE = body.blockingScore;
-                this.config.DEBUG_MODE = body.debugMode;
+                this.config.LOGGER_SEVERITY = body.debugMode ? LoggerSeverity.DEBUG : LoggerSeverity.ERROR;
                 this.config.ENABLE_MODULE = body.moduleEnabled;
                 this.config.SENSITIVE_HEADERS = body.sensitiveHeaders;
                 this.config.IP_HEADERS = body.ipHeaders;
                 this.config.ACTIVITIES_TIMEOUT = body.connectTimeout;
                 this.config.API_TIMEOUT_MS = body.riskTimeout;
-                this.config.MODULE_MODE = body.moduleMode === 'blocking' ? this.config.MONITOR_MODE.BLOCK : this.config.MONITOR_MODE.MONITOR;
+                this.config.MODULE_MODE = body.moduleMode === 'blocking' ? ModuleMode.ACTIVE_BLOCKING : ModuleMode.MONITOR;
                 this.config.FIRST_PARTY_ENABLED = body.firstPartyEnabled;
                 this.config.FIRST_PARTY_XHR_ENABLED = body.firstPartyXhrEnabled;
                 this.pxClient.sendEnforcerTelemetry('remote_config', this.config);

lib/enums/CookieOrigin.js

@@ -0,0 +1,9 @@
+const CookieOrigin = {
+    NONE: undefined,
+    COOKIE: 'cookie',
+    HEADER: 'header'
+};
+
+module.exports = {
+    CookieOrigin
+};

lib/enums/LoggerSeverity.js

@@ -0,0 +1,9 @@
+const LoggerSeverity = {
+    NONE: 'none',
+    ERROR: 'error',
+    DEBUG: 'debug',
+};
+
+module.exports = {
+    LoggerSeverity
+};

lib/enums/ModuleMode.js

@@ -0,0 +1,8 @@
+const ModuleMode = {
+    ACTIVE_BLOCKING: 'active_blocking',
+    MONITOR: 'monitor',
+};
+
+module.exports = {
+    ModuleMode
+};

lib/pxapi.js

@@ -3,7 +3,7 @@ const pxUtil = require('./pxutil');
 const pxHttpc = require('./pxhttpc');
 
 const S2SErrorInfo = require('./models/S2SErrorInfo');
-
+const { ModuleMode } = require('./enums/ModuleMode');
 const PassReason = require('./enums/PassReason');
 const ScoreEvaluateAction = require('./enums/ScoreEvaluateAction');
 const S2SErrorReason = require('./enums/S2SErrorReason');
@@ -38,7 +38,7 @@ function buildRequestData(ctx, config) {
     const headers = pxUtil.formatHeaders(ctx.headers, config.SENSITIVE_HEADERS);
     const httpVersion = ctx.httpVersion;
     const riskMode =
-        (config.MODULE_MODE === config.MONITOR_MODE.MONITOR && !ctx.shouldBypassMonitor) || ctx.monitoredRoute
+        (config.MODULE_MODE === ModuleMode.MONITOR && !ctx.shouldBypassMonitor) || ctx.monitoredRoute
             ? 'monitor'
             : 'active_blocking';
 
@@ -130,6 +130,9 @@ function evalByServerCall(ctx, config, callback) {
             );
             ctx.passReason = PassReason.S2S_ERROR;
             ctx.s2sErrorInfo = err;
+            if (res && res.uuid) {
+                ctx.uuid = res.uuid;
+            }
             return callback(ScoreEvaluateAction.UNEXPECTED_RESULT);
         }
         ctx.pxhdServer = res.pxhd;