Skip to contentSkip to conversation

hfsplus: validate thread record before delete key rebuild

PATCH Superseded Kyle Zeng 2 participants 3 messages Jul 7 – Jul 9

Subsystems (2)

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Kyle Zeng

author
#0 lore raw

PATCH v4 1/1 hfsplus: validate thread record before delete key rebuild

hfsplus_delete_cat() is called with str == NULL when the last open reference to an unlinked HFS+ hardlink backing inode is closed. In that case, the function finds the catalog thread by CNID and rebuilds the catalog key from thread.nodeName.

That reconstruction path reads thread.nodeName.length directly from the catalog B-tree into fd.search_key and then copies length * 2 bytes into fd.search_key->cat.name.unicode. It does not first check that the found record is a thread record, that the record size matches the thread name length, or that nodeName.length fits in the fixed HFS+ catalog key buffer.

A corrupted image can therefore provide an oversized thread name length and make hfs_bnode_read() write past the catalog search-key allocation.

Read the CNID record through hfsplus_brec_read_cat(), which performs the hfs_brec_find() lookup via hfs_brec_read() before validating the catalog record. Reject non-thread records before building the delete key from the validated thread name.

Make hfsplus_brec_read_cat() validate that a thread nodeName length both fits HFSPLUS_MAX_STRLEN and exactly matches fd->entrylength, then share the HFS+ thread-record-type helper between hfsplus_find_cat() and hfsplus_delete_cat().

Fixes 1da177e4c3f4 ("Linux-2.6.12-rc2")
Assisted-by Codex:gpt-5.5
---
 fs/hfsplus/bfind.c      |  8 ++++++--
 fs/hfsplus/catalog.c    | 30 ++++++++++++------------------
 fs/hfsplus/hfsplus_fs.h | 12 ++++++++++++
 3 files changed, 30 insertions(+), 20 deletions(-)
fs/hfsplus/bfind.c +6 -2
index 9a55fa6d5294..d5e41e1c70b3 100644
@@ -322,8 +322,12 @@ int hfsplus_brec_read_cat(struct hfs_find_data *fd, hfsplus_cat_entry *entry)
 			pr_err("thread record too short (got %u)\n", fd->entrylength);
 			return -EIO;
 		}
-		expected_size = hfsplus_cat_thread_size(&entry->thread);
-		break;
+		if (!is_hfsplus_cat_thread_name_length_valid(&entry->thread,
+							     fd->entrylength)) {
+			pr_err("catalog thread name length corrupted\n");
+			return -EIO;
+		}
+		return 0;
 	default:
 		pr_err("unknown catalog record type %d\n",
 		       be16_to_cpu(entry->type));
fs/hfsplus/catalog.c +12 -18
index 776ce36cf076..1a4b0beae135 100644
@@ -204,16 +204,11 @@ int hfsplus_find_cat(struct super_block *sb, u32 cnid,
 		return err;
 
 	type = be16_to_cpu(tmp.type);
-	if (type != HFSPLUS_FOLDER_THREAD && type != HFSPLUS_FILE_THREAD) {
+	if (!is_hfs_thread_record_type(type)) {
 		pr_err("found bad thread record in catalog\n");
 		return -EIO;
 	}
 
-	if (be16_to_cpu(tmp.thread.nodeName.length) > 255) {
-		pr_err("catalog name length corrupted\n");
-		return -EIO;
-	}
-
 	hfsplus_cat_build_key_uni(fd->search_key,
 		be32_to_cpu(tmp.thread.parentID),
 		&tmp.thread.nodeName);
@@ -350,23 +345,22 @@ int hfsplus_delete_cat(u32 cnid, struct inode *dir, const struct qstr *str)
 		goto out;
 
 	if (!str) {
-		int len;
+		hfsplus_cat_entry entry = {0};
 
 		hfsplus_cat_build_key_with_cnid(sb, fd.search_key, cnid);
-		err = hfs_brec_find(&fd, hfs_find_rec_by_key);
+		err = hfsplus_brec_read_cat(&fd, &entry);
 		if (err)
 			goto out;
 
-		off = fd.entryoffset +
-			offsetof(struct hfsplus_cat_thread, nodeName);
-		fd.search_key->cat.parent = cpu_to_be32(dir->i_ino);
-		hfs_bnode_read(fd.bnode,
-			&fd.search_key->cat.name.length, off, 2);
-		len = be16_to_cpu(fd.search_key->cat.name.length) * 2;
-		hfs_bnode_read(fd.bnode,
-			&fd.search_key->cat.name.unicode,
-			off + 2, len);
-		fd.search_key->key_len = cpu_to_be16(6 + len);
+		type = be16_to_cpu(entry.type);
+		if (!is_hfs_thread_record_type(type)) {
+			pr_err("found bad thread record in catalog\n");
+			err = -EIO;
+			goto out;
+		}
+
+		hfsplus_cat_build_key_uni(fd.search_key, dir->i_ino,
+					  &entry.thread.nodeName);
 	} else {
 		err = hfsplus_cat_build_key(sb, fd.search_key, dir->i_ino, str);
 		if (unlikely(err))
fs/hfsplus/hfsplus_fs.h +12 -0
index ec04b82ad927..01e5f1246ff6 100644
@@ -521,6 +521,18 @@ static inline u32 hfsplus_cat_thread_size(const struct hfsplus_cat_thread *threa
 	       be16_to_cpu(thread->nodeName.length) * sizeof(hfsplus_unichr);
 }
 
+static inline bool is_hfs_thread_record_type(u16 type)
+{
+	return type == HFSPLUS_FOLDER_THREAD || type == HFSPLUS_FILE_THREAD;
+}
+
+static inline bool is_hfsplus_cat_thread_name_length_valid(
+		const struct hfsplus_cat_thread *thread, u32 entrylength)
+{
+	return be16_to_cpu(thread->nodeName.length) <= HFSPLUS_MAX_STRLEN &&
+	       entrylength == hfsplus_cat_thread_size(thread);
+}
+
 int hfsplus_brec_read_cat(struct hfs_find_data *fd, hfsplus_cat_entry *entry);
 
 /*
Signature · 1 line
2.54.0
#1 lore raw
Quoted 64 lines · Kyle Zeng

hfsplus_delete_cat() is called with str == NULL when the last open reference to an unlinked HFS+ hardlink backing inode is closed. In that
case, the function finds the catalog thread by CNID and rebuilds the catalog key from thread.nodeName.

That reconstruction path reads thread.nodeName.length directly from the
catalog B-tree into fd.search_key and then copies length * 2 bytes into
fd.search_key->cat.name.unicode. It does not first check that the found
record is a thread record, that the record size matches the thread name
length, or that nodeName.length fits in the fixed HFS+ catalog key buffer.

A corrupted image can therefore provide an oversized thread name length
and make hfs_bnode_read() write past the catalog search-key allocation.

Read the CNID record through hfsplus_brec_read_cat(), which performs the
hfs_brec_find() lookup via hfs_brec_read() before validating the catalog
record. Reject non-thread records before building the delete key from the validated thread name.

Make hfsplus_brec_read_cat() validate that a thread nodeName length both
fits HFSPLUS_MAX_STRLEN and exactly matches fd->entrylength, then share
the HFS+ thread-record-type helper between hfsplus_find_cat() and hfsplus_delete_cat().

Fixes 1da177e4c3f4 ("Linux-2.6.12-rc2")
Assisted-by Codex:gpt-5.5

---
 fs/hfsplus/bfind.c      |  8 ++++++-- fs/hfsplus/catalog.c    | 30 ++++++++++++------------------ fs/hfsplus/hfsplus_fs.h | 12 ++++++++++++

 3 files changed, 30 insertions(+), 20 deletions(-)
fs/hfsplus/bfind.c +1 -2
index 9a55fa6d5294..d5e41e1c70b3 100644
@@ -322,8 +322,12 @@ int hfsplus_brec_read_cat(struct hfs_find_data
 *fd, hfsplus_cat_entry *entry)
  			pr_err("thread record too short (got %u)\n",
 fd->entrylength);
  			return -EIO;
  		}
-		expected_size = hfsplus_cat_thread_size(&entry-
 >thread);
-		break;
+		if (!is_hfsplus_cat_thread_name_length_valid(&entry-
Quoted 1 line

thread,

fs/hfsplus/bfind.c +1 -0
+							     fd-
Quoted 1 line

entrylength)) {

fs/hfsplus/bfind.c +1 -0
+			pr_err("catalog thread name length

corrupted\n");

fs/hfsplus/bfind.c int hfsplus_brec_read_cat(struct hfs_find_data *fd, hfsplus_cat_entry *entry) · line 330

Quoted 3 lines
fs/hfsplus/bfind.c +3 -0
+			return -EIO;
+		}
+		return 0;

Do we really need to change this function at all? Because, current check already works pretty well. This check covers everything already:

	if (fd->entrylength != expected_size) {
		pr_err("catalog record size mismatch (type %d, got %u,
expected %u)\n",
		       be16_to_cpu(entry->type), fd->entrylength,
expected_size);
		return -EIO;
	}
Quoted 19 lines

  default:
  pr_err("unknown catalog record type %d\n", be16_to_cpu(entry->type));

fs/hfsplus/catalog.c +0 -0
index 776ce36cf076..1a4b0beae135 100644
@@ -204,16 +204,11 @@ int hfsplus_find_cat(struct super_block *sb,
 u32 cnid,
  		return err;


  type = be16_to_cpu(tmp.type);

fs/hfsplus/catalog.c +0 -1
-	if (type != HFSPLUS_FOLDER_THREAD && type !=

HFSPLUS_FILE_THREAD) {

fs/hfsplus/catalog.c +1 -0
+	if (!is_hfs_thread_record_type(type)) {

  pr_err("found bad thread record in catalog\n"); return -EIO;
  }

fs/hfsplus/catalog.c int hfsplus_find_cat(struct super_block *sb, u32 cnid, · line 215

Quoted 4 lines
fs/hfsplus/catalog.c +0 -4
-	if (be16_to_cpu(tmp.thread.nodeName.length) > 255) {
-		pr_err("catalog name length corrupted\n");
-		return -EIO;
-	}

If hfsplus_brec_read_cat() covers this check already, then, probably, we don't need in new function and we don't need this check. If we still need to keep this check, then we cannot simply remove it but we need to call the is_cat_thread_name_length_valid() here. So, do we really need to introduce the is_cat_thread_name_length_valid() finally?

Quoted 63 lines

-
  hfsplus_cat_build_key_uni(fd->search_key,
  be32_to_cpu(tmp.thread.parentID),
  &tmp.thread.nodeName);

fs/hfsplus/catalog.c +0 -0
@@ -350,23 +345,22 @@ int hfsplus_delete_cat(u32 cnid, struct inode
 *dir, const struct qstr *str)
  		goto out;


  if (!str) {

fs/hfsplus/catalog.c +1 -1
-		int len;
+		hfsplus_cat_entry entry = {0};


  hfsplus_cat_build_key_with_cnid(sb, fd.search_key, cnid);

fs/hfsplus/catalog.c +1 -1
-		err = hfs_brec_find(&fd, hfs_find_rec_by_key);
+		err = hfsplus_brec_read_cat(&fd, &entry);

  if (err)
  goto out;

fs/hfsplus/catalog.c +0 -2
-		off = fd.entryoffset +
-			offsetof(struct hfsplus_cat_thread,

nodeName);

fs/hfsplus/catalog.c +0 -4
-		fd.search_key->cat.parent = cpu_to_be32(dir->i_ino);
-		hfs_bnode_read(fd.bnode,
-			&fd.search_key->cat.name.length, off, 2);
-		len = be16_to_cpu(fd.search_key->cat.name.length) *

2;

fs/hfsplus/catalog.c +3 -4
-		hfs_bnode_read(fd.bnode,
-			&fd.search_key->cat.name.unicode,
-			off + 2, len);
-		fd.search_key->key_len = cpu_to_be16(6 + len);
+		type = be16_to_cpu(entry.type);
+		if (!is_hfs_thread_record_type(type)) {
+			pr_err("found bad thread record in

catalog\n");

fs/hfsplus/catalog.c +6 -0
+			err = -EIO;
+			goto out;
+		}
+
+		hfsplus_cat_build_key_uni(fd.search_key, dir->i_ino,
+					  &entry.thread.nodeName);

  } else {
  err = hfsplus_cat_build_key(sb, fd.search_key, dir-

Quoted 1 line

i_ino, str);

  if (unlikely(err))

fs/hfsplus/hfsplus_fs.h +0 -0
index ec04b82ad927..01e5f1246ff6 100644
@@ -521,6 +521,18 @@ static inline u32 hfsplus_cat_thread_size(const

struct hfsplus_cat_thread *threa be16_to_cpu(thread->nodeName.length) * sizeof(hfsplus_unichr);
 }

fs/hfsplus/hfsplus_fs.h +3 -0
+static inline bool is_hfs_thread_record_type(u16 type)
+{
+	return type == HFSPLUS_FOLDER_THREAD || type ==

HFSPLUS_FILE_THREAD;

fs/hfsplus/hfsplus_fs.h +4 -0
+}
+
+static inline bool is_hfsplus_cat_thread_name_length_valid(
+		const struct hfsplus_cat_thread *thread, u32
Quoted 1 line

entrylength)

I don't like this style. :) Potentially, we can rework it:

static inline
bool is_cat_thread_name_length_valid(struct hfsplus_cat_thread *thread,

                                     u32 entrylength);

Technically speaking, it will be better to provide struct hfs_find_data *fd and hfsplus_cat_entry *entry here.

Quoted 3 lines
fs/hfsplus/hfsplus_fs.h +2 -0
+{
+	return be16_to_cpu(thread->nodeName.length) <=

HFSPLUS_MAX_STRLEN

Do we need to have this check now? I assume that the second check could cover everything. What do you think?

Thanks,
Slava.

Quoted 8 lines

&&

fs/hfsplus/hfsplus_fs.h +3 -0
+	       entrylength == hfsplus_cat_thread_size(thread);
+}
+

 int hfsplus_brec_read_cat(struct hfs_find_data *fd, hfsplus_cat_entry *entry);

 /*

author
#2 lore raw

Considering that we want to reuse the check in hfsplus_brec_read_cat, we can just switch to using hfsplus_brec_read_cat, avoid the changes in hfsplus_brec_read_cat and avoid adding the is_hfsplus_cat_thread_name_length_valid function?
will send a v5 in a bit.

Best,
Kyle

Quoted 205 lines · Viacheslav Dubeyko
Quoted 64 lines · Kyle Zeng

hfsplus_delete_cat() is called with str == NULL when the last open reference to an unlinked HFS+ hardlink backing inode is closed. In that
case, the function finds the catalog thread by CNID and rebuilds the catalog key from thread.nodeName.

That reconstruction path reads thread.nodeName.length directly from the
catalog B-tree into fd.search_key and then copies length * 2 bytes into
fd.search_key->cat.name.unicode. It does not first check that the found
record is a thread record, that the record size matches the thread name
length, or that nodeName.length fits in the fixed HFS+ catalog key buffer.

A corrupted image can therefore provide an oversized thread name length
and make hfs_bnode_read() write past the catalog search-key allocation.

Read the CNID record through hfsplus_brec_read_cat(), which performs the
hfs_brec_find() lookup via hfs_brec_read() before validating the catalog
record. Reject non-thread records before building the delete key from the validated thread name.

Make hfsplus_brec_read_cat() validate that a thread nodeName length both
fits HFSPLUS_MAX_STRLEN and exactly matches fd->entrylength, then share
the HFS+ thread-record-type helper between hfsplus_find_cat() and hfsplus_delete_cat().

Fixes 1da177e4c3f4 ("Linux-2.6.12-rc2")
Assisted-by Codex:gpt-5.5
---
 fs/hfsplus/bfind.c      |  8 ++++++--
 fs/hfsplus/catalog.c    | 30 ++++++++++++------------------
 fs/hfsplus/hfsplus_fs.h | 12 ++++++++++++
 3 files changed, 30 insertions(+), 20 deletions(-)
fs/hfsplus/bfind.c +1 -2
index 9a55fa6d5294..d5e41e1c70b3 100644
@@ -322,8 +322,12 @@ int hfsplus_brec_read_cat(struct hfs_find_data
 *fd, hfsplus_cat_entry *entry)
                      pr_err("thread record too short (got %u)\n",
 fd->entrylength);
                      return -EIO;
              }
-             expected_size = hfsplus_cat_thread_size(&entry-
 >thread);
-             break;
+             if (!is_hfsplus_cat_thread_name_length_valid(&entry-
Quoted 1 line

thread,

+ fd-

Quoted 1 line

entrylength)) {

+ pr_err("catalog thread name length
corrupted\n");

fs/hfsplus/bfind.c int hfsplus_brec_read_cat(struct hfs_find_data *fd, hfsplus_cat_entry *entry) · line 330

Quoted 3 lines
fs/hfsplus/bfind.c +3 -0
+                     return -EIO;
+             }
+             return 0;

Do we really need to change this function at all? Because, current check already works pretty well. This check covers everything already:

if (fd->entrylength != expected_size) {
pr_err("catalog record size mismatch (type %d, got %u,
expected %u)\n",

                       be16_to_cpu(entry->type), fd->entrylength,
expected_size);
                return -EIO;
        }
Quoted 13 lines

default:
pr_err("unknown catalog record type %d\n",
be16_to_cpu(entry->type));

fs/hfsplus/catalog.c +0 -1
index 776ce36cf076..1a4b0beae135 100644
@@ -204,16 +204,11 @@ int hfsplus_find_cat(struct super_block *sb,
 u32 cnid,
              return err;
 
      type = be16_to_cpu(tmp.type);
-     if (type != HFSPLUS_FOLDER_THREAD && type !=

fs/hfsplus/catalog.c int hfsplus_find_cat(struct super_block *sb, · line 217

Quoted 10 lines
fs/hfsplus/catalog.c +1 -4
 HFSPLUS_FILE_THREAD) {
+     if (!is_hfs_thread_record_type(type)) {
              pr_err("found bad thread record in catalog\n");
              return -EIO;
      }
 
-     if (be16_to_cpu(tmp.thread.nodeName.length) > 255) {
-             pr_err("catalog name length corrupted\n");
-             return -EIO;
-     }

If hfsplus_brec_read_cat() covers this check already, then, probably, we don't need in new function and we don't need this check. If we still need to keep this check, then we cannot simply remove it but we need to call the is_cat_thread_name_length_valid() here. So, do we really need to introduce the is_cat_thread_name_length_valid() finally?

Quoted 63 lines
fs/hfsplus/catalog.c +0 -1
-
      hfsplus_cat_build_key_uni(fd->search_key,
              be32_to_cpu(tmp.thread.parentID),
              &tmp.thread.nodeName);
fs/hfsplus/catalog.c +5 -12
@@ -350,23 +345,22 @@ int hfsplus_delete_cat(u32 cnid, struct inode
 *dir, const struct qstr *str)
              goto out;
 
      if (!str) {
-             int len;
+             hfsplus_cat_entry entry = {0};
 
              hfsplus_cat_build_key_with_cnid(sb, fd.search_key,
 cnid);
-             err = hfs_brec_find(&fd, hfs_find_rec_by_key);
+             err = hfsplus_brec_read_cat(&fd, &entry);
              if (err)
                      goto out;
 
-             off = fd.entryoffset +
-                     offsetof(struct hfsplus_cat_thread,
 nodeName);
-             fd.search_key->cat.parent = cpu_to_be32(dir->i_ino);
-             hfs_bnode_read(fd.bnode,
-                     &fd.search_key->cat.name.length, off, 2);
-             len = be16_to_cpu(fd.search_key->cat.name.length) *
 2;
-             hfs_bnode_read(fd.bnode,
-                     &fd.search_key->cat.name.unicode,
-                     off + 2, len);
-             fd.search_key->key_len = cpu_to_be16(6 + len);
+             type = be16_to_cpu(entry.type);
+             if (!is_hfs_thread_record_type(type)) {
+                     pr_err("found bad thread record in

catalog\n");

fs/hfsplus/catalog.c +6 -0
+                     err = -EIO;
+                     goto out;
+             }
+
+             hfsplus_cat_build_key_uni(fd.search_key, dir->i_ino,
+                                       &entry.thread.nodeName);
      } else {
              err = hfsplus_cat_build_key(sb, fd.search_key, dir-
Quoted 1 line

i_ino, str);

if (unlikely(err))

fs/hfsplus/hfsplus_fs.h +0 -0
index ec04b82ad927..01e5f1246ff6 100644
@@ -521,6 +521,18 @@ static inline u32 hfsplus_cat_thread_size(const

struct hfsplus_cat_thread *threa

             be16_to_cpu(thread->nodeName.length) *

sizeof(hfsplus_unichr);
}

fs/hfsplus/hfsplus_fs.h +3 -0
+static inline bool is_hfs_thread_record_type(u16 type)
+{
+     return type == HFSPLUS_FOLDER_THREAD || type ==

HFSPLUS_FILE_THREAD;

fs/hfsplus/hfsplus_fs.h +4 -0
+}
+
+static inline bool is_hfsplus_cat_thread_name_length_valid(
+             const struct hfsplus_cat_thread *thread, u32
Quoted 1 line

entrylength)

I don't like this style. :) Potentially, we can rework it:

static inline
bool is_cat_thread_name_length_valid(struct hfsplus_cat_thread *thread,

                                     u32 entrylength);

Technically speaking, it will be better to provide struct hfs_find_data *fd and hfsplus_cat_entry *entry here.

Quoted 3 lines
fs/hfsplus/hfsplus_fs.h +2 -0
+{
+     return be16_to_cpu(thread->nodeName.length) <=

HFSPLUS_MAX_STRLEN

Do we need to have this check now? I assume that the second check could cover everything. What do you think?

Thanks,
Slava.

Quoted 8 lines

&&

fs/hfsplus/hfsplus_fs.h +3 -0
+            entrylength == hfsplus_cat_thread_size(thread);
+}
+
 int hfsplus_brec_read_cat(struct hfs_find_data *fd,

hfsplus_cat_entry *entry);

/*