Control chars breaks JSON serialization on CFEngine version 3.24.2

[m4rtinh4rt]

Control chars breaks JSON serialization on CFEngine version 3.24.2

As specified in section 7 of RFC 7159, the control characters (U+0000 through U+001F) must be escaped.

Example using a Python implementation with the control character 'escape' (ASCII: 27, Unicode: U+001B):

import json

example_red = '{ "msg": "�[1;31mSome red text\n�[39;49m" }'
a = json.dumps(example_red)
print(a)

Outputs: "{ \"msg\": \"\u001b[1;31mSome red text\n\u001b[39;49m\" }"

Minimal example in CFEngine to reproduce the bug:

bundle agent main
{
    vars:
      "example_red"		data => parsejson('{ "msg": "�[1;31mSome red text\n�[39;49m" }');
      "my_red_string"		string => storejson(example_red);

    reports:
      "${my_red_string}";

    files:
      "/tmp/datastate.json"
        template_method      => "inline_mustache",
        create               => "true",
        edit_template_string => "{{%-top-}}";
}

The created /tmp/datastate.json contains unescaped U+001B and therefore is not valid JSON.

...
    "main": {
      "example_red": {
        "msg": "^[[1;31mSome red text\n\\x1b[39;49m"
      },
      "my_red_string": "{\n  \"msg\": \"^[[1;31mSome red text\\n\\\^[[39;49m\"\n}"
    },

$ jq '.' /tmp/datastate.json

outputs: jq: parse error: Invalid string: control characters from U+0000 through U+001F must be escaped at line 125, column 51

[larsewi]

Hi @m4rtinh4rt, thanks for reporting this issue. I created a ticket in our bug tracker (see CFE-4616). Feel free to make a contribution if you want to :)

[m4rtinh4rt]

Hello @larsewi, I made a PR to solve this issue.

[larsewi]

Thanks @m4rtinh4rt I will take a look at it :)