From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.9 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_PASS,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id CFAF61F934 for ; Thu, 7 Jan 2021 06:41:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726772AbhAGGih (ORCPT ); Thu, 7 Jan 2021 01:38:37 -0500 Received: from out4-smtp.messagingengine.com ([66.111.4.28]:36053 "EHLO out4-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726751AbhAGGig (ORCPT ); Thu, 7 Jan 2021 01:38:36 -0500 Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 4E7B65C0178; Thu, 7 Jan 2021 01:37:22 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Thu, 07 Jan 2021 01:37:22 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=date :from:to:cc:subject:message-id:references:mime-version :content-type:in-reply-to; s=fm3; bh=yMfAJEY4BI+MuXS2tzJNgOCaS0W tIFbpXx9uTIv/M/4=; b=yMYEnT+jy7wg2FEnSOl4yiKJxQGd0dUFEd5Umg0CSnv QZ51KTJP/1Ft4feRTallHfbbF3i9jtkN0cnalGN626RxAiGG+ZLw+0mkozTBF9lj caYo2dXyxZ1sdTYmgxjL1eiNTBVl/0KvrRAK5vDVdyFW3IOSy5NF/rBvLA+RrYnz /m5VrqK0UTMFsKWFFo6zUX/IxDUT7jNypTJhjuYBm5YnOHJBo3fXWYrWcaC0Lxxu sykXksjoiPn/8PYKU8Nyfg3QiwBXdzKUBN4RMDAldaZZTVcLQvleMLmOat0ZP+Lg AfvhvJDKLpPh6OWWkXTTYowd5/zMRy5yIa71J2eZkyA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=yMfAJE Y4BI+MuXS2tzJNgOCaS0WtIFbpXx9uTIv/M/4=; b=mUUlRthwWyv3q7nrGOicOQ P5EdEBGJtFCMqLf5RHYf1KCD5VnDI1rBEdCsuUrsTsSujqEFN8DNgYJ2EDXQPyWq CfTQfMX2DUahWwbkO0/+tnYJjI+0HnkQ2kEt6MzB5rf2UOF5pdBG9+NtfCDStO8B ScF981aBefNF4ocuUhtLpdB5csV4RYuzVSbufhF02ITdiuWyZFfYoA+y7haxIw3w h/t6xJKtxI919NLmCcpnyy0CFNifJ9xQjEQcgYhg3O/TQQTCjbLeIOxwjWLLXB6S LUjh4aPFZ21mBAKkpAoDAXewyfOdOW84x7UYSA6SpRq7BoeROwnNM10Rfp8/0SwQ == X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrvdeguddgudejucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvffukfhfgggtuggjsehgtderredttddvnecuhfhrohhmpefrrghtrhhi tghkucfuthgvihhnhhgrrhguthcuoehpshesphhkshdrihhmqeenucggtffrrghtthgvrh hnpeehgefhtdefueffheekgfffudelffejtdfhvdejkedthfehvdelgfetgfdvtedthfen ucfkphepjeejrddufedrfeegrddvfedvnecuvehluhhsthgvrhfuihiivgepkeenucfrrg hrrghmpehmrghilhhfrhhomhepphhssehpkhhsrdhimh X-ME-Proxy: Received: from vm-mail.pks.im (dynamic-077-013-034-232.77.13.pool.telefonica.de [77.13.34.232]) by mail.messagingengine.com (Postfix) with ESMTPA id 5E1D624005C; Thu, 7 Jan 2021 01:37:21 -0500 (EST) Received: from localhost (ncase [10.192.0.11]) by vm-mail.pks.im (OpenSMTPD) with ESMTPSA id 71d45a58 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 7 Jan 2021 06:37:20 +0000 (UTC) Date: Thu, 7 Jan 2021 07:37:19 +0100 From: Patrick Steinhardt To: git@vger.kernel.org Cc: =?iso-8859-1?Q?=C6var_Arnfj=F6r=F0?= Bjarmason , Junio C Hamano , Jeff King , "brian m. carlson" , Philip Oakley Subject: [PATCH v6 8/8] config: allow specifying config entries via envvar pairs Message-ID: <4e3f208d1358193f253128dde747b235359edaa5.1610001187.git.ps@pks.im> References: MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="WW6VmcfxN4P+zKFq" Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org --WW6VmcfxN4P+zKFq Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable While we currently have the `GIT_CONFIG_PARAMETERS` environment variable which can be used to pass runtime configuration data to git processes, it's an internal implementation detail and not supposed to be used by end users. Next to being for internal use only, this way of passing config entries has a major downside: the config keys need to be parsed as they contain both key and value in a single variable. As such, it is left to the user to escape any potentially harmful characters in the value, which is quite hard to do if values are controlled by a third party. This commit thus adds a new way of adding config entries via the environment which gets rid of this shortcoming. If the user passes the `GIT_CONFIG_COUNT=3D$n` environment variable, Git will parse environment variable pairs `GIT_CONFIG_KEY_$i` and `GIT_CONFIG_VALUE_$i` for each `i` in `[0,n)`. While the same can be achieved with `git -c =3D`, one may wish to not do so for potentially sensitive information. E.g. if one wants to set `http.extraHeader` to contain an authentication token, doing so via `-c` would trivially leak those credentials via e.g. ps(1), which typically also shows command arguments. Signed-off-by: Patrick Steinhardt --- Documentation/git-config.txt | 16 +++++ cache.h | 1 + config.c | 67 +++++++++++++++++--- environment.c | 1 + t/t1300-config.sh | 115 ++++++++++++++++++++++++++++++++++- 5 files changed, 191 insertions(+), 9 deletions(-) diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 0e9351d3cb..4b4cc5c5e8 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -346,6 +346,22 @@ GIT_CONFIG_NOSYSTEM:: =20 See also <>. =20 +GIT_CONFIG_COUNT:: +GIT_CONFIG_KEY_:: +GIT_CONFIG_VALUE_:: + If GIT_CONFIG_COUNT is set to a positive number, all environment pairs + GIT_CONFIG_KEY_ and GIT_CONFIG_VALUE_ up to that number will be + added to the process's runtime configuration. The config pairs are + zero-indexed. Any missing key or value is treated as an error. An empty + GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=3D0, namely no + pairs are processed. These environment variables will override values + in configuration files, but will be overridden by any explicit options + passed via `git -c`. ++ +This is useful for cases where you want to spawn multiple git commands +with a common configuration but cannot depend on a configuration file, +for example when writing scripts. + =20 [[EXAMPLES]] EXAMPLES diff --git a/cache.h b/cache.h index 7109765748..a2e318c62b 100644 --- a/cache.h +++ b/cache.h @@ -472,6 +472,7 @@ static inline enum object_type object_type(unsigned int= mode) #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" #define CONFIG_ENVIRONMENT "GIT_CONFIG" #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" +#define CONFIG_COUNT_ENVIRONMENT "GIT_CONFIG_COUNT" #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" diff --git a/config.c b/config.c index 60a7261807..1742aefa3e 100644 --- a/config.c +++ b/config.c @@ -8,6 +8,7 @@ #include "cache.h" #include "branch.h" #include "config.h" +#include "environment.h" #include "repository.h" #include "lockfile.h" #include "exec-cmd.h" @@ -594,23 +595,73 @@ static int parse_config_env_list(char *env, config_fn= _t fn, void *data) =20 int git_config_from_parameters(config_fn_t fn, void *data) { - const char *env =3D getenv(CONFIG_DATA_ENVIRONMENT); + const char *env; + struct strbuf envvar =3D STRBUF_INIT; + struct strvec to_free =3D STRVEC_INIT; int ret =3D 0; - char *envw; + char *envw =3D NULL; struct config_source source; =20 - if (!env) - return 0; - memset(&source, 0, sizeof(source)); source.prev =3D cf; source.origin_type =3D CONFIG_ORIGIN_CMDLINE; cf =3D &source; =20 - /* sq_dequote will write over it */ - envw =3D xstrdup(env); - ret =3D parse_config_env_list(envw, fn, data); + env =3D getenv(CONFIG_COUNT_ENVIRONMENT); + if (env) { + unsigned long count; + char *endp; + int i; =20 + count =3D strtoul(env, &endp, 10); + if (*endp) { + ret =3D error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT); + goto out; + } + if (count > INT_MAX) { + ret =3D error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT); + goto out; + } + + for (i =3D 0; i < count; i++) { + const char *key, *value; + + strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i); + key =3D getenv_safe(&to_free, envvar.buf); + if (!key) { + ret =3D error(_("missing config key %s"), envvar.buf); + goto out; + } + strbuf_reset(&envvar); + + strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i); + value =3D getenv_safe(&to_free, envvar.buf); + if (!value) { + ret =3D error(_("missing config value %s"), envvar.buf); + goto out; + } + strbuf_reset(&envvar); + + if (config_parse_pair(key, value, fn, data) < 0) { + ret =3D -1; + goto out; + } + } + } + + env =3D getenv(CONFIG_DATA_ENVIRONMENT); + if (env) { + /* sq_dequote will write over it */ + envw =3D xstrdup(env); + if (parse_config_env_list(envw, fn, data) < 0) { + ret =3D -1; + goto out; + } + } + +out: + strbuf_release(&envvar); + strvec_clear(&to_free); free(envw); cf =3D source.prev; return ret; diff --git a/environment.c b/environment.c index 2234af462c..2f27008424 100644 --- a/environment.c +++ b/environment.c @@ -117,6 +117,7 @@ const char * const local_repo_env[] =3D { ALTERNATE_DB_ENVIRONMENT, CONFIG_ENVIRONMENT, CONFIG_DATA_ENVIRONMENT, + CONFIG_COUNT_ENVIRONMENT, DB_ENVIRONMENT, GIT_DIR_ENVIRONMENT, GIT_WORK_TREE_ENVIRONMENT, diff --git a/t/t1300-config.sh b/t/t1300-config.sh index 35a1a6e8b1..e06961767f 100755 --- a/t/t1300-config.sh +++ b/t/t1300-config.sh @@ -1421,6 +1421,117 @@ test_expect_success '--config-env handles keys with= equals' ' test_cmp expect actual ' =20 +test_expect_success 'git config handles environment config pairs' ' + GIT_CONFIG_COUNT=3D2 \ + GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D"foo" \ + GIT_CONFIG_KEY_1=3D"pair.two" GIT_CONFIG_VALUE_1=3D"bar" \ + git config --get-regexp "pair.*" >actual && + cat >expect <<-EOF && + pair.one foo + pair.two bar + EOF + test_cmp expect actual +' + +test_expect_success 'git config ignores pairs without count' ' + test_must_fail env GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D"va= lue" \ + git config pair.one 2>error && + test_must_be_empty error +' + +test_expect_success 'git config ignores pairs with zero count' ' + test_must_fail env \ + GIT_CONFIG_COUNT=3D0 \ + GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D"value" \ + git config pair.one +' + +test_expect_success 'git config ignores pairs exceeding count' ' + GIT_CONFIG_COUNT=3D1 \ + GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D"value" \ + GIT_CONFIG_KEY_1=3D"pair.two" GIT_CONFIG_VALUE_1=3D"value" \ + git config --get-regexp "pair.*" >actual && + cat >expect <<-EOF && + pair.one value + EOF + test_cmp expect actual +' + +test_expect_success 'git config ignores pairs with zero count' ' + test_must_fail env \ + GIT_CONFIG_COUNT=3D0 GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D= "value" \ + git config pair.one >error && + test_must_be_empty error +' + +test_expect_success 'git config ignores pairs with empty count' ' + test_must_fail env \ + GIT_CONFIG_COUNT=3D GIT_CONFIG_KEY_0=3D"pair.one" GIT_CONFIG_VALUE_0=3D"= value" \ + git config pair.one >error && + test_must_be_empty error +' + +test_expect_success 'git config fails with invalid count' ' + test_must_fail env GIT_CONFIG_COUNT=3D10a git config --list 2>error && + test_i18ngrep "bogus count" error && + test_must_fail env GIT_CONFIG_COUNT=3D9999999999999999 git config --list = 2>error && + test_i18ngrep "too many entries" error +' + +test_expect_success 'git config fails with missing config key' ' + test_must_fail env GIT_CONFIG_COUNT=3D1 GIT_CONFIG_VALUE_0=3D"value" \ + git config --list 2>error && + test_i18ngrep "missing config key" error +' + +test_expect_success 'git config fails with missing config value' ' + test_must_fail env GIT_CONFIG_COUNT=3D1 GIT_CONFIG_KEY_0=3D"pair.one" \ + git config --list 2>error && + test_i18ngrep "missing config value" error +' + +test_expect_success 'git config fails with invalid config pair key' ' + test_must_fail env GIT_CONFIG_COUNT=3D1 \ + GIT_CONFIG_KEY_0=3D GIT_CONFIG_VALUE_0=3Dvalue \ + git config --list && + test_must_fail env GIT_CONFIG_COUNT=3D1 \ + GIT_CONFIG_KEY_0=3Dmissing-section GIT_CONFIG_VALUE_0=3Dvalue \ + git config --list +' + +test_expect_success 'environment overrides config file' ' + test_when_finished "rm -f .git/config" && + cat >.git/config <<-EOF && + [pair] + one =3D value + EOF + GIT_CONFIG_COUNT=3D1 GIT_CONFIG_KEY_0=3Dpair.one GIT_CONFIG_VALUE_0=3Dove= rride \ + git config pair.one >actual && + cat >expect <<-EOF && + override + EOF + test_cmp expect actual +' + +test_expect_success 'GIT_CONFIG_PARAMETERS overrides environment config' ' + GIT_CONFIG_COUNT=3D1 GIT_CONFIG_KEY_0=3Dpair.one GIT_CONFIG_VALUE_0=3Dval= ue \ + GIT_CONFIG_PARAMETERS=3D"${SQ}pair.one=3Doverride${SQ}" \ + git config pair.one >actual && + cat >expect <<-EOF && + override + EOF + test_cmp expect actual +' + +test_expect_success 'command line overrides environment config' ' + GIT_CONFIG_COUNT=3D1 GIT_CONFIG_KEY_0=3Dpair.one GIT_CONFIG_VALUE_0=3Dval= ue \ + git -c pair.one=3Doverride config pair.one >actual && + cat >expect <<-EOF && + override + EOF + test_cmp expect actual +' + test_expect_success 'git config --edit works' ' git config -f tmp test.value no && echo test.value=3Dyes >expect && @@ -1766,9 +1877,11 @@ test_expect_success '--show-origin with --list' ' file:.git/config user.override=3Dlocal file:.git/config include.path=3D../include/relative.include file:.git/../include/relative.include user.relative=3Dinclude + command line: user.environ=3Dtrue command line: user.cmdline=3Dtrue EOF - git -c user.cmdline=3Dtrue config --list --show-origin >output && + GIT_CONFIG_COUNT=3D1 GIT_CONFIG_KEY_0=3Duser.environ GIT_CONFIG_VALUE_0= =3Dtrue\ + git -c user.cmdline=3Dtrue config --list --show-origin >output && test_cmp expect output ' =20 --=20 2.30.0 --WW6VmcfxN4P+zKFq Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCgAdFiEEF9hrgiFbCdvenl/rVbJhu7ckPpQFAl/2rB4ACgkQVbJhu7ck PpTMkw/+LIwDNxcblXkRamJESiOMuHj4xaP8NkZhZkzEP4bqf+ClAI+PD9gWwRvv NhjV0GuOGs/dx5hFr5t3mJ+/39gcp9/yTzqIYLZoJn1Pke1gDZYHuI5WmCsQjVrw 9hVkRdwjcVpx8i5iaE31Z23rnnidAW8d5Lm4D++FASyWtByHgd4PDNXD3GQz1Tda 1hA43DasInVzBGB0gM42Un02+f2RDGXdTaEeaw3kkY3xwQ9wTg/gCsteJ4qmLpm0 pbPftNU3dvdXygwBZGpK/Fe1AxkDFF1iktyITH/fCRlhHEItnvIP8OknKsXSvfE3 +QNQoDtHD6myxzQkoQtwDI3M+VNQcCwXD7g431qKzWRHrN1xyU+usYd8qqgOb1+e tVvU3YtTHOJvleY2el70YdzBqTF19je/wpd1pwfxMDHNuMbvY5DxbWllsQ/BkpEU 6FC0UqVKu0Ib3bmYxv7LB21Qc9xdQHlQQKrRI3Jt0WnWXphvV1k0LgoPwNc3BUSG OV8ZmzBKGnVafHflJHg6GZiD33yqkPjLKGG1+5AcitOC7RK9gMC8KtExsSvSzhvt m5g/RmFBuw+hy4xYVDdRahgOG33DPuMKmzKHjsdNPGqQLmvbKcJvqqpWOKoeGPD4 UxbJBbhSIebZJukA0FLtExNJQE6Y3FaZ0Gzh+q1dSWid5RtrtWg= =WBvV -----END PGP SIGNATURE----- --WW6VmcfxN4P+zKFq--