[Security] Mask SHOPIFY_API_SECRET in CLI output#7909
Conversation
This PR hardens the `env show` and `env pull` commands by masking the `SHOPIFY_API_SECRET` in the console output. - Adds `MaskContentToken` to `cli-kit` for consistent redaction. - Masks the secret in `app env show` when outputting in text format. - Masks the secret in `app env pull` when displaying the updated `.env` file content and the diff to the user. - Ensures masking applies to all lines in the diff (added, removed, and context) to prevent leakage. - Maintains cleartext secrets in JSON output for automation and in the actual `.env` file for application functionality.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
This PR hardens the `env show` and `env pull` commands by masking the `SHOPIFY_API_SECRET` in the console output. - Adds `MaskContentToken` to `cli-kit` for consistent redaction. - Masks the secret in `app env show` when outputting in text format. - Masks the secret in `app env pull` when displaying the updated `.env` file content and the diff to the user. - Ensures masking applies to all lines in the diff (added, removed, and context) to prevent leakage. - Maintains cleartext secrets in JSON output for automation and in the actual `.env` file for application functionality. - Updates relevant unit tests including `info.test.ts` to reflect the masking behavior.
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/private/node/content-tokens.d.ts@@ -42,4 +42,7 @@ export declare class SubHeadingContentToken extends ContentToken<OutputMessage>
}
export declare class ItalicContentToken extends ContentToken<OutputMessage> {
output(): string;
+}
+export declare class MaskContentToken extends ContentToken<string> {
+ output(): string;
}
\ No newline at end of file
packages/cli-kit/dist/public/node/output.d.ts@@ -1,7 +1,7 @@
import { PackageManager } from './node-package-manager.js';
import { AbortSignal } from './abort.js';
import { TokenItem } from './ui.js';
-import { ColorContentToken, CommandContentToken, ContentToken, ErrorContentToken, HeadingContentToken, ItalicContentToken, JsonContentToken, LinesDiffContentToken, LinkContentToken, PathContentToken, RawContentToken, SubHeadingContentToken } from '../../private/node/content-tokens.js';
+import { ColorContentToken, CommandContentToken, ContentToken, ErrorContentToken, HeadingContentToken, ItalicContentToken, JsonContentToken, LinesDiffContentToken, LinkContentToken, MaskContentToken, PathContentToken, RawContentToken, SubHeadingContentToken } from '../../private/node/content-tokens.js';
import { Writable } from 'stream';
import type { Change } from 'diff';
export type Logger = Writable | ((message: string, logLevel?: LogLevel) => void);
@@ -29,6 +29,7 @@ export declare const outputToken: {
successIcon(): ColorContentToken;
failIcon(): ErrorContentToken;
linesDiff(value: Change[]): LinesDiffContentToken;
+ mask(value: string): MaskContentToken;
};
/**
* Given a command and its arguments, it formats it depending on the package manager.
|
WHY are these changes introduced?
To improve security by preventing sensitive API secrets from being displayed in cleartext in the console output.
WHAT is this pull request doing?
outputToken.maskutility incli-kitfor redacting sensitive values.SHOPIFY_API_SECRETinapp env show(text format).SHOPIFY_API_SECRETinapp env pullconsole output, including file content previews and diff context.How to test your changes?
shopify app env showshopify app env pullChecklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset addPR created automatically by Jules for task 18035476117825723708 started by @gonzaloriestra