First draft of external property file media type registration

["Larry Golding (Myriad Consulting Inc)" <v-lgold@microsoft.com>]

Hi Chet,

 

Here is the first draft of the registration for the media type application/sarif-external-properties+json.

 

A SARIF external property file can contain almost anything a SARIF file can â just arranged differently â so it turned out that the security considerations were absolutely identical. It was just s/SARIF file/SARIF external property file/g ð

 

Please reach out to IANA to get the process started.

 

Thanks,

Larry

Type name: application

Subtype name: sarif-external-properties+json

Required parameters: N/A

Optional parameters: N/A

Encoding considerations: Binary: UTF8-encoded text only

Security considerations:

   - Since SARIF external property files are serialized as JSON, they are
   subject to the same security vulnerabilities as any JSON file.

   - The SARIF external property file format captures results from static
   analysis tools. Such analysis might disclose information about software
   vulnerabilities. Therefore SARIF external property file contents can be
   extremely sensitive, requiring external privacy and integrity protection.
   Even when the analysis results themselves are not sensitive, SARIF external
   property files can have other security issues:

   - SARIF external property files can embed the contents of the programming
   artifacts (such as source or binary files) that were analyzed. Such content
   can be of any type and may include compressed material, with all their
   associated vulnerabilities.

   - SARIF external property files can refer to programming artifacts through
   arbitrary URIs, with all their associated vulnerabilities.

   - SARIF external property files produced by web site analysis tools can
   contain the full contents of the web requests sent by the tool, and the
   resulting web responses. The contents of the requests and responses can be
   of any type, with the associated vulnerabilities of those types.

   - The use of absolute paths in analysis result location URIs might reveal 
   sensitive information about the machine on which the scan was performed.

   - The use of the hostname component in analysis result location URI might 
   reveal the network location of the machine on which the scan was performed.

   - The use of raw HTML in message strings expressed in Markdown might allow 
   arbitrary code execution (for example, through javascript: links).

   - Any other vulnerabilities associated with Markdown can be leveraged to 
   attack a SARIF processor. For example, the use of deeply nested constructs 
   in Markdown message strings might lead to stack overflow in some Markdown 
   implementations.

   - Certain properties of the SARIF object model might reveal information 
   about the machine on which a scan was run. (The specification allows such 
   properties to be omitted or "redacted".)

   - SARIF external property files can contain information about how the
   analysis tool was invoked, including the command line that was executed.
   This can contain arbitrary commands which might damage a machine on which
   they are run.

   - SARIF external property files can contain information about when the
   analysis tool was invoked. An attacker might be able to deduce how
   frequently scans are run, and therefore might be able to make a malicious
   change and then revert it before the next scan detects the problem.

   - SARIF external property files can contain information about errors
   encountered by the analysis tool, including its exit code. This can allow
   an attacker to craft input to attack the analysis tool.

   Interoperability considerations: N/A

   Published specification: Static Analysis Results Interchange Format 
   (SARIF) Version 2.1.0. Edited by Michael C. Fanning and Laurence J. 
   Golding. 27 March 2020. OASIS Standard. 

   https://docs.oasisopen.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html.

   Latest stage: 
   https://docs.oasisopen.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html.

Applications that use this media type: 

   The following list is not exhaustive:

   - Static analysis tools
   - Static analysis results visualization tools (viewers)
   - Bug filing tools
   - Defect databases
   - Compliance systems

Fragment identifier considerations: N/A

Additional information:

   Deprecated alias names for this type: N/A
   Magic number(s): N/A
   File extension(s): .sarif-external-properties,
                      .sarif-external-properties.json
   Macintosh file type code(s): N/A

Person & email address to contact for further information: 

   Michael C. Fanning (mikefan&microsoft.com) and Laurence J. Golding 
   (v-lgold&microsoft.com)

Intended usage: COMMON

Restrictions on usage: N/A

Author: OASIS Static Analysis Results Interchange Format (SARIF) TC 
   (https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sarif)

Change controller: OASIS Open (https://www.oasis-open.org/)