docs: add security warning for ZX_PREFIX and ZX_POSTFIX env variables#1450
Open
Shreyansh-Kushwaha wants to merge 1 commit intogoogle:mainfrom
Open
docs: add security warning for ZX_PREFIX and ZX_POSTFIX env variables#1450Shreyansh-Kushwaha wants to merge 1 commit intogoogle:mainfrom
Shreyansh-Kushwaha wants to merge 1 commit intogoogle:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #1435
What does this PR do?
This PR adds a security warning to the documentation regarding the use of
ZX_PREFIX,ZX_POSTFIX, andZX_SHELLenvironment variables.As highlighted in issue #1435, because these variables are injected globally into every command executed via the
$template tag without sanitization, they represent a potential silent command injection surface. While this behavior is highly useful for parameterization in CI/CD and containerized environments, it wasn't explicitly documented as a security boundary.Changes made:
> [!WARNING]callout indocs/cli.mdunder the Environment variables section.> [!WARNING]callout indocs/configuration.mdunder the$.prefixsection.These notes ensure developers are explicitly aware of the risks when using untrusted environment variables in shared or automated environments.