Merge pull request #256 from PerimeterX/release/v3.5.0

chen-zimmer-px · web-flow · commit 52136680ddff · 2022-10-23T04:36:20.000-07:00
Release/v3.5.0 to master
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,28 @@
+name: ci
+on: pull_request
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install dependencies
+        run: npm install
+      - name: Run linter
+        run: npm run lint
+  unit-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ 10, 12, 14, 16, lts/* ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run unit tests
+        run: npm run test
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,16 @@ 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.5.0] - 2022-10-23
+
+### Added
+
+- Support for `px_custom_first_party_path` configuration
+
+### Changed
+
+- Updated dependencies
+
 ## [3.4.3] - 2022-06-30
 
 ### Fixed
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [PerimeterX](http://www.perimeterx.com) Shared base for NodeJS enforcers
 =============================================================
 
-> Latest stable version: [v3.4.3](https://www.npmjs.com/package/perimeterx-node-core)
+> Latest stable version: [v3.5.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.
 
diff --git a/lib/extract_field/credentials_intelligence/ICredentialsIntelligenceProtocol.js b/lib/extract_field/credentials_intelligence/ICredentialsIntelligenceProtocol.js
@@ -1,4 +1,5 @@
 class ICredentialsIntelligenceProtocol {
+    // eslint-disable-next-line no-unused-vars
     ProcessCredentials(username, password) {
         throw new Error('Unimplemented method!');
     }
diff --git a/lib/extract_field/credentials_intelligence/V2CredentialsIntelligenceProtocol.js b/lib/extract_field/credentials_intelligence/V2CredentialsIntelligenceProtocol.js
@@ -43,7 +43,6 @@ class V2CredentialsIntelligenceProtocol extends ICredentialsIntelligenceProtocol
     }
 }
 
-
 module.exports = {
     V2CredentialsIntelligenceProtocol
 };
diff --git a/lib/pxcdenforcer.js b/lib/pxcdenforcer.js
@@ -38,7 +38,7 @@ function handleCSP(response, cspData, vid) {
             }
         }
     } catch (e) {
-        // CSP couldnt be read, continue without it
+        // CSP couldn't be read, continue without it
         console.log(`Exception Caught in HandleCSP. error: ${e}`);
     }
 }
diff --git a/lib/pxclient.js b/lib/pxclient.js
@@ -11,7 +11,7 @@ const {
     CI_CREDENTIALS_COMPROMISED_FIELD,
     GQL_OPERATION_TYPE_FIELD,
     GQL_OPERATION_NAME_FIELD
-} = require('./utils/constants')
+} = require('./utils/constants');
 
 class PxClient {
     constructor() {
diff --git a/lib/pxconfig.js b/lib/pxconfig.js
@@ -71,6 +71,7 @@ class PxConfig {
             ['FILTER_BY_IP', 'px_filter_by_ip'],
             ['FILTER_BY_USERAGENT', 'px_filter_by_user_agent'],
             ['FILTER_BY_METHOD', 'px_filter_by_http_method'],
+            ['PX_CUSTOM_FIRST_PARTY_PATH', 'px_custom_first_party_path'],
             ['PXHD_SECURE', 'px_pxhd_secure_enabled'],
             ['BACKEND_URL', 'px_backend_url'],
             ['CUSTOM_COOKIE_HEADER', 'px_custom_cookie_header'],
@@ -315,6 +316,7 @@ function pxDefaultConfig() {
         PXHD_SECURE: false,
         BACKEND_URL: '',
         CUSTOM_COOKIE_HEADER: '',
+        PX_CUSTOM_FIRST_PARTY_PATH: '',
         ENABLE_LOGIN_CREDS_EXTRACTION: false,
         LOGIN_CREDS_EXTRACTION: [],
         CREDENTIALS_INTELLIGENCE_VERSION: CIVersion.V2,
@@ -374,6 +376,7 @@ const allowedConfigKeys = [
     'px_pxhd_secure_enabled',
     'px_backend_url',
     'px_custom_cookie_header',
+    'px_custom_first_party_path',
     'px_login_credentials_extraction_enabled',
     'px_login_credentials_extraction',
     'px_credentials_intelligence_version',
diff --git a/lib/pxcontext.js b/lib/pxcontext.js
@@ -105,6 +105,7 @@ class PxContext {
     }
 
     areCredentialsCompromised() {
+        // eslint-disable-next-line eqeqeq
         return (this.pxde && this.pxde['breached_account'] && this.pxdeVerified) != null;
     }
 }
diff --git a/lib/pxcookie.js b/lib/pxcookie.js
@@ -88,7 +88,7 @@ function evalCookie(ctx, config) {
         }
 
         if (config.ENABLE_LOGIN_CREDS_EXTRACTION && ctx.additionalFields && ctx.additionalFields.loginCredentials) {
-            config.logger.debug("Login credentials extracted successfully, sending Risk API");
+            config.logger.debug('Login credentials extracted successfully, sending Risk API');
             ctx.s2sCallReason = 'sensitive_route';
             return ScoreEvaluateAction.SENSITIVE_ROUTE;
         }
diff --git a/lib/pxenforcer.js b/lib/pxenforcer.js
@@ -532,12 +532,10 @@ class PxEnforcer {
         let hostUrl = ctx.collectorUrl;
 
         if (this._config.FIRST_PARTY_ENABLED && !ctx.isMobile()) {
-            const prefix = this._config.PX_APP_ID.substring(2);
-            jsClientSrc = `/${prefix}${this._config.FIRST_PARTY_VENDOR_PATH}`;
-            captchaSrc = `/${prefix}${this._config.FIRST_PARTY_CAPTCHA_PATH}/captcha.js?a=${ctx.blockAction}&u=${
-                ctx.uuid
-            }&v=${ctx.vid || ''}&m=${ctx.isMobile() ? '1' : '0'}`;
-            hostUrl = `/${prefix}${this._config.FIRST_PARTY_XHR_PATH}`;
+            const prefix = this._config.PX_CUSTOM_FIRST_PARTY_PATH || `/${this._config.PX_APP_ID.substring(2)}`;
+            jsClientSrc = `${prefix}${this._config.FIRST_PARTY_VENDOR_PATH}`;
+            captchaSrc = `${prefix}${this._config.FIRST_PARTY_CAPTCHA_PATH}${captchaParams}`;
+            hostUrl = `${prefix}${this._config.FIRST_PARTY_XHR_PATH}`;
         }
 
         return {
diff --git a/lib/pxproxy.js b/lib/pxproxy.js
@@ -124,7 +124,7 @@ function sendCDXHR(req, config, ip, reversePrefix, cb) {
         if (req.method === 'POST') {
             request.post(callData, config, (error, response) => {
                 if (error || !response || response.statusCode >= 400) {
-                    res = { status: 200, header: { key: 'Content-Type', value: 'application/json' }, body: {} };
+                    res = { status: 200, header: { key: 'Content-Type', value: 'application/json' }, body: {}};
                 } else {
                     res = { status: response.statusCode, headers: response.headers, body: response.body || '' };
                 }
diff --git a/lib/pxutil.js b/lib/pxutil.js
@@ -7,7 +7,7 @@ const crypto = require('crypto');
 const { ModuleMode } = require('./enums/ModuleMode');
 const { GraphqlOperationType } = require('./enums/GraphqlOperationType');
 const { GraphqlData } = require('./models/GraphqlData');
-const {EMAIL_ADDRESS_REGEX, HASH_ALGORITHM} = require('./utils/constants')
+const { EMAIL_ADDRESS_REGEX, HASH_ALGORITHM } = require('./utils/constants');
 
 /**
  * PerimeterX (http://www.perimeterx.com) NodeJS-Express SDK
@@ -279,7 +279,7 @@ function getGraphqlData(req) {
     }
 
     const operationType = extractGraphqlOperationType(query);
-    const operationName = extractGraphqlOperationName(query, body['operationName'])
+    const operationName = extractGraphqlOperationName(query, body['operationName']);
     return new GraphqlData(operationType, operationName);
 }
 
diff --git a/lib/utils/constants.js b/lib/utils/constants.js
@@ -25,7 +25,7 @@ const CI_CREDENTIALS_COMPROMISED_FIELD = 'credentials_compromised';
 
 const GQL_OPERATION_TYPE_FIELD = 'graphql_operation_type';
 const GQL_OPERATION_NAME_FIELD = 'graphql_operation_name';
-const EMAIL_ADDRESS_REGEX = /^([a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)$/
+const EMAIL_ADDRESS_REGEX = /^([a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)$/;
 const HASH_ALGORITHM = { SHA256: 'sha256' };
 
 module.exports = {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`class ICredentialsIntelligenceProtocol {`
	`2`	`+ // eslint-disable-next-line no-unused-vars`
`2`	`3`	`ProcessCredentials(username, password) {`
`3`	`4`	`throw new Error('Unimplemented method!');`
`4`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ class V2CredentialsIntelligenceProtocol extends ICredentialsIntelligenceProtocol`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-`
`47`	`46`	`module.exports = {`
`48`	`47`	`V2CredentialsIntelligenceProtocol`
`49`	`48`	`};`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ function handleCSP(response, cspData, vid) {`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`} catch (e) {`
`41`		`- // CSP couldnt be read, continue without it`
	`41`	`+ // CSP couldn't be read, continue without it`
`42`	`42`	console.log(`Exception Caught in HandleCSP. error: ${e}`);
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,6 +105,7 @@ class PxContext {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`areCredentialsCompromised() {`
	`108`	`+ // eslint-disable-next-line eqeqeq`
`108`	`109`	`return (this.pxde && this.pxde['breached_account'] && this.pxdeVerified) != null;`
`109`	`110`	`}`
`110`	`111`	`}`