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

[PATCH 55/68] color: add overflow checks for parsing colors

From
Jeff King <peff@peff.net>
Date
Sep 24, 2015, 21:08 UTC
Message-ID
<20150924210807.GZ30946@sigill.intra.peff.net>
In-Reply-To
<20150924210225.GA23624@sigill.intra.peff.net>

Our color parsing is designed to never exceed COLOR_MAXLEN bytes. But the relationship between that hand-computed number and the parsing code is not at all obvious, and we merely hope that it has been computed correctly for all cases.

Let's mark the expected "end" pointer for the destination buffer and make sure that we do not exceed it.

Signed-off-by: Jeff King <peff@peff.net>
---
 color.c | 41 ++++++++++++++++++++++++++---------------
 1 file changed, 26 insertions(+), 15 deletions(-)
diff --git a/color.c b/color.c
index 9027352..22782f8 100644
--- a/color.c
+++ b/color.c
@@ -150,22 +150,24 @@ int color_parse(const char *value, char *dst)
  * already have the ANSI escape code in it. "out" should have enough
  * space in it to fit any color.
  */
-static char *color_output(char *out, const struct color *c, char type)
+static char *color_output(char *out, int len, const struct color *c, char type)
 {
 	switch (c->type) {
 	case COLOR_UNSPECIFIED:
 	case COLOR_NORMAL:
 		break;
 	case COLOR_ANSI:
+		if (len < 2)
+			die("BUG: color parsing ran out of space");
 		*out++ = type;
 		*out++ = '0' + c->value;
 		break;
 	case COLOR_256:
-		out += sprintf(out, "%c8;5;%d", type, c->value);
+		out += xsnprintf(out, len, "%c8;5;%d", type, c->value);
 		break;
 	case COLOR_RGB:
-		out += sprintf(out, "%c8;2;%d;%d;%d", type,
-			       c->red, c->green, c->blue);
+		out += xsnprintf(out, len, "%c8;2;%d;%d;%d", type,
+				 c->red, c->green, c->blue);
 		break;
 	}
 	return out;
@@ -180,12 +182,13 @@ int color_parse_mem(const char *value, int value_len, char *dst)
 {
 	const char *ptr = value;
 	int len = value_len;
+	char *end = dst + COLOR_MAXLEN;
 	unsigned int attr = 0;
 	struct color fg = { COLOR_UNSPECIFIED };
 	struct color bg = { COLOR_UNSPECIFIED };
 
 	if (!strncasecmp(value, "reset", len)) {
-		strcpy(dst, GIT_COLOR_RESET);
+		xsnprintf(dst, end - dst, GIT_COLOR_RESET);
 		return 0;
 	}
 
@@ -224,12 +227,19 @@ int color_parse_mem(const char *value, int value_len, char *dst)
 			goto bad;
 	}
 
+#undef OUT
+#define OUT(x) do { \
+	if (dst == end) \
+		die("BUG: color parsing ran out of space"); \
+	*dst++ = (x); \
+} while(0)
+
 	if (attr || !color_empty(&fg) || !color_empty(&bg)) {
 		int sep = 0;
 		int i;
 
-		*dst++ = '\033';
-		*dst++ = '[';
+		OUT('\033');
+		OUT('[');
 
 		for (i = 0; attr; i++) {
 			unsigned bit = (1 << i);
@@ -237,27 +247,28 @@ int color_parse_mem(const char *value, int value_len, char *dst)
 				continue;
 			attr &= ~bit;
 			if (sep++)
-				*dst++ = ';';
-			dst += sprintf(dst, "%d", i);
+				OUT(';');
+			dst += xsnprintf(dst, end - dst, "%d", i);
 		}
 		if (!color_empty(&fg)) {
 			if (sep++)
-				*dst++ = ';';
+				OUT(';');
 			/* foreground colors are all in the 3x range */
-			dst = color_output(dst, &fg, '3');
+			dst = color_output(dst, end - dst, &fg, '3');
 		}
 		if (!color_empty(&bg)) {
 			if (sep++)
-				*dst++ = ';';
+				OUT(';');
 			/* background colors are all in the 4x range */
-			dst = color_output(dst, &bg, '4');
+			dst = color_output(dst, end - dst, &bg, '4');
 		}
-		*dst++ = 'm';
+		OUT('m');
 	}
-	*dst = 0;
+	OUT(0);
 	return 0;
 bad:
 	return error(_("invalid color value: %.*s"), value_len, value);
+#undef OUT
 }
 
 int git_config_colorbool(const char *var, const char *value)
-- 
2.6.0.rc3.454.g204ad51
Previous: Jeff KingNext: Jeff King
Message 74 of 93 in “war on sprintf”
  1. 0/68 war on sprintfJeff King, Sep 24, 2015
  2. 01/68 show-branch: avoid segfault with --reflog of unborn branchJeff King, Sep 24, 2015
  3. 02/68 mailsplit: fix FILE* leak in split_maildirJeff King, Sep 24, 2015
  4. 03/68 archive-tar: fix minor indentation violationJeff King, Sep 24, 2015
  5. 04/68 fsck: don't fsck alternates for connectivity-only checkJeff King, Sep 24, 2015
  6. 05/68 add xsnprintf helper functionJeff King, Sep 24, 2015
  7. 06/68 add git_path_buf helper functionJeff King, Sep 24, 2015
  8. 07/68 strbuf: make strbuf_complete_line more genericJeff King, Sep 24, 2015
  9. 08/68 add reentrant variants of sha1_to_hex and find_unique_abbrevJeff King, Sep 24, 2015
  10. 09/68 fsck: use strbuf to generate alternate directoriesJeff King, Sep 24, 2015
  11. 10/68 mailsplit: make PATH_MAX buffers dynamicJeff King, Sep 24, 2015
  12. 11/68 trace: use strbuf for quote_crnl outputJeff King, Sep 24, 2015
  13. 12/68 progress: store throughput display in a strbufJeff King, Sep 24, 2015
  14. 13/68 test-dump-cache-tree: avoid overflow of cache-tree nameJeff King, Sep 24, 2015
  15. 14/68 compat/inet_ntop: fix off-by-one in inet_ntop4Jeff King, Sep 24, 2015
  16. 15/68 convert trivial sprintf / strcpy calls to xsnprintfJeff King, Sep 24, 2015
  17. 16/68 archive-tar: use xsnprintf for trivial formattingJeff King, Sep 24, 2015
  18. 17/68 use xsnprintf for generating git object headersJeff King, Sep 24, 2015
  19. 18/68 find_short_object_filename: convert sprintf to xsnprintfJeff King, Sep 24, 2015
  20. 19/68 stop_progress_msg: convert sprintf to xsnprintfJeff King, Sep 24, 2015
  21. 20/68 compat/hstrerror: convert sprintf to snprintfJeff King, Sep 24, 2015
  22. 21/68 grep: use xsnprintf to format failure messageJeff King, Sep 24, 2015
  23. 22/68 entry.c: convert strcpy to xsnprintfJeff King, Sep 24, 2015
  24. 23/68 add_packed_git: convert strcpy into xsnprintfJeff King, Sep 24, 2015
  25. 24/68 http-push: replace strcat with xsnprintfJeff King, Sep 24, 2015
  26. 25/68 receive-pack: convert strncpy to xsnprintfJeff King, Sep 24, 2015
  27. 26/68 replace trivial malloc + sprintf / strcpy calls with xstrfmtJeff King, Sep 24, 2015
  28. 27/68 config: use xstrfmt in normalize_valueJeff King, Sep 24, 2015
  29. 28/68 fetch: replace static buffer with xstrfmtJeff King, Sep 24, 2015
  30. 29/68 use strip_suffix and xstrfmt to replace suffixJeff King, Sep 24, 2015
  31. 30/68 ref-filter: drop sprintf and strcpy callsJeff King, Sep 24, 2015
  32. 31/68 help: drop prepend function in favor of xstrfmtJeff King, Sep 24, 2015
  33. 32/68 mailmap: replace strcpy with xstrdupJeff King, Sep 24, 2015
  34. 33/68 read_branches_file: simplify string handlingJeff King, Sep 24, 2015
  35. 34/68 read_remotes_file: simplify string handlingJeff King, Sep 24, 2015
  36. 35/68 resolve_ref: use strbufs for internal buffersJeff King, Sep 24, 2015
  37. 36/68 upload-archive: convert sprintf to strbufJeff King, Sep 24, 2015
  38. 37/68 remote-ext: simplify git pkt-line generationJeff King, Sep 24, 2015
  39. 38/68 http-push: use strbuf instead of fwrite_bufferJeff King, Sep 24, 2015
  40. 39/68 http-walker: store url in a strbufJeff King, Sep 24, 2015
  41. 40/68 sha1_get_pack_name: use a strbufJeff King, Sep 24, 2015
  42. 41/68 init: use strbufs to store pathsJeff King, Sep 24, 2015
  43. Michael BlumeSep 29, 2015
  44. Jeff KingSep 30, 2015
  45. Junio C HamanoSep 30, 2015
  46. Jeff KingOct 1, 2015
  47. Torsten BögershausenOct 2, 2015
  48. Jeff KingOct 2, 2015
  49. Torsten BögershausenOct 3, 2015
  50. Junio C HamanoOct 3, 2015
  51. Torsten BögershausenOct 3, 2015
  52. Jeff KingOct 4, 2015
  53. Torsten BögershausenOct 4, 2015
  54. Jeff KingOct 5, 2015
  55. 1/3 precompose_utf8: drop unused variableJeff King, Oct 5, 2015
  56. Torsten BögershausenOct 6, 2015
  57. 2/3 probe_utf8_pathname_composition: use internal strbufJeff King, Oct 5, 2015
  58. 3/3 init: use strbufs to store pathsJeff King, Oct 5, 2015
  59. 42/68 apply: convert root string to strbufJeff King, Sep 24, 2015
  60. 43/68 transport: use strbufs for status table "quickref" stringsJeff King, Sep 24, 2015
  61. 44/68 merge-recursive: convert malloc / strcpy to strbufJeff King, Sep 24, 2015
  62. 45/68 enter_repo: convert fixed-size buffers to strbufsJeff King, Sep 24, 2015
  63. 46/68 remove_leading_path: use a strbuf for internal storageJeff King, Sep 24, 2015
  64. 47/68 write_loose_object: convert to strbufJeff King, Sep 24, 2015
  65. 48/68 diagnose_invalid_index_path: use strbuf to avoid strcpy/strcatJeff King, Sep 24, 2015
  66. 49/68 fetch-pack: use argv_array for index-pack / unpack-objectsJeff King, Sep 24, 2015
  67. 50/68 http-push: use an argv_array for setup_revisionsJeff King, Sep 24, 2015
  68. 51/68 stat_tracking_info: convert to argv_arrayJeff King, Sep 24, 2015
  69. 52/68 daemon: use cld->env_array when re-spawningJeff King, Sep 24, 2015
  70. 53/68 use sha1_to_hex_r() instead of strcpyJeff King, Sep 24, 2015
  71. 54/68 drop strcpy in favor of raw sha1_to_hexJeff King, Sep 24, 2015
  72. Eric SunshineSep 24, 2015
  73. Jeff KingSep 25, 2015
  74. 55/68 color: add overflow checks for parsing colorsJeff King, Sep 24, 2015
  75. 56/68 use alloc_ref rather than hand-allocating "struct ref"Jeff King, Sep 24, 2015
  76. 57/68 avoid sprintf and strcpy with flex arraysJeff King, Sep 24, 2015
  77. 58/68 receive-pack: simplify keep_arg computationJeff King, Sep 24, 2015
  78. 59/68 help: clean up kfmclient mungingJeff King, Sep 24, 2015
  79. 60/68 prefer memcpy to strcpyJeff King, Sep 24, 2015
  80. René ScharfeSep 27, 2015
  81. Torsten BögershausenSep 27, 2015
  82. René ScharfeSep 27, 2015
  83. René ScharfeSep 27, 2015
  84. Rasmus VillemoesSep 28, 2015
  85. 61/68 color: add color_set helper for copying raw colorsJeff King, Sep 24, 2015
  86. 62/68 notes: document length of fanout path with a constantJeff King, Sep 24, 2015
  87. 63/68 convert strncpy to memcpyJeff King, Sep 24, 2015
  88. 64/68 fsck: drop inode-sorting codeJeff King, Sep 24, 2015
  89. 65/68 Makefile: drop D_INO_IN_DIRENT build knobJeff King, Sep 24, 2015
  90. 66/68 fsck: use for_each_loose_file_in_objdirJeff King, Sep 24, 2015
  91. Jeff KingSep 26, 2015
  92. 67/68 use strbuf_complete to conditionally append slashJeff King, Sep 24, 2015
  93. 68/68 name-rev: use strip_suffix to avoid magic numbersJeff King, Sep 24, 2015

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.