@contrast/config 1.22.0 → 1.23.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright: 2023 Contrast Security, Inc
+Copyright: 2024 Contrast Security, Inc
 Contact: support@contrastsecurity.com
 License: Commercial
 

package/lib/common.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 

package/lib/config.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -34,6 +34,7 @@ const {
 
 const CONTRAST_CONFIG_PATH = 'CONTRAST_CONFIG_PATH';
 const CONTRAST_PREFIX = 'CONTRAST_';
+const HOME_CONFIG_DIR = path.resolve(os.homedir(), '.config', 'contrast');
 const OS_CONFIG_DIR = os.platform() === 'win32'
   ? path.resolve(process.env.ProgramData || '', 'contrast')
   : '/etc/contrast';
@@ -130,7 +131,8 @@ module.exports = class Config {
       process.cwd(),
       path.resolve(OS_CONFIG_DIR, 'node'),
       OS_CONFIG_DIR,
-      path.resolve(os.homedir(), '.config', 'contrast'),
+      path.resolve(HOME_CONFIG_DIR, 'node'),
+      HOME_CONFIG_DIR,
     ];
   }
 

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -192,7 +192,7 @@ export interface Config {
         reporting: {
           /** Default: `true` */
           enable: boolean;
-          /** Default: `1` */
+          /** Default: `100` */
           interval_ms: number;
         };
       };
@@ -202,6 +202,8 @@ export interface Config {
         /** 'Set the response duration (in milliseconds) after which we will warn that a request has been hanging.' Default: `5000` */
         warn_ms: number;
       };
+      /** Set the full path of the npm executable, used for library analysis. Default: `'npm'` */
+      npm_path: string;
     };
   };
 
@@ -262,11 +264,22 @@ export interface Config {
      */
     session_id: string | null;
 
+    /**
+     * How to report the application's group for auto-grouping
+     */
+    group: string | null;
+
+    /**
+     * Comma-separated list of key=value pairs that are applied to each application reported by the agent.
+     */
+    metadata: string | null;
+
     /**
      * Provide metadata used to create a new session within Contrast UI.
      * Default: `null`
      */
     session_metadata: string | null;
+
   };
 
   /** Reported server information overrides */

package/lib/index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 

package/lib/options.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -433,7 +433,8 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
   {
     name: 'agent.node.library_usage.reporting.interval_ms',
     arg: '<num>',
-    default: 1,
+    fn: parseNum,
+    default: 100,
     desc: 'Set the interval (in milliseconds) for collecting code events for library usage.',
   },
   {
@@ -450,6 +451,12 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
     fn: parseNum,
     desc: 'Set the response duration (in milliseconds) after which we will warn that a request has been hanging.'
   },
+  {
+    name: 'agent.node.npm_path',
+    arg: '<path>',
+    default: 'npm',
+    desc: 'Set the full path of the npm executable, used for library analysis',
+  },
   // inventory
   {
     name: 'inventory.analyze_libraries',
@@ -569,6 +576,16 @@ Example - \`label1, label2, label3\``,
     default: null,
     desc: 'Provide metadata which is used to create a new session ID in the Contrast UI. Vulnerabilities discovered by the agent are associated with this new session. This value should be formatted as `key=value` pairs (conforming to RFC 2253). Available key names for this configuration are branchName, buildNumber, commitHash, committer, gitTag, repository, testRun, and version. This option and `application.session_id` are mutually exclusive; if both are set the agent will be disabled.',
   },
+  {
+    name: 'application.group',
+    arg: '<tags>',
+    desc: "how to report the application's group for auto-grouping",
+  },
+  {
+    name: 'application.metadata',
+    args: '<metadata>',
+    desc: 'comma-separated list of key=value pairs that are applied to each application reported by the agent.',
+  },
   // server
   {
     name: 'server.name',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.22.0",
+  "version": "1.23.1",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.16.0",
+    "@contrast/common": "1.16.1",
     "yaml": "^2.2.2"
   }
 }