Skip to content

Validate version format and escape tar command arguments #131

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
swissspidy merged 1 commit into from
Aug 3, 2026
Merged

Validate version format and escape tar command arguments #131

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
55 changes: 55 additions & 0 deletions features/dist-archive.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,3 +562,58 @@ Feature: Generate a distribution archive of a project
"""
foo/foo.txt
"""

Scenario: Prevents GNU tar argument injection via Version header
Given an empty directory
And a foo/.distignore file:
"""
"""
And a foo/style.css file:
"""
/*
Theme Name: Test Theme
Version: 1.0 --checkpoint=1 --checkpoint-action=exec=foo/pwn.sh --owner=x
*/
"""
And a foo/pwn.sh file:
"""
echo "RCE" > rce_proof.txt
"""

When I run `wp dist-archive foo --format=targz`
Comment thread
swissspidy marked this conversation as resolved.
Then STDOUT should match /^Success: Created foo.tar.gz \(Size: \d+(?:\.\d*)? [a-zA-Z]{1,3}\)$/
And the foo.tar.gz file should exist
And the rce_proof.txt file should not exist

Scenario: Rejects invalid version headers in plugin PHP file and composer.json
Given an empty directory
And a bar/.distignore file:
"""
"""
And a bar/bar.php file:
"""
<?php
/*
Plugin Name: Test Plugin
Version: 2.0 --checkpoint=1 --owner=x
*/
"""

When I run `wp dist-archive bar --format=targz`
Then STDOUT should match /^Success: Created bar.tar.gz \(Size: \d+(?:\.\d*)? [a-zA-Z]{1,3}\)$/
And the bar.tar.gz file should exist

Given a baz/.distignore file:
"""
"""
And a baz/composer.json file:
"""
{
"name": "vendor/baz",
"version": "3.0 --checkpoint=1 --owner=x"
}
"""

When I run `wp dist-archive baz --format=targz`
Then STDOUT should match /^Success: Created baz.tar.gz \(Size: \d+(?:\.\d*)? [a-zA-Z]{1,3}\)$/
And the baz.tar.gz file should exist
29 changes: 21 additions & 8 deletions src/Dist_Archive_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ public function __invoke( $args, $assoc_args ) {
// If the files are being zipped in place, we need the exclusion rules.
// whereas if they were copied for any reasons above, the rules have already been applied.
if ( $source_path !== $source_dir_path || empty( $file_ignore_rules ) ) {
$cmd = "tar -zcvf {$archive_absolute_filepath} {$archive_output_dir_name}";
$cmd = Utils\esc_cmd( 'tar -zcvf %s %s', $archive_absolute_filepath, $archive_output_dir_name );
} else {
$tmp_dir = sys_get_temp_dir() . '/' . uniqid( $archive_file_name );
mkdir( $tmp_dir, 0777, true );
Expand All @@ -161,7 +161,7 @@ function ( $ignored_file ) use ( $source_path ) {
trim( implode( "\n", $excludes ) )
);
$anchored_flag = ( php_uname( 's' ) === 'Linux' ) ? '--anchored ' : '';
$cmd = "tar {$anchored_flag} --exclude-from={$exclude_list_filepath} -zcvf {$archive_absolute_filepath} {$archive_output_dir_name}";
$cmd = Utils\esc_cmd( "tar {$anchored_flag}--exclude-from=%s -zcvf %s %s", $exclude_list_filepath, $archive_absolute_filepath, $archive_output_dir_name );
}

$escape_whitelist = array( '^', '*' );
Expand Down Expand Up @@ -286,7 +286,10 @@ private function get_version( $source_dir_path ) {
$contents = str_replace( "\r", "\n", $contents );
$pattern = '/^' . preg_quote( 'Version', ',' ) . ':(.*)$/mi';
if ( preg_match( $pattern, $contents, $match ) && $match[1] ) {
$version = trim( (string) preg_replace( '/\s*(?:\*\/|\?>).*/', '', $match[1] ) );
$matched_version = trim( (string) preg_replace( '/\s*(?:\*\/|\?>).*/', '', $match[1] ) );
if ( preg_match( '/^[A-Za-z0-9][A-Za-z0-9._+-]*$/', $matched_version ) ) {
$version = $matched_version;
}
}
}

Expand All @@ -299,8 +302,11 @@ private function get_version( $source_dir_path ) {
$contents = str_replace( "\r", "\n", $contents );
$pattern = '/^[ \t\/*#@]*Version:(.*)$/mi';
if ( preg_match( $pattern, $contents, $match ) && $match[1] ) {
$version = trim( (string) preg_replace( '/\s*(?:\*\/|\?>).*/', '', $match[1] ) );
break;
$matched_version = trim( (string) preg_replace( '/\s*(?:\*\/|\?>).*/', '', $match[1] ) );
if ( preg_match( '/^[A-Za-z0-9][A-Za-z0-9._+-]*$/', $matched_version ) ) {
$version = $matched_version;
break;
}
}
}
}
Expand All @@ -311,21 +317,28 @@ private function get_version( $source_dir_path ) {
*/
$composer_obj = json_decode( (string) file_get_contents( $source_dir_path . '/composer.json' ) );
if ( $composer_obj && ! empty( $composer_obj->version ) ) {
$version = trim( $composer_obj->version );
$matched_version = trim( (string) $composer_obj->version );
if ( preg_match( '/^[A-Za-z0-9][A-Za-z0-9._+-]*$/', $matched_version ) ) {
$version = $matched_version;
}
Comment thread
swissspidy marked this conversation as resolved.
}
}

if ( ! empty( $version ) && false !== stripos( $version, '-alpha' ) && is_dir( $source_dir_path . '/.git' ) ) {
/**
* @var WP_CLI\ProcessRun $response
*/
$response = WP_CLI::launch( "cd {$source_dir_path}; git log --pretty=format:'%h' -n 1", false, true );
$response = WP_CLI::launch( Utils\esc_cmd( 'git -C %s log --pretty=format:%%h -n 1', $source_dir_path ), false, true );
$maybe_hash = trim( $response->stdout );
if ( $maybe_hash && 7 === strlen( $maybe_hash ) ) {
if ( $maybe_hash && 7 === strlen( $maybe_hash ) && preg_match( '/^[0-9a-f]{7}$/i', $maybe_hash ) ) {
$version .= '-' . $maybe_hash;
}
}

if ( ! empty( $version ) && ! preg_match( '/^[A-Za-z0-9][A-Za-z0-9._+-]*$/', $version ) ) {
return '';
}

return $version;
}

Expand Down
Loading