Skip to contentSkip to conversation

index-helper: take extra care with readlink

PATCH In review Ramsay Jones 3 participants 3 messages Jun 16, 2016

lore
Share & tools
lore
#0 lore raw

PATCH 3/3 index-helper: take extra care with readlink

It took me a few minutes to convince myself that, if index-helper is the only writer for the symlink, that the call to readlink would result in a properly NULL terminated string. This relies on the initialization of the address variable setting each byte of the 'struct sockaddr_un' to zero and the contents of the symlink being no more than 'sizeof(address.sun_path) - 1' bytes long.

In order to make the call easier to reason about, introduce a wrapper function, read_link(), which copes with overlong symlinks and ensures correct NULL termination.

---
 read-cache.c | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
read-cache.c +12 -1
index c7053d8..39330a1 100644
@@ -1722,12 +1722,23 @@ static void post_read_index_from(struct index_state *istate)
 	tweak_untracked_cache(istate);
 }
 
+static int read_link(const char *path, char *buf, size_t bufsize)
+{
+	int len;
+
+	len = readlink(path, buf, bufsize);
+	if (len < 0 || len >= bufsize)
+		return -1;
+	buf[len] = '\0';
+	return 0;
+}
+
 int connect_to_index_helper(void)
 {
 	struct sockaddr_un address = {0};
 	int fd;
 
-	if (readlink(git_path("index-helper.path"), address.sun_path,
+	if (read_link(git_path("index-helper.path"), address.sun_path,
 		     sizeof(address.sun_path)) < 0)
 		return -1;
 
Signature · 1 line
2.8.0
#1 lore raw
Quoted 46 lines · Ramsay Jones

It took me a few minutes to convince myself that, if index-helper is the only writer for the symlink, that the call to readlink would result in a properly NULL terminated string. This relies on the initialization of the address variable setting each byte of the 'struct sockaddr_un' to zero and the contents of the symlink being no more than 'sizeof(address.sun_path) - 1' bytes long.

In order to make the call easier to reason about, introduce a wrapper function, read_link(), which copes with overlong symlinks and ensures correct NULL termination.

---
 read-cache.c | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
read-cache.c +12 -1
index c7053d8..39330a1 100644
@@ -1722,12 +1722,23 @@ static void post_read_index_from(struct
 index_state *istate)
 	tweak_untracked_cache(istate);
 }
 
+static int read_link(const char *path, char *buf, size_t bufsize)
+{
+	int len;
+
+	len = readlink(path, buf, bufsize);
+	if (len < 0 || len >= bufsize)
+		return -1;
+	buf[len] = '\0';
+	return 0;
+}
+
 int connect_to_index_helper(void)
 {
 	struct sockaddr_un address = {0};
 	int fd;
 
-	if (readlink(git_path("index-helper.path"),
 address.sun_path,
+	if (read_link(git_path("index-helper.path"),
 address.sun_path,

read-cache.c static void post_read_index_from(struct index_state *istate) · line 1743

Quoted 2 lines
read-cache.c +0 -0
 		     sizeof(address.sun_path)) < 0)
 		return -1;

Will squash.

#2 lore raw
In reply to Ramsay Jones
Quoted 4 lines · Ramsay Jones

It took me a few minutes to convince myself that, if index-helper is the only writer for the symlink, that the call to readlink would result in a properly NULL terminated string. This relies on the

Minor nit:
s/NULL/NUL/