Bluetooth: btintel: Fix issue reported by static analysis tool
PATCH 1/1 Bluetooth: btintel: Fix issue reported by static analysis tool
Smatch tool reported the below issue:
drivers/bluetooth/btintel.c:490 btintel_read_version_tlv()
error: 'tlv->len' from user is not capped properly
Additional details in the below link
https://www.spinics.net/lists/linux-bluetooth/msg87786.html
--- drivers/bluetooth/btintel.c | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-)
drivers/bluetooth/btintel.c +42 -1
@@ -431,62 +431,99 @@ int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver* version field like hw_platform, hw_variant, and fw_variant * to keep the existing setup flow */ -while (skb->len) { +while (skb->len >=sizeof (struct intel_tlv )) {struct intel_tlv *tlv; tlv = (struct intel_tlv *)skb->data; +if (struct_size (tlv, val, tlv->len) > skb->len) + goto failed; +switch (tlv->type) {case INTEL_TLV_CNVI_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVI_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_DEV_REV_ID : +if (tlv->len <sizeof (u16)) + goto failed; version->dev_rev_id =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_IMAGE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->img_type = tlv->val[0 ];break ;case INTEL_TLV_TIME_STAMP : +if (tlv->len <sizeof (u16)) + goto failed; version->timestamp =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_BUILD_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->build_type = tlv->val[0 ];break ;case INTEL_TLV_BUILD_NUM : +if (tlv->len <sizeof (u32)) + goto failed; version->build_num =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_SECURE_BOOT : +if (tlv->len <sizeof (u8)) + goto failed; version->secure_boot = tlv->val[0 ];break ;case INTEL_TLV_OTP_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->otp_lock = tlv->val[0 ];break ;case INTEL_TLV_API_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->api_lock = tlv->val[0 ];break ;case INTEL_TLV_DEBUG_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->debug_lock = tlv->val[0 ];break ;case INTEL_TLV_MIN_FW : +if (tlv->len <3 ) + goto failed; version->min_fw_build_nn = tlv->val[0 ]; version->min_fw_build_cw = tlv->val[1 ]; version->min_fw_build_yy = tlv->val[2 ];break ;case INTEL_TLV_LIMITED_CCE : +if (tlv->len <sizeof (u8)) + goto failed; version->limited_cce = tlv->val[0 ];break ;case INTEL_TLV_SBE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->sbe_type = tlv->val[0 ];break ;case INTEL_TLV_OTP_BDADDR : +if (tlv->len !=sizeof (version->otp_bd_addr)) + goto failed;memcpy (&version->otp_bd_addr, tlv->val, tlv->len);break ;default :
@@ -499,6 +536,10 @@ int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *verkfree_skb (skb);return 0 ; + +failed: +kfree_skb (skb); +return -EINVAL ; }EXPORT_SYMBOL_GPL (btintel_read_version_tlv);
Signature · 1 line
2.7.4
Luiz Augusto von Dentz
maintainerHi Kiran,
Quoted 106 lines · Kiran K
Smatch tool reported the below issue:
drivers/bluetooth/btintel.c:490btintel_read_version_tlv()
error: 'tlv->len' from user is not capped properlyAdditional details in the below link
https://www.spinics.net/lists/linux-bluetooth/msg87786.htmlSigned-off-by Kiran K <[email protected]>--- drivers/bluetooth/btintel.c | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-)drivers/bluetooth/btintel.c +34
-1@@ -431,62 +431,99 @@ int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver* version field like hw_platform, hw_variant, and fw_variant * to keep the existing setup flow */ -while (skb->len) { +while (skb->len >=sizeof (struct intel_tlv )) {struct intel_tlv *tlv; tlv = (struct intel_tlv *)skb->data; +if (struct_size (tlv, val, tlv->len) > skb->len) + goto failed; +switch (tlv->type) {case INTEL_TLV_CNVI_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVI_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_DEV_REV_ID : +if (tlv->len <sizeof (u16)) + goto failed; version->dev_rev_id =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_IMAGE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->img_type = tlv->val[0 ];break ;case INTEL_TLV_TIME_STAMP : +if (tlv->len <sizeof (u16)) + goto failed; version->timestamp =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_BUILD_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->build_type = tlv->val[0 ];break ;case INTEL_TLV_BUILD_NUM : +if (tlv->len <sizeof (u32)) + goto failed; version->build_num =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_SECURE_BOOT : +if (tlv->len <sizeof (u8)) + goto failed; version->secure_boot = tlv->val[0 ];break ;case INTEL_TLV_OTP_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->otp_lock = tlv->val[0 ];break ;case INTEL_TLV_API_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->api_lock = tlv->val[0 ];break ;case INTEL_TLV_DEBUG_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->debug_lock = tlv->val[0 ];break ;case INTEL_TLV_MIN_FW : +if (tlv->len <3 ) + goto failed; version->min_fw_build_nn = tlv->val[0 ]; version->min_fw_build_cw = tlv->val[1 ]; version->min_fw_build_yy = tlv->val[2 ];break ;case INTEL_TLV_LIMITED_CCE : +if (tlv->len <sizeof (u8)) + goto failed;
drivers/bluetooth/btintel.c int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver · line 526
Quoted 10 lines
drivers/bluetooth/btintel.c +4
-0version->limited_cce = tlv->val[0 ];break ;case INTEL_TLV_SBE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->sbe_type = tlv->val[0 ];break ;case INTEL_TLV_OTP_BDADDR : +if (tlv->len !=sizeof (version->otp_bd_addr)) + goto failed;
Do we really want to fail here? The advantage of using a TLV is that we can skip if the type is not understood or is malformed but with this checks the length becomes useless since the types will always have a fixed value, also we cannot extend the types later on since it would not be backward compatible if we maintain such strict checks.
Quoted 17 lines
drivers/bluetooth/btintel.c +4
-1memcpy (&version->otp_bd_addr, tlv->val, tlv->len);break ;default :@@ -499,6 +536,10 @@ int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *verkfree_skb (skb);return 0 ; + +failed: +kfree_skb (skb); +return -EINVAL ; }EXPORT_SYMBOL_GPL (btintel_read_version_tlv); --2.7.4
Signature · 1 line
Luiz Augusto von Dentz
Hi Luiz,
Quoted 133 lines
-----Original Message-----
From: Luiz Augusto von Dentz <[email protected]>
Sent: Tuesday, September 22, 2020 10:47 AM
To: Kiran K <[email protected]>
Cc: [email protected]; Tumkur Narayan, Chethan <[email protected]>; Srivatsa, Ravishankar <[email protected]>; [email protected]; K, Kiran <[email protected]>
Subject: Re: [PATCH v1] Bluetooth: btintel: Fix issue reported by static analysis toolHi Kiran,
drivers/bluetooth/btintel.c int btintel_read_version_tlv(struct hci_dev
Quoted 20 lines · Kiran K
Smatch tool reported the below issue:
drivers/bluetooth/btintel.c:490btintel_read_version_tlv()
error: 'tlv->len' from user is not capped properlyAdditional details in the below link
https://www.spinics.net/lists/linux-bluetooth/msg87786.htmlSigned-off-by Kiran K <[email protected]>--- drivers/bluetooth/btintel.c | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-)drivers/bluetooth/btintel.c +0
-0@@ -431,62 +431,99 @@ int btintel_read_version_tlv(struct hci_dev*hdev, struct
intel_version_tlv*verQuoted 87 lines
drivers/bluetooth/btintel.c +34
-1* version field like hw_platform, hw_variant, and fw_variant * to keep the existing setup flow */ -while (skb->len) { +while (skb->len >=sizeof (struct intel_tlv )) {struct intel_tlv *tlv; tlv = (struct intel_tlv *)skb->data; +if (struct_size (tlv, val, tlv->len) > skb->len) + goto failed; +switch (tlv->type) {case INTEL_TLV_CNVI_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVI_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_DEV_REV_ID : +if (tlv->len <sizeof (u16)) + goto failed; version->dev_rev_id =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_IMAGE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->img_type = tlv->val[0 ];break ;case INTEL_TLV_TIME_STAMP : +if (tlv->len <sizeof (u16)) + goto failed; version->timestamp =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_BUILD_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->build_type = tlv->val[0 ];break ;case INTEL_TLV_BUILD_NUM : +if (tlv->len <sizeof (u32)) + goto failed; version->build_num =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_SECURE_BOOT : +if (tlv->len <sizeof (u8)) + goto failed; version->secure_boot = tlv->val[0 ];break ;case INTEL_TLV_OTP_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->otp_lock = tlv->val[0 ];break ;case INTEL_TLV_API_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->api_lock = tlv->val[0 ];break ;case INTEL_TLV_DEBUG_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->debug_lock = tlv->val[0 ];break ;case INTEL_TLV_MIN_FW : +if (tlv->len <3 ) + goto failed; version->min_fw_build_nn = tlv->val[0 ]; version->min_fw_build_cw = tlv->val[1 ]; version->min_fw_build_yy = tlv->val[2 ];break ;case INTEL_TLV_LIMITED_CCE : +if (tlv->len <sizeof (u8)) + goto failed;drivers/bluetooth/btintel.c int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver · line 526
Quoted 10 lines
drivers/bluetooth/btintel.c +4
-0version->limited_cce = tlv->val[0 ];break ;case INTEL_TLV_SBE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->sbe_type = tlv->val[0 ];break ;case INTEL_TLV_OTP_BDADDR : +if (tlv->len !=sizeof (version->otp_bd_addr)) + goto failed;
Quoted 3 lines
Do we really want to fail here? The advantage of using a TLV is that we can skip if the type is not understood or is malformed but with this checks the length becomes useless since the types will always have a fixed value, also
Agree that the types are fixed here. But if due to some reason if controller is not honoring the same, then driver might end up reading unwanted data. The check is more about driver being defensive rather than believing what comes on wire.
Quoted 2 lines
we cannot extend the types later on since it would not be backward compatible if we maintain such strict checks.
I didn’t get this part. Could you please be more specific ?
Quoted 16 lines
Quoted 16 lines
drivers/bluetooth/btintel.c +4
-0memcpy (&version->otp_bd_addr, tlv->val, tlv->len);break ;default :@@ -499,6 +536,10 @@ int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *verkfree_skb (skb);return 0 ; + +failed: +kfree_skb (skb); +return -EINVAL ; }EXPORT_SYMBOL_GPL (btintel_read_version_tlv);
Quoted 7 lines
Quoted 3 lines
--
2.7.4--
Luiz Augusto von Dentz
Thanks,
Kiran
Marcel Holtmann
maintainerHi Kiran,
Quoted 122 lines
Quoted 118 lines
drivers/bluetooth/btintel.c int btintel_read_version_tlv(struct hci_dev
Quoted 19 lines
Smatch tool reported the below issue:
drivers/bluetooth/btintel.c:490btintel_read_version_tlv()
error: 'tlv->len' from user is not capped properlyAdditional details in the below link
https://www.spinics.net/lists/linux-bluetooth/msg87786.htmlSigned-off-by Kiran K <[email protected]>---
drivers/bluetooth/btintel.c| 43
++++++++++++++++++++++++++++++++++++++++++-1 file changed, 42 insertions(+), 1 deletion(-)drivers/bluetooth/btintel.c +0
-0@@ -431,62 +431,99 @@ int btintel_read_version_tlv(struct hci_dev*hdev, struct
intel_version_tlv*verQuoted 87 lines
drivers/bluetooth/btintel.c +34
-1* version field like hw_platform, hw_variant, and fw_variant * to keep the existing setup flow */ -while (skb->len) { +while (skb->len >=sizeof (struct intel_tlv )) {struct intel_tlv *tlv; tlv = (struct intel_tlv *)skb->data; +if (struct_size (tlv, val, tlv->len) > skb->len) + goto failed; +switch (tlv->type) {case INTEL_TLV_CNVI_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_TOP : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_top =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVI_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvi_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_CNVR_BT : +if (tlv->len <sizeof (u32)) + goto failed; version->cnvr_bt =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_DEV_REV_ID : +if (tlv->len <sizeof (u16)) + goto failed; version->dev_rev_id =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_IMAGE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->img_type = tlv->val[0 ];break ;case INTEL_TLV_TIME_STAMP : +if (tlv->len <sizeof (u16)) + goto failed; version->timestamp =get_unaligned_le16 (tlv->val);break ;case INTEL_TLV_BUILD_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->build_type = tlv->val[0 ];break ;case INTEL_TLV_BUILD_NUM : +if (tlv->len <sizeof (u32)) + goto failed; version->build_num =get_unaligned_le32 (tlv->val);break ;case INTEL_TLV_SECURE_BOOT : +if (tlv->len <sizeof (u8)) + goto failed; version->secure_boot = tlv->val[0 ];break ;case INTEL_TLV_OTP_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->otp_lock = tlv->val[0 ];break ;case INTEL_TLV_API_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->api_lock = tlv->val[0 ];break ;case INTEL_TLV_DEBUG_LOCK : +if (tlv->len <sizeof (u8)) + goto failed; version->debug_lock = tlv->val[0 ];break ;case INTEL_TLV_MIN_FW : +if (tlv->len <3 ) + goto failed; version->min_fw_build_nn = tlv->val[0 ]; version->min_fw_build_cw = tlv->val[1 ]; version->min_fw_build_yy = tlv->val[2 ];break ;case INTEL_TLV_LIMITED_CCE : +if (tlv->len <sizeof (u8)) + goto failed;drivers/bluetooth/btintel.c int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver · line 526
Quoted 10 lines
drivers/bluetooth/btintel.c +4
-0version->limited_cce = tlv->val[0 ];break ;case INTEL_TLV_SBE_TYPE : +if (tlv->len <sizeof (u8)) + goto failed; version->sbe_type = tlv->val[0 ];break ;case INTEL_TLV_OTP_BDADDR : +if (tlv->len !=sizeof (version->otp_bd_addr)) + goto failed;Quoted 3 lines
Do we really want to fail here? The advantage of using a TLV is that we can skip if the type is not understood or is malformed but with this checks the length becomes useless since the types will always have a fixed value, also
Quoted 6 lines
Agree that the types are fixed here. But if due to some reason if controller is not honoring the same, then driver might end up reading unwanted data. The check is more about driver being defensive rather than believing what comes on wire.
Quoted 2 lines
we cannot extend the types later on since it would not be backward compatible if we maintain such strict checks.
I didn’t get this part. Could you please be more specific ?
please change this that you check the size of the TLV data part against the expected size of the field and only then assign it.
Regards
Marcel