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

[PATCH 1/9] trailer: use size_t for string offsets

From
Jeff King <peff@peff.net>
Date
Aug 23, 2018, 00:44 UTC
Message-ID
<20180823004438.GA3126@sigill.intra.peff.net>
In-Reply-To
<20180823004300.GA1355@sigill.intra.peff.net>

Many of the string-parsing functions inside trailer.c return integer offsets into the string (e.g., to point to the end of the trailer block). Several of these use an "int" to return or store the offsets. On a system where "size_t" is much larger than "int" (e.g., most 64-bit ones), it's easy to feed a gigantic commit message that results in a negative offset. This can result in us reading memory before the string (if the int is used as an index) or far after (if it's implicitly cast to a size_t by passing to a strbuf function).

Let's fix this by using size_t for all string offsets. Note that several of the functions need ssize_t, since they use "-1" as a sentinel value. The interactions here can be pretty subtle. E.g., end_of_title in find_trailer_start() does not itself need to be signed, but it is compared to the result of last_line(), which is. That promotes the latter to unsigned, and the ">=" does not behave as you might expect.

Signed-off-by: Jeff King <peff@peff.net>
---
Noticed while I was in the area. I did pretty easily reproduce a
segfault with this.
 trailer.c | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)
diff --git a/trailer.c b/trailer.c
index 4e309460d1..88b35b8e89 100644
--- a/trailer.c
+++ b/trailer.c
@@ -585,7 +585,7 @@ static const char *token_from_item(struct arg_item *item, char *tok)
 	return item->conf.name;
 }
 
-static int token_matches_item(const char *tok, struct arg_item *item, int tok_len)
+static int token_matches_item(const char *tok, struct arg_item *item, size_t tok_len)
 {
 	if (!strncasecmp(tok, item->conf.name, tok_len))
 		return 1;
@@ -603,7 +603,7 @@ static int token_matches_item(const char *tok, struct arg_item *item, int tok_le
  * distinguished from the non-well-formed-line case (in which this function
  * returns -1) because some callers of this function need such a distinction.
  */
-static int find_separator(const char *line, const char *separators)
+static ssize_t find_separator(const char *line, const char *separators)
 {
 	int whitespace_found = 0;
 	const char *c;
@@ -630,10 +630,10 @@ static int find_separator(const char *line, const char *separators)
  */
 static void parse_trailer(struct strbuf *tok, struct strbuf *val,
 			 const struct conf_info **conf, const char *trailer,
-			 int separator_pos)
+			 ssize_t separator_pos)
 {
 	struct arg_item *item;
-	int tok_len;
+	size_t tok_len;
 	struct list_head *pos;
 
 	if (separator_pos != -1) {
@@ -721,7 +721,7 @@ static void process_command_line_args(struct list_head *arg_head,
 	list_for_each(pos, new_trailer_head) {
 		struct new_trailer_item *tr =
 			list_entry(pos, struct new_trailer_item, list);
-		int separator_pos = find_separator(tr->text, cl_separators);
+		ssize_t separator_pos = find_separator(tr->text, cl_separators);
 
 		if (separator_pos == 0) {
 			struct strbuf sb = STRBUF_INIT;
@@ -763,9 +763,9 @@ static const char *next_line(const char *str)
 /*
  * Return the position of the start of the last line. If len is 0, return -1.
  */
-static int last_line(const char *buf, size_t len)
+static ssize_t last_line(const char *buf, size_t len)
 {
-	int i;
+	ssize_t i;
 	if (len == 0)
 		return -1;
 	if (len == 1)
@@ -788,7 +788,7 @@ static int last_line(const char *buf, size_t len)
  * Return the position of the start of the patch or the length of str if there
  * is no patch in the message.
  */
-static int find_patch_start(const char *str)
+static size_t find_patch_start(const char *str)
 {
 	const char *s;
 
@@ -804,10 +804,11 @@ static int find_patch_start(const char *str)
  * Return the position of the first trailer line or len if there are no
  * trailers.
  */
-static int find_trailer_start(const char *buf, size_t len)
+static size_t find_trailer_start(const char *buf, size_t len)
 {
 	const char *s;
-	int end_of_title, l, only_spaces = 1;
+	ssize_t end_of_title, l;
+	int only_spaces = 1;
 	int recognized_prefix = 0, trailer_lines = 0, non_trailer_lines = 0;
 	/*
 	 * Number of possible continuation lines encountered. This will be
@@ -838,7 +839,7 @@ static int find_trailer_start(const char *buf, size_t len)
 	     l = last_line(buf, l)) {
 		const char *bol = buf + l;
 		const char **p;
-		int separator_pos;
+		ssize_t separator_pos;
 
 		if (bol[0] == comment_line_char) {
 			non_trailer_lines += possible_continuation_lines;
@@ -899,14 +900,14 @@ static int find_trailer_start(const char *buf, size_t len)
 }
 
 /* Return the position of the end of the trailers. */
-static int find_trailer_end(const char *buf, size_t len)
+static size_t find_trailer_end(const char *buf, size_t len)
 {
 	return len - ignore_non_trailer(buf, len);
 }
 
 static int ends_with_blank_line(const char *buf, size_t len)
 {
-	int ll = last_line(buf, len);
+	ssize_t ll = last_line(buf, len);
 	if (ll < 0)
 		return 0;
 	return is_blank_line(buf + ll);
@@ -939,10 +940,10 @@ static void unfold_value(struct strbuf *val)
 	strbuf_release(&out);
 }
 
-static int process_input_file(FILE *outfile,
-			      const char *str,
-			      struct list_head *head,
-			      const struct process_trailer_options *opts)
+static size_t process_input_file(FILE *outfile,
+				 const char *str,
+				 struct list_head *head,
+				 const struct process_trailer_options *opts)
 {
 	struct trailer_info info;
 	struct strbuf tok = STRBUF_INIT;
@@ -1032,7 +1033,7 @@ void process_trailers(const char *file,
 {
 	LIST_HEAD(head);
 	struct strbuf sb = STRBUF_INIT;
-	int trailer_end;
+	size_t trailer_end;
 	FILE *outfile = stdout;
 
 	ensure_configured();
@@ -1132,7 +1133,7 @@ static void format_trailer_info(struct strbuf *out,
 
 	for (i = 0; i < info->trailer_nr; i++) {
 		char *trailer = info->trailers[i];
-		int separator_pos = find_separator(trailer, separators);
+		ssize_t separator_pos = find_separator(trailer, separators);
 
 		if (separator_pos >= 1) {
 			struct strbuf tok = STRBUF_INIT;
-- 
2.19.0.rc0.412.g7005db4e88
Previous: Jeff KingNext: Jeff King
Message 42 of 53 in “test-tool.h: include git-compat-util.h”
  1. test-tool.h: include git-compat-util.hJeff King, Aug 21, 2018
  2. Junio C HamanoAug 21, 2018
  3. 1/6 t/perf: factor boilerplate out of test_perfJeff King, Aug 21, 2018
  4. 2/6 t/perf: factor out percent calculationsJeff King, Aug 21, 2018
  5. 3/6 t/perf: add infrastructure for measuring sizesJeff King, Aug 21, 2018
  6. Derrick StoleeAug 22, 2018
  7. Jeff KingAug 22, 2018
  8. 4/6 t/perf: add perf tests for fetches from a bitmapped serverJeff King, Aug 21, 2018
  9. 5/6 pack-bitmap: save "have" bitmap from walkJeff King, Aug 21, 2018
  10. Derrick StoleeAug 21, 2018
  11. Jeff KingAug 21, 2018
  12. Ævar Arnfjörð BjarmasonAug 31, 2018
  13. Jeff KingAug 31, 2018
  14. 0/4 un-breaking pack-objects with bitmapsJeff King, Sep 1, 2018
  15. 1/4 bitmap_has_sha1_in_uninteresting(): drop BUG checkJeff King, Sep 1, 2018
  16. 2/4 t5310: test delta reuse with bitmapsJeff King, Sep 1, 2018
  17. Jeff KingSep 1, 2018
  18. Ævar Arnfjörð BjarmasonSep 1, 2018
  19. Ben PeartSep 1, 2018
  20. Jeff KingSep 2, 2018
  21. Stefan BellerSep 4, 2018
  22. Junio C HamanoSep 4, 2018
  23. Jeff KingSep 4, 2018
  24. 3/4 traverse_bitmap_commit_list(): don't free resultJeff King, Sep 1, 2018
  25. 4/4 pack-bitmap: drop "loaded" flagJeff King, Sep 1, 2018
  26. Stefan BellerSep 4, 2018
  27. Jeff KingSep 4, 2018
  28. Ævar Arnfjörð BjarmasonSep 8, 2018
  29. Junio C HamanoSep 10, 2018
  30. Jeff KingSep 10, 2018
  31. Junio C HamanoSep 10, 2018
  32. 6/6 pack-objects: reuse on-disk deltas for thin "have" objectsJeff King, Aug 21, 2018
  33. Junio C HamanoAug 21, 2018
  34. Junio C HamanoAug 21, 2018
  35. Jeff KingAug 21, 2018
  36. Jeff KingAug 21, 2018
  37. Junio C HamanoAug 21, 2018
  38. Jeff KingAug 21, 2018
  39. Junio C HamanoAug 21, 2018
  40. Jeff KingAug 21, 2018
  41. 0/9 trailer-parsing false positivesJeff King, Aug 23, 2018
  42. 1/9 trailer: use size_t for string offsetsJeff King, Aug 23, 2018
  43. 2/9 trailer: use size_t for iterating trailer listJeff King, Aug 23, 2018
  44. 3/9 trailer: pass process_trailer_opts to trailer_info_get()Jeff King, Aug 23, 2018
  45. 4/9 interpret-trailers: tighten check for "---" patch boundaryJeff King, Aug 23, 2018
  46. 5/9 interpret-trailers: allow suppressing "---" dividerJeff King, Aug 23, 2018
  47. 6/9 pretty, ref-filter: format %(trailers) with no_divider optionJeff King, Aug 23, 2018
  48. 7/9 sequencer: ignore "---" divider when parsing trailersJeff King, Aug 23, 2018
  49. 8/9 append_signoff: use size_t for string offsetsJeff King, Aug 23, 2018
  50. 9/9 sequencer: handle ignore_footer when parsing trailersJeff King, Aug 23, 2018
  51. Junio C HamanoAug 23, 2018
  52. Jeff KingAug 24, 2018
  53. Jeff KingAug 21, 2018

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.