# [PATCH v6 6/6] t/t7004-tag: Add --format specifier tests 20 messages from 2017-01-17 to 2017-01-19. Participants: santiago@nyu.edu, Junio C Hamano, Jeff King, Santiago Torres, Eric Wong. Thread: https://gitlist.dev/t/44903 ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 6/6] t/t7004-tag: Add --format specifier tests Message-ID: <20170117233723.23897-7-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-7-santiago%40nyu.edu In-Reply-To: <20170117233723.23897-1-santiago@nyu.edu> ``` From: Santiago Torres tag -v now supports --format specifiers to inspect the contents of a tag upon verification. Add two tests to ensure this behavior is respected in future changes. Signed-off-by: Santiago Torres --- t/t7004-tag.sh | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh index 07869b0c0..ba88b556b 100755 --- a/t/t7004-tag.sh +++ b/t/t7004-tag.sh @@ -874,6 +874,22 @@ test_expect_success GPG 'verifying a forged tag should fail' ' test_must_fail git tag -v forged-tag ' +test_expect_success 'verifying a proper tag with --format pass and format accordingly' ' + cat >expect <<-\EOF + tagname : signed-tag + EOF && + git tag -v --format="tagname : %(tag)" "signed-tag" >actual && + test_cmp expect actual +' + +test_expect_success 'verifying a forged tag with --format fail and format accordingly' ' + cat >expect <<-\EOF + tagname : forged-tag + EOF && + test_must_fail git tag -v --format="tagname : %(tag)" "forged-tag" >actual && + test_cmp expect actual +' + # blank and empty messages for signed tags: get_tag_header empty-signed-tag $commit commit $time >expect -- 2.11.0 ``` ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 3/6] builtin/verify-tag: add --format to verify-tag Message-ID: <20170117233723.23897-4-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-4-santiago%40nyu.edu In-Reply-To: <20170117233723.23897-1-santiago@nyu.edu> ``` From: Santiago Torres Callers of verify-tag may want to cross-check the tagname from refs/tags with the tagname from the tag object header upon GPG verification. This is to avoid tag refs that point to an incorrect object. Add a --format parameter to git verify-tag to print the formatted tag object header in addition to or instead of the --verbose or --raw GPG verification output. Signed-off-by: Santiago Torres --- Documentation/git-verify-tag.txt | 2 +- builtin/verify-tag.c | 23 ++++++++++++++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt index d590edceb..0b8075dad 100644 --- a/Documentation/git-verify-tag.txt +++ b/Documentation/git-verify-tag.txt @@ -8,7 +8,7 @@ git-verify-tag - Check the GPG signature of tags SYNOPSIS -------- [verse] -'git verify-tag' ... +'git verify-tag' [--format=] ... DESCRIPTION ----------- diff --git a/builtin/verify-tag.c b/builtin/verify-tag.c index 99f8148cf..18443bf9f 100644 --- a/builtin/verify-tag.c +++ b/builtin/verify-tag.c @@ -12,12 +12,14 @@ #include #include "parse-options.h" #include "gpg-interface.h" +#include "ref-filter.h" static const char * const verify_tag_usage[] = { - N_("git verify-tag [-v | --verbose] ..."), + N_("git verify-tag [-v | --verbose] [--format=] ..."), NULL }; + static int git_verify_tag_config(const char *var, const char *value, void *cb) { int status = git_gpg_config(var, value, cb); @@ -30,9 +32,11 @@ int cmd_verify_tag(int argc, const char **argv, const char *prefix) { int i = 1, verbose = 0, had_error = 0; unsigned flags = 0; + char *fmt_pretty = NULL; const struct option verify_tag_options[] = { OPT__VERBOSE(&verbose, N_("print tag contents")), OPT_BIT(0, "raw", &flags, N_("print raw gpg status output"), GPG_VERIFY_RAW), + OPT_STRING( 0 , "format", &fmt_pretty, N_("format"), N_("format to use for the output")), OPT_END() }; @@ -46,13 +50,26 @@ int cmd_verify_tag(int argc, const char **argv, const char *prefix) if (verbose) flags |= GPG_VERIFY_VERBOSE; + if (fmt_pretty) { + verify_ref_format(fmt_pretty); + flags |= GPG_VERIFY_OMIT_STATUS; + } + while (i < argc) { unsigned char sha1[20]; const char *name = argv[i++]; - if (get_sha1(name, sha1)) + if (get_sha1(name, sha1)) { had_error = !!error("tag '%s' not found.", name); - else if (gpg_verify_tag(sha1, name, flags)) + continue; + } + + if (gpg_verify_tag(sha1, name, flags)) { had_error = 1; + continue; + } + + if (fmt_pretty) + pretty_print_ref(name, sha1, fmt_pretty); } return had_error; } -- 2.11.0 ``` ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 1/6] gpg-interface,tag: add GPG_VERIFY_OMIT_STATUS flag Message-ID: <20170117233723.23897-2-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-2-santiago%40nyu.edu In-Reply-To: <20170117233723.23897-1-santiago@nyu.edu> ``` From: Lukas Puehringer Functions that print git object information may require that the gpg-interface functions be silent. Add GPG_VERIFY_OMIT_STATUS flag and prevent print_signature_buffer from being called if flag is set. Signed-off-by: Lukas Puehringer --- gpg-interface.h | 5 +++-- tag.c | 5 ++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/gpg-interface.h b/gpg-interface.h index ea68885ad..d2d4fd3a6 100644 --- a/gpg-interface.h +++ b/gpg-interface.h @@ -1,8 +1,9 @@ #ifndef GPG_INTERFACE_H #define GPG_INTERFACE_H -#define GPG_VERIFY_VERBOSE 1 -#define GPG_VERIFY_RAW 2 +#define GPG_VERIFY_VERBOSE 1 +#define GPG_VERIFY_RAW 2 +#define GPG_VERIFY_OMIT_STATUS 4 struct signature_check { char *payload; diff --git a/tag.c b/tag.c index d1dcd18cd..243d1fdbb 100644 --- a/tag.c +++ b/tag.c @@ -3,6 +3,7 @@ #include "commit.h" #include "tree.h" #include "blob.h" +#include "gpg-interface.h" const char *tag_type = "tag"; @@ -24,7 +25,9 @@ static int run_gpg_verify(const char *buf, unsigned long size, unsigned flags) ret = check_signature(buf, payload_size, buf + payload_size, size - payload_size, &sigc); - print_signature_buffer(&sigc, flags); + + if (!(flags & GPG_VERIFY_OMIT_STATUS)) + print_signature_buffer(&sigc, flags); signature_check_clear(&sigc); return ret; -- 2.11.0 ``` ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 0/6] Add --format to tag verification Message-ID: <20170117233723.23897-1-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-1-santiago%40nyu.edu ``` From: Santiago Torres This is the sixth iteration of [1][2][3][4][5], and as a result of the discussion in [5]. The main goal of this patch series is to bring --format to git tag verification so that upper-layer tools can inspect the content of a tag and make decisions based on it. In this re-woll we: * Changed the call interface so printing is done outside of verification. * Fixed a couple of whitespace issues and whatnot. Thanks, -Santiago [1] http://public-inbox.org/git/20170115184705.10376-1-santiago@nyu.edu/ [2] http://public-inbox.org/git/20161007210721.20437-1-santiago@nyu.edu/ [3] http://public-inbox.org/git/20160930221806.3398-1-santiago@nyu.edu/ [4] http://public-inbox.org/git/20160922185317.349-1-santiago@nyu.edu/ [5] http://public-inbox.org/git/20160926224233.32702-1-santiago@nyu.edu/ [6] http://public-inbox.org/git/20160607195608.16643-1-santiago@nyu.edu/ [7] http://public-inbox.org/git/20161019203546.dfqmi2czcxopgj6w@sigill.intra.peff.net/ [8] http://public-inbox.org/git/20161019203943.epjxnfci7vcqg4xv@sigill.intra.peff.net/ Lukas Puehringer (3): gpg-interface,tag: add GPG_VERIFY_OMIT_STATUS flag ref-filter: add function to print single ref_array_item builtin/tag: add --format argument for tag -v Santiago Torres (3): builtin/verify-tag: add --format to verify-tag t/t7030-verify-tag: Add --format specifier tests t/t7004-tag: Add --format specifier tests Documentation/git-tag.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- builtin/tag.c | 38 ++++++++++++++++++++++++++++---------- builtin/verify-tag.c | 23 ++++++++++++++++++++--- gpg-interface.h | 5 +++-- ref-filter.c | 27 +++++++++++++++++++++------ ref-filter.h | 7 +++++++ t/t7004-tag.sh | 16 ++++++++++++++++ t/t7030-verify-tag.sh | 16 ++++++++++++++++ tag.c | 5 ++++- 10 files changed, 117 insertions(+), 24 deletions(-) -- 2.11.0 ``` ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 2/6] ref-filter: add function to print single ref_array_item Message-ID: <20170117233723.23897-3-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-3-santiago%40nyu.edu In-Reply-To: <20170117233723.23897-1-santiago@nyu.edu> ``` From: Lukas Puehringer ref-filter functions are useful for printing git object information using a format specifier. However, some other modules may not want to use this functionality on a ref-array but only print a single item. Expose a pretty_print_ref function to create, pretty print and free individual ref-items. Signed-off-by: Lukas Puehringer --- ref-filter.c | 27 +++++++++++++++++++++------ ref-filter.h | 7 +++++++ 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/ref-filter.c b/ref-filter.c index 1a978405e..5f4b08792 100644 --- a/ref-filter.c +++ b/ref-filter.c @@ -1361,7 +1361,7 @@ static struct ref_array_item *new_ref_array_item(const char *refname, return ref; } -static int filter_ref_kind(struct ref_filter *filter, const char *refname) +static int ref_kind_from_refname(const char *refname) { unsigned int i; @@ -1374,11 +1374,7 @@ static int filter_ref_kind(struct ref_filter *filter, const char *refname) { "refs/tags/", FILTER_REFS_TAGS} }; - if (filter->kind == FILTER_REFS_BRANCHES || - filter->kind == FILTER_REFS_REMOTES || - filter->kind == FILTER_REFS_TAGS) - return filter->kind; - else if (!strcmp(refname, "HEAD")) + if (!strcmp(refname, "HEAD")) return FILTER_REFS_DETACHED_HEAD; for (i = 0; i < ARRAY_SIZE(ref_kind); i++) { @@ -1389,6 +1385,15 @@ static int filter_ref_kind(struct ref_filter *filter, const char *refname) return FILTER_REFS_OTHERS; } +static int filter_ref_kind(struct ref_filter *filter, const char *refname) +{ + if (filter->kind == FILTER_REFS_BRANCHES || + filter->kind == FILTER_REFS_REMOTES || + filter->kind == FILTER_REFS_TAGS) + return filter->kind; + return ref_kind_from_refname(refname); +} + /* * A call-back given to for_each_ref(). Filter refs and keep them for * later object processing. @@ -1671,6 +1676,16 @@ void show_ref_array_item(struct ref_array_item *info, const char *format, int qu putchar('\n'); } +void pretty_print_ref(const char *name, const unsigned char *sha1, + const char *format) +{ + struct ref_array_item *ref_item; + ref_item = new_ref_array_item(name, sha1, 0); + ref_item->kind = ref_kind_from_refname(name); + show_ref_array_item(ref_item, format, 0); + free_array_item(ref_item); +} + /* If no sorting option is given, use refname to sort as default */ struct ref_sorting *ref_default_sorting(void) { diff --git a/ref-filter.h b/ref-filter.h index fc55fa357..7b05592ba 100644 --- a/ref-filter.h +++ b/ref-filter.h @@ -109,4 +109,11 @@ struct ref_sorting *ref_default_sorting(void); /* Function to parse --merged and --no-merged options */ int parse_opt_merge_filter(const struct option *opt, const char *arg, int unset); +/* + * Print a single ref, outside of any ref-filter. Note that the + * name must be a fully qualified refname. + */ +void pretty_print_ref(const char *name, const unsigned char *sha1, + const char *format); + #endif /* REF_FILTER_H */ -- 2.11.0 ``` ## santiago@nyu.edu, 2017-01-17 23:37 Subject: [PATCH v6 4/6] builtin/tag: add --format argument for tag -v Message-ID: <20170117233723.23897-5-santiago@nyu.edu> URL: https://gitlist.dev/e/20170117233723.23897-5-santiago%40nyu.edu In-Reply-To: <20170117233723.23897-1-santiago@nyu.edu> ``` From: Lukas Puehringer Adding --format to git tag -v mutes the default output of the GPG verification and instead prints the formatted tag object. This allows callers to cross-check the tagname from refs/tags with the tagname from the tag object header upon GPG verification. The callback function for for_each_tag_name() didn't allow callers to pass custom data to their callback functions. Add a new opaque pointer to each_tag_name_fn's parameter to allow this. Signed-off-by: Lukas Puehringer --- Documentation/git-tag.txt | 2 +- builtin/tag.c | 38 ++++++++++++++++++++++++++++---------- 2 files changed, 29 insertions(+), 11 deletions(-) diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 76cfe40d9..586aaa315 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -15,7 +15,7 @@ SYNOPSIS 'git tag' [-n[]] -l [--contains ] [--points-at