@contrast/config 1.41.0 → 1.43.0

package/lib/index.d.ts

@@ -76,6 +76,19 @@ export interface Config {
     /** No default value but required when `api.enable` is `true` */
     user_name: string;
 
+    certificate: {
+      /** If set to `false`, the agent will ignore the certificate configuration in this section. Default: `true` */
+      enable: boolean;
+      /** Set the absolute or relative path to a CA for communication with the Contrast UI using a self-signed certificate. */
+      ca_file?: string;
+      /** Set the absolute or relative path to the Certificate PEM file for communication with the Contrast UI. */
+      cert_file?: string;
+      /** Set the absolute or relative path to the Key PEM file for communication with the Contrast UI. */
+      key_file?: string;
+      /** When set to `true`, the agent ignores certificate verification errors when the agent communicates with the Contrast UI. Default: `false` */
+      ignore_cert_errors: boolean;
+    };
+
     proxy: {
       /** Default: `false` */
       enable: boolean;

package/lib/options.js

@@ -185,6 +185,37 @@ const options = [
       }
     }
   },
+  // api.certificate
+  {
+    name: 'api.certificate.enable',
+    desc: 'If set to `false`, the agent will ignore the certificate configuration in this section.',
+    arg: '[false]',
+    default: true,
+  },
+  {
+    name: 'api.certificate.ca_file',
+    description: 'Set the absolute or relative path to a CA for communication with the Contrast UI using a self-signed certificate.',
+    arg: '<path>',
+    fn: toAbsolutePath,
+  },
+  {
+    name: 'api.certificate.cert_file',
+    description: 'Set the absolute or relative path to the Certificate PEM file for communication with the Contrast UI.',
+    arg: '<path>',
+    fn: toAbsolutePath,
+  },
+  {
+    name: 'api.certificate.key_file',
+    description: 'Set the absolute or relative path to the Key PEM file for communication with the Contrast UI.',
+    arg: '<path>',
+    fn: toAbsolutePath,
+  },
+  {
+    name: 'api.certificate.ignore_cert_errors',
+    description: 'When set to `true`, the agent ignores certificate verification errors when the agent communicates with the Contrast UI.',
+    arg: '[true]',
+    default: false,
+  },
   // api.proxy
   {
     name: 'api.proxy.enable',
@@ -645,6 +676,21 @@ Example - \`label1, label2, label3\``,
       enum: ['monitor', 'block', 'block_at_perimeter', 'off'],
       desc: 'Set the mode of the rule. Value options are `monitor`, `block`, `block_at_perimeter`, or `off`.',
     })),
+  // observability
+  {
+    name: 'observe.enable',
+    arg: '[true]',
+    default: false, // TODO: Default true when MVP is done
+    fn: castBoolean,
+    desc: 'Lightweight and low overhead observation mode for the agent.',
+  },
+  {
+    name: 'observe.periodic_export_interval_ms',
+    arg: '[true]',
+    default: 60000,
+    fn: parseNum,
+    desc: 'Interval the metrics are flushed to the upstream collector.',
+  },
   // application
   {
     name: 'application.name',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.41.0",
+  "version": "1.43.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)",
@@ -20,7 +20,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.30.0",
+    "@contrast/common": "1.32.0",
     "yaml": "^2.2.2"
   }
 }