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

Re: [PATCH v3 1/4] real_path: resolve symlinks by hand

From
BWBrandon Williams <bmwill@google.com>
Date
Dec 12, 2016, 22:50 UTC
Message-ID
<20161212225006.GB193413@google.com>
In-Reply-To
<xmqqd1gw94f1.fsf@gitster.mtv.corp.google.com>
On 12/12, Junio C Hamano wrote:
Show 25 quoted lines
> Brandon Williams <bmwill@google.com> writes:
> 
> > +/* removes the last path component from 'path' except if 'path' is root */
> > +static void strip_last_component(struct strbuf *path)
> > +{
> > +	size_t offset = offset_1st_component(path->buf);
> > +	size_t len = path->len;
> > +
> > +	/* Find start of the last component */
> > +	while (offset < len && !is_dir_sep(path->buf[len - 1]))
> > +		len--;
> 
> If somebody at a higher level in the callchain has already
> normalized path, this is not a problem, but this will behave
> "unexpectedly" when path ends with a dir_sep byte (or more).
> 
> E.g. for input path "foo/bar/", the above loop runs zero times and
> then ...
> 
> > +	/* Skip sequences of multiple path-separators */
> > +	while (offset < len && is_dir_sep(path->buf[len - 1]))
> > +		len--;
> 
> ... the slash at the end is removed, leaving "foo/bar" in path.
> 

The way this is currently used I don't believe this scenario can happen (since input to this shouldn't have trailing slashes), but if others begin to use this function then yes, that is an implicit assumption. I think it may be an ok assumption though since this is only called on "resolved" which is the ouput and needs to be normalized to begin with. To fix this we could simply add the while loop that strips dir_sep at the beginning as well as at the end, like so:

  /* Skip sequences of multiple path-separators */
  while (offset < len && is_dir_sep(path->buf[len - 1]))
  	len--;
  /* Skip sequences of multiple path-separators */
  while (offset < len && !is_dir_sep(path->buf[len - 1]))
  	len--;
  /* Skip sequences of multiple path-separators */
  while (offset < len && is_dir_sep(path->buf[len - 1]))
  	len--;
Show 66 quoted lines
> > +	strbuf_setlen(path, len);
> > +}
> > ...
> > +/* get (and remove) the next component in 'remaining' and place it in 'next' */
> > +static void get_next_component(struct strbuf *next, struct strbuf *remaining)
> > +{
> > +	char *start = NULL;
> > +	char *end = NULL;
> > +
> > +	strbuf_reset(next);
> > +
> > +	/* look for the next component */
> > +	/* Skip sequences of multiple path-separators */
> > +	for (start = remaining->buf; is_dir_sep(*start); start++)
> > +		; /* nothing */
> > +	/* Find end of the path component */
> > +	for (end = start; *end && !is_dir_sep(*end); end++)
> > +		; /* nothing */
> > +
> > +	strbuf_add(next, start, end - start);
> > +	/* remove the component from 'remaining' */
> > +	strbuf_remove(remaining, 0, end - remaining->buf);
> > +}
> 
> Unlike the strip_last_component(), I think this one is more
> carefully done and avoids getting fooled by //extra//slashes// at
> the beginning or at the end, which does help in the correctness of
> the loop we see below.
> 
> > @@ -58,74 +88,112 @@ static const char *real_path_internal(const char *path, int die_on_error)
> >  			goto error_out;
> >  	}
> >  
> > +	strbuf_reset(&resolved);
> > +
> > +	if (is_absolute_path(path)) {
> > +		/* absolute path; start with only root as being resolved */
> > +		int offset = offset_1st_component(path);
> > +		strbuf_add(&resolved, path, offset);
> > +		strbuf_addstr(&remaining, path + offset);
> > +	} else {
> > +		/* relative path; can use CWD as the initial resolved path */
> > +		if (strbuf_getcwd(&resolved)) {
> > +			if (die_on_error)
> > +				die_errno("unable to get current working directory");
> > +			else
> > +				goto error_out;
> >  		}
> > +		strbuf_addstr(&remaining, path);
> > +	}
> >  
> > +	/* Iterate over the remaining path components */
> > +	while (remaining.len > 0) {
> > +		get_next_component(&next, &remaining);
> > +
> > +		if (next.len == 0) {
> > +			continue; /* empty component */
> > +		} else if (next.len == 1 && !strcmp(next.buf, ".")) {
> > +			continue; /* '.' component */
> > +		} else if (next.len == 2 && !strcmp(next.buf, "..")) {
> > +			/* '..' component; strip the last path component */
> > +			strip_last_component(&resolved);
> 
> Wouldn't this let "resolved" eventually run out of the path
> components to strip for a malformed input e.g. "/a/../../b"?
> 

As I understand it, that path is correct and would resolve to "/b". The strip_last_component function doesn't allow striping the "1st" component or the "root" component. So if resolved is "/" and we encounter a ".." which requires striping of the last component, the result would be "/".

Show 14 quoted lines
> > + ...
> > +			/*
> > +			 * if there are still remaining components to resolve
> > +			 * then append them to symlink
> > +			 */
> > +			if (remaining.len) {
> > +				strbuf_addch(&symlink, '/');
> 
> This can add duplicate dir_sep if readlink(2)'ed contents of the
> symbolic link already ends with a slash, but I think it (together
> with the fact that the code does nothing to normalize what is read
> from the symbolic link) probably does not matter, given the way how
> get_next_component() is implemented.
> 

Yes, I think the way get_next_component() is written will account for non-normalized symlink contents. This way we only have to worry about normalizing input in one location (maybe two with strip_last_component()).

Show 21 quoted lines
> > +				strbuf_addbuf(&symlink, &remaining);
> > +			}
> > +
> > +			/*
> > +			 * use the symlink as the remaining components that
> > +			 * need to be resloved
> > +			 */
> > +			strbuf_swap(&symlink, &remaining);
> > +		}
> >  	}
> >  
> > +	retval = resolved.buf;
> > +
> >  error_out:
> > +	strbuf_release(&remaining);
> > +	strbuf_release(&next);
> > +	strbuf_release(&symlink);
> >  
> >  	return retval;
> >  }
> 
-- 
Brandon Williams
Previous: Junio C HamanoNext: Junio C Hamano
Message 38 of 83 in “making real_path thread-safe”
  1. making real_path thread-safeBrandon Williams, Dec 5, 2016
  2. real_path: make real_path thread-safeBrandon Williams, Dec 5, 2016
  3. Stefan BellerDec 5, 2016
  4. Brandon WilliamsDec 5, 2016
  5. Stefan BellerDec 5, 2016
  6. Stefan BellerDec 5, 2016
  7. Brandon WilliamsDec 5, 2016
  8. Duy NguyenDec 8, 2016
  9. Brandon WilliamsDec 8, 2016
  10. Junio C HamanoDec 6, 2016
  11. Brandon WilliamsDec 7, 2016
  12. Ramsay JonesDec 7, 2016
  13. Torsten BögershausenDec 7, 2016
  14. Junio C HamanoDec 7, 2016
  15. Brandon WilliamsDec 7, 2016
  16. Torsten BögershausenDec 8, 2016
  17. Johannes SixtDec 8, 2016
  18. Brandon WilliamsDec 8, 2016
  19. Johannes SixtDec 7, 2016
  20. Brandon WilliamsDec 7, 2016
  21. Johannes SixtDec 8, 2016
  22. Junio C HamanoDec 8, 2016
  23. 0/4 road to reentrant real_pathBrandon Williams, Dec 8, 2016
  24. 1/4 real_path: resolve symlinks by handBrandon Williams, Dec 8, 2016
  25. Jacob KellerDec 9, 2016
  26. Johannes SixtDec 9, 2016
  27. Brandon WilliamsDec 9, 2016
  28. 2/4 real_path: convert real_path_internal to strbuf_realpathBrandon Williams, Dec 8, 2016
  29. 3/4 real_path: create real_pathdupBrandon Williams, Dec 8, 2016
  30. Johannes SixtDec 9, 2016
  31. 4/4 real_path: have callers use real_pathdup and strbuf_realpathBrandon Williams, Dec 8, 2016
  32. Duy NguyenDec 9, 2016
  33. Brandon WilliamsDec 9, 2016
  34. Duy NguyenDec 10, 2016
  35. 0/4 road to reentrant real_pathBrandon Williams, Dec 12, 2016
  36. 1/4 real_path: resolve symlinks by handBrandon Williams, Dec 12, 2016
  37. Junio C HamanoDec 12, 2016
  38. Brandon WilliamsDec 12, 2016
  39. Junio C HamanoDec 12, 2016
  40. 4/4 real_path: have callers use real_pathdup and strbuf_realpathBrandon Williams, Dec 12, 2016
  41. Junio C HamanoDec 12, 2016
  42. Junio C HamanoDec 12, 2016
  43. Stefan BellerDec 12, 2016
  44. Brandon WilliamsDec 13, 2016
  45. Junio C HamanoDec 13, 2016
  46. 2/4 real_path: convert real_path_internal to strbuf_realpathBrandon Williams, Dec 12, 2016
  47. Junio C HamanoDec 12, 2016
  48. 3/4 real_path: create real_pathdupBrandon Williams, Dec 12, 2016
  49. Junio C HamanoDec 12, 2016
  50. real_path: canonicalize directory separators in root partsJohannes Sixt, Dec 21, 2016
  51. Brandon WilliamsDec 21, 2016
  52. Johannes SixtDec 22, 2016
  53. Brandon WilliamsDec 22, 2016
  54. Johannes SixtDec 22, 2016
  55. Junio C HamanoDec 22, 2016
  56. 0/5 road to reentrant real_pathBrandon Williams, Jan 3, 2017
  57. 2/5 real_path: convert real_path_internal to strbuf_realpathBrandon Williams, Jan 3, 2017
  58. 4/5 real_path: have callers use real_pathdup and strbuf_realpathBrandon Williams, Jan 3, 2017
  59. Jacob KellerJan 4, 2017
  60. Brandon WilliamsJan 4, 2017
  61. 5/5 real_path: canonicalize directory separators in root partsBrandon Williams, Jan 3, 2017
  62. 1/5 real_path: resolve symlinks by handBrandon Williams, Jan 3, 2017
  63. 3/5 real_path: create real_pathdupBrandon Williams, Jan 3, 2017
  64. Jeff KingJan 4, 2017
  65. Torsten BögershausenJan 4, 2017
  66. Jeff KingJan 4, 2017
  67. Brandon WilliamsJan 4, 2017
  68. Stefan BellerJan 4, 2017
  69. Jacob KellerJan 4, 2017
  70. Brandon WilliamsJan 4, 2017
  71. 0/5 road to reentrant real_pathBrandon Williams, Jan 4, 2017
  72. 3/5 real_path: create real_pathdupBrandon Williams, Jan 4, 2017
  73. 4/5 real_path: have callers use real_pathdup and strbuf_realpathBrandon Williams, Jan 4, 2017
  74. 5/5 real_path: canonicalize directory separators in root partsBrandon Williams, Jan 4, 2017
  75. 2/5 real_path: convert real_path_internal to strbuf_realpathBrandon Williams, Jan 4, 2017
  76. 1/5 real_path: resolve symlinks by handBrandon Williams, Jan 4, 2017
  77. Junio C HamanoJan 8, 2017
  78. Brandon WilliamsJan 9, 2017
  79. Junio C HamanoJan 9, 2017
  80. Brandon WilliamsJan 9, 2017
  81. Junio C HamanoJan 9, 2017
  82. 1/2 real_path: prevent redefinition of MAXSYMLINKSBrandon Williams, Jan 9, 2017
  83. 2/2 real_path: set errno when max number of symlinks is exceededBrandon Williams, Jan 9, 2017

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.