@contrast/config 1.28.2 → 1.29.0

package/lib/index.d.ts

@@ -17,10 +17,10 @@ import { ProtectRuleMode, Rule } from '@contrast/common';
 import { LevelWithSilent } from 'pino';
 export { ConfigSource } from './common.js';
 
-export interface EffectiveEntry {
+export interface EffectiveEntry<T> {
   canonical_name: string;
   name: string;
-  value: any;
+  value: T;
   source: ConfigSource;
 }
 
@@ -53,7 +53,7 @@ export interface ConfigOption<T> {
 
 export interface Config {
   _filepath: string;
-  _effectiveMap: Map<EffectiveEntry>;
+  _effectiveMap: Map<string, EffectiveEntry<any>>;
   _errors: Error[];
   _status: string,
 
@@ -213,6 +213,7 @@ export interface Config {
   inventory: {
     /** Default: `true` */
     analyze_libraries: boolean;
+    gather_metadata_via: 'AWS' | 'Azure' | 'GCP' | undefined;
   };
 
   assess: {
@@ -292,6 +293,8 @@ export interface Config {
     environment?: string;
     tags?: string;
     version?: string;
+    /** Default: `true` */
+    discover_cloud_resource: boolean;
   };
   getEffectiveSource(cannonicalName: string): any;
   getEffectiveValue(cannonicalName: string): any;

package/lib/options.js

@@ -495,6 +495,12 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
     fn: castBoolean,
     desc: 'Set to `false` to disable library analysis.',
   },
+  {
+    name: 'inventory.gather_metadata_via',
+    arg: '<provider>',
+    enum: ['AWS', 'Azure', 'GCP'],
+    desc: 'Specifies the cloud provider from which the agent should gather metadata (such as resource identifiers). Options are `AWS`, `Azure`, or `GCP`'
+  },
   // assess
   {
     name: 'assess.enable',
@@ -613,7 +619,7 @@ Example - \`label1, label2, label3\``,
   },
   {
     name: 'application.metadata',
-    args: '<metadata>',
+    arg: '<metadata>',
     desc: 'comma-separated list of key=value pairs that are applied to each application reported by the agent.',
   },
   // server
@@ -649,6 +655,13 @@ Example - \`label1, label2, label3\``,
     arg: '<version>',
     desc: "override the reported server version (if different from 'version' field in the application's package.json)",
   },
+  {
+    name: 'server.discover_cloud_resource',
+    arg: '[false]',
+    default: true,
+    fn: castBoolean,
+    desc: 'Set to `false` to disable detection of cloud provider metadata such as resource identifiers.'
+  },
 ].map((opt) => Object.assign(opt, {
   env: `CONTRAST__${opt.name.toUpperCase().replaceAll('.', '__')
     .replaceAll('-', '_')}`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.28.2",
+  "version": "1.29.0",
   "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.21.2",
+    "@contrast/common": "1.22.0",
     "yaml": "^2.2.2"
   }
 }