git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 3/3] config: store "git -c" variables using more robust format

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Dec 10, 2020, 20:55 UTC
Message-ID
<87pn3hwfd5.fsf@evledraar.gmail.com>
In-Reply-To
<X9D5SnXca2rGnJFl@coredump.intra.peff.net>
On Wed, Dec 09 2020, Jeff King wrote:
Show 137 quoted lines
> The previous commit added a new format for $GIT_CONFIG_PARAMETERS which
> is able to robustly handle subsections with "=" in them. Let's start
> writing the new format. Unfortunately, this does much less than you'd
> hope, because "git -c" itself has the same ambiguity problem! But it's
> still worth doing:
>
>   - we've now pushed the problem from the inter-process communication
>     into the "-c" command-line parser. This would free us up to later
>     add an unambiguous format there (e.g., separate arguments like "git
>     --config key value", etc).
>
>   - for --config-env, the parser already disallows "=" in the
>     environment variable name. So:
>
>       git --config-env section.with=equals.key=ENVVAR
>
>     will robustly set section.with=equals.key to the contents of
>     $ENVVAR.
>
> The new test shows the improvement for --config-env.
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> One other side effect I just noticed is that we're very aggressive about
> trimming leading and trailing whitespace in the old-style format, but
> the new one will store values verbatim. IMHO that's better overall, but
> we might consider a preparatory patch to remove that trimming
> explicitly.
>
>  config.c          | 52 ++++++++++++++++++++++++++++++++++++++++-------
>  t/t1300-config.sh |  8 ++++++++
>  2 files changed, 53 insertions(+), 7 deletions(-)
>
> diff --git a/config.c b/config.c
> index fb160c33d2..04029e45dc 100644
> --- a/config.c
> +++ b/config.c
> @@ -333,38 +333,76 @@ int git_config_include(const char *var, const char *value, void *data)
>  	return ret;
>  }
>  
> -void git_config_push_parameter(const char *text)
> +static void git_config_push_split_parameter(const char *key, const char *value)
>  {
>  	struct strbuf env = STRBUF_INIT;
>  	const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
>  	if (old && *old) {
>  		strbuf_addstr(&env, old);
>  		strbuf_addch(&env, ' ');
>  	}
> -	sq_quote_buf(&env, text);
> +	sq_quote_buf(&env, key);
> +	strbuf_addch(&env, '=');
> +	if (value)
> +		sq_quote_buf(&env, value);
>  	setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
>  	strbuf_release(&env);
>  }
>  
> +void git_config_push_parameter(const char *text)
> +{
> +	const char *value;
> +
> +	/*
> +	 * When we see:
> +	 *
> +	 *   section.subsection=with=equals.key=value
> +	 *
> +	 * we cannot tell if it means:
> +	 *
> +	 *   [section "subsection=with=equals"]
> +	 *   key = value
> +	 *
> +	 * or:
> +	 *
> +	 *   [section]
> +	 *   subsection = with=equals.key=value
> +	 *
> +	 * We parse left-to-right for the first "=", meaning we'll prefer to
> +	 * keep the value intact over the subsection. This is historical, but
> +	 * also sensible since values are more likely to contain odd or
> +	 * untrusted input than a section name.
> +	 *
> +	 * A missing equals is explicitly allowed (as a bool-only entry).
> +	 */
> +	value = strchr(text, '=');
> +	if (value) {
> +		char *key = xmemdupz(text, value - text);
> +		git_config_push_split_parameter(key, value + 1);
> +		free(key);
> +	} else {
> +		git_config_push_split_parameter(text, NULL);
> +	}
> +}
> +
>  void git_config_push_env(const char *spec)
>  {
> -	struct strbuf buf = STRBUF_INIT;
> +	char *key;
>  	const char *env_name;
>  	const char *env_value;
>  
>  	env_name = strrchr(spec, '=');
>  	if (!env_name)
>  		die("invalid config format: %s", spec);
> +	key = xmemdupz(spec, env_name - spec);
>  	env_name++;
>  
>  	env_value = getenv(env_name);
>  	if (!env_value)
>  		die("config variable missing for '%s'", env_name);
>  
> -	strbuf_add(&buf, spec, env_name - spec);
> -	strbuf_addstr(&buf, env_value);
> -	git_config_push_parameter(buf.buf);
> -	strbuf_release(&buf);
> +	git_config_push_split_parameter(key, env_value);
> +	free(key);
>  }
>  
>  static inline int iskeychar(int c)
> diff --git a/t/t1300-config.sh b/t/t1300-config.sh
> index bd602e7720..e06961767f 100755
> --- a/t/t1300-config.sh
> +++ b/t/t1300-config.sh
> @@ -1413,6 +1413,14 @@ test_expect_success 'git -c and --config-env override each other' '
>  	test_cmp expect actual
>  '
>  
> +test_expect_success '--config-env handles keys with equals' '
> +	echo value=with=equals >expect &&
> +	ENVVAR=value=with=equals git \
> +		--config-env=section.subsection=with=equals.key=ENVVAR \
> +		config section.subsection=with=equals.key >actual &&
> +	test_cmp expect actual
> +'
> +
Maybe worth adding a test for the strrchr() semantics here with:
    perl -we '$ENV{"Y=Z"}="why and zed"; system "Z=zed git --config-env=X=Y=Z ..."'
Which would show that we can't look up "Y=Z", but will always get "Z".

I think that's fine b.t.w., 1/2 of the minor objection I had to --config-env in https://lore.kernel.org/git/87y2i7vvz4.fsf@evledraar.gmail.com/ was mainly about being unable to e.g. support odd token usernames with the "insteadOf" feature.

But aside from having a feature meant to improve security being able to be combined with a config variable we have in a way that leaks the password in ps(1) I think these improved semantics make sense.

I.e. I can't imagine someone wants an env var with "=" in it, even though POSIX makes such a thing possible (you just can't do it in a shellscript).

Previous: Jeff KingNext: Junio C Hamano
Message 39 of 116 in “config: allow specifying config entries via envvar pairs”
  1. 0/2 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Nov 24, 2020
  2. 1/2 config: extract function to parse config pairsPatrick Steinhardt, Nov 24, 2020
  3. 2/2 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Nov 24, 2020
  4. Junio C HamanoNov 25, 2020
  5. Patrick SteinhardtNov 25, 2020
  6. Junio C HamanoNov 25, 2020
  7. Patrick SteinhardtNov 25, 2020
  8. Ævar Arnfjörð BjarmasonNov 25, 2020
  9. Ævar Arnfjörð BjarmasonNov 25, 2020
  10. Junio C HamanoNov 25, 2020
  11. Jeff KingNov 25, 2020
  12. Patrick SteinhardtNov 25, 2020
  13. Jeff KingNov 26, 2020
  14. Junio C HamanoNov 25, 2020
  15. brian m. carlsonNov 25, 2020
  16. Patrick SteinhardtNov 26, 2020
  17. Patrick SteinhardtDec 1, 2020
  18. Jeff KingDec 1, 2020
  19. 0/4 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Dec 1, 2020
  20. 1/4 environment: make `getenv_safe()` non-staticPatrick Steinhardt, Dec 1, 2020
  21. 3/4 config: refactor parsing of GIT_CONFIG_PARAMETERSPatrick Steinhardt, Dec 1, 2020
  22. 2/4 config: extract function to parse config pairsPatrick Steinhardt, Dec 1, 2020
  23. 4/4 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Dec 1, 2020
  24. 0/6 config: allow specifying config entries via envPatrick Steinhardt, Dec 9, 2020
  25. 1/6 git: add `--super-prefix` to usage stringPatrick Steinhardt, Dec 9, 2020
  26. 3/6 environment: make `getenv_safe()` non-staticPatrick Steinhardt, Dec 9, 2020
  27. 2/6 config: add new way to pass config via `--config-env`Patrick Steinhardt, Dec 9, 2020
  28. Ævar Arnfjörð BjarmasonDec 9, 2020
  29. Jeff KingDec 9, 2020
  30. Patrick SteinhardtDec 11, 2020
  31. Jeff KingDec 11, 2020
  32. Patrick SteinhardtDec 11, 2020
  33. Jeff KingDec 11, 2020
  34. Jeff KingDec 9, 2020
  35. 1/3 quote: make sq_dequote_step() a public functionJeff King, Dec 9, 2020
  36. 2/3 config: parse more robust format in GIT_CONFIG_PARAMETERSJeff King, Dec 9, 2020
  37. 3/3 config: store "git -c" variables using more robust formatJeff King, Dec 9, 2020
  38. Jeff KingDec 9, 2020
  39. Ævar Arnfjörð BjarmasonDec 10, 2020
  40. Junio C HamanoDec 10, 2020
  41. Jeff KingDec 11, 2020
  42. Junio C HamanoDec 10, 2020
  43. Jeff KingDec 10, 2020
  44. Junio C HamanoDec 10, 2020
  45. Patrick SteinhardtDec 11, 2020
  46. Jeff KingDec 11, 2020
  47. 4/6 config: extract function to parse config pairsPatrick Steinhardt, Dec 9, 2020
  48. Ævar Arnfjörð BjarmasonDec 9, 2020
  49. 6/6 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Dec 9, 2020
  50. 5/6 config: refactor parsing of GIT_CONFIG_PARAMETERSPatrick Steinhardt, Dec 9, 2020
  51. Ævar Arnfjörð BjarmasonDec 9, 2020
  52. Patrick SteinhardtDec 11, 2020
  53. Jeff KingDec 11, 2020
  54. Jeff KingDec 11, 2020
  55. Patrick SteinhardtDec 11, 2020
  56. Patrick SteinhardtDec 11, 2020
  57. Ævar Arnfjörð BjarmasonDec 11, 2020
  58. Jeff KingDec 11, 2020
  59. 0/8 config: allow specifying config entries via envPatrick Steinhardt, Dec 16, 2020
  60. 1/8 git: add `--super-prefix` to usage stringPatrick Steinhardt, Dec 16, 2020
  61. 2/8 config: add new way to pass config via `--config-env`Patrick Steinhardt, Dec 16, 2020
  62. Junio C HamanoDec 23, 2020
  63. 4/8 config: extract function to parse config pairsPatrick Steinhardt, Dec 16, 2020
  64. 8/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Dec 16, 2020
  65. Junio C HamanoDec 23, 2020
  66. Junio C HamanoDec 23, 2020
  67. Patrick SteinhardtJan 6, 2021
  68. Junio C HamanoJan 6, 2021
  69. 7/8 environment: make `getenv_safe()` a public functionPatrick Steinhardt, Dec 16, 2020
  70. 6/8 config: parse more robust format in GIT_CONFIG_PARAMETERSPatrick Steinhardt, Dec 16, 2020
  71. Phillip WoodDec 16, 2020
  72. 3/8 quote: make sq_dequote_step() a public functionPatrick Steinhardt, Dec 16, 2020
  73. 5/8 config: store "git -c" variables using more robust formatPatrick Steinhardt, Dec 16, 2020
  74. 0/8 config: allow specifying config entries via envPatrick Steinhardt, Jan 7, 2021
  75. 4/8 config: extract function to parse config pairsPatrick Steinhardt, Jan 7, 2021
  76. 1/8 git: add `--super-prefix` to usage stringPatrick Steinhardt, Jan 7, 2021
  77. 2/8 config: add new way to pass config via `--config-env`Patrick Steinhardt, Jan 7, 2021
  78. Simon RuderichJan 10, 2021
  79. Junio C HamanoJan 11, 2021
  80. Patrick SteinhardtJan 11, 2021
  81. 3/8 quote: make sq_dequote_step() a public functionPatrick Steinhardt, Jan 7, 2021
  82. 5/8 config: store "git -c" variables using more robust formatPatrick Steinhardt, Jan 7, 2021
  83. 6/8 config: parse more robust format in GIT_CONFIG_PARAMETERSPatrick Steinhardt, Jan 7, 2021
  84. 7/8 environment: make `getenv_safe()` a public functionPatrick Steinhardt, Jan 7, 2021
  85. 8/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Jan 7, 2021
  86. 0/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Jan 11, 2021
  87. 2/8 config: add new way to pass config via `--config-env`Patrick Steinhardt, Jan 11, 2021
  88. Junio C HamanoJan 11, 2021
  89. 3/8 quote: make sq_dequote_step() a public functionPatrick Steinhardt, Jan 11, 2021
  90. 1/8 git: add `--super-prefix` to usage stringPatrick Steinhardt, Jan 11, 2021
  91. 4/8 config: extract function to parse config pairsPatrick Steinhardt, Jan 11, 2021
  92. 5/8 config: store "git -c" variables using more robust formatPatrick Steinhardt, Jan 11, 2021
  93. 7/8 environment: make `getenv_safe()` a public functionPatrick Steinhardt, Jan 11, 2021
  94. 6/8 config: parse more robust format in GIT_CONFIG_PARAMETERSPatrick Steinhardt, Jan 11, 2021
  95. 8/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Jan 11, 2021
  96. 0/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Jan 12, 2021
  97. 2/8 config: add new way to pass config via `--config-env`Patrick Steinhardt, Jan 12, 2021
  98. Ævar Arnfjörð BjarmasonApr 16, 2021
  99. Jeff KingApr 17, 2021
  100. Patrick SteinhardtApr 19, 2021
  101. Ævar Arnfjörð BjarmasonApr 20, 2021
  102. Ævar Arnfjörð BjarmasonApr 20, 2021
  103. Jeff KingApr 23, 2021
  104. Ævar Arnfjörð BjarmasonMay 19, 2021
  105. 4/8 config: extract function to parse config pairsPatrick Steinhardt, Jan 12, 2021
  106. 1/8 git: add `--super-prefix` to usage stringPatrick Steinhardt, Jan 12, 2021
  107. 3/8 quote: make sq_dequote_step() a public functionPatrick Steinhardt, Jan 12, 2021
  108. 6/8 config: parse more robust format in GIT_CONFIG_PARAMETERSPatrick Steinhardt, Jan 12, 2021
  109. 8/8 config: allow specifying config entries via envvar pairsPatrick Steinhardt, Jan 12, 2021
  110. 5/8 config: store "git -c" variables using more robust formatPatrick Steinhardt, Jan 12, 2021
  111. Jeff KingJan 15, 2021
  112. Patrick SteinhardtJan 20, 2021
  113. Junio C HamanoJan 20, 2021
  114. Patrick SteinhardtJan 20, 2021
  115. Junio C HamanoJan 20, 2021
  116. 7/8 environment: make `getenv_safe()` a public functionPatrick Steinhardt, Jan 12, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.