tools: bpftool: Remove invalid \' json escape
authorLuis Gerhorst <gerhorst@cs.fau.de>
Mon, 27 Feb 2023 15:08:54 +0000 (16:08 +0100)
committerAndrii Nakryiko <andrii@kernel.org>
Mon, 27 Feb 2023 19:28:16 +0000 (11:28 -0800)
commitc679bbd611c08b0559ffae079330bc4e5574696a
tree01d17eb881ca7b0bd1c433250d1270155775db39
parent84c22fa83f9cb97061359f97d85f53a9ccde02c4
tools: bpftool: Remove invalid \' json escape

RFC8259 ("The JavaScript Object Notation (JSON) Data Interchange
Format") only specifies \", \\, \/, \b, \f, \n, \r, and \r as valid
two-character escape sequences. This does not include \', which is not
required in JSON because it exclusively uses double quotes as string
separators.

Solidus (/) may be escaped, but does not have to. Only reverse
solidus (\), double quotes ("), and the control characters have to be
escaped. Therefore, with this fix, bpftool correctly supports all valid
two-character escape sequences (but still does not support characters
that require multi-character escape sequences).

Witout this fix, attempting to load a JSON file generated by bpftool
using Python 3.10.6's default json.load() may fail with the error
"Invalid \escape" if the file contains the invalid escaped single
quote (\').

Fixes: b66e907cfee2 ("tools: bpftool: copy JSON writer from iproute2 repository")
Signed-off-by: Luis Gerhorst <gerhorst@cs.fau.de>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Reviewed-by: Quentin Monnet <quentin@isovalent.com>
Link: https://lore.kernel.org/bpf/20230227150853.16863-1-gerhorst@cs.fau.de
tools/bpf/bpftool/json_writer.c