Skip to contentSkip to conversation

btrfs-progs: mkfs: fix xattr enumeration

PATCH In review Vladimir Panteleev 3 participants 5 messages Sep 6, 2019 – Sep 9, 2019 Btrfs file system

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 btrfs-progs: mkfs: fix xattr enumeration

Use the return value of listxattr instead of tokenizing.

The end of the extended attribute list is indicated by the return value, not an empty list item (two consecutive NULs). Using strtok in this way thus sometimes caused add_xattr_item to reuse stack data in xattr_list from the previous invocation, thus querying attributes that are not actually in the file's xattr list.

Issue: #194

---
 mkfs/rootdir.c | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
mkfs/rootdir.c +5 -6
index 51411e02..c86159e7 100644
@@ -228,10 +228,9 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 	int ret;
 	int cur_name_len;
 	char xattr_list[XATTR_LIST_MAX];
+	char *xattr_list_end;
 	char *cur_name;
 	char cur_value[XATTR_SIZE_MAX];
-	char delimiter = '\0';
-	char *next_location = xattr_list;
 
 	ret = llistxattr(file_name, xattr_list, XATTR_LIST_MAX);
 	if (ret < 0) {
@@ -243,10 +242,10 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 	if (ret == 0)
 		return ret;
 
-	cur_name = strtok(xattr_list, &delimiter);
-	while (cur_name != NULL) {
+	xattr_list_end = xattr_list + ret;
+	cur_name = xattr_list;
+	while (cur_name < xattr_list_end) {
 		cur_name_len = strlen(cur_name);
-		next_location += cur_name_len + 1;
 
 		ret = lgetxattr(file_name, cur_name, cur_value, XATTR_SIZE_MAX);
 		if (ret < 0) {
@@ -266,7 +265,7 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 					file_name);
 		}
 
-		cur_name = strtok(next_location, &delimiter);
+		cur_name += cur_name_len + 1;
 	}
 
 	return ret;
Signature · 1 line
2.23.0
#1 lore raw
Quoted 10 lines · Vladimir Panteleev

Use the return value of listxattr instead of tokenizing.

The end of the extended attribute list is indicated by the return value, not an empty list item (two consecutive NULs). Using strtok in this way thus sometimes caused add_xattr_item to reuse stack data in xattr_list from the previous invocation, thus querying attributes that are not actually in the file's xattr list.

Issue: #194

Can you elaborate how to trigger this? I tried by creating a folder with 2 files and set 5 xattr to the first file and 1 to the second. Then I run mkfs.btrfs -r /path/to/dir /dev/vdc and stepped through the code with gdb and didn't see any issues. Ideally I'd like to see a regression test for this issue.

Your code looks correct.

Quoted 44 lines
---
 mkfs/rootdir.c | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
mkfs/rootdir.c +5 -6
index 51411e02..c86159e7 100644
@@ -228,10 +228,9 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 	int ret;
 	int cur_name_len;
 	char xattr_list[XATTR_LIST_MAX];
+	char *xattr_list_end;
 	char *cur_name;
 	char cur_value[XATTR_SIZE_MAX];
-	char delimiter = '\0';
-	char *next_location = xattr_list;
 
 	ret = llistxattr(file_name, xattr_list, XATTR_LIST_MAX);
 	if (ret < 0) {
@@ -243,10 +242,10 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 	if (ret == 0)
 		return ret;
 
-	cur_name = strtok(xattr_list, &delimiter);
-	while (cur_name != NULL) {
+	xattr_list_end = xattr_list + ret;
+	cur_name = xattr_list;
+	while (cur_name < xattr_list_end) {
 		cur_name_len = strlen(cur_name);
-		next_location += cur_name_len + 1;
 
 		ret = lgetxattr(file_name, cur_name, cur_value, XATTR_SIZE_MAX);
 		if (ret < 0) {
@@ -266,7 +265,7 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
 					file_name);
 		}
 
-		cur_name = strtok(next_location, &delimiter);
+		cur_name += cur_name_len + 1;
 	}
 
 	return ret;
#2 lore raw

Hi Nikolay,

Unfortunately, as I mentioned in the issue, I have also been unable to reproduce this issue locally.

Please see here:
https://github.com/kdave/btrfs-progs/issues/194

The reporter tested the patch and confirmed that it worked. Additionally, they have provided strace output which appears to confirm that the bug description in the patch commit message indeed corresponds to the behavior they are observing on their machine.

Perhaps the issue might be reproducible in an environment closer to the reporter's (looks like some Fedora distro judging by the uname).

Quoted 67 lines · Nikolay Borisov
Quoted 10 lines · Vladimir Panteleev

Use the return value of listxattr instead of tokenizing.

The end of the extended attribute list is indicated by the return value, not an empty list item (two consecutive NULs). Using strtok in this way thus sometimes caused add_xattr_item to reuse stack data in xattr_list from the previous invocation, thus querying attributes that are not actually in the file's xattr list.

Issue: #194

Can you elaborate how to trigger this? I tried by creating a folder with 2 files and set 5 xattr to the first file and 1 to the second. Then I run mkfs.btrfs -r /path/to/dir /dev/vdc and stepped through the code with gdb and didn't see any issues. Ideally I'd like to see a regression test for this issue.

Your code looks correct.

Quoted 44 lines
---
 mkfs/rootdir.c | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
mkfs/rootdir.c +5 -6
index 51411e02..c86159e7 100644
@@ -228,10 +228,9 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
      int ret;
      int cur_name_len;
      char xattr_list[XATTR_LIST_MAX];
+     char *xattr_list_end;
      char *cur_name;
      char cur_value[XATTR_SIZE_MAX];
-     char delimiter = '\0';
-     char *next_location = xattr_list;
 
      ret = llistxattr(file_name, xattr_list, XATTR_LIST_MAX);
      if (ret < 0) {
@@ -243,10 +242,10 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
      if (ret == 0)
              return ret;
 
-     cur_name = strtok(xattr_list, &delimiter);
-     while (cur_name != NULL) {
+     xattr_list_end = xattr_list + ret;
+     cur_name = xattr_list;
+     while (cur_name < xattr_list_end) {
              cur_name_len = strlen(cur_name);
-             next_location += cur_name_len + 1;
 
              ret = lgetxattr(file_name, cur_name, cur_value, XATTR_SIZE_MAX);
              if (ret < 0) {
@@ -266,7 +265,7 @@ static int add_xattr_item(struct btrfs_trans_handle *trans,
                                      file_name);
              }
 
-             cur_name = strtok(next_location, &delimiter);
+             cur_name += cur_name_len + 1;
      }
 
      return ret;
Reviewed-by
#3 lore raw
Quoted 8 lines · Vladimir Panteleev

Hi Nikolay,

Unfortunately, as I mentioned in the issue, I have also been unable to reproduce this issue locally.

Please see here:
https://github.com/kdave/btrfs-progs/issues/194

Quoted 7 lines

The reporter tested the patch and confirmed that it worked. Additionally, they have provided strace output which appears to confirm that the bug description in the patch commit message indeed corresponds to the behavior they are observing on their machine.

Perhaps the issue might be reproducible in an environment closer to the reporter's (looks like some Fedora distro judging by the uname).

Right, looking at the kernel portion listxattr just copies the attribute names into the passed user pointer. So if the data copied is less than XATTR_LIST_MAX then the data beyond the return value of llistxattr is undefined which could cause the described problem.

I agree that your code is more correct as it handles data only in the range [0...ret].

Consider this patch:

#4 lore raw
In reply to Vladimir Panteleev
Quoted 10 lines · Vladimir Panteleev

Use the return value of listxattr instead of tokenizing.

The end of the extended attribute list is indicated by the return value, not an empty list item (two consecutive NULs). Using strtok in this way thus sometimes caused add_xattr_item to reuse stack data in xattr_list from the previous invocation, thus querying attributes that are not actually in the file's xattr list.

Issue: #194

Added to devel, thanks.