Skip to content

fix(deploy-tooling): prevent cleartext credentials in deploy configuration#4539

Open
longieirl wants to merge 7 commits intomainfrom
fix/issue-1156-prevent-cleartext-credentials
Open

fix(deploy-tooling): prevent cleartext credentials in deploy configuration#4539
longieirl wants to merge 7 commits intomainfrom
fix/issue-1156-prevent-cleartext-credentials

Conversation

@longieirl
Copy link
Copy Markdown
Contributor

Summary

  • Add validateCredentials() guard in src/base/config.ts — throws if username or password is present but does not start with env:, ensuring credentials are always resolved from environment variables
  • Called from validateConfig() before replaceEnvVariables runs, covering both the CLI and UI5 task entry points
  • Parameter typed as NonNullable<AbapDeployConfig['credentials']> to eliminate redundant null guard inside the function

Closes #1156

Test plan

  • pnpm build passes
  • pnpm --filter @sap-ux/deploy-tooling lint passes (0 errors)
  • pnpm --filter @sap-ux/deploy-tooling test passes (126/126)
  • 6 new tests: plaintext username throws, plaintext password throws, both plaintext throws, both env: passes, absent credentials passes, only env-prefixed username passes
  • Changeset created: deploy-tooling-prevent-cleartext-credentials.md (patch)

@longieirl longieirl self-assigned this Apr 9, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 9, 2026

🦋 Changeset detected

Latest commit: 923a93d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sap-ux/deploy-tooling Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@longieirl longieirl marked this pull request as ready for review April 9, 2026 12:22
@longieirl longieirl requested a review from a team as a code owner April 9, 2026 12:22
@longieirl longieirl requested a review from lfindlaysap April 9, 2026 12:24
Comment thread packages/deploy-tooling/src/base/config.ts Outdated
Co-authored-by: Louise Findlay <[email protected]>
@longieirl longieirl requested a review from lfindlaysap April 10, 2026 09:41
lfindlaysap
lfindlaysap previously approved these changes Apr 10, 2026
mikicvi-SAP
mikicvi-SAP previously approved these changes Apr 14, 2026
Copy link
Copy Markdown
Contributor

@mikicvi-SAP mikicvi-SAP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @longieirl

  • Changes look good, plenty of tests
  • Changeset ✅
  • Did not test manually

#3384

- Add Credentials section to README explaining env: variable requirement
- Update --username/--password CLI option descriptions in deploy and undeploy tables
- Add cliCmdWithBasicAuth test case to CLI integration tests
@longieirl longieirl dismissed stale reviews from mikicvi-SAP and lfindlaysap via a600e9b April 16, 2026 12:49
Copy link
Copy Markdown
Contributor

@mikicvi-SAP mikicvi-SAP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approving.

@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TBI - ABAP deployment should prevent crendentials being entered in clear text

3 participants