@contrast/config 1.3.0 → 1.3.2

package/lib/index.d.ts

@@ -16,7 +16,7 @@
 import { RulesConfig } from '@contrast/common';
 import { Level } from 'pino';
 
-type SyslogLevel =
+export type SyslogLevel =
   | 'alert'
   | 'critical'
   | 'error'
@@ -81,34 +81,34 @@ export interface Config {
       path: string;
 
       syslog: {
-        enable: boolean;
+        enable?: boolean;
 
-        ip: string;
+        ip?: string;
 
-        /** Default: UDP `514` */
-        port: number;
+        port?: number;
 
         /**
          * The facility code of the messages the agent sends to Syslog.
-         * Values: 0-23, inclusive. Default: `19`
+         * Values: 0-23, inclusive.
          */
-        facility: number;
+        facility?: number;
 
-        /** Log level of 'Blocked' attacks. Default: `'notice'` */
-        severity_blocked: SyslogLevel;
+        /** Log level of 'Blocked' attacks. */
+        severity_blocked?: SyslogLevel;
 
-        /** Log level of 'Exploited' attacks. Default: `'alert'` */
-        severity_exploited: SyslogLevel;
+        /** Log level of 'Exploited' attacks. */
+        severity_exploited?: SyslogLevel;
 
-        /** Log level of 'Probed' attacks. Default: `'warning'` */
-        severity_probed: SyslogLevel;
+        /** Log level of 'Probed' attacks. */
+        severity_probed?: SyslogLevel;
 
-        /** Log level of 'Blocked at Perimeter' attacks. Default: `'notice'` */
-        severity_blocked_perimeter: SyslogLevel;
+        /** Log level of 'Blocked at Perimeter' attacks. */
+        severity_blocked_perimeter?: SyslogLevel;
 
-        /** Log level of suspcious but not blocked attacks. Default: `'warning'` */
-        severity_suspicious: SyslogLevel;
+        /** Log level of suspcious but not blocked attacks. */
+        severity_suspicious?: SyslogLevel;
       };
+
     };
 
     node: {

package/lib/options.js

@@ -173,7 +173,7 @@ const api = [
     name: 'api.proxy.url',
     arg: '<url>',
     desc: 'url of proxy for communicating agent data',
-  },
+  }
 ];
 
 const agent = [
@@ -194,7 +194,6 @@ const agent = [
     arg: '<level>',
     fn: lowercase,
     enum: ['error', 'warn', 'info', 'debug', 'trace'],
-    default: 'error',
     desc: 'logging level (error, warn, info, debug, trace). overrides FeatureSet:logLevel',
   },
   {
@@ -218,12 +217,11 @@ const agent = [
     // NOTE: syslog actually specifies 8 levels, starting with 0-emergency, but
     // we do not let the user set emergency for whatever reason
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'debug',
     desc: 'security logging level (alert, crit, err, warning, notice, info, debug)',
   },
   {
     name: 'agent.security_logger.path',
-    // default: 'security',
+    default: 'security.log',
     fn: toAbsolutePath,
     arg: '<path>',
     desc: 'where to log security events',
@@ -241,7 +239,6 @@ const agent = [
   {
     name: 'agent.security_logger.syslog.port',
     desc: 'Set the port of the Syslog server to which the agent should send messages',
-    default: 514,
     arg: '<port>',
     fn: parseNum,
   },
@@ -252,14 +249,12 @@ const agent = [
       0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
       21, 22, 23,
     ],
-    default: 19,
     arg: '<facility>',
   },
   {
     name: 'agent.security_logger.syslog.severity_blocked',
     desc: 'Set the log level of Blocked attacks. Value options are ALERT/CRITICAL/ERROR/WARNING/NOTICE/INFO/DEBUG',
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'notice',
     arg: '<level>',
     fn: lowercase,
   },
@@ -267,7 +262,6 @@ const agent = [
     name: 'agent.security_logger.syslog.severity_exploited',
     desc: 'Set the log level of Exploited attacks. Value options are ALERT/CRITICAL/ERROR/WARNING/NOTICE/INFO/DEBUG',
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'alert',
     arg: '<level>',
     fn: lowercase,
   },
@@ -275,7 +269,6 @@ const agent = [
     name: 'agent.security_logger.syslog.severity_probed',
     desc: 'Set the log level of Probed attacks. Value options are ALERT/CRITICAL/ERROR/WARNING/NOTICE/INFO/DEBUG',
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'warning',
     arg: '<level>',
     fn: lowercase,
   },
@@ -283,7 +276,6 @@ const agent = [
     name: 'agent.security_logger.syslog.severity_blocked_perimeter',
     desc: 'Set the log level of Blocked at Perimeter attacks. Value options are ALERT/CRITICAL/ERROR/WARNING/NOTICE/INFO/DEBUG',
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'notice',
     arg: '<level>',
     fn: lowercase,
   },
@@ -291,7 +283,6 @@ const agent = [
     name: 'agent.security_logger.syslog.severity_suspicious',
     desc: 'Set the log level of suspicious but not blocked attacks. Value options are ALERT/CRITICAL/ERROR/WARNING/NOTICE/INFO/DEBUG',
     enum: ['alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
-    default: 'warning',
     arg: '<level>',
     fn: lowercase,
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "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.1.3",
+    "@contrast/common": "1.1.4",
     "yaml": "^2.0.1"
   }
 }