diff mbox series

[v3,09/13] telemetry: limit command characters

Message ID	20220909093523.471727-10-bruce.richardson@intel.com (mailing list archive)
State	Accepted, archived
Delegated to:	David Marchand
Headers	From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: Bruce Richardson <bruce.richardson@intel.com>, Ciara Power <ciara.power@intel.com>, =?utf-8?q?Morten_Br=C3=B8rup?= <mb@smartsharesystems.com> Subject: [PATCH v3 09/13] telemetry: limit command characters Date: Fri, 9 Sep 2022 10:35:19 +0100 Message-Id: <20220909093523.471727-10-bruce.richardson@intel.com> In-Reply-To: <20220909093523.471727-1-bruce.richardson@intel.com> References: <20220623164245.561371-1-bruce.richardson@intel.com> <20220909093523.471727-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: list Errors-To: dev-bounces@dpdk.org
Series	telemetry JSON escaping and other enhancements \| [v3,00/13] telemetry JSON escaping and other enhancements [v3,01/13] telemetry: limit characters allowed in dictionary names [v3,02/13] test/telemetry_json: print success or failure per subtest [v3,03/13] telemetry: fix escaping of invalid json characters [v3,04/13] test/telemetry_json: add test for string character escaping [v3,05/13] telemetry: add escaping of strings in arrays [v3,06/13] test/telemetry-json: add test for escaping strings in arrays [v3,07/13] telemetry: add escaping of strings in dicts [v3,08/13] test/telemetry_json: add test for string escaping in objects [v3,09/13] telemetry: limit command characters [v3,10/13] test/telemetry_data: refactor for maintainability [v3,11/13] test/telemetry_data: add test cases for character escaping [v3,12/13] telemetry: eliminate duplicate code for json output [v3,13/13] telemetry: make help command more helpful

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK

Commit Message

Bruce Richardson Sept. 9, 2022, 9:35 a.m. UTC

  Limit the telemetry command characters to the minimum set needed for
current implementations. This prevents issues with invalid json
characters needing to be escaped on replies.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Ciara Power <ciara.power@intel.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 --------
 lib/telemetry/telemetry.c            | 7 +++++++
 2 files changed, 7 insertions(+), 8 deletions(-)

diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index e7583cae4c..d1c93ca7e3 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -212,14 +212,6 @@  Deprecation Notices
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.
 
-* telemetry: The allowed characters in names for dictionary values
-  will be limited to alphanumeric characters
-  and a small subset of additional printable characters.
-  This will ensure that all dictionary parameter names can be output
-  without escaping in JSON - or in any future output format used.
-  Names for the telemetry commands will be similarly limited.
-  The parameters for telemetry commands are unaffected by this change.
-
 * net/octeontx_ep: The driver ``octeontx_ep`` was to support OCTEON TX
   line of products.
   It will be renamed to ``octeon_ep`` in DPDK 22.11 to apply for
diff --git a/lib/telemetry/telemetry.c b/lib/telemetry/telemetry.c
index 7188b1905c..03651e947d 100644
--- a/lib/telemetry/telemetry.c
+++ b/lib/telemetry/telemetry.c
@@ -70,12 +70,19 @@  int
 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
 {
 	struct cmd_callback *new_callbacks;
+	const char *cmdp = cmd;
 	int i = 0;
 
 	if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
 			|| strlen(help) >= RTE_TEL_MAX_STRING_LEN)
 		return -EINVAL;
 
+	while (*cmdp != '\0') {
+		if (!isalnum(*cmdp) && *cmdp != '_' && *cmdp != '/')
+			return -EINVAL;
+		cmdp++;
+	}
+
 	rte_spinlock_lock(&callback_sl);
 	new_callbacks = realloc(callbacks, sizeof(callbacks[0]) * (num_callbacks + 1));
 	if (new_callbacks == NULL) {