Merge pull request #2424 from zowe/secure-value-censor-refactor

Secure value censorship refactor
zowe · Feb 19, 2025 · e80dcd2 · e80dcd2
2 parents 1626aa7 + 94364f5
commit e80dcd2
Show file tree

Hide file tree

Showing 32 changed files with 1,676 additions and 241 deletions.
diff --git a/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/TargetProfile.handler.unit.test.ts b/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/TargetProfile.handler.unit.test.ts
@@ -50,9 +50,10 @@ describe("TargetProfileHandler", () => {
                 api: {
                     layers: { get: jest.fn() },
                     profiles: { get: getProfileMock },
-                    secure: { secureFields: jest.fn().mockReturnValue([]) }
+                    secure: { findSecure: jest.fn().mockReturnValue([]), securePropsForProfile: jest.fn().mockReturnValue([]) }
                 },
-                exists: true
+                exists: true,
+                mProperties: { profiles: {} }
             },
             envVariablePrefix: "ZOWE",
             loadedConfig: {}

diff --git a/packages/imperative/CHANGELOG.md b/packages/imperative/CHANGELOG.md
@@ -2,7 +2,19 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Fixed inconsistent behavior with the `ZOWE_SHOW_SECURE_ARGS` environment variable continuing to mask secure properties when it should not. [#2430](https://github.com/zowe/zowe-cli/issues/2430)
+- Enhancement: Added the `Censor` class, consolidating all sensitive data hiding logic into one class. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Enhancement: Added the `showSecureArgs` environment variable to the `EnvironmentalVariableSettings` class to allow extenders to determine if they should mask secure values. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Deprecated: The `LoggerUtils` class has been deprecated. Use the `Censor` class instead. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Deprecated: The `CliUtils.CENSOR_RESPONSE` property has been deprecated. Use the `Censor.CENSOR_RESPONSE` property instead. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Deprecated: The `CliUtils.CENSORED_OPTIONS` property has been deprecated. Use the `Censor.CENSORED_OPTIONS` property instead. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Deprecated: The `CliUtils.censorCLIArgs` function has been deprecated. Use the `Censor.censorCLIArgs` function instead. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+- Deprecated: The `CliUtils.censorYargsArguments` function has been deprecated. Use the `Censor.censorYargsArguments` function instead. [#2424](https://github.com/zowe/zowe-cli/pull/2424)
+
 ## `8.13.0`
+
 - Format fix: `DeferredPromise` and `DeferredPromise.unit.test` comment format changed to match standard.
 
 ## `8.11.0`

diff --git a/...ntegration__/api/env/__snapshots__/EnvironmentalVariableSettings.integration.test.ts.snap b/...ntegration__/api/env/__snapshots__/EnvironmentalVariableSettings.integration.test.ts.snap
@@ -26,5 +26,9 @@ Object {
     "key": "IMP_INTEGRATION_TESTING_PROMPT_PHRASE",
     "value": undefined,
   },
+  "showSecureArgs": Object {
+    "key": "IMP_INTEGRATION_TESTING_SHOW_SECURE_ARGS",
+    "value": "FALSE",
+  },
 }
 `;
diff --git a/...tests__/__integration__/cli/test/cli.imperative-test-cli.test.masking.integration.test.ts b/...tests__/__integration__/cli/test/cli.imperative-test-cli.test.masking.integration.test.ts
@@ -36,7 +36,7 @@ describe("imperative-test-cli test masking command", () => {
         TestLogger.info(`Working directory: ${TEST_ENVIRONMENT.workingDir}`);
         runCliScript(__dirname + "/../config/init/__scripts__/init_config.sh", TEST_ENVIRONMENT.workingDir, ["--no-prompt"]);
         runCliScript(__dirname + "/../config/set/__scripts__/set_secure.sh", TEST_ENVIRONMENT.workingDir,
-            ["profiles.secured.profiles.secure_profile.properties.info", "secret"]);
+            ["profiles.secured.properties.info", "secret"]);
     });
 
     const _logPrefix = (_log: string, level: string) => {

diff --git a/...mperative/__tests__/__integration__/imperative/src/cli/test/masking/Masking.definition.ts b/...mperative/__tests__/__integration__/imperative/src/cli/test/masking/Masking.definition.ts
@@ -17,8 +17,11 @@ export const MaskingDefinition: ICommandDefinition = {
     summary: "Test imperative masking",
     type: "command",
     handler: __dirname + "/Masking.handler",
+    profile: {
+        optional: ["secured"]
+    },
     positionals: [{
-        name: "test-argument",
+        name: "info",
         description: "test argument",
         type: "string",
         required: true,

diff --git a/...s/imperative/__tests__/__integration__/imperative/src/cli/test/masking/Masking.handler.ts b/...s/imperative/__tests__/__integration__/imperative/src/cli/test/masking/Masking.handler.ts
@@ -19,25 +19,25 @@ import { IHandlerParameters, ICommandHandler, Imperative } from "../../../../../
 export default class MaskingHandler implements ICommandHandler {
     public async process(params: IHandlerParameters) {
         // Issue various log messages to the console logger
-        params.response.console.log("Test-Masking: console logger: log message: " + params.arguments.testArgument);
-        params.response.console.error("Test-Masking: console logger: error message: " + params.arguments.testArgument);
-        params.response.console.errorHeader("Test-Masking: console logger: errorHeader message: " + params.arguments.testArgument);
-        params.response.console.prompt("Test-Masking: console logger: prompt message: " + params.arguments.testArgument);
+        params.response.console.log("Test-Masking: console logger: log message: " + params.arguments.info);
+        params.response.console.error("Test-Masking: console logger: error message: " + params.arguments.info);
+        params.response.console.errorHeader("Test-Masking: console logger: errorHeader message: " + params.arguments.info);
+        params.response.console.prompt("Test-Masking: console logger: prompt message: " + params.arguments.info);
 
         // Issue various log messages to the imperative logger
-        Imperative.api.imperativeLogger.trace("Test-Masking: imperative logger: trace message: " + params.arguments.testArgument);
-        Imperative.api.imperativeLogger.debug("Test-Masking: imperative logger: debug message: " + params.arguments.testArgument);
-        Imperative.api.imperativeLogger.info("Test-Masking: imperative logger: info message: " + params.arguments.testArgument);
-        Imperative.api.imperativeLogger.warn("Test-Masking: imperative logger: warn message: " + params.arguments.testArgument);
-        Imperative.api.imperativeLogger.error("Test-Masking: imperative logger: error message: " + params.arguments.testArgument);
-        Imperative.api.imperativeLogger.fatal("Test-Masking: imperative logger: fatal message: " + params.arguments.testArgument);
+        Imperative.api.imperativeLogger.trace("Test-Masking: imperative logger: trace message: " + params.arguments.info);
+        Imperative.api.imperativeLogger.debug("Test-Masking: imperative logger: debug message: " + params.arguments.info);
+        Imperative.api.imperativeLogger.info("Test-Masking: imperative logger: info message: " + params.arguments.info);
+        Imperative.api.imperativeLogger.warn("Test-Masking: imperative logger: warn message: " + params.arguments.info);
+        Imperative.api.imperativeLogger.error("Test-Masking: imperative logger: error message: " + params.arguments.info);
+        Imperative.api.imperativeLogger.fatal("Test-Masking: imperative logger: fatal message: " + params.arguments.info);
 
         // Issue various log messages to the app logger
-        Imperative.api.appLogger.trace("Test-Masking: app logger: trace message: " + params.arguments.testArgument);
-        Imperative.api.appLogger.debug("Test-Masking: app logger: debug message: " + params.arguments.testArgument);
-        Imperative.api.appLogger.info("Test-Masking: app logger: info message: " + params.arguments.testArgument);
-        Imperative.api.appLogger.warn("Test-Masking: app logger: warn message: " + params.arguments.testArgument);
-        Imperative.api.appLogger.error("Test-Masking: app logger: error message: " + params.arguments.testArgument);
-        Imperative.api.appLogger.fatal("Test-Masking: app logger: fatal message: " + params.arguments.testArgument);
+        Imperative.api.appLogger.trace("Test-Masking: app logger: trace message: " + params.arguments.info);
+        Imperative.api.appLogger.debug("Test-Masking: app logger: debug message: " + params.arguments.info);
+        Imperative.api.appLogger.info("Test-Masking: app logger: info message: " + params.arguments.info);
+        Imperative.api.appLogger.warn("Test-Masking: app logger: warn message: " + params.arguments.info);
+        Imperative.api.appLogger.error("Test-Masking: app logger: error message: " + params.arguments.info);
+        Imperative.api.appLogger.fatal("Test-Masking: app logger: fatal message: " + params.arguments.info);
     }
 }
diff --git a/packages/imperative/__tests__/__integration__/imperative/src/imperative.ts b/packages/imperative/__tests__/__integration__/imperative/src/imperative.ts
@@ -106,12 +106,12 @@ export const config: IImperativeConfig = {
                     info: {
                         type: "string",
                         includeInTemplate: true,
-                        optionDefinition: {...infoOption, required: true}
+                        optionDefinition: infoOption
                     },
                     secret: {
                         type: "string",
                         secure: true,
-                        optionDefinition: {...secretOption, required: true}
+                        optionDefinition: secretOption
                     }
                 }
             }