btrfs: validate root ref names in tree-checker
PATCH v4 1/1 btrfs: validate root ref names in tree-checker
ROOT_REF and ROOT_BACKREF items contain a struct btrfs_root_ref followed by the subvolume name. Several readers assume that this layout is already valid and then use the on-disk name length directly. A corrupted item can therefore make those readers address bytes outside the item, and BTRFS_IOC_GET_SUBVOL_INFO can copy too many bytes into its fixed-size UAPI name buffer.
Validate ROOT_REF and ROOT_BACKREF items in tree-checker before any reader uses them. Reject records that do not contain a non-empty name, whose name_len does not exactly describe the remaining item payload, or whose name exceeds BTRFS_NAME_LEN.
For BTRFS_IOC_GET_SUBVOL_INFO, copy only the validated on-disk name_len instead of deriving the copy length from the item size. The ioctl result is zeroed when allocated. That leaves the existing trailing zero byte untouched.
--- fs/btrfs/ioctl.c | 12 ++++++------ fs/btrfs/tree-checker.c | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 6 deletions(-)
fs/btrfs/ioctl.c +6 -6
@@ -1956,7 +1956,6 @@ static int btrfs_ioctl_get_subvol_info(struct inode *inode, void __user *argp)struct btrfs_root_ref *rref;struct extent_buffer *leaf;unsigned long item_off; -unsigned long item_len;int slot;int ret =0 ;
@@ -2031,17 +2030,18 @@ static int btrfs_ioctl_get_subvol_info(struct inode *inode, void __user *argp)btrfs_item_key_to_cpu (leaf, &key, slot);if (key.objectid == subvol_info->treeid && key.type ==BTRFS_ROOT_BACKREF_KEY ) { +u16 name_len; + subvol_info->parent_id = key.offset; rref = btrfs_item_ptr(leaf, slot, struct btrfs_root_ref); + name_len =btrfs_root_ref_name_len (leaf, rref); subvol_info->dirid =btrfs_root_ref_dirid (leaf, rref); - item_off =btrfs_item_ptr_offset (leaf, slot) - +sizeof (struct btrfs_root_ref ); - item_len =btrfs_item_size (leaf, slot) - -sizeof (struct btrfs_root_ref ); + item_off =btrfs_item_ptr_offset (leaf, slot) + +sizeof (*rref);read_extent_buffer (leaf, subvol_info->name, - item_off, item_len); + item_off, name_len); }else { ret = -ENOENT ; goto out;
fs/btrfs/tree-checker.c +36 -0
@@ -1371,6 +1371,38 @@ static int check_root_item(struct extent_buffer *leaf, struct btrfs_key *key,return 0 ; } +static int check_root_ref (struct extent_buffer *leaf,struct btrfs_key *key, +int slot) +{ +struct btrfs_root_ref *rref; +u32 item_size =btrfs_item_size (leaf, slot); +u32 name_len; + +if (unlikely (item_size <=sizeof (*rref))) { +generic_err (leaf, slot, +"invalid root ref item size for key type %u, have %u expect > %zu" , + key->type, item_size,sizeof (*rref)); +return -EUCLEAN ; + } + + rref = btrfs_item_ptr(leaf, slot, struct btrfs_root_ref); + name_len =btrfs_root_ref_name_len (leaf, rref); +if (unlikely (name_len >BTRFS_NAME_LEN )) { +generic_err (leaf, slot, +"root ref name too long for key type %u, have %u max %u" , + key->type, name_len,BTRFS_NAME_LEN ); +return -EUCLEAN ; + } +if (unlikely (item_size !=sizeof (*rref) + name_len)) { +generic_err (leaf, slot, +"invalid root ref item size for key type %u, have %u expect %zu" , + key->type, item_size,sizeof (*rref) + name_len); +return -EUCLEAN ; + } + +return 0 ; +} + __printf(3,4)__cold static void extent_err(const struct extent_buffer *eb, int slot,
@@ -2226,6 +2258,10 @@ static enum btrfs_tree_block_status check_leaf_item(struct extent_buffer *leaf,case BTRFS_ROOT_ITEM_KEY : ret =check_root_item (leaf, key, slot);break ; +case BTRFS_ROOT_REF_KEY : +case BTRFS_ROOT_BACKREF_KEY : + ret =check_root_ref (leaf, key, slot); +break ;case BTRFS_EXTENT_ITEM_KEY :case BTRFS_METADATA_ITEM_KEY : ret =check_extent_item (leaf, key, slot, prev_key);
Signature · 1 line
2.43.0
Quoted 12 lines · Zhang Cen
ROOT_REFandROOT_BACKREFitems contain a structbtrfs_root_reffollowed by the subvolume name. Several readers assume that this layout is already valid and then use the on-disk name length directly. A corrupted item can therefore make those readers address bytes outside the item, andBTRFS_IOC_GET_SUBVOL_INFOcan copy too many bytes into its fixed-size UAPI name buffer.Validate
ROOT_REFandROOT_BACKREFitems in tree-checker before any reader uses them. Reject records that do not contain a non-empty name, whosename_lendoes not exactly describe the remaining item payload, or whose name exceedsBTRFS_NAME_LEN.
Quoted 6 lines
For
BTRFS_IOC_GET_SUBVOL_INFO, copy only the validated on-diskname_leninstead of deriving the copy length from the item size. The ioctl result is zeroed when allocated. That leaves the existing trailing zero byte untouched.Signed-off-by Zhang Cen <[email protected]>
Will run a full test before merge.
Thanks,
Qu
Quoted 95 lines
--- fs/btrfs/ioctl.c | 12 ++++++------ fs/btrfs/tree-checker.c | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 6 deletions(-)fs/btrfs/ioctl.c +6
-6@@ -1956,7 +1956,6 @@ static int btrfs_ioctl_get_subvol_info(struct inode *inode, void __user *argp)struct btrfs_root_ref *rref;struct extent_buffer *leaf;unsigned long item_off; -unsigned long item_len;int slot;int ret =0 ;@@ -2031,17 +2030,18 @@ static int btrfs_ioctl_get_subvol_info(struct inode *inode, void __user *argp)btrfs_item_key_to_cpu (leaf, &key, slot);if (key.objectid == subvol_info->treeid && key.type ==BTRFS_ROOT_BACKREF_KEY ) { +u16 name_len; + subvol_info->parent_id = key.offset; rref = btrfs_item_ptr(leaf, slot, struct btrfs_root_ref); + name_len =btrfs_root_ref_name_len (leaf, rref); subvol_info->dirid =btrfs_root_ref_dirid (leaf, rref); - item_off =btrfs_item_ptr_offset (leaf, slot) - +sizeof (struct btrfs_root_ref ); - item_len =btrfs_item_size (leaf, slot) - -sizeof (struct btrfs_root_ref ); + item_off =btrfs_item_ptr_offset (leaf, slot) + +sizeof (*rref);read_extent_buffer (leaf, subvol_info->name, - item_off, item_len); + item_off, name_len); }else { ret = -ENOENT ; goto out;fs/btrfs/tree-checker.c +36
-0@@ -1371,6 +1371,38 @@ static int check_root_item(struct extent_buffer *leaf, struct btrfs_key *key,return 0 ; } +static int check_root_ref (struct extent_buffer *leaf,struct btrfs_key *key, +int slot) +{ +struct btrfs_root_ref *rref; +u32 item_size =btrfs_item_size (leaf, slot); +u32 name_len; + +if (unlikely (item_size <=sizeof (*rref))) { +generic_err (leaf, slot, +"invalid root ref item size for key type %u, have %u expect > %zu" , + key->type, item_size,sizeof (*rref)); +return -EUCLEAN ; + } + + rref = btrfs_item_ptr(leaf, slot, struct btrfs_root_ref); + name_len =btrfs_root_ref_name_len (leaf, rref); +if (unlikely (name_len >BTRFS_NAME_LEN )) { +generic_err (leaf, slot, +"root ref name too long for key type %u, have %u max %u" , + key->type, name_len,BTRFS_NAME_LEN ); +return -EUCLEAN ; + } +if (unlikely (item_size !=sizeof (*rref) + name_len)) { +generic_err (leaf, slot, +"invalid root ref item size for key type %u, have %u expect %zu" , + key->type, item_size,sizeof (*rref) + name_len); +return -EUCLEAN ; + } + +return 0 ; +} + __printf(3,4)__cold static void extent_err(const struct extent_buffer *eb, int slot,@@ -2226,6 +2258,10 @@ static enum btrfs_tree_block_status check_leaf_item(struct extent_buffer *leaf,case BTRFS_ROOT_ITEM_KEY : ret =check_root_item (leaf, key, slot);break ; +case BTRFS_ROOT_REF_KEY : +case BTRFS_ROOT_BACKREF_KEY : + ret =check_root_ref (leaf, key, slot); +break ;case BTRFS_EXTENT_ITEM_KEY :case BTRFS_METADATA_ITEM_KEY : ret =check_extent_item (leaf, key, slot, prev_key);