[v5,1/2] format-patch: create leading components of output directory
diff mbox series

Message ID ac3cc3df4452355dc41c58fe94961c37ca09ebec.1571653441.git.bert.wesarg@googlemail.com
State New
Headers show
Series
  • [v5,1/2] format-patch: create leading components of output directory
Related show

Commit Message

Bert Wesarg Oct. 21, 2019, 10:25 a.m. UTC
'git format-patch -o <outdir>' did an equivalent of 'mkdir <outdir>'
not 'mkdir -p <outdir>', which is being corrected.

Avoid the usage of 'adjust_shared_perm' on the leading directories which
may have security implications. Achieved by temporarily disabling of
'config.sharedRepository' like 'git init' does.

Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>

---
Changes in v2:
 * squashed and base new tests on 'dl/format-patch-doc-test-cleanup'

Changes in v3:
 * avoid applying adjust_shared_perm

Changes in v4:
 * based on dl/format-patch-doc-test-cleanup and adopt it

Changes in v5:
 * make tests self-contained

Cc: Denton Liu <liu.denton@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
Cc: SZEDER Gábor <szeder.dev@gmail.com>
---
 Documentation/config/format.txt    |  2 +-
 Documentation/git-format-patch.txt |  3 ++-
 builtin/log.c                      | 16 ++++++++++++++++
 t/t4014-format-patch.sh            | 26 ++++++++++++++++++++++++++
 4 files changed, 45 insertions(+), 2 deletions(-)

Comments

Bert Wesarg Oct. 21, 2019, 1:20 p.m. UTC | #1
Please ignore this. Will rebase on 2.24-rc0 and will only include the
test changes.

Bert

On Mon, Oct 21, 2019 at 12:25 PM Bert Wesarg <bert.wesarg@googlemail.com> wrote:
>
> 'git format-patch -o <outdir>' did an equivalent of 'mkdir <outdir>'
> not 'mkdir -p <outdir>', which is being corrected.
>
> Avoid the usage of 'adjust_shared_perm' on the leading directories which
> may have security implications. Achieved by temporarily disabling of
> 'config.sharedRepository' like 'git init' does.
>
> Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
>
> ---
> Changes in v2:
>  * squashed and base new tests on 'dl/format-patch-doc-test-cleanup'
>
> Changes in v3:
>  * avoid applying adjust_shared_perm
>
> Changes in v4:
>  * based on dl/format-patch-doc-test-cleanup and adopt it
>
> Changes in v5:
>  * make tests self-contained
>
> Cc: Denton Liu <liu.denton@gmail.com>
> Cc: Junio C Hamano <gitster@pobox.com>
> Cc: SZEDER Gábor <szeder.dev@gmail.com>
> ---
>  Documentation/config/format.txt    |  2 +-
>  Documentation/git-format-patch.txt |  3 ++-
>  builtin/log.c                      | 16 ++++++++++++++++
>  t/t4014-format-patch.sh            | 26 ++++++++++++++++++++++++++
>  4 files changed, 45 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
> index cb629fa769..40cad9278f 100644
> --- a/Documentation/config/format.txt
> +++ b/Documentation/config/format.txt
> @@ -81,7 +81,7 @@ format.coverLetter::
>
>  format.outputDirectory::
>         Set a custom directory to store the resulting files instead of the
> -       current working directory.
> +       current working directory. All directory components will be created.
>
>  format.useAutoBase::
>         A boolean value which lets you enable the `--base=auto` option of
> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
> index 0ac56f4b70..2035d4d5d5 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -66,7 +66,8 @@ they are created in the current working directory. The default path
>  can be set with the `format.outputDirectory` configuration option.
>  The `-o` option takes precedence over `format.outputDirectory`.
>  To store patches in the current working directory even when
> -`format.outputDirectory` points elsewhere, use `-o .`.
> +`format.outputDirectory` points elsewhere, use `-o .`. All directory
> +components will be created.
>
>  By default, the subject of a single patch is "[PATCH] " followed by
>  the concatenation of lines from the commit message up to the first blank
> diff --git a/builtin/log.c b/builtin/log.c
> index 44b10b3415..8d08632858 100644
> --- a/builtin/log.c
> +++ b/builtin/log.c
> @@ -1765,10 +1765,26 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
>                 setup_pager();
>
>         if (output_directory) {
> +               int saved;
>                 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
>                         rev.diffopt.use_color = GIT_COLOR_NEVER;
>                 if (use_stdout)
>                         die(_("standard output, or directory, which one?"));
> +               /*
> +                * We consider <outdir> as 'outside of gitdir', therefore avoid
> +                * applying adjust_shared_perm in s-c-l-d.
> +                */
> +               saved = get_shared_repository();
> +               set_shared_repository(0);
> +               switch (safe_create_leading_directories_const(output_directory)) {
> +               case SCLD_OK:
> +               case SCLD_EXISTS:
> +                       break;
> +               default:
> +                       die(_("could not create leading directories "
> +                             "of '%s'"), output_directory);
> +               }
> +               set_shared_repository(saved);
>                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
>                         die_errno(_("could not create directory '%s'"),
>                                   output_directory);
> diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
> index 72b09896cf..3aab25da76 100755
> --- a/t/t4014-format-patch.sh
> +++ b/t/t4014-format-patch.sh
> @@ -1606,6 +1606,32 @@ test_expect_success 'From line has expected format' '
>         test_cmp from filtered
>  '
>
> +test_expect_success 'format-patch -o with no leading directories' '
> +       rm -fr patches &&
> +       git format-patch -o patches master..side &&
> +       count=$(git rev-list --count master..side) &&
> +       ls patches >list &&
> +       test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading existing directories' '
> +       rm -rf existing-dir &&
> +       mkdir existing-dir &&
> +       git format-patch -o existing-dir/patches master..side &&
> +       count=$(git rev-list --count master..side) &&
> +       ls existing-dir/patches >list &&
> +       test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading non-existing directories' '
> +       rm -rf non-existing-dir &&
> +       git format-patch -o non-existing-dir/patches master..side &&
> +       count=$(git rev-list --count master..side) &&
> +       test_path_is_dir non-existing-dir
> +       ls non-existing-dir/patches >list &&
> +       test_line_count = $count list
> +'
> +
>  test_expect_success 'format-patch format.outputDirectory option' '
>         test_config format.outputDirectory patches &&
>         rm -fr patches &&
> --
> 2.23.0.13.g28bc381d7c
>
Junio C Hamano Oct. 23, 2019, 2:08 a.m. UTC | #2
Bert Wesarg <bert.wesarg@googlemail.com> writes:

> Please ignore this. Will rebase on 2.24-rc0 and will only include the
> test changes.

Thanks.

Patch
diff mbox series

diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index cb629fa769..40cad9278f 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -81,7 +81,7 @@  format.coverLetter::
 
 format.outputDirectory::
 	Set a custom directory to store the resulting files instead of the
-	current working directory.
+	current working directory. All directory components will be created.
 
 format.useAutoBase::
 	A boolean value which lets you enable the `--base=auto` option of
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 0ac56f4b70..2035d4d5d5 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -66,7 +66,8 @@  they are created in the current working directory. The default path
 can be set with the `format.outputDirectory` configuration option.
 The `-o` option takes precedence over `format.outputDirectory`.
 To store patches in the current working directory even when
-`format.outputDirectory` points elsewhere, use `-o .`.
+`format.outputDirectory` points elsewhere, use `-o .`. All directory
+components will be created.
 
 By default, the subject of a single patch is "[PATCH] " followed by
 the concatenation of lines from the commit message up to the first blank
diff --git a/builtin/log.c b/builtin/log.c
index 44b10b3415..8d08632858 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1765,10 +1765,26 @@  int cmd_format_patch(int argc, const char **argv, const char *prefix)
 		setup_pager();
 
 	if (output_directory) {
+		int saved;
 		if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
 			rev.diffopt.use_color = GIT_COLOR_NEVER;
 		if (use_stdout)
 			die(_("standard output, or directory, which one?"));
+		/*
+		 * We consider <outdir> as 'outside of gitdir', therefore avoid
+		 * applying adjust_shared_perm in s-c-l-d.
+		 */
+		saved = get_shared_repository();
+		set_shared_repository(0);
+		switch (safe_create_leading_directories_const(output_directory)) {
+		case SCLD_OK:
+		case SCLD_EXISTS:
+			break;
+		default:
+			die(_("could not create leading directories "
+			      "of '%s'"), output_directory);
+		}
+		set_shared_repository(saved);
 		if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
 			die_errno(_("could not create directory '%s'"),
 				  output_directory);
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 72b09896cf..3aab25da76 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1606,6 +1606,32 @@  test_expect_success 'From line has expected format' '
 	test_cmp from filtered
 '
 
+test_expect_success 'format-patch -o with no leading directories' '
+	rm -fr patches &&
+	git format-patch -o patches master..side &&
+	count=$(git rev-list --count master..side) &&
+	ls patches >list &&
+	test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading existing directories' '
+	rm -rf existing-dir &&
+	mkdir existing-dir &&
+	git format-patch -o existing-dir/patches master..side &&
+	count=$(git rev-list --count master..side) &&
+	ls existing-dir/patches >list &&
+	test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading non-existing directories' '
+	rm -rf non-existing-dir &&
+	git format-patch -o non-existing-dir/patches master..side &&
+	count=$(git rev-list --count master..side) &&
+	test_path_is_dir non-existing-dir
+	ls non-existing-dir/patches >list &&
+	test_line_count = $count list
+'
+
 test_expect_success 'format-patch format.outputDirectory option' '
 	test_config format.outputDirectory patches &&
 	rm -fr patches &&