escaping new lines (/n) for sarif format

[DmitriyLewen]

Select Topic Area

Question

Body

Hello!
sarif docs say (about text property) The SARIF producer SHALL escape any characters that JSON [[RFC8259](https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#RFC8259)] requires to be escaped. - https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790674
And, if i undertand correctly, we need to escape /, so we need to use //n for new lines.

But after using //n and uploading with github/codeql-action/upload-sarif@v2 we don't get new lines in UI:
aquasecurity/trivy#5804

Can you explain which way is correct?

Thank you in advance!
Best Regards, Dmitriy!

[jketema]

Hi @DmitriyLewen,

A concrete repoducer where you're seeing this - and what exactly you're seeing after the fix on your side - would help us diagnose this issue.

[DmitriyLewen]

Thanks a lot!

[orhantoy]

Have you tried \n (instead of \\n)?

[DmitriyLewen]

\n works correctly, but i try to understand correct way.
docs say that we need to escape \.

[orhantoy]

The docs also specifically calls out line breaks though:

Notwithstanding any necessary transcoding and escaping, the SARIF producer SHALL preserve the text artifact’s line breaking convention (for example, "\n" or "\r\n").

[DmitriyLewen]

So we don't need to escape \r\n and \n, right?

[orhantoy]

Correct.

[DmitriyLewen]

Got it!
Thanks for your answer!

[DmitriyLewen]

@orhantoy 1 more small question:
do we need to use escaping for markdown property?