@contrast/core 1.14.0 → 1.16.0

package/lib/effective-config/index.js

@@ -15,18 +15,19 @@
 
 'use strict';
 
+const REDACTED_KEYS = ['api.api_key', 'api.service_key'];
 const { Event, featureReaders, settingsReaders, mergeRemoteData } = require('@contrast/common');
 const { configOptions } = require('@contrast/config/lib/options');
 
 module.exports = function(core) {
   const { config, messages } = core;
   const effectiveConfig = createEffectiveConfig({ config, remoteData: {} });
-  let Status = '';
+  let status = '';
 
   if (core.config?.protect?.enable === true) {
     messages.on(Event.SERVER_SETTINGS_UPDATE, (msg) => {
-      if (!Status) {
-        Status = 'Success';
+      if (!status) {
+        status = 'Success';
       }
 
       mergeRemoteData(config, msg, featureReaders, setterFn, effectiveConfig);
@@ -34,8 +35,8 @@ module.exports = function(core) {
     });
   }
 
-  core.getEffectiveConfig = function () {
-    return formatEffectiveConfig(effectiveConfig);
+  core.getEffectiveConfig = function (tsFriendly = false) {
+    return formatEffectiveConfig(effectiveConfig, tsFriendly);
   };
 
   return;
@@ -44,34 +45,46 @@ module.exports = function(core) {
     let remoteValue = value;
     if (typeof value === 'string') remoteValue = remoteValue.toLowerCase();
     target.set(name, {
-      CanonicalName: name,
-      Name: name,
-      Value: remoteValue,
-      Source: 'ContrastUI',
+      canonical_name: name,
+      name,
+      value: remoteValue,
+      source: 'CONTRAST_UI',
     });
   }
 
-  function createEffectiveConfig({ config, remoteData }) {
-    const list = configOptions.map(({ name }) => ({
-      CanonicalName: name,
-      Name: name,
-      Value: config._flat[name],
-      Source: config._sources[name]
-    }));
-
-    return new Map(list.map((entry) => [entry.CanonicalName, entry]));
+  function createEffectiveConfig({ config }) {
+    return new Map(configOptions.map(({ name }) => [name, {
+      canonical_name: name,
+      name,
+      value: config._flat[name],
+      source: config._sources[name]
+    }]));
   }
 
-  function formatEffectiveConfig(configMap) {
-    const values = Array.from(configMap.values()).filter(s => s.Value != undefined);
+  function formatEffectiveConfig(configMap, tsFriendly = false) {
+    const effective_config = [], environment_variable = [], contrast_ui = [];
+    Array.from(configMap.values()).forEach((v) => {
+      if (v.value != undefined) {
+        if (tsFriendly) {
+          const value = REDACTED_KEYS.includes(v.name)
+            ? `contrast-redacted-${v.name}`
+            : v.value.toString();
+          effective_config.push({ ...v, value });
+        } else {
+          effective_config.push(v);
+        }
+      }
+      if (v.source === 'ENVIRONMENT_VARIABLE') environment_variable.push(v);
+      if (v.source === 'CONTRAST_UI') contrast_ui.push(v);
+    });
+
     const content = {
-      Status,
-      ReportCreate: new Date(),
-      Config: {
-        EffectiveConfig: values,
-        Environment: values.filter(v => v.Source === 'ENV'),
-        ContrastUI: values.filter(v => v.Source === 'ContrastUI'),
-        File: values.filter(v => v.Source === 'YAML'),
+      report_create: new Date(),
+      config: {
+        status,
+        effective_config,
+        environment_variable,
+        contrast_ui,
       }
     };
 

package/lib/index.d.ts

@@ -13,6 +13,7 @@
  * way not consistent with the End User License Agreement.
  */
 
+import { EventEmitter } from 'events';
 import { Agentify } from '@contrast/agentify';
 import { Config } from '@contrast/config';
 import { Logger } from '@contrast/logger';
@@ -34,12 +35,14 @@ export interface Core {
   appInfo: AppInfo;
   logger: Logger;
   messages: Messages;
+  events: { lifecycle: EventEmitter };
   patcher: Patcher;
   reporter: ReporterBus;
   protect: Protect;
   rewriter: Rewriter;
   scopes: Scopes;
   deadzones: Deadzones;
+  getEffectiveConfig: any;
 }
 
 declare function init(): Core;

package/lib/index.js

@@ -19,6 +19,10 @@ const EventEmitter = require('events');
 
 module.exports = function init(core = {}) {
   core.messages = new EventEmitter();
+  core.events = {
+    lifecycle: new EventEmitter(),
+    // messages: new EventEmitter(),
+  };
   require('./agent-info')(core);
   require('@contrast/config')(core);
   require('./logger-factory')(core);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/core",
-  "version": "1.14.0",
+  "version": "1.16.0",
   "description": "Preconfigured Contrast agent core services and models",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,16 +17,16 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/agentify": "1.5.1",
-    "@contrast/common": "1.7.0",
-    "@contrast/config": "1.9.0",
+    "@contrast/agentify": "1.7.0",
+    "@contrast/common": "1.9.0",
+    "@contrast/config": "1.11.0",
     "@contrast/deadzones": "1.1.0",
     "@contrast/dep-hooks": "1.1.0",
     "@contrast/fn-inspect": "^3.2.0",
     "@contrast/instrumentation": "1.1.1",
-    "@contrast/logger": "1.2.0",
-    "@contrast/patcher": "1.2.0",
-    "@contrast/reporter": "1.12.0",
+    "@contrast/logger": "1.3.0",
+    "@contrast/patcher": "1.4.0",
+    "@contrast/reporter": "1.14.0",
     "@contrast/rewriter": "1.4.0",
     "@contrast/scopes": "1.3.0"
   }