RUN-4579: Document sshExportQuoting control - #1951
Open
ronaveva wants to merge 1 commit into
Open
Conversation
Add a Security-section entry for rundeck.execution.sshExportQuoting (opt-in,
default off, system-level): when enabled, values exported to remote nodes via a
node's ssh-variable-export-pattern are POSIX shell-quoted to prevent command
injection through option values. Documents the default, opt-in semantics, that
only values with whitespace/metacharacters are quoted, and that patterns must
reference {value} without surrounding quotes.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the new system control rundeck.execution.sshExportQuoting in the Rundeck config file reference, describing how it affects SSH variable export quoting to mitigate command injection risks when exporting values (e.g., job option values) to remote nodes.
Changes:
- Added a new SSH Exported Variable Quoting subsection under the Security area of the config reference.
- Documented opt-in semantics (
falseby default), scope (system-level), and guidance forssh-variable-export-patternusage.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| | Property | Default | Description | | ||
| |----------|---------|-------------| | ||
| | `rundeck.execution.sshExportQuoting` | `false` | When `true`, values interpolated into a node's `ssh-variable-export-pattern` (the `export {key}={value}` prefix prepended to the remote SSH command) are shell-quoted before dispatch. | |
elquimeras
approved these changes
Sep 2, 2026
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
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.
Summary
Documents the new system control
rundeck.execution.sshExportQuoting(product PR rundeck/rundeck#10534).When enabled, values exported to remote nodes via a node's
ssh-variable-export-patternare POSIX shell-quoted, preventing command injection through job option values (RUN-4579). Opt-in, default off, system-level.Changes
docs/administration/configuration/config-file-reference.md— new "SSH Exported Variable Quoting" subsection under Security: property table, opt-in/default-off semantics, that only whitespace/metacharacter-bearing values are quoted, and that patterns must reference{value}without surrounding quotes.Scope note: only the new property is documented. The pre-existing
ssh-variable-export-patternnode attribute is referenced for context but not newly documented here.🤖 Generated with Claude Code