@contrast/common 1.0.0 → 1.0.3

package/lib/constants.js

@@ -1,4 +1,18 @@
 "use strict";
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rule = exports.Event = void 0;
 var Event;

package/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,0BAAiB,CAAA;IACjB,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAED,IAAY,IAkBX;AAlBD,WAAY,IAAI;IACd,mCAA2B,CAAA;IAC3B,uCAA+B,CAAA;IAC/B,2EAAmE,CAAA;IACnE,2FAAmF,CAAA;IACnF,yFAAiF,CAAA;IACjF,mCAA2B,CAAA;IAC3B,6CAAqC,CAAA;IACrC,2CAAmC,CAAA;IACnC,uDAA+C,CAAA;IAC/C,yCAAiC,CAAA;IACjC,uCAA+B,CAAA;IAC/B,uCAA+B,CAAA;IAC/B,yCAAiC,CAAA;IACjC,uCAA+B,CAAA;IAC/B,+DAAuD,CAAA;IACvD,iDAAyC,CAAA;IACzC,mBAAW,CAAA;AACb,CAAC,EAlBW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAkBf"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAEH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,0BAAiB,CAAA;IACjB,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAED,IAAY,IAkBX;AAlBD,WAAY,IAAI;IACd,mCAA2B,CAAA;IAC3B,uCAA+B,CAAA;IAC/B,2EAAmE,CAAA;IACnE,2FAAmF,CAAA;IACnF,yFAAiF,CAAA;IACjF,mCAA2B,CAAA;IAC3B,6CAAqC,CAAA;IACrC,2CAAmC,CAAA;IACnC,uDAA+C,CAAA;IAC/C,yCAAiC,CAAA;IACjC,uCAA+B,CAAA;IAC/B,uCAA+B,CAAA;IAC/B,yCAAiC,CAAA;IACjC,uCAA+B,CAAA;IAC/B,+DAAuD,CAAA;IACvD,iDAAyC,CAAA;IACzC,mBAAW,CAAA;AACb,CAAC,EAlBW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAkBf"}

package/lib/index.js

@@ -1,4 +1,18 @@
 "use strict";
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,0CAAwB;AAExB;;;GAGG;AACH,wDAAwD;AACxD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAC;AAC9D,CAAC;AAFD,4BAEC;AAED,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;;;;;;;;;;;;;;;AAEH,8CAA4B;AAC5B,0CAAwB;AAExB;;;GAGG;AACH,wDAAwD;AACxD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAC;AAC9D,CAAC;AAFD,4BAEC;AAED,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAFD,oCAEC"}

package/lib/types/index.d.ts

@@ -7,6 +7,7 @@ export interface RuleConfig {
 export interface RulesConfig extends Record<Rule, RuleConfig> {
 }
 export interface Result {
+    blocked: boolean;
     ruleId: Rule;
     inputType: string;
     path: string[];
@@ -14,31 +15,39 @@ export interface Result {
     value: string;
     details?: any[];
 }
+export interface ReqData {
+    method: string;
+    headers: string[];
+    uriPath: string;
+    queries: string;
+    contentType?: string;
+    standardUrlParsing: boolean;
+    ip: string;
+    httpVersion: string;
+    headers2: {
+        [key: string]: Array<string>;
+    };
+}
+export interface Findings {
+    trackRequest: boolean;
+    securityException?: [mode: string, ruleId: string];
+    bodyType?: 'json' | 'urlencoded';
+    resultsMap: Record<Rule, Result[]>;
+}
 export interface RequestStore {
-    protect?: {
-        reqData: {
-            method: string;
-            headers: string[];
-            uriPath: string;
-            queries: string;
-            contentType?: string;
-            standardUrlParsing: boolean;
-        };
-        block: (mode: string, ruleId: string) => void;
-        rules: {
-            agentLibRules: RulesConfig;
-            agentLibRulesMask: number;
-            agentRules: RulesConfig;
-        };
-        exclusions: any[];
-        virtualPatches: any[];
-        findings: {
-            trackRequest: boolean;
-            securityException?: [mode: string, ruleId: string];
-            bodyType?: 'json' | 'urlencoded';
-            resultsMap: Record<Rule, Result[]>;
-        };
+    protect?: ProtectMessage;
+}
+export interface ProtectMessage {
+    reqData: ReqData;
+    block: (mode: string, ruleId: string) => void;
+    rules: {
+        agentLibRules: RulesConfig;
+        agentLibRulesMask: number;
+        agentRules: RulesConfig;
     };
+    exclusions: any[];
+    virtualPatches: any[];
+    findings: Findings;
 }
 export interface Messages extends EventEmitter {
     addListener(event: Event.PROTECT, listener: (msg: RequestStore) => void): this;

package/lib/types/index.js

@@ -1,3 +1,17 @@
 "use strict";
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contrast/common",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Shared constants and utilities for all Contrast Agent modules",
   "license": "UNLICENSED",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "engines": {
-    "npm": ">= 8.4.0",
+    "npm": ">=6.13.7 <7 || >= 8.3.1",
     "node": ">= 14.15.0"
   },
   "scripts": {

package/src/constants.ts

@@ -1,3 +1,18 @@
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
 export enum Event {
   ASSESS = 'assess',
   PROTECT = 'protect',

package/src/index.ts

@@ -1,3 +1,18 @@
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
 export * from './constants';
 export * from './types';
 

package/src/types/index.ts

@@ -1,3 +1,18 @@
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
 import { Event, Rule } from '../constants';
 import { EventEmitter } from 'events';
 
@@ -8,12 +23,32 @@ export interface RuleConfig {
 export interface RulesConfig extends Record<Rule, RuleConfig> {}
 
 export interface Result {
+  blocked: boolean;
   ruleId: Rule,
   inputType: string, // TODO
   path: string[],
   key: string,
   value: string,
-  details?: any[],
+  details?: any[], // TODO
+}
+
+export interface ReqData {
+  method: string;
+  headers: string[];
+  uriPath: string;
+  queries: string;
+  contentType?: string;
+  standardUrlParsing: boolean;
+  ip: string;
+  httpVersion: string,
+  headers2: { [key: string]: Array<string> };
+}
+
+export interface Findings {
+  trackRequest: boolean;
+  securityException?: [mode: string, ruleId: string];
+  bodyType?: 'json' | 'urlencoded';
+  resultsMap: Record<Rule, Result[]>
 }
 
 //
@@ -28,30 +63,20 @@ export interface Result {
 //
 export interface RequestStore {
   // TODO: from protect/lib/make-source-context
-  protect?: {
-    reqData: {
-      method: string;
-      headers: string[];
-      uriPath: string;
-      queries: string;
-      contentType?: string;
-      standardUrlParsing: boolean;
-    };
-    block: (mode: string, ruleId: string) => void;
-    rules: {
-      agentLibRules: RulesConfig;
-      agentLibRulesMask: number;
-      agentRules: RulesConfig;
-    };
-    exclusions: any[]; // TODO
-    virtualPatches: any[]; // TODO
-    findings: {
-      trackRequest: boolean;
-      securityException?: [mode: string, ruleId: string];
-      bodyType?: 'json' | 'urlencoded';
-      resultsMap: Record<Rule, Result[]>
-    };
+  protect?: ProtectMessage;
+}
+
+export interface ProtectMessage {
+  reqData: ReqData;
+  block: (mode: string, ruleId: string) => void;
+  rules: {
+    agentLibRules: RulesConfig;
+    agentLibRulesMask: number;
+    agentRules: RulesConfig;
   };
+  exclusions: any[]; // TODO
+  virtualPatches: any[]; // TODO
+  findings: Findings;
 }
 
 export interface Messages extends EventEmitter {