-
Notifications
You must be signed in to change notification settings - Fork 2k
refactor: escape --host in spark serve to prevent CLI command injection
#10156
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.
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
Open
sgInnora
wants to merge
2
commits into
codeigniter4:develop
Choose a base branch
from
sgInnora:security/escape-spark-serve-host
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+104
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * This file is part of CodeIgniter 4 framework. | ||
| * | ||
| * (c) CodeIgniter Foundation <admin@codeigniter.com> | ||
| * | ||
| * For the full copyright and license information, please view | ||
| * the LICENSE file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace CodeIgniter\Commands\Server; | ||
|
|
||
| use CodeIgniter\Test\CIUnitTestCase; | ||
| use CodeIgniter\Test\StreamFilterTrait; | ||
| use PHPUnit\Framework\Attributes\Group; | ||
|
|
||
| /** | ||
| * Override the global passthru() within this namespace so the unit test | ||
| * can capture the shell command that Serve::run() would otherwise execute. | ||
| * | ||
| * @internal | ||
| */ | ||
| function passthru(string $command, ?int &$result_code = null): void | ||
| { | ||
| ServeTest::$capturedCommand = $command; | ||
| $result_code = 0; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| #[Group('Others')] | ||
| final class ServeTest extends CIUnitTestCase | ||
| { | ||
| use StreamFilterTrait; | ||
|
|
||
| /** | ||
| * Captured shell command from the namespaced passthru() stub above. | ||
| */ | ||
| public static string $capturedCommand = ''; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| parent::setUp(); | ||
|
|
||
| self::$capturedCommand = ''; | ||
| $_SERVER['argv'] = ['spark', 'serve']; | ||
| } | ||
|
|
||
| protected function tearDown(): void | ||
| { | ||
| // Restore default argv so other tests are not affected. | ||
| $_SERVER['argv'] = ['spark']; | ||
|
|
||
| parent::tearDown(); | ||
| } | ||
|
|
||
| public function testServeRunsWithDefaultHostAndPort(): void | ||
| { | ||
| command('serve'); | ||
|
|
||
| $this->assertStringContainsString(' -S ', self::$capturedCommand); | ||
| $this->assertStringContainsString("'localhost:8080'", self::$capturedCommand); | ||
| } | ||
|
|
||
| public function testServeEscapesShellMetacharactersInHost(): void | ||
| { | ||
| $_SERVER['argv'] = ['spark', 'serve', '--host', '$(id)']; | ||
|
|
||
| command('serve --host="$(id)"'); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| // The literal '$(id)' must remain inside single quotes so /bin/sh -c | ||
| // never expands it into a sub-shell. escapeshellarg() wraps the | ||
| // entire host:port pair in single quotes and escapes any embedded | ||
| // single quote. | ||
| $this->assertStringNotContainsString(' $(id) ', self::$capturedCommand); | ||
| $this->assertMatchesRegularExpression( | ||
| "/'[^']*\\\$\\(id\\)[^']*:[0-9]+'/", | ||
| self::$capturedCommand, | ||
| 'host:port must be wrapped in single quotes by escapeshellarg()', | ||
| ); | ||
| } | ||
|
|
||
| public function testServeEscapesEmbeddedSingleQuoteInHost(): void | ||
| { | ||
| $_SERVER['argv'] = ['spark', 'serve', '--host', "evil'host"]; | ||
|
|
||
| command("serve --host=\"evil'host\""); | ||
|
|
||
| // escapeshellarg() turns a single quote into '\'' inside the wrapper, | ||
| // so the dangerous quote can never break out of the argument. | ||
| $this->assertStringNotContainsString(" evil'host:", self::$capturedCommand); | ||
| $this->assertStringContainsString("'\\''", self::$capturedCommand); | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do you need this separate argv manipulation?