Skip to content

[Security] Redact secrets in app env pull output #7693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gonzaloriestra wants to merge 1 commit into from
Closed

[Security] Redact secrets in app env pull output #7693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions packages/app/src/cli/services/app/env/pull.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('env pull', () => {
"Created ${filePath}:

SHOPIFY_API_KEY=api-key
SHOPIFY_API_SECRET=api-secret
SHOPIFY_API_SECRET=****
SCOPES=my-scope
"
`)
Expand All @@ -66,15 +66,14 @@ describe('env pull', () => {
"Updated ${filePath} to be:

SHOPIFY_API_KEY=api-key
SHOPIFY_API_SECRET=api-secret
SHOPIFY_API_SECRET=****
SCOPES=my-scope

Here's what changed:

- SHOPIFY_API_KEY=ABC
- SHOPIFY_API_SECRET=XYZ
+ SHOPIFY_API_KEY=api-key
+ SHOPIFY_API_SECRET=api-secret
SHOPIFY_API_SECRET=****
SCOPES=my-scope
"
`)
Expand Down
14 changes: 11 additions & 3 deletions packages/app/src/cli/services/app/env/pull.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ export async function pullEnv({app, remoteApp, organization, envFile}: PullEnvOp
SCOPES: getAppScopes(app.configuration),
}

const redactedValues = {
...updatedValues,
SHOPIFY_API_SECRET: '****',
}

if (await fileExists(envFile)) {
const envFileContent = await readFile(envFile)
const updatedEnvFileContent = patchEnvFile(envFileContent, updatedValues)
Expand All @@ -33,10 +38,12 @@ export async function pullEnv({app, remoteApp, organization, envFile}: PullEnvOp
} else {
await writeFile(envFile, updatedEnvFileContent)

const diff = diffLines(envFileContent ?? '', updatedEnvFileContent)
const redactedOldEnvFileContent = patchEnvFile(envFileContent, {SHOPIFY_API_SECRET: '****'})
const redactedEnvFileContent = patchEnvFile(envFileContent, redactedValues)
const diff = diffLines(redactedOldEnvFileContent, redactedEnvFileContent)
return outputContent`Updated ${outputToken.path(envFile)} to be:

${updatedEnvFileContent}
${redactedEnvFileContent}

Here's what changed:

Expand All @@ -45,12 +52,13 @@ ${outputToken.linesDiff(diff)}
}
} else {
const newEnvFileContent = patchEnvFile(null, updatedValues)
const redactedEnvFileContent = patchEnvFile(null, redactedValues)

await writeFile(envFile, newEnvFileContent)

return outputContent`Created ${outputToken.path(envFile)}:

${newEnvFileContent}
${redactedEnvFileContent}
`
}
}
Loading