net/bnxt: bounds checking patches
cover net/bnxt: bounds checking patches
This set of patches came from security review of bnxt driver. It introduces a set of overflow macros that could be more widely used in other places in DPDK to check for math overflows.
Stephen Hemminger (6):
eal: add portable way to check for math overflow net/bnxt: fix potential data race
net/bnxt: avoid potential out of bounds read net/bnxt: check for integer overflow in buffer sizing net/bnxt: add integer underflow check net/bnxt: sanitize max_l2_ctx
drivers/net/bnxt/bnxt_hwrm.c | 31 ++++++-- lib/librte_eal/common/Makefile | 2 +- lib/librte_eal/common/include/rte_overflow.h | 74 ++++++++++++++++++++ 3 files changed, 101 insertions(+), 6 deletions(-) create mode 100644 lib/librte_eal/common/include/rte_overflow.h
Signature · 1 line
2.20.1
PATCH 1/6 eal: add portable way to check for math overflow
Clang and recent versions of GCC has builtin functions to do most math operations and check for wraparound. On most architectures this is a just a math operation followed by a branch on carry set.
But DPDK needs to be able to handle older GCC versions, and other compilers so a wrapper macro is needed.
Chose to use a macro instead of inline functions to avoid having to write lots of variants for each numeric type.
--- lib/librte_eal/common/Makefile | 2 +- lib/librte_eal/common/include/rte_overflow.h | 74 ++++++++++++++++++++ 2 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 lib/librte_eal/common/include/rte_overflow.h
lib/librte_eal/common/Makefile +1 -1
@@ -13,7 +13,7 @@ INC += rte_tailq.h rte_interrupts.h rte_alarm.h INC += rte_string_fns.h rte_version.h INC += rte_eal_memconfig.h INC += rte_hexdump.h rte_devargs.h rte_bus.h rte_dev.h rte_class.h -INC += rte_option.h +INC += rte_option.h rte_overflow.h INC += rte_pci_dev_feature_defs.h rte_pci_dev_features.h INC += rte_malloc.h rte_keepalive.h rte_time.h INC += rte_service.h rte_service_component.h
lib/librte_eal/common/include/rte_overflow.h new file +74 -0
74 lines not on this page · raw message
Signature · 1 line
2.20.1
Re: [dpdk-dev] [PATCH 1/6] eal: add portable way to check for math overflow
lib/librte_eal/common/include/rte_overflow.h line 31
Quoted 6 lines
lib/librte_eal/common/include/rte_overflow.h new file +6
-0+#if defined(__has_builtin) +# if __has_builtin (__builtin_add_overflow) +# define RTE_HAVE_BUILTIN_OVERFLOW +# endif +#elif defined(RTE_TOOLCHAIN_GCC ) && (GCC_VERSION >=5000 ) +# define RTE__HAVE_BUILTIN_OVERFLOW
Excessive underline after RTE results in RTE_HAVE_BUILTIN_OVERFLOW not being defined.
Signature · 1 line
Dmitry Kozlyuk
PATCH 2/6 net/bnxt: fix potential data race
In reply to Stephen HemmingerThe response from the firmware is accessed multiple times. This is a potential TOCTOU error.
--- drivers/net/bnxt/bnxt_hwrm.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/net/bnxt/bnxt_hwrm.c +4 -2
@@ -3746,6 +3746,7 @@ int bnxt_hwrm_port_led_qcaps(struct bnxt *bp) {struct hwrm_port_led_qcaps_output *resp = bp->hwrm_cmd_resp_addr;struct hwrm_port_led_qcaps_input req = {0 }; +uint8_t num_leds;int rc;if (BNXT_VF (bp))
@@ -3757,10 +3758,11 @@ int bnxt_hwrm_port_led_qcaps(struct bnxt *bp)HWRM_CHECK_RESULT (); -if (resp->num_leds >0 && resp->num_leds <BNXT_MAX_LED ) { + num_leds = resp->num_leds; +if (num_leds >0 && num_leds <BNXT_MAX_LED ) {unsigned int i; - bp->num_leds = resp->num_leds; + bp->num_leds = num_leds;memcpy (bp->leds, &resp->led0_id,sizeof (bp->leds[0 ]) * bp->num_leds);for (i =0 ; i < bp->num_leds; i++) {
Signature · 1 line
2.20.1
Re: [dpdk-dev] [EXTERNAL] [PATCH 2/6] net/bnxt: fix potential data race
Can we add the volatile qualifier to the hwrm_cmd_resp_addr member (in drivers/net/bnxt/bnxt.h) to get a stronger guarantee that the compiler won't insert TOCTOU races in the output?
Christopher Ertl | MSRC Vulnerabilities & Mitigations | Microsoft Limited | +44 7773976589 | [email protected]
Microsoft Limited (company number 01624297) is a company registered in England and Wales whose registered office is at Microsoft Campus, Thames Valley Park, Reading. RG6 1WG
-----Original Message-----
From: Stephen Hemminger <[email protected]>
Sent: Tuesday, March 3, 2020 6:00 PM
To: Ajit Kumar Khaparde <[email protected]>; [email protected]
Cc: [email protected]; Stephen Hemminger <[email protected]>; Christopher Ertl <[email protected]>
Subject: [EXTERNAL] [PATCH 2/6] net/bnxt: fix potential data race
The response from the firmware is accessed multiple times. This is a potential TOCTOU error.
--- drivers/net/bnxt/bnxt_hwrm.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/net/bnxt/bnxt_hwrm.c +4 -2
@@ -3746,6 +3746,7 @@ int bnxt_hwrm_port_led_qcaps(struct bnxt *bp) {struct hwrm_port_led_qcaps_output *resp = bp->hwrm_cmd_resp_addr;struct hwrm_port_led_qcaps_input req = {0 }; +uint8_t num_leds;int rc;if (BNXT_VF (bp))
@@ -3757,10 +3758,11 @@ int bnxt_hwrm_port_led_qcaps(struct bnxt *bp)HWRM_CHECK_RESULT (); -if (resp->num_leds >0 && resp->num_leds <BNXT_MAX_LED ) { + num_leds = resp->num_leds; +if (num_leds >0 && num_leds <BNXT_MAX_LED ) {unsigned int i; - bp->num_leds = resp->num_leds; + bp->num_leds = num_leds;memcpy (bp->leds, &resp->led0_id,sizeof (bp->leds[0 ]) * bp->num_leds);for (i =0 ; i < bp->num_leds; i++) {
--
2.20.1
Re: [dpdk-dev] [EXTERNAL] [PATCH 2/6] net/bnxt: fix potential data race
Quoted 5 lines · On Tue, 3 Mar 2020 18:13:22 +0000 Christopher Ertl…
Can we add the
volatilequalifier to thehwrm_cmd_resp_addrmember (indrivers/net/bnxt/bnxt.h) to get a stronger guarantee that the compiler won't insert TOCTOU races in the output?Christopher Ertl | MSRC Vulnerabilities & Mitigations | Microsoft Limited | +44 7773976589 | [email protected]
Microsoft Limited (company number 01624297) is a company registered in England and Wales whose registered office is at Microsoft Campus, Thames Valley Park, Reading. RG6 1WG
Should this be done for all the registers in that structure?
PATCH 3/6 net/bnxt: avoid potential out of bounds read
In reply to Stephen HemmingerIf hardware returned a bogus number of vnic's from the query it could cause an out of bounds read into vnic table.
--- drivers/net/bnxt/bnxt_hwrm.c | 6 ++++++ 1 file changed, 6 insertions(+)
drivers/net/bnxt/bnxt_hwrm.c +6 -0
@@ -4029,6 +4029,12 @@ static int bnxt_hwrm_func_vf_vnic_query(struct bnxt *bp, uint16_t vf,HWRM_UNLOCK (); +if (rc > bp->pf.total_vnics) { +PMD_DRV_LOG (ERR , +"Vnic id %d is out of range\n" , rc); +return -EINVAL ; + } +return rc; }
Signature · 1 line
2.20.1
PATCH 4/6 net/bnxt: check for integer overflow in buffer sizing
In reply to Stephen HemmingerIf the hardware returns invalid values, the buffer size calculation could overflow. Check for this by using the GCC/Clang builtin that checks.
--- drivers/net/bnxt/bnxt_hwrm.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/net/bnxt/bnxt_hwrm.c +4 -1
@@ -11,6 +11,7 @@#include <rte_malloc.h> #include <rte_memzone.h> #include <rte_version.h> +#include <rte_overflow.h> #include <rte_io.h> #include "bnxt.h"
@@ -3861,7 +3862,9 @@ int bnxt_get_nvram_directory(struct bnxt *bp, uint32_t len, uint8_t *data) len -=2 ;memset (data,0xff , len); - buflen = dir_entries * entry_length; +if (rte_mul_overflow (dir_entries, entry_length, &buflen)) +return -EINVAL ; + buf =rte_malloc ("nvm_dir" , buflen,0 );if (buf ==NULL )return -ENOMEM ;
Signature · 1 line
2.20.1
PATCH 5/6 net/bnxt: add integer underflow check
In reply to Stephen HemmingerIf a request to read a small value is passed to nvram reader it would underflow.
--- drivers/net/bnxt/bnxt_hwrm.c | 3 +++ 1 file changed, 3 insertions(+)
drivers/net/bnxt/bnxt_hwrm.c +3 -0
@@ -3859,6 +3859,9 @@ int bnxt_get_nvram_directory(struct bnxt *bp, uint32_t len, uint8_t *data) *data++ = dir_entries; *data++ = entry_length; +if (len <=2 ) +return -EINVAL ; + len -=2 ;memset (data,0xff , len);
Signature · 1 line
2.20.1
PATCH 6/6 net/bnxt: sanitize max_l2_ctx
In reply to Stephen HemmingerIf max_l2_ctx is very large, then adding the additional value could cause wraparound.
--- drivers/net/bnxt/bnxt_hwrm.c | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-)
drivers/net/bnxt/bnxt_hwrm.c +9 -2
@@ -651,8 +651,15 @@ static int __bnxt_hwrm_func_qcaps(struct bnxt *bp) bp->first_vf_id =rte_le_to_cpu_16 (resp->first_vf_id); bp->max_rx_em_flows =rte_le_to_cpu_16 (resp->max_rx_em_flows); bp->max_l2_ctx =rte_le_to_cpu_16 (resp->max_l2_ctxs); -if (!BNXT_CHIP_THOR (bp)) - bp->max_l2_ctx += bp->max_rx_em_flows; +if (!BNXT_CHIP_THOR (bp)) { +uint16_t max_l2_ctx; + +if (rte_add_overflow (bp->max_l2_ctx, bp->max_rx_em_flows, + &max_l2_ctx)) +return -EINVAL ; + bp->max_l2_ctx = max_l2_ctx; + } +/* TODO: For now, do not support VMDq/RFS on VFs. */ if (BNXT_PF (bp)) {if (bp->pf.max_vfs)
Signature · 1 line
2.20.1
Quoted 4 lines · Stephen Hemminger
This set of patches came from security review of bnxt driver. It introduces a set of overflow macros that could be more widely used in other places in DPDK to check for math overflows.
Quoted 8 lines
Stephen Hemminger (6):
eal: add portable way to check for math overflow net/bnxt: fix potential data race
net/bnxt: avoid potential out of bounds read net/bnxt: check for integer overflow in buffer sizing net/bnxt: add integer underflow check net/bnxt: sanitizemax_l2_ctx
Hi Ajit,
I can see this patchset has been merged into your tree, although the note in the mail list is missing. Since it has eal changes, I believe they should be reviewed first before merging into brcm tree, can you separate the eal and dependent patch for review, we can proceed with rest?
Regards,
ferruh
Quoted 14 lines · Ferruh Yigit
Quoted 4 lines · Stephen Hemminger
This set of patches came from security review of bnxt driver. It introduces a set of overflow macros that could be more widely used in other places in DPDK to check for math overflows.
Quoted 8 lines
Stephen Hemminger (6):
eal: add portable way to check for math overflow net/bnxt: fix potential data race
net/bnxt: avoid potential out of bounds read net/bnxt: check for integer overflow in buffer sizing net/bnxt: add integer underflow check net/bnxt: sanitizemax_l2_ctx
Quoted 8 lines
Hi Ajit,
I can see this patchset has been merged into your tree, although the note in the
mail list is missing. Since it has eal changes, I believe they should be reviewed first before merging into brcm tree, can you separate the eal and dependent patch for review, we can proceed with rest?
I don't mind.
But being original owner - Stephen, do you want to go ahead?
Thanks
Ajit
Quoted 4 lines
Regards,
ferruh
Quoted 24 lines · On Tue, 31 Mar 2020 10:52:47 -0700 Ajit Khaparde <[email protected]>…
Quoted 14 lines · Ferruh Yigit
Quoted 4 lines · Stephen Hemminger
This set of patches came from security review of bnxt driver. It introduces a set of overflow macros that could be more widely used in other places in DPDK to check for math overflows.
Quoted 8 lines
Stephen Hemminger (6):
eal: add portable way to check for math overflow net/bnxt: fix potential data race
net/bnxt: avoid potential out of bounds read net/bnxt: check for integer overflow in buffer sizing net/bnxt: add integer underflow check net/bnxt: sanitizemax_l2_ctxQuoted 8 lines
Hi Ajit,
I can see this patchset has been merged into your tree, although the note in the
mail list is missing. Since it has eal changes, I believe they should be reviewed first before merging into brcm tree, can you separate the eal and dependent patch for review, we can proceed with rest?
Quoted 10 lines
I don't mind.
But being original owner - Stephen, do you want to go ahead?Thanks
AjitQuoted 4 lines
Regards,
ferruh
Sure, I expected normal review cycle on this.
Hoped that other drivers and eal core would also add overflow checks
Why there was no progress on this during 6 months?
Ajit, it was out of my radar because delegated to you.
Please restart fresh with a separate patch for EAL, addressing comments. Thanks
31/03/2020 20:04, Stephen Hemminger:
Quoted 41 lines
Quoted 24 lines · On Tue, 31 Mar 2020 10:52:47 -0700 Ajit Khaparde <[email protected]>…
Quoted 14 lines · Ferruh Yigit
Quoted 4 lines · Stephen Hemminger
This set of patches came from security review of bnxt driver. It introduces a set of overflow macros that could be more widely used in other places in DPDK to check for math overflows.
Quoted 8 lines
Stephen Hemminger (6):
eal: add portable way to check for math overflow net/bnxt: fix potential data race
net/bnxt: avoid potential out of bounds read net/bnxt: check for integer overflow in buffer sizing net/bnxt: add integer underflow check net/bnxt: sanitizemax_l2_ctxQuoted 8 lines
Hi Ajit,
I can see this patchset has been merged into your tree, although the note in the
mail list is missing. Since it has eal changes, I believe they should be reviewed first before merging into brcm tree, can you separate the eal and dependent patch for review, we can proceed with rest?Quoted 10 lines
I don't mind.
But being original owner - Stephen, do you want to go ahead?Thanks
AjitQuoted 4 lines
Regards,
ferruhSure, I expected normal review cycle on this.
Hoped that other drivers and eal core would also add overflow checks