app/proc-info: fix string copying to use strlcpy

Message ID 20190926151159.19256-1-ciara.power@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series app/proc-info: fix string copying to use strlcpy |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/iol-dpdk_compile_ovs success Compile Testing PASS
ci/iol-dpdk_compile_spdk success Compile Testing PASS
ci/iol-dpdk_compile success Compile Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Power, Ciara Sept. 26, 2019, 3:11 p.m. UTC
  Replaced strncpy and strcpy with strlcpy.
Also replaced snprintf with strlcpy where applicable.
Using strlcpy is safe practice when copying strings,
as it will include a null terminator.

Cc: romanx.korynkevych@intel.com
Cc: vipin.varghese@intel.com
Cc: stable@dpdk.org

Fixes: 2deb6b5246d7 ("app/procinfo: add collectd format and host id")
Fixes: 8a37f37fc243 ("app/procinfo: add --show-port")
Reported-by: Reshma Pattan <reshma.pattan@intel.com>
Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 app/proc-info/main.c | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)
  

Comments

Bruce Richardson Sept. 26, 2019, 2:44 p.m. UTC | #1
On Thu, Sep 26, 2019 at 04:11:59PM +0100, Ciara Power wrote:
> Replaced strncpy and strcpy with strlcpy.
> Also replaced snprintf with strlcpy where applicable.
> Using strlcpy is safe practice when copying strings,
> as it will include a null terminator.
> 
> Cc: romanx.korynkevych@intel.com
> Cc: vipin.varghese@intel.com
> Cc: stable@dpdk.org
> 
> Fixes: 2deb6b5246d7 ("app/procinfo: add collectd format and host id")
> Fixes: 8a37f37fc243 ("app/procinfo: add --show-port")
> Reported-by: Reshma Pattan <reshma.pattan@intel.com>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> ---
+1 for using strlcpy over strncpy

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
David Marchand Oct. 27, 2019, 10:36 a.m. UTC | #2
On Thu, Sep 26, 2019 at 4:44 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> On Thu, Sep 26, 2019 at 04:11:59PM +0100, Ciara Power wrote:
> > Replaced strncpy and strcpy with strlcpy.
> > Also replaced snprintf with strlcpy where applicable.
> > Using strlcpy is safe practice when copying strings,
> > as it will include a null terminator.
> >
> >
> > Fixes: 2deb6b5246d7 ("app/procinfo: add collectd format and host id")
> > Fixes: 8a37f37fc243 ("app/procinfo: add --show-port")
> > Cc: stable@dpdk.org

> > Reported-by: Reshma Pattan <reshma.pattan@intel.com>
> > Signed-off-by: Ciara Power <ciara.power@intel.com>
> > ---
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.
  

Patch

diff --git a/app/proc-info/main.c b/app/proc-info/main.c
index a89b51bb3..903921b0f 100644
--- a/app/proc-info/main.c
+++ b/app/proc-info/main.c
@@ -201,7 +201,7 @@  proc_info_preparse_args(int argc, char **argv)
 		int err = gethostname(host_id, MAX_LONG_OPT_SZ-1);
 
 		if (err)
-			strcpy(host_id, "unknown");
+			strlcpy(host_id, "unknown", sizeof(host_id));
 	}
 
 	return 0;
@@ -396,50 +396,50 @@  static void collectd_resolve_cnt_type(char *cnt_type, size_t cnt_type_len,
 	if ((type_end != NULL) &&
 	    (strncmp(cnt_name, "rx_", strlen("rx_")) == 0)) {
 		if (strncmp(type_end, "_errors", strlen("_errors")) == 0)
-			strncpy(cnt_type, "if_rx_errors", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_errors", cnt_type_len);
 		else if (strncmp(type_end, "_dropped", strlen("_dropped")) == 0)
-			strncpy(cnt_type, "if_rx_dropped", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_dropped", cnt_type_len);
 		else if (strncmp(type_end, "_bytes", strlen("_bytes")) == 0)
-			strncpy(cnt_type, "if_rx_octets", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_octets", cnt_type_len);
 		else if (strncmp(type_end, "_packets", strlen("_packets")) == 0)
-			strncpy(cnt_type, "if_rx_packets", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_packets", cnt_type_len);
 		else if (strncmp(type_end, "_placement",
 				 strlen("_placement")) == 0)
-			strncpy(cnt_type, "if_rx_errors", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_errors", cnt_type_len);
 		else if (strncmp(type_end, "_buff", strlen("_buff")) == 0)
-			strncpy(cnt_type, "if_rx_errors", cnt_type_len);
+			strlcpy(cnt_type, "if_rx_errors", cnt_type_len);
 		else
 			/* Does not fit obvious type: use a more generic one */
-			strncpy(cnt_type, "derive", cnt_type_len);
+			strlcpy(cnt_type, "derive", cnt_type_len);
 	} else if ((type_end != NULL) &&
 		(strncmp(cnt_name, "tx_", strlen("tx_"))) == 0) {
 		if (strncmp(type_end, "_errors", strlen("_errors")) == 0)
-			strncpy(cnt_type, "if_tx_errors", cnt_type_len);
+			strlcpy(cnt_type, "if_tx_errors", cnt_type_len);
 		else if (strncmp(type_end, "_dropped", strlen("_dropped")) == 0)
-			strncpy(cnt_type, "if_tx_dropped", cnt_type_len);
+			strlcpy(cnt_type, "if_tx_dropped", cnt_type_len);
 		else if (strncmp(type_end, "_bytes", strlen("_bytes")) == 0)
-			strncpy(cnt_type, "if_tx_octets", cnt_type_len);
+			strlcpy(cnt_type, "if_tx_octets", cnt_type_len);
 		else if (strncmp(type_end, "_packets", strlen("_packets")) == 0)
-			strncpy(cnt_type, "if_tx_packets", cnt_type_len);
+			strlcpy(cnt_type, "if_tx_packets", cnt_type_len);
 		else
 			/* Does not fit obvious type: use a more generic one */
-			strncpy(cnt_type, "derive", cnt_type_len);
+			strlcpy(cnt_type, "derive", cnt_type_len);
 	} else if ((type_end != NULL) &&
 		   (strncmp(cnt_name, "flow_", strlen("flow_"))) == 0) {
 		if (strncmp(type_end, "_filters", strlen("_filters")) == 0)
-			strncpy(cnt_type, "operations", cnt_type_len);
+			strlcpy(cnt_type, "operations", cnt_type_len);
 		else if (strncmp(type_end, "_errors", strlen("_errors")) == 0)
-			strncpy(cnt_type, "errors", cnt_type_len);
+			strlcpy(cnt_type, "errors", cnt_type_len);
 		else if (strncmp(type_end, "_filters", strlen("_filters")) == 0)
-			strncpy(cnt_type, "filter_result", cnt_type_len);
+			strlcpy(cnt_type, "filter_result", cnt_type_len);
 	} else if ((type_end != NULL) &&
 		   (strncmp(cnt_name, "mac_", strlen("mac_"))) == 0) {
 		if (strncmp(type_end, "_errors", strlen("_errors")) == 0)
-			strncpy(cnt_type, "errors", cnt_type_len);
+			strlcpy(cnt_type, "errors", cnt_type_len);
 	} else {
 		/* Does not fit obvious type, or strrchr error: */
 		/* use a more generic type */
-		strncpy(cnt_type, "derive", cnt_type_len);
+		strlcpy(cnt_type, "derive", cnt_type_len);
 	}
 }
 
@@ -1321,7 +1321,7 @@  main(int argc, char **argv)
 	if (ret)
 		printf("Error from rte_eal_cleanup(), %d\n", ret);
 
-	snprintf(bdr_str, MAX_STRING_LEN, " ");
+	strlcpy(bdr_str, " ", MAX_STRING_LEN);
 	STATS_BDR_STR(50, bdr_str);
 
 	return 0;