Skip to content
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

Jump to bottom

Escape shell arguments correctly #3603

Merged
merged 5 commits into from
Feb 11, 2024
Merged

Escape shell arguments correctly #3603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d431bea
escape shell argument depending on target operating system
fritzmg May 18, 2023
84de127
only escape unix style
fritzmg May 19, 2023
1c660c8
add some basic tests
fritzmg May 19, 2023
0d1fd91
use json_encode in test
fritzmg May 22, 2023
edbba81
correctly escape single quotes on the Linux command line
fritzmg May 22, 2023
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
16 changes: 8 additions & 8 deletions docs/recipe/deploy/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ require 'recipe/deploy/release.php';

## Configuration
### release_name
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L8)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L9)

The name of the release.

Expand All @@ -26,7 +26,7 @@ return strval(intval($latest) + 1);


### releases_log
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L16)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L17)

Holds releases log from `.dep/releases_log` file.
:::info Autogenerated
Expand All @@ -37,7 +37,7 @@ The value of this configuration is autogenerated on access.


### releases_list
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L31)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L32)

Return list of release names on host.
:::info Autogenerated
Expand All @@ -48,7 +48,7 @@ The value of this configuration is autogenerated on access.


### release_path
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L58)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L59)

Return release path.
:::info Autogenerated
Expand All @@ -59,7 +59,7 @@ The value of this configuration is autogenerated on access.


### release_revision
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L69)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L70)

Current release revision. Usually a git hash.

Expand All @@ -69,7 +69,7 @@ return run('cat {{release_path}}/REVISION');


### release_or_current_path
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L75)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L76)

Return the release path during a deployment
but fallback to the current path otherwise.
Expand All @@ -84,15 +84,15 @@ return $releaseExists ? get('release_path') : get('current_path');
## Tasks

### deploy:release
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L82)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L83)

Prepares release.

Clean up unfinished releases and prepare next release


### releases
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L157)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/deploy/release.php#L158)

Shows releases list.

Expand Down
3 changes: 2 additions & 1 deletion recipe/deploy/release.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

use Deployer\Exception\Exception;
use Symfony\Component\Console\Helper\Table;
use function Deployer\Support\escape_shell_argument;

// The name of the release.
set('release_name', function () {
Expand Down Expand Up @@ -123,7 +124,7 @@
];

// Save metainfo about release.
$json = escapeshellarg(json_encode($metainfo));
$json = escape_shell_argument(json_encode($metainfo));
run("echo $json >> .dep/releases_log");

// Make new release.
Expand Down
5 changes: 5 additions & 0 deletions src/Support/helpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,8 @@ function colorize_host(string $alias): string
$tag = $colors[abs(crc32($alias)) % count($colors)];
return "<$tag>$alias</>";
}

function escape_shell_argument(string $argument): string
{
return "'".str_replace("'", "'\\''", $argument)."'";
}
5 changes: 5 additions & 0 deletions tests/src/Support/HelpersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,9 @@ public function testParseHomeDir()
$this->assertStringStartsWith('~', parse_home_dir('~path'));
$this->assertStringEndsWith('~', parse_home_dir('path~'));
}

public function testEscapeShellArgument()
{
$this->assertEquals('\'{"foobar":"Lorem ipsum\'\\\'\'s dolor"}\'', escape_shell_argument(json_encode(['foobar' => 'Lorem ipsum\'s dolor'])));
}
}