fix that log sensitive infomation in cmd of script by YLChen-007 · Pull Request #12024 · apache/cloudstack

YLChen-007 · 2025-11-08T02:34:07Z

Description

This PR fixes that log sensitive infomation in cmd of cloud.utils.script.Script. #12005

codecov · 2025-11-08T07:04:07Z

Codecov Report

❌ Patch coverage is 68.51852% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.25%. Comparing base (c0b5358) to head (0720c3f).
⚠️ Report is 7 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...s/src/main/java/com/cloud/utils/script/Script.java	66.66%	16 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #12024   +/-   ##
=========================================
  Coverage     16.24%   16.25%           
- Complexity    13396    13401    +5     
=========================================
  Files          5658     5658           
  Lines        499273   499291   +18     
  Branches      60600    60598    -2     
=========================================
+ Hits          81125    81143   +18     
  Misses       409104   409104           
  Partials       9044     9044

Flag	Coverage Δ
uitests	`4.03% <ø> (ø)`
unittests	`17.10% <68.51%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

DaanHoogland · 2025-11-10T08:28:56Z

@blueorangutan package

blueorangutan · 2025-11-10T08:30:05Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-11-10T09:40:25Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15701

DaanHoogland · 2025-11-10T12:30:26Z

@blueorangutan test

blueorangutan · 2025-11-10T12:32:06Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-11-11T02:43:56Z

[SF] Trillian test result (tid-14794)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 48295 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12024-t14794-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_create_pvlan_network	`Error`	0.09	test_pvlan.py

Copilot

Pull Request Overview

This PR addresses a security issue where sensitive information (such as passwords) was being logged in plain text within the Script class. The fix introduces a new addSensitive() method to mark specific command arguments as sensitive, ensuring they are masked with "******" in logs and command-line representations.

Key changes:

Added sensitiveArgIndices Set to track which arguments contain sensitive data
Implemented addSensitive() method for explicitly marking sensitive arguments
Updated all logging statements throughout the execute() methods to conditionally log sanitized messages when sensitive arguments are present

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 13 comments.

File	Description
Script.java	Core implementation adding sensitive argument tracking and comprehensive logging changes to mask sensitive data
ScriptTest.java	Test cases validating that sensitive arguments are properly masked in command-line output
LibvirtUpdateHostPasswordCommandWrapper.java	Updated to use `addSensitive()` for password arguments
CitrixUpdateHostPasswordCommandWrapper.java	Updated logging to mask password in debug output

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

utils/src/main/java/com/cloud/utils/script/Script.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…guments

…ithub.com/YLChen-007/cloudstack into my-fix-420-mask-script-cmd-sensitive-info

…when debugging

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

utils/src/main/java/com/cloud/utils/script/Script.java

github-actions · 2026-01-22T10:59:22Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

DaanHoogland · 2026-01-22T13:27:31Z

@blueorangutan package

blueorangutan · 2026-01-22T13:28:35Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-01-22T14:21:09Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 16497

utils/src/main/java/com/cloud/utils/script/Script.java

DaanHoogland · 2026-01-22T14:32:44Z

@blueorangutan package

blueorangutan · 2026-01-22T14:34:36Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-01-22T15:38:31Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 16501

DaanHoogland · 2026-01-23T07:39:46Z

@blueorangutan test

blueorangutan · 2026-01-23T07:40:34Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

utils/src/main/java/com/cloud/utils/script/Script.java

blueorangutan · 2026-01-23T08:23:05Z

[SF] Trillian Build Failed (tid-15250)

sureshanaparti

clgtm

borisstoyanov · 2026-01-27T10:39:13Z

@blueorangutan test

blueorangutan · 2026-01-27T10:40:04Z

@borisstoyanov a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

github-actions · 2026-01-27T12:11:01Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

blueorangutan · 2026-01-28T01:32:18Z

[SF] Trillian test result (tid-15303)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 50538 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12024-t15303-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

borisstoyanov

LGTM, based on test results and code review

* fix that log sensitive infomation in cmd of script * Remove unnecessary line break in Script.java * Update utils/src/main/java/com/cloud/utils/script/Script.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refactor logging in Script class to simplify handling of sensitive arguments * Improve command logging in Script class to include full command line when debugging * Remove unused _passwordCommand flag from Script class to simplify code * Update utils/src/main/java/com/cloud/utils/script/Script.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Remove unused import for KeyStoreUtils * Update utils/src/main/java/com/cloud/utils/script/Script.java --------- Co-authored-by: chenyoulong20g@ict.ac.cn <chenyoulong20g@ict.ac.cn> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: dahn <daan@onecht.net> Co-authored-by: dahn <daan.hoogland@gmail.com>

fix that log sensitive infomation in cmd of script

5bae182

boring-cyborg bot added component:kvm component:XenServer labels Nov 8, 2025

Remove unnecessary line break in Script.java

f9a05f5

DaanHoogland requested review from Copilot, shwstppr and sureshanaparti and removed request for Copilot and sureshanaparti November 11, 2025 08:54

Copilot started reviewing on behalf of DaanHoogland November 11, 2025 08:55 View session

Copilot finished reviewing on behalf of DaanHoogland November 11, 2025 08:57

Copilot AI reviewed Nov 11, 2025

View reviewed changes

YLChen-007 and others added 4 commits November 11, 2025 17:30

Update utils/src/main/java/com/cloud/utils/script/Script.java

7dc5b2b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Refactor logging in Script class to simplify handling of sensitive ar…

d15379b

…guments

Merge branch 'my-fix-420-mask-script-cmd-sensitive-info' of https://g…

30fed1a

…ithub.com/YLChen-007/cloudstack into my-fix-420-mask-script-cmd-sensitive-info

Improve command logging in Script class to include full command line …

64a6547

…when debugging

DaanHoogland requested a review from Copilot November 11, 2025 14:37

Copilot started reviewing on behalf of DaanHoogland November 11, 2025 14:38 View session

Copilot finished reviewing on behalf of DaanHoogland November 11, 2025 14:40

Copilot AI reviewed Nov 11, 2025

View reviewed changes

utils/src/main/java/com/cloud/utils/script/Script.java Show resolved Hide resolved

utils/src/main/java/com/cloud/utils/script/Script.java Outdated Show resolved Hide resolved

Remove unused _passwordCommand flag from Script class to simplify code

a617571

github-actions bot added the status:has-conflicts label Jan 22, 2026

Merge branch '4.20' into my-fix-420-mask-script-cmd-sensitive-info

1988400

github-actions bot removed the status:has-conflicts label Jan 22, 2026

DaanHoogland reviewed Jan 22, 2026

View reviewed changes

utils/src/main/java/com/cloud/utils/script/Script.java Show resolved Hide resolved

Update utils/src/main/java/com/cloud/utils/script/Script.java

c6ee04f

sureshanaparti reviewed Jan 23, 2026

View reviewed changes

utils/src/main/java/com/cloud/utils/script/Script.java Show resolved Hide resolved

sureshanaparti approved these changes Jan 27, 2026

View reviewed changes

github-actions bot added the status:has-conflicts label Jan 27, 2026

Merge branch '4.20' into my-fix-420-mask-script-cmd-sensitive-info

0720c3f

github-actions bot removed the status:has-conflicts label Jan 27, 2026

sureshanaparti self-assigned this Jan 28, 2026

borisstoyanov approved these changes Jan 28, 2026

View reviewed changes

borisstoyanov merged commit 35e6d7c into apache:4.20 Jan 28, 2026
26 checks passed

DaanHoogland mentioned this pull request Jan 28, 2026

Security: Inadequate Password Masking in Script Execution Framework Exposes Credentials Across Multiple Log Levels #12005

Closed

Conversation

YLChen-007 commented Nov 8, 2025

Description

Uh oh!

codecov bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DaanHoogland commented Nov 10, 2025

Uh oh!

blueorangutan commented Nov 10, 2025

Uh oh!

blueorangutan commented Nov 10, 2025

Uh oh!

DaanHoogland commented Nov 10, 2025

Uh oh!

blueorangutan commented Nov 10, 2025

Uh oh!

blueorangutan commented Nov 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 22, 2026

Uh oh!

DaanHoogland commented Jan 22, 2026

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

Uh oh!

DaanHoogland commented Jan 22, 2026

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

DaanHoogland commented Jan 23, 2026

Uh oh!

blueorangutan commented Jan 23, 2026

Uh oh!

Uh oh!

blueorangutan commented Jan 23, 2026

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

borisstoyanov commented Jan 27, 2026

Uh oh!

blueorangutan commented Jan 27, 2026

Uh oh!

github-actions bot commented Jan 27, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

borisstoyanov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

codecov bot commented Nov 8, 2025 •

edited

Loading