Skip to content

docs: Document external-decompressor-use-manifest flag for backup/restore security #2076

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

Merged
timvaillancourt merged 1 commit into from
Feb 24, 2026
Merged

docs: Document external-decompressor-use-manifest flag for backup/restore security #2076

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
9 changes: 9 additions & 0 deletions content/en/docs/24.0/user-guides/operating-vitess/backup-and-restore/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,15 @@ All three programs can be made aware of Backup Engine and Backup Storage using t
<code>--external-decompressor "pigz -d -c"</code>
</td>
</tr>
<tr>
<td><code>external-decompressor-use-manifest</code></td>
Copy link
Copy Markdown
Contributor Author

@promptless promptless Bot Feb 24, 2026

Choose a reason for hiding this comment

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

Citation: PR #19460 adds the --external-decompressor-use-manifest flag to address a security vulnerability. See go/vt/mysqlctl/compression.go for the flag registration and resolveExternalDecompressor() function implementation that handles the precedence logic. The flag help text in the PR explicitly warns about the security risk of trusting manifest decompressor commands.
View source

<td>
Allows the decompressor command stored in the backup manifest to be used at restore time.
This is disabled by default for security reasons: an attacker with write access to backup storage
could modify the manifest to execute arbitrary commands on the tablet as the Vitess user.
Only enable this flag if you trust your backup storage and understand the risks involved.
</td>
</tr>
<tr>
<td><code>file-backup-storage-root</code></td>
<td>For the <code>file</code> plugin, this identifies the root directory
Expand Down