rte_eth_dev_get_name_by_port() uses strcpy() into a caller-provided buffer with no bounds checking. A mistaken caller that supplies a buffer smaller than RTE_ETH_NAME_MAX_LEN can overflow the buffer.
Add a size parameter and replace strcpy() with strlcpy(), returning -ERANGE if the name is truncated. The copy is now performed under the ethdev shared data lock so that the name cannot be mutated by another process between reading and copying. Update all in-tree callers to pass the size of the buffer and add checks for return value. Signed-off-by: Stephen Hemminger <[email protected]> --- v5 - rebase and update new pmd memif test app/dumpcap/main.c | 8 +++--- app/pdump/main.c | 8 +++--- app/test-pmd/config.c | 13 ++++++---- app/test/test_event_eth_tx_adapter.c | 4 +-- app/test/test_pmd_memif.c | 2 +- app/test/test_pmd_ring_perf.c | 4 +-- app/test/test_pmd_tap.c | 6 ++--- doc/guides/rel_notes/release_26_11.rst | 3 +++ drivers/net/bnxt/tf_ulp/bnxt_ulp_tf.c | 4 +-- drivers/net/cnxk/cnxk_flow.c | 10 +++++--- examples/multi_process/hotplug_mp/commands.c | 5 ++-- examples/pipeline/cli.c | 4 ++- lib/ethdev/rte_ethdev.c | 27 +++++++++++++------- lib/ethdev/rte_ethdev.h | 12 ++++++--- lib/pdump/rte_pdump.c | 8 +++--- 15 files changed, 72 insertions(+), 46 deletions(-) diff --git a/app/dumpcap/main.c b/app/dumpcap/main.c index 46a6cb251e..47483535fc 100644 --- a/app/dumpcap/main.c +++ b/app/dumpcap/main.c @@ -244,7 +244,7 @@ static void find_interfaces(void) /* maybe got passed port number string as name */ intf->port = get_uint(intf->name, "port_number", UINT16_MAX); - if (rte_eth_dev_get_name_by_port(intf->port, intf->name) < 0) + if (rte_eth_dev_get_name_by_port(intf->port, intf->name, sizeof(intf->name)) < 0) rte_exit(EXIT_FAILURE, "Invalid port number %u\n", intf->port); } @@ -261,7 +261,7 @@ static void set_default_interface(void) uint16_t p; RTE_ETH_FOREACH_DEV(p) { - if (rte_eth_dev_get_name_by_port(p, name) < 0) + if (rte_eth_dev_get_name_by_port(p, name, sizeof(name)) < 0) continue; intf = add_interface(name); @@ -278,7 +278,7 @@ static void dump_interfaces(void) uint16_t p; RTE_ETH_FOREACH_DEV(p) { - if (rte_eth_dev_get_name_by_port(p, name) < 0) + if (rte_eth_dev_get_name_by_port(p, name, sizeof(name)) < 0) continue; printf("%u. %s\n", p, name); } @@ -498,7 +498,7 @@ static void statistics_loop(void) while (!rte_atomic_load_explicit(&quit_signal, rte_memory_order_relaxed)) { RTE_ETH_FOREACH_DEV(p) { - if (rte_eth_dev_get_name_by_port(p, name) < 0) + if (rte_eth_dev_get_name_by_port(p, name, sizeof(name)) < 0) continue; r = rte_eth_stats_get(p, &stats); diff --git a/app/pdump/main.c b/app/pdump/main.c index 1e62c8adc1..1f6135b20e 100644 --- a/app/pdump/main.c +++ b/app/pdump/main.c @@ -539,16 +539,16 @@ cleanup_pdump_resources(void) /* Remove the vdev(s) created */ if (pt->dir & RTE_PDUMP_FLAG_RX) { - rte_eth_dev_get_name_by_port(pt->rx_vdev_id, name); - rte_eal_hotplug_remove("vdev", name); + if (rte_eth_dev_get_name_by_port(pt->rx_vdev_id, name, sizeof(name)) == 0) + rte_eal_hotplug_remove("vdev", name); } if (pt->single_pdump_dev) continue; if (pt->dir & RTE_PDUMP_FLAG_TX) { - rte_eth_dev_get_name_by_port(pt->tx_vdev_id, name); - rte_eal_hotplug_remove("vdev", name); + if (rte_eth_dev_get_name_by_port(pt->tx_vdev_id, name, sizeof(name)) == 0) + rte_eal_hotplug_remove("vdev", name); } } diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c index 6bd5292836..8986d6998f 100644 --- a/app/test-pmd/config.c +++ b/app/test-pmd/config.c @@ -699,8 +699,8 @@ device_infos_display(const char *identifier) &mac_addr) == 0) print_ethaddr("\n\tMAC address: ", &mac_addr); - rte_eth_dev_get_name_by_port(port_id, name); - printf("\n\tDevice name: %s", name); + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) == 0) + printf("\n\tDevice name: %s", name); if (rte_eth_dev_info_get(port_id, &dev_info) == 0) device_infos_display_speeds(dev_info.speed_capa); printf("\n"); @@ -832,8 +832,8 @@ port_infos_display(portid_t port_id) info_border, port_id, info_border); if (eth_macaddr_get_print_err(port_id, &mac_addr) == 0) print_ethaddr("MAC address: ", &mac_addr); - rte_eth_dev_get_name_by_port(port_id, name); - printf("\nDevice name: %s", name); + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) == 0) + printf("\nDevice name: %s", name); printf("\nDriver name: %s", dev_info.driver_name); if (rte_eth_dev_fw_version_get(port_id, fw_version, @@ -1033,7 +1033,10 @@ port_summary_display(portid_t port_id) if (ret != 0) return; - rte_eth_dev_get_name_by_port(port_id, name); + ret = rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)); + if (ret != 0) + return; + ret = eth_macaddr_get_print_err(port_id, &mac_addr); if (ret != 0) return; diff --git a/app/test/test_event_eth_tx_adapter.c b/app/test/test_event_eth_tx_adapter.c index 0c161897ce..a0d53414dc 100644 --- a/app/test/test_event_eth_tx_adapter.c +++ b/app/test/test_event_eth_tx_adapter.c @@ -192,8 +192,8 @@ deinit_ports(void) for (i = 0; i < RTE_DIM(default_params.port); i++) { rte_eth_dev_stop(default_params.port[i]); - rte_eth_dev_get_name_by_port(default_params.port[i], name); - rte_vdev_uninit(name); + if (rte_eth_dev_get_name_by_port(default_params.port[i], name, sizeof(name)) == 0) + rte_vdev_uninit(name); for (j = 0; j < RTE_DIM(default_params.r[i]); j++) rte_ring_free(default_params.r[i][j]); } diff --git a/app/test/test_pmd_memif.c b/app/test/test_pmd_memif.c index 9bab43adb0..225640bdf2 100644 --- a/app/test/test_pmd_memif.c +++ b/app/test/test_pmd_memif.c @@ -81,7 +81,7 @@ find_port(const char *frag) char name[RTE_ETH_NAME_MAX_LEN]; RTE_ETH_FOREACH_DEV(port_id) { - if (rte_eth_dev_get_name_by_port(port_id, name) == 0 && + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) == 0 && strstr(name, frag) != NULL) return port_id; } diff --git a/app/test/test_pmd_ring_perf.c b/app/test/test_pmd_ring_perf.c index 3636df5c73..ac60f506ab 100644 --- a/app/test/test_pmd_ring_perf.c +++ b/app/test/test_pmd_ring_perf.c @@ -157,8 +157,8 @@ test_ring_pmd_perf(void) /* release port and ring resources */ if (rte_eth_dev_stop(ring_ethdev_port) != 0) return -1; - rte_eth_dev_get_name_by_port(ring_ethdev_port, name); - rte_vdev_uninit(name); + if (rte_eth_dev_get_name_by_port(ring_ethdev_port, name, sizeof(name)) == 0) + rte_vdev_uninit(name); rte_ring_free(r); return 0; } diff --git a/app/test/test_pmd_tap.c b/app/test/test_pmd_tap.c index 6d0e8b4f54..ded26bc5e3 100644 --- a/app/test/test_pmd_tap.c +++ b/app/test/test_pmd_tap.c @@ -594,7 +594,7 @@ test_tap_multi_queue(void) uint16_t port; RTE_ETH_FOREACH_DEV(port) { char name[RTE_ETH_NAME_MAX_LEN]; - if (rte_eth_dev_get_name_by_port(port, name) == 0 && + if (rte_eth_dev_get_name_by_port(port, name, sizeof(name)) == 0 && strstr(name, "net_tap_mq")) goto found; } @@ -739,7 +739,7 @@ test_tap_setup(void) /* Find the port IDs */ RTE_ETH_FOREACH_DEV(port_id) { char name[RTE_ETH_NAME_MAX_LEN]; - if (rte_eth_dev_get_name_by_port(port_id, name) != 0) + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) != 0) continue; if (strstr(name, "net_tap0")) @@ -785,7 +785,7 @@ test_tap_rx_queue_setup(void) port = -1; RTE_ETH_FOREACH_DEV(port_id) { char name[RTE_ETH_NAME_MAX_LEN]; - if (rte_eth_dev_get_name_by_port(port_id, name) == 0 && + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) == 0 && strstr(name, "net_tap_neg")) { port = port_id; break; diff --git a/doc/guides/rel_notes/release_26_11.rst b/doc/guides/rel_notes/release_26_11.rst index d3ab3662dd..8387949ef3 100644 --- a/doc/guides/rel_notes/release_26_11.rst +++ b/doc/guides/rel_notes/release_26_11.rst @@ -666,6 +666,9 @@ API Changes ``rte_event_port_profile_links_get`` and ``rte_event_port_profile_unlink`` +* ethdev: Added ``size`` parameter to ``rte_eth_dev_get_name_by_port()`` + to prevent buffer overflows. + * raw/ntb: Removed the ``mw_size_align`` field from ``struct ntb_dev_info``. Applications must now query the required memory window base-address alignment with the new ``rte_pmd_ntb_get_mem_align()`` function instead of relying on this field. diff --git a/drivers/net/bnxt/tf_ulp/bnxt_ulp_tf.c b/drivers/net/bnxt/tf_ulp/bnxt_ulp_tf.c index 6ca9d3309b..e1ffc64c5e 100644 --- a/drivers/net/bnxt/tf_ulp/bnxt_ulp_tf.c +++ b/drivers/net/bnxt/tf_ulp/bnxt_ulp_tf.c @@ -608,7 +608,7 @@ ulp_tf_ctx_shared_session_open(struct bnxt *bp, memset(&parms, 0, sizeof(parms)); rc = rte_eth_dev_get_name_by_port(ethdev->data->port_id, - parms.ctrl_chan_name); + parms.ctrl_chan_name, sizeof(parms.ctrl_chan_name)); if (rc) { BNXT_DRV_DBG(ERR, "Invalid port %d, rc = %d\n", ethdev->data->port_id, rc); @@ -786,7 +786,7 @@ ulp_tf_ctx_session_open(struct bnxt *bp, memset(¶ms, 0, sizeof(params)); rc = rte_eth_dev_get_name_by_port(ethdev->data->port_id, - params.ctrl_chan_name); + params.ctrl_chan_name, sizeof(params.ctrl_chan_name)); if (rc) { BNXT_DRV_DBG(ERR, "Invalid port %d, rc = %d\n", ethdev->data->port_id, rc); diff --git a/drivers/net/cnxk/cnxk_flow.c b/drivers/net/cnxk/cnxk_flow.c index 1562b7389e..d52c61fc3e 100644 --- a/drivers/net/cnxk/cnxk_flow.c +++ b/drivers/net/cnxk/cnxk_flow.c @@ -117,7 +117,7 @@ npc_parse_port_id_action(struct rte_eth_dev *eth_dev, const struct rte_flow_acti port_act = (const struct rte_flow_action_port_id *)action->conf; - rc = rte_eth_dev_get_name_by_port(port_act->id, if_name); + rc = rte_eth_dev_get_name_by_port(port_act->id, if_name, sizeof(if_name)); if (rc) { plt_err("Name not found for output port id"); goto err_exit; @@ -519,7 +519,8 @@ cnxk_map_actions(struct rte_eth_dev *eth_dev, const struct rte_flow_attr *attr, case RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR: in_actions[i].conf = actions->conf; act_ethdev = (const struct rte_flow_action_ethdev *)actions->conf; - if (rte_eth_dev_get_name_by_port(act_ethdev->port_id, if_name)) { + if (rte_eth_dev_get_name_by_port(act_ethdev->port_id, if_name, + sizeof(if_name))) { plt_err("Name not found for output port id"); goto err_exit; } @@ -559,7 +560,7 @@ cnxk_map_actions(struct rte_eth_dev *eth_dev, const struct rte_flow_attr *attr, actions->type != RTE_FLOW_ACTION_TYPE_PORT_ID ? act_ethdev->port_id : port_act->id, - if_name)) { + if_name, sizeof(if_name))) { plt_err("Name not found for output port id"); goto err_exit; } @@ -715,7 +716,8 @@ cnxk_map_pattern(struct rte_eth_dev *eth_dev, const struct rte_flow_item pattern if (pattern->type == RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT || pattern->type == RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR) { rep_eth_dev = (const struct rte_flow_item_ethdev *)pattern->spec; - if (rte_eth_dev_get_name_by_port(rep_eth_dev->port_id, if_name)) { + if (rte_eth_dev_get_name_by_port(rep_eth_dev->port_id, if_name, + sizeof(if_name))) { plt_err("Name not found for output port id"); goto fail; } diff --git a/examples/multi_process/hotplug_mp/commands.c b/examples/multi_process/hotplug_mp/commands.c index 900eb9f774..e84e130b3c 100644 --- a/examples/multi_process/hotplug_mp/commands.c +++ b/examples/multi_process/hotplug_mp/commands.c @@ -31,12 +31,13 @@ cmd_list_parsed(__rte_unused void *parsed_result, __rte_unused void *data) { uint16_t port_id; - char dev_name[RTE_DEV_NAME_MAX_LEN]; cmdline_printf(cl, "list all etherdev\n"); RTE_ETH_FOREACH_DEV(port_id) { - rte_eth_dev_get_name_by_port(port_id, dev_name); + char dev_name[RTE_DEV_NAME_MAX_LEN] = ""; + + rte_eth_dev_get_name_by_port(port_id, dev_name, sizeof(dev_name)); if (strlen(dev_name) > 0) cmdline_printf(cl, "%d\t%s\n", port_id, dev_name); else diff --git a/examples/pipeline/cli.c b/examples/pipeline/cli.c index 901706fab9..644ae56fd3 100644 --- a/examples/pipeline/cli.c +++ b/examples/pipeline/cli.c @@ -396,7 +396,9 @@ ethdev_show(uint16_t port_id, char **out, size_t *out_size) if (rte_eth_link_get(port_id, &link) != 0) return; - rte_eth_dev_get_name_by_port(port_id, name); + if (rte_eth_dev_get_name_by_port(port_id, name, sizeof(name)) != 0) + return; + rte_eth_stats_get(port_id, &stats); rte_eth_macaddr_get(port_id, &addr); rte_eth_dev_get_mtu(port_id, &mtu); diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c index a72169d80d..f280ecf7c3 100644 --- a/lib/ethdev/rte_ethdev.c +++ b/lib/ethdev/rte_ethdev.c @@ -715,25 +715,34 @@ rte_eth_dev_count_total(void) RTE_EXPORT_SYMBOL(rte_eth_dev_get_name_by_port) int -rte_eth_dev_get_name_by_port(uint16_t port_id, char *name) +rte_eth_dev_get_name_by_port(uint16_t port_id, char *name, size_t size) { - char *tmp; - RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); if (name == NULL) { - RTE_ETHDEV_LOG_LINE(ERR, "Cannot get ethdev port %u name to NULL", - port_id); + RTE_ETHDEV_LOG_LINE(ERR, "Cannot get ethdev port %u name to NULL", port_id); + return -EINVAL; + } + + if (size == 0) { + RTE_ETHDEV_LOG_LINE(ERR, "Cannot get ethdev port %u name with zero-size buffer", + port_id); return -EINVAL; } rte_spinlock_lock(rte_mcfg_ethdev_get_lock()); - /* shouldn't check 'rte_eth_devices[i].data', - * because it might be overwritten by VDEV PMD */ - tmp = eth_dev_shared_data->data[port_id].name; + /* + * Use the shared data name rather than rte_eth_devices[].data->name + * because VDEV PMDs may overwrite the per-process data pointer. + */ + size_t n = strlcpy(name, eth_dev_shared_data->data[port_id].name, size); rte_spinlock_unlock(rte_mcfg_ethdev_get_lock()); - strcpy(name, tmp); + if (n >= size) { + RTE_ETHDEV_LOG_LINE(ERR, "ethdev port %u name exceeds buffer size %zu", + port_id, size); + return -ERANGE; + } rte_ethdev_trace_get_name_by_port(port_id, name); diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index 2c0ef6a4e5..599299a781 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -5553,14 +5553,20 @@ rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id); * @param port_id * Port identifier of the device. * @param name - * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name. + * Buffer to store the name. + * @param size + * Size of the buffer pointed to by *name*. + * Must be large enough to hold device name, + * RTE_ETH_NAME_MAX_LEN is always sufficient. * @return * - (0) if successful. * - (-ENODEV) if *port_id* is invalid. - * - (-EINVAL) on failure. + * - (-EINVAL) if *name* is NULL or *size* is 0. + * - (-ERANGE) if the buffer is too small for the device name, + * result is truncated. */ int -rte_eth_dev_get_name_by_port(uint16_t port_id, char *name); +rte_eth_dev_get_name_by_port(uint16_t port_id, char *name, size_t size); /** * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from diff --git a/lib/pdump/rte_pdump.c b/lib/pdump/rte_pdump.c index ac94efe7ff..3d494592b3 100644 --- a/lib/pdump/rte_pdump.c +++ b/lib/pdump/rte_pdump.c @@ -726,7 +726,7 @@ pdump_validate_flags(uint32_t flags) } static int -pdump_validate_port(uint16_t port, char *name) +pdump_validate_port(uint16_t port, char *name, size_t len) { int ret = 0; @@ -736,7 +736,7 @@ pdump_validate_port(uint16_t port, char *name) return -1; } - ret = rte_eth_dev_get_name_by_port(port, name); + ret = rte_eth_dev_get_name_by_port(port, name, len); if (ret < 0) { PDUMP_LOG_LINE(ERR, "port %u to name mapping failed", port); @@ -818,7 +818,7 @@ pdump_enable(uint16_t port, uint16_t queue, int ret; char name[RTE_DEV_NAME_MAX_LEN]; - ret = pdump_validate_port(port, name); + ret = pdump_validate_port(port, name, sizeof(name)); if (ret < 0) return ret; ret = pdump_validate_ring_mp(ring, mp); @@ -912,7 +912,7 @@ rte_pdump_disable(uint16_t port, uint16_t queue, uint32_t flags) int ret = 0; char name[RTE_DEV_NAME_MAX_LEN]; - ret = pdump_validate_port(port, name); + ret = pdump_validate_port(port, name, sizeof(name)); if (ret < 0) return ret; ret = pdump_validate_flags(flags); -- 2.53.0

