Sarif

TBD these all need good comments.

Gets or sets flags that specify how log SARIF should be enriched, e.g., by including file hashes or comprehensive regions properties.

Gets or sets flags that specify how log SARIF should be optimized, e.g., by including file hashes or comprehensive regions properties.

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

Gets a value indicating the type of object implementing .

The address expressed as a byte offset from the start of the addressable region.

The address expressed as a byte offset from the absolute address of the top-most parent object.

The number of bytes in this range of addresses.

An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

A name that is associated with the address, e.g., '.text'.

A human-readable fully qualified name that is associated with the address.

The byte offset of this address from the absolute or relative address of the parent object.

The index within run.addresses of the cached object for this address.

The index within run.addresses of the parent object.

Key/value pairs that provide additional information about the address.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Address for sorting.

Defines methods to support the comparison of objects of type Address for equality.

A single artifact. In some cases, this artifact might be nested within another artifact.

Gets a value indicating the type of object implementing .

A short description of the artifact.

The location of the artifact.

Identifies the index of the immediate parent of the artifact, if this artifact is nested.

The offset in bytes of the artifact within its containing artifact.

The length of the artifact in bytes.

The role or roles played by the artifact in the analysis.

The MIME type (RFC 2045) of the artifact.

The contents of the artifact.

Specifies the encoding for an artifact object that refers to a text file.

Specifies the source language for any artifact object that refers to a text file that contains source code.

A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.

The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

Key/value pairs that provide additional information about the artifact.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

A change to a single artifact.

Gets a value indicating the type of object implementing .

The location of the artifact to change.

An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

Key/value pairs that provide additional information about the change.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ArtifactChange for sorting.

Defines methods to support the comparison of objects of type ArtifactChange for equality.

Defines methods to support the comparison of objects of type Artifact for sorting.

Represents the contents of an artifact.

Gets a value indicating the type of object implementing .

UTF-8-encoded content from a text artifact.

MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).

Key/value pairs that provide additional information about the artifact content.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ArtifactContent for sorting.

Defines methods to support the comparison of objects of type ArtifactContent for equality.

Defines methods to support the comparison of objects of type Artifact for equality.

Specifies the location of an artifact.

Gets a value indicating the type of object implementing .

A string containing a valid relative or absolute URI.

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

The index within the run artifacts array of the artifact object associated with the artifact location.

A short description of the artifact location.

Key/value pairs that provide additional information about the artifact location.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Attempt to reconstruct a URI, if appropriate, using Run instance originalUriBaseId and uriBaseId properties. If this method cannot successfully reconstitute an absolute URI, it will return false and populate 'resolvedUri' with null.

The original uri base id values associated with the tool run. The reconstructed absolute URI or null (if an absolute URI cannot be reconstructed).

Creates a instance from data representing a single-line region.

The line number within the file (1 based). The starting column number within the line (1-based). The length of the region, measured in characters. The offset of the region start from the beginning of the file, measured in characters. An instance of a Location class.

Defines methods to support the comparison of objects of type ArtifactLocation for sorting.

Defines methods to support the comparison of objects of type ArtifactLocation for equality.

Values specifying the roles played by the file in the analysis.

An artifact relevant to a result.

Gets a value indicating the type of object implementing .

A message describing the role played by the attachment.

The location of the attachment.

An array of regions of interest within the attachment.

An array of rectangles specifying areas of interest within the image.

Key/value pairs that provide additional information about the attachment.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Attachment for sorting.

Defines methods to support the comparison of objects of type Attachment for equality.

The state of a result relative to a baseline of a previous run.

A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

A thread flow location of a SARIF thread flow.

Gets a value indicating the type of object implementing .

A message relevant to the code flow.

An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

Key/value pairs that provide additional information about the code flow.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type CodeFlow for sorting.

Defines methods to support the comparison of objects of type CodeFlow for equality.

A value that specifies the unit in which the tool measures columns.

Information about how a specific rule or notification was reconfigured at runtime.

Gets a value indicating the type of object implementing .

Specifies how the rule or notification was configured during the scan.

A reference used to locate the descriptor whose configuration was overridden.

Key/value pairs that provide additional information about the configuration override.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ConfigurationOverride for sorting.

Defines methods to support the comparison of objects of type ConfigurationOverride for equality.

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

Gets a value indicating the type of object implementing .

A tool object that describes the converter.

An invocation object that describes the invocation of the converter.

The locations of the analysis tool's per-run log files.

Key/value pairs that provide additional information about the conversion.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Conversion for sorting.

Defines methods to support the comparison of objects of type Conversion for equality.

Represents a directed edge in a graph.

Gets a value indicating the type of object implementing .

A string that uniquely identifies the edge within its graph.

A short description of the edge.

Identifies the source node (the node at which the edge starts).

Identifies the target node (the node at which the edge ends).

Key/value pairs that provide additional information about the edge.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Edge for sorting.

Defines methods to support the comparison of objects of type Edge for equality.

Represents the traversal of a single edge during a graph traversal.

Gets a value indicating the type of object implementing .

Identifies the edge being traversed.

A message to display to the user as the edge is traversed.

The values of relevant expressions after the edge has been traversed.

The number of edge traversals necessary to return from a nested graph.

Key/value pairs that provide additional information about the edge traversal.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type EdgeTraversal for sorting.

Defines methods to support the comparison of objects of type EdgeTraversal for equality.

Describes a runtime exception encountered during the execution of an analysis tool.

Describes a condition relevant to the tool itself, as opposed to being relevant to a file being analyzed by the tool.

Gets a value indicating the type of object implementing .

A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

A message that describes the exception.

The sequence of function calls leading to the exception.

An array of exception objects each of which is considered a cause of this exception.

Key/value pairs that provide additional information about the exception.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

This is an implementation similar to Exception.ToString()

Defines methods to support the comparison of objects of type ExceptionData for sorting.

Defines methods to support the comparison of objects of type ExceptionData for equality.

The top-level element of an external property file.

Gets a value indicating the type of object implementing .

The URI of the JSON schema corresponding to the version of the external property file format.

The SARIF format version of this external properties object.

A stable, unique identifier for this external properties object, in the form of a GUID.

A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

A conversion object that will be merged with a separate run.

An array of graph objects that will be merged with a separate run.

Key/value pairs that provide additional information that will be merged with a separate run.

An array of artifact objects that will be merged with a separate run.

Describes the invocation of the analysis tool that will be merged with a separate run.

An array of logical locations such as namespaces, types or functions that will be merged with a separate run.

An array of threadFlowLocation objects that will be merged with a separate run.

An array of result objects that will be merged with a separate run.

Tool taxonomies that will be merged with a separate run.

The analysis tool object that will be merged with a separate run.

Tool extensions that will be merged with a separate run.

Tool policies that will be merged with a separate run.

Tool translations that will be merged with a separate run.

Addresses that will be merged with a separate run.

Requests that will be merged with a separate run.

Responses that will be merged with a separate run.

Key/value pairs that provide additional information about the external properties.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ExternalProperties for sorting.

Defines methods to support the comparison of objects of type ExternalProperties for equality.

Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.

Gets a value indicating the type of object implementing .

The location of the external property file.

A stable, unique identifier for the external property file in the form of a GUID.

A non-negative integer specifying the number of items contained in the external property file.

Key/value pairs that provide additional information about the external property file.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ExternalPropertyFileReference for sorting.

Defines methods to support the comparison of objects of type ExternalPropertyFileReference for equality.

References to external property files that should be inlined with the content of a root log file.

Gets a value indicating the type of object implementing .

An external property file containing a run.conversion object to be merged with the root log file.

An array of external property files containing a run.graphs object to be merged with the root log file.

An external property file containing a run.properties object to be merged with the root log file.

An array of external property files containing run.artifacts arrays to be merged with the root log file.

An array of external property files containing run.invocations arrays to be merged with the root log file.

An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

An array of external property files containing run.results arrays to be merged with the root log file.

An array of external property files containing run.taxonomies arrays to be merged with the root log file.

An array of external property files containing run.addresses arrays to be merged with the root log file.

An external property file containing a run.driver object to be merged with the root log file.

An array of external property files containing run.extensions arrays to be merged with the root log file.

An array of external property files containing run.policies arrays to be merged with the root log file.

An array of external property files containing run.translations arrays to be merged with the root log file.

An array of external property files containing run.requests arrays to be merged with the root log file.

An array of external property files containing run.responses arrays to be merged with the root log file.

Key/value pairs that provide additional information about the external property files.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ExternalPropertyFileReferences for sorting.

Defines methods to support the comparison of objects of type ExternalPropertyFileReferences for equality.

Values specifying the failure level of a notification or result.

A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

Gets a value indicating the type of object implementing .

A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.

One or more artifact changes that comprise a fix for a result.

Key/value pairs that provide additional information about the fix.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Fix for sorting.

Defines methods to support the comparison of objects of type Fix for equality.

A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

Gets a value indicating the type of object implementing .

A description of the graph.

An array of node objects representing the nodes of the graph.

An array of edge objects representing the edges of the graph.

Key/value pairs that provide additional information about the graph.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Graph for sorting.

Defines methods to support the comparison of objects of type Graph for equality.

Represents a path through a graph.

Gets a value indicating the type of object implementing .

The index within the run.graphs to be associated with the result.

The index within the result.graphs to be associated with the result.

A description of this graph traversal.

Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

The sequences of edges traversed by this graph traversal.

Key/value pairs that provide additional information about the graph traversal.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type GraphTraversal for sorting.

Defines methods to support the comparison of objects of type GraphTraversal for equality.

The runtime environment of the analysis tool run.

Gets a value indicating the type of object implementing .

The command line used to invoke the tool.

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

The locations of any response files specified on the tool's command line.

The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.

The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.

The process exit code.

An array of configurationOverride objects that describe rules related runtime overrides.

An array of configurationOverride objects that describe notifications related runtime overrides.

A list of runtime conditions detected by the tool during the analysis.

A list of conditions detected by the tool that are relevant to the tool's configuration.

The reason for the process exit.

The name of the signal that caused the process to exit.

The numeric value of the signal that caused the process to exit.

The reason given by the operating system that the process failed to start.

Specifies whether the tool's execution completed successfully.

The machine on which the invocation occurred.

The account under which the invocation occurred.

The id of the process in which the invocation occurred.

An absolute URI specifying the location of the executable that was invoked.

The working directory for the invocation.

The environment variables associated with the analysis tool process, expressed as key/value pairs.

A file containing the standard input stream to the process that was invoked.

A file containing the standard output stream from the process that was invoked.

A file containing the standard error stream from the process that was invoked.

A file containing the interleaved standard output and standard error stream from the process that was invoked.

Key/value pairs that provide additional information about the invocation.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Invocation for sorting.

Defines methods to support the comparison of objects of type Invocation for equality.

An interface for all types generated from the Sarif schema.

Gets a value indicating the type of object implementing .

Makes a deep copy of this instance.

A location within a programming artifact.

Gets a value indicating the type of object implementing .

Value that distinguishes this location from all other locations within a single result object.

Identifies the artifact and region.

The logical locations associated with the result.

A message relevant to the location.

A set of regions relevant to the location.

An array of objects that describe relationships between this location and others.

Key/value pairs that provide additional information about the location.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Location for sorting.

Defines methods to support the comparison of objects of type Location for equality.

Information about the relation of one location to another.

Gets a value indicating the type of object implementing .

A reference to the related location.

A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

A description of the location relationship.

Key/value pairs that provide additional information about the location relationship.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type LocationRelationship for sorting.

Defines methods to support the comparison of objects of type LocationRelationship for equality.

A logical location of a construct that produced a result.

Gets a value indicating the type of object implementing .

Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

The index within the logical locations array.

The human-readable fully qualified name of the logical location.

The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

Key/value pairs that provide additional information about the logical location.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type LogicalLocation for sorting.

Defines methods to support the comparison of objects of type LogicalLocation for equality.

Encapsulates a message intended to be read by the end user.

Gets a value indicating the type of object implementing .

A plain text message string.

A Markdown message string.

The identifier for this message.

An array of strings to substitute into the message string.

Key/value pairs that provide additional information about the message.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Message for sorting.

Defines methods to support the comparison of objects of type Message for equality.

A message string or message format string rendered in multiple formats.

Gets a value indicating the type of object implementing .

A plain text message string or format string.

A Markdown message string or format string.

Key/value pairs that provide additional information about the message.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type MultiformatMessageString for sorting.

Defines methods to support the comparison of objects of type MultiformatMessageString for equality.

Represents a node in a graph.

Gets a value indicating the type of object implementing .

A string that uniquely identifies the node within its graph.

A short description of the node.

A code location associated with the node.

Array of child nodes.

Key/value pairs that provide additional information about the node.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Node for sorting.

Defines methods to support the comparison of objects of type Node for equality.

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

Gets a value indicating the type of object implementing .

The locations relevant to this notification.

A message that describes the condition that was encountered.

A value specifying the severity level of the notification.

The thread identifier of the code that generated the notification.

The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

The runtime exception, if any, relevant to this notification.

A reference used to locate the descriptor relevant to this notification.

A reference used to locate the rule descriptor associated with this notification.

Key/value pairs that provide additional information about the notification.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Notification for sorting.

Defines methods to support the comparison of objects of type Notification for equality.

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Gets a value indicating the type of object implementing .

The address of the location.

The location of the artifact.

Specifies a portion of the artifact.

Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

Key/value pairs that provide additional information about the physical location.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type PhysicalLocation for sorting.

Defines methods to support the comparison of objects of type PhysicalLocation for equality.

Key/value pairs that provide additional information about the object.

Gets a value indicating the type of object implementing .

A set of distinct strings that provide additional information.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type PropertyBag for sorting.

Defines methods to support the comparison of objects of type PropertyBag for equality.

An area within an image.

Gets a value indicating the type of object implementing .

The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

The X coordinate of the left edge of the rectangle, measured in the image's natural units.

The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

The X coordinate of the right edge of the rectangle, measured in the image's natural units.

A message relevant to the rectangle.

Key/value pairs that provide additional information about the rectangle.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Rectangle for sorting.

Defines methods to support the comparison of objects of type Rectangle for equality.

A region within an artifact where a result was detected.

Gets a value indicating the type of object implementing .

The line number of the first character in the region.

The column number of the first character in the region.

The line number of the last character in the region.

The column number of the character following the end of the region.

The zero-based offset from the beginning of the artifact of the first character in the region.

The length of the region in characters.

The zero-based offset from the beginning of the artifact of the first byte in the region.

The length of the region in bytes.

The portion of the artifact contents within the specified region.

A message relevant to the region.

Specifies the source language, if any, of the portion of the artifact specified by the region object.

Key/value pairs that provide additional information about the region.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Region for sorting.

Defines methods to support the comparison of objects of type Region for equality.

The replacement of a single region of an artifact.

Gets a value indicating the type of object implementing .

The region of the artifact to delete.

The content to insert at the location specified by the 'deletedRegion' property.

Key/value pairs that provide additional information about the replacement.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Replacement for sorting.

Defines methods to support the comparison of objects of type Replacement for equality.

Information about a rule or notification that can be configured at runtime.

Gets a value indicating the type of object implementing .

Specifies whether the report may be produced during the scan.

Specifies the failure level for the report.

Specifies the relative priority of the report. Used for analysis output only.

Contains configuration information specific to a report.

Key/value pairs that provide additional information about the reporting configuration.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ReportingConfiguration for sorting.

Defines methods to support the comparison of objects of type ReportingConfiguration for equality.

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Gets a value indicating the type of object implementing .

A stable, opaque identifier for the report.

An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

A unique identifier for the reporting descriptor in the form of a GUID.

An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

A report identifier that is understandable to an end user.

An array of readable identifiers by which this report was known in some previous version of the analysis tool.

A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

Default reporting configuration information.

A URI where the primary documentation for the report can be found.

Provides the primary documentation for the report, useful when there is no online documentation.

An array of objects that describe relationships between this reporting descriptor and others.

Key/value pairs that provide additional information about the report.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ReportingDescriptor for sorting.

Defines methods to support the comparison of objects of type ReportingDescriptor for equality.

Information about how to locate a relevant reporting descriptor.

Gets a value indicating the type of object implementing .

The id of the descriptor.

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

A guid that uniquely identifies the descriptor.

A reference used to locate the toolComponent associated with the descriptor.

Key/value pairs that provide additional information about the reporting descriptor reference.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ReportingDescriptorReference for sorting.

Defines methods to support the comparison of objects of type ReportingDescriptorReference for equality.

Information about the relation of one reporting descriptor to another.

Gets a value indicating the type of object implementing .

A reference to the related reporting descriptor.

A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.

A description of the reporting descriptor relationship.

Key/value pairs that provide additional information about the reporting descriptor reference.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ReportingDescriptorRelationship for sorting.

Defines methods to support the comparison of objects of type ReportingDescriptorRelationship for equality.

A result produced by an analysis tool.

Gets a value indicating the type of object implementing .

The stable, unique identifier of the rule, if any, to which this result is relevant.

The index within the tool component rules array of the rule object associated with this result.

A reference used to locate the rule descriptor relevant to this result.

A value that categorizes results by evaluation state.

A value specifying the severity level of the result.

A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.

The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

A stable, unique identifier for the result in the form of a GUID.

A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

A positive integer specifying the number of times this logically unique result was observed in this run.

A set of strings that contribute to the stable, unique identity of the result.

A set of strings each of which individually defines a stable, unique identity for the result.

An array of 'stack' objects relevant to the result.

An array of 'codeFlow' objects relevant to the result.

An array of zero or more unique graph objects associated with the result.

An array of one or more unique 'graphTraversal' objects.

A set of locations relevant to this result.

A set of suppressions relevant to this result.

The state of a result relative to a baseline of a previous run.

A number representing the priority or importance of the result.

A set of artifacts relevant to the result.

An absolute URI at which the result can be viewed.

The URIs of the work items associated with this result.

Information about how and when the result was detected.

An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

An array of references to taxonomy reporting descriptors that are applicable to the result.

A web request associated with this result.

A web response associated with this result.

Key/value pairs that provide additional information about the result.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Reference to the Run containing this Result, if available.

Used to look up Result details which may be on Run collections (ex: Run.Tool.Driver.Rules)

Resolve the RuleId for this Result, from direct properties or via Run.Rules lookup.

Run containing this Result RuleId of this Result

Look up the ReportingDescriptor for this Result.

Run instance containing this Result ReportingDescriptor for Result Rule, if available

Defines methods to support the comparison of objects of type Result for sorting.

Defines methods to support the comparison of objects of type Result for equality.

Values specifying the evaluation state of a result.

Contains information about how and when a result was detected.

Gets a value indicating the type of object implementing .

The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

Key/value pairs that provide additional information about the result.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ResultProvenance for sorting.

Defines methods to support the comparison of objects of type ResultProvenance for equality.

Describes a single run of an analysis tool, and contains the reported output of that run.

Gets a value indicating the type of object implementing .

Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

Describes the invocation of the analysis tool.

A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Specifies the revision in version control of the artifacts that were scanned.

The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

An array of artifact objects relevant to the run.

An array of logical locations such as namespaces, types or functions.

An array of zero or more unique graph objects associated with the run.

The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

Automation details that describe this run.

Automation details that describe the aggregate of runs to which this run belongs.

The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

An array of strings used to replace sensitive information in a redaction-aware property.

Specifies the default encoding for any artifact object that refers to a text file.

Specifies the default source language for any artifact object that refers to a text file that contains source code.

An ordered list of character sequences that were treated as line breaks when computing region information for the run.

Specifies the unit in which the tool measures columns.

References to external property files that should be inlined with the content of a root log file.

An array of threadFlowLocation objects cached at run level.

An array of toolComponent objects relevant to a taxonomy in which results are categorized.

Addresses associated with this run instance, if any.

The set of available translations of the localized data provided by the tool.

Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

An array of request objects cached at run level.

An array of response objects cached at run level.

A specialLocations object that defines locations of special significance to SARIF consumers.

Key/value pairs that provide additional information about the run.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Find the ToolComponent corresponding to a ToolComponentReference.

ToolComponentReference to resolve ToolComponent for reference

Set the Run property on each Result to this Run, so that Result methods and properties which may need to look up Run collections can do so.

Applies the policies contained in this run, if any, to remap result failure levels. When multiple policies remap the same rule, the last policy in the policies collection has precedence.

Returns a value indicating whether this run has any results whose baseline state is "absent".

The whose results are to be examined. true if has any absent results, otherwise false. The SARIF spec states that the property must either be present on all results or on none of them. This requirement is intended to optimize performance of SARIF consumers such as results viewers, which (for example) need only examine the first result to decide whether to display a "Baseline state" column. Therefore if the first result has , this method does not examine the rest of the results, and it returns false.

Returns a value indicating whether this run has any suppressed results.

The whose results are to be examined. true if has any suppressed results, otherwise false. The SARIF spec states that the property must either be present on all results or on none of them. This requirement is intended to optimize performance of SARIF consumers such as results viewers, which (for example) need only examine the first result to decide whether to display a "Suppressed" column. Therefore if the first result has a Suppressions value of null, this method does examine the rest of the results, and it returns false.

Information that describes a run's identity and role within an engineering system process.

Gets a value indicating the type of object implementing .

A description of the identity and role played within the engineering system by this object's containing run object.

A hierarchical string that uniquely identifies this object's containing run object.

A stable, unique identifier for this object's containing run object in the form of a GUID.

A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

Key/value pairs that provide additional information about the run automation details.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type RunAutomationDetails for sorting.

Defines methods to support the comparison of objects of type RunAutomationDetails for equality.

Defines methods to support the comparison of objects of type Run for sorting.

Defines methods to support the comparison of objects of type Run for equality.

Static Analysis Results Format (SARIF) Version 2.1.0-rtm.6 JSON Schema: a standard format for the output of static analysis tools.

Gets a value indicating the type of object implementing .

The URI of the JSON schema corresponding to the version.

The SARIF format version of this log file.

The set of runs contained in this log file.

References to external property files that share data between runs.

Key/value pairs that provide additional information about the log file.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Load a SARIF file into a SarifLog object model instance using deferred loading. [Less memory use, but slower; safe for large Sarif]

File Path to Sarif file to load SarifLog instance for file

Load a SARIF file into a SarifLog object model instance. [File is fully loaded; more RAM but faster]

File Path to Sarif file to load SarifLog instance for file

Load a SARIF stream into a SarifLog object model instance. [File is fully loaded; more RAM but faster]

Stream with SARIF to load SarifLog instance for file

Post the SARIF log file to a URI.

Thrown if filePath does not exist. Thrown if postUri/filePath/stream/httpClient is null. Throws an exception if the IsSuccessStatusCode property for the HTTP response is false. If the SarifLog has been posted successfully.

Post the SARIF stream to a URI.

Thrown if postUri/stream/httpClient is null. Throws an exception if the IsSuccessStatusCode property for the HTTP response is false.

Write a SARIF log to disk as a file.

File Path to Sarif file to write to

Write a SARIF log to a destination stream.

Stream to write SARIF to

Write a SARIF log to a destination StreamWriter.

StreamWriter to write SARIF to

Enumerate all results from all runs in the SARIF log.

A Result enumerator for the SARIF log.

Applies the policies contained in each run

Applies the policies contained from a sarif file

Defines methods to support the comparison of objects of type SarifLog for sorting.

Defines methods to support the comparison of objects of type SarifLog for equality.

A set of values for all the types that implement .

An uninitialized kind.

A value indicating that the object is of type .

Rewriting visitor for the Sarif object model.

Starts a rewriting visit of a node in the Sarif object model.

The node to rewrite. A rewritten instance of the node.

Visits and rewrites a node in the Sarif object model.

The node to rewrite. A rewritten instance of the node.

Possible values for the SARIF schema version.

Defines locations of special significance to SARIF consumers.

Gets a value indicating the type of object implementing .

Provides a suggestion to SARIF consumers to display file paths relative to the specified location.

Key/value pairs that provide additional information about the special locations.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type SpecialLocations for sorting.

Defines methods to support the comparison of objects of type SpecialLocations for equality.

A call stack that is relevant to a result.

A call stack relevant to a SARIF result.

Gets a value indicating the type of object implementing .

A message relevant to this call stack.

An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

Key/value pairs that provide additional information about the stack.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Create one or more Stack instances from a .NET exception. Captures inner exceptions and handles aggregated exceptions.

Creates a SARIF Stack instance from a .NET StackTrace instance

Creates a SARIF Stack instance from a .NET StackTrace text representation (as returned by StackTrace.ToString())

Defines methods to support the comparison of objects of type Stack for sorting.

Defines methods to support the comparison of objects of type Stack for equality.

A function call within a stack trace.

A stack frame of a SARIF stack.

Gets a value indicating the type of object implementing .

The location to which this stack frame refers.

The name of the module that contains the code of this stack frame.

The thread identifier of the stack frame.

The parameters of the call that is executing.

Key/value pairs that provide additional information about the stack frame.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Creates a SARIF StackFrame instance from a .NET StackFrame instance

Defines methods to support the comparison of objects of type StackFrame for sorting.

Defines methods to support the comparison of objects of type StackFrame for equality.

A suppression that is relevant to a result.

Gets a value indicating the type of object implementing .

A stable, unique identifier for the suprression in the form of a GUID.

A string that indicates where the suppression is persisted.

A string that indicates the review status of the suppression.

A string representing the justification for the suppression.

Identifies the location associated with the suppression.

Key/value pairs that provide additional information about the suppression.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type Suppression for sorting.

Defines methods to support the comparison of objects of type Suppression for equality.

A string that indicates where the suppression is persisted.

A string that indicates the review status of the suppression.

Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.

A thread flow location of a SARIF thread flow.

Gets a value indicating the type of object implementing .

An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

A message relevant to the thread flow.

Values of relevant expressions at the start of the thread flow that may change during thread flow execution.

Values of relevant expressions at the start of the thread flow that remain constant.

A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

Key/value pairs that provide additional information about the thread flow.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ThreadFlow for sorting.

Defines methods to support the comparison of objects of type ThreadFlow for equality.

A location visited by an analysis tool while simulating or monitoring the execution of a program.

A thread flow location of a SARIF thread flow.

Gets a value indicating the type of object implementing .

The index within the run threadFlowLocations array.

The code location.

The call stack leading to this location.

A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

The name of the module that contains the code that is executing.

A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

An integer representing a containment hierarchy within the thread flow.

An integer representing the temporal order in which execution reached this location.

The Coordinated Universal Time (UTC) date and time at which this location was executed.

Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

A web request associated with this thread flow location.

A web response associated with this thread flow location.

Key/value pairs that provide additional information about the threadflow location.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ThreadFlowLocation for sorting.

Defines methods to support the comparison of objects of type ThreadFlowLocation for equality.

Values specifying the importance of an "threadFlowLocation" within the "codeFlow" in which it occurs

The analysis tool that was run.

Gets a value indicating the type of object implementing .

The analysis tool that was run.

Tool extensions that contributed to or reconfigured the analysis tool that was run.

Key/value pairs that provide additional information about the tool.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Find the ToolComponent corresponding to a ToolComponentReference.

ToolComponentReference to resolve ToolComponent for reference

Defines methods to support the comparison of objects of type Tool for sorting.

A component, such as a plug-in or the driver, of the analysis tool that was run.

A component of the analysis tool that was run, such as the primary driver or a plug-in.

Gets a value indicating the type of object implementing .

A unique identifier for the tool component in the form of a GUID.

The name of the tool component.

The organization or company that produced the tool component.

A product suite to which the tool component belongs.

A localizable string containing the name of the suite of products to which the tool component belongs.

A brief description of the tool component.

A comprehensive description of the tool component.

The name of the tool component along with its version and any other useful identifying information, such as its locale.

The tool component version, in whatever format the component natively provides.

The tool component version in the format specified by Semantic Versioning 2.0.

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

A string specifying the UTC date (and optionally, the time) of the component's release.

The absolute URI from which the tool component can be downloaded.

The absolute URI at which information about this version of the tool component can be found.

A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

An array of the artifactLocation objects associated with the tool component.

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

The kinds of data contained in this object.

Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

The semantic version of the localized strings defined in this component; maintained by components that provide translations.

The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.

Translation metadata, required for a translation, not populated by other component types.

An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

Key/value pairs that provide additional information about the tool component.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type ToolComponent for sorting.

Values specifying the roles played by the file in the analysis.

Defines methods to support the comparison of objects of type ToolComponent for equality.

Identifies a particular toolComponent object, either the driver or an extension.

A reference to a ToolComponent defined at the Run level.

Gets a value indicating the type of object implementing .

The 'name' property of the referenced toolComponent.

An index into the referenced toolComponent in tool.extensions.

The 'guid' property of the referenced toolComponent.

Key/value pairs that provide additional information about the toolComponentReference.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

An initialization value for the property. An initialization value for the property. An initialization value for the property. An initialization value for the property.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Look up the ToolComponent for this ToolComponentReference.

Run instance within which this ToolComponentReference occurs. ToolComponent instance referenced by this reference.

Defines methods to support the comparison of objects of type ToolComponentReference for sorting.

Defines methods to support the comparison of objects of type ToolComponentReference for equality.

Defines methods to support the comparison of objects of type Tool for equality.

Provides additional metadata related to translation.

Gets a value indicating the type of object implementing .

The name associated with the translation metadata.

The full name associated with the translation metadata.

A brief description of the translation metadata.

A comprehensive description of the translation metadata.

The absolute URI from which the translation metadata can be downloaded.

The absolute URI from which information related to the translation metadata can be downloaded.

Key/value pairs that provide additional information about the translation metadata.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type TranslationMetadata for sorting.

Defines methods to support the comparison of objects of type TranslationMetadata for equality.

Specifies the information necessary to retrieve a desired revision from a version control system.

Gets a value indicating the type of object implementing .

The absolute URI of the repository.

A string that uniquely and permanently identifies the revision within the repository.

The name of a branch containing the revision.

A tag that has been applied to the revision.

A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.

The location in the local file system to which the root of the repository was mapped at the time of the analysis.

Key/value pairs that provide additional information about the version control details.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type VersionControlDetails for sorting.

Defines methods to support the comparison of objects of type VersionControlDetails for equality.

Describes an HTTP request.

Gets a value indicating the type of object implementing .

The index within the run.webRequests array of the request object associated with this result.

The request protocol. Example: 'http'.

The request version. Example: '1.1'.

The target of the request.

The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

The request headers.

The request parameters.

The body of the request.

Key/value pairs that provide additional information about the request.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type WebRequest for sorting.

Defines methods to support the comparison of objects of type WebRequest for equality.

Describes the response to an HTTP request.

Gets a value indicating the type of object implementing .

The index within the run.webResponses array of the response object associated with this result.

The response protocol. Example: 'http'.

The response version. Example: '1.1'.

The response status code. Example: 451.

The response reason. Example: 'Not found'.

The response headers.

The body of the response.

Specifies whether a response was received from the server.

Key/value pairs that provide additional information about the response.

Initializes a new instance of the class.

Initializes a new instance of the class from the supplied values.

Initializes a new instance of the class from the specified instance.

The instance from which the new instance is to be initialized. Thrown if is null.

Creates a deep copy of this instance.

Defines methods to support the comparison of objects of type WebResponse for sorting.

Defines methods to support the comparison of objects of type WebResponse for equality.

This class associates a Result object with additional metadata that makes it possible for a matching algorithm to determine if it matches a result from another run.

If a matching algorithm determines that two such results _do_ match, it will construct a object to capture the association.

Match the 'Category' of two ExtractedResults (Tool and RuleId).

ExtractedResult to match True if Category is identical, False otherwise

Match enough of the 'What' properties of two ExtractedResults (Guid, Fingerprints, PartialFingerprints, Snippets, Message, Properties). A match in high-confidence identity properties is a match (Guid, Fingerprint, >= 50% of PartialFingerprint). A non-match in high-confidence identity properties is a non-match (Fingerprint, 0% of PartialFingerprints, Properties). Otherwise, Results match if Message and first Snippet match.

ExtractedResult to match True if *any* 'What' property matches, False otherwise

ExtractedResult to match TrustMap for either Run being compared, to weight attributes selectively True if *any* 'What' property matches, False otherwise

Match all of the 'Where' properties of two ExtractedResults (FileUri, StartLine/Column, EndLine/Column).

ExtractedResult to match True if *all* 'Where' properties match, False otherwise

Determine whether this ExtractedResult is 'sufficiently similar' to another. An ExtractedResult must have the same category and either match a 'What' property or all 'Where' properties.

ExtractedResult to match True if ExtractedResults are 'sufficiently similar', otherwise False.

Determine whether this ExtractedResult is 'sufficiently similar' to another. An ExtractedResult must have the same category and either match a 'What' property or all 'Where' properties.

ExtractedResult to match TrustMap for either Run being compared, to weight attributes selectively True if ExtractedResults are 'sufficiently similar', otherwise False.

A pair of results that have been matched by a matching algorithm.

Creates a new SARIF Result object with contents from the most recent result of the matched pair, the appropriate state and time of first detection, and some metadata in the property bag about the matching algorithm used.

The new SARIF result.

Returns a result matcher that matches results that are logically identical (i.e. every part of the result is the same, except for fields used in baselining).

Returns a result matcher that matches two results when their fingerprints match.

Matches two results if every part of the result is identical, except the fields used in baselining. If a run contains multiple identical results, we will match them in order.

We want to mask out the fields that may be set during baselining, as they will not be equivalent during a comparison.

We create a deep copy of the result (so as to not change the actual result contents), and mask the fields that relate to result matching (status, suppression states, correllation GUID, etc.).

The original result A masked deep copy of the result.

Checks if the result matcher applies to a particular result. For example, we don't want to try to match results without partial fingerprints in a partial fingerprint matcher.

Matching result to check. True if the result matcher applies, false if it does not.

Compares two results, and declares them equal if all of their partial fingerprints match. TODO: Handle versioning of partial fingerprints.

Get a Result Matching Baseliner that matches results between two groups of Sarif Logs using a sensible default set of rules for matching results.

A result matching baseliner instance with the default set of strategies.

Get a result matching baseliner that matches results between two groups of sarif logs using a

Default Result Matching Baseliner.

Helper function that accepts a single baseline and current SARIF log and matches them.

Array of SARIF logs representing the baseline run Array of SARIF logs representing the current run A SARIF log with the merged set of results.

Take two groups of SARIF logs, and compute a SARIF log containing the complete set of results, with status (compared to baseline) and various baseline-related fields persisted (e.x. work item links, ID, etc.

Array of SARIF logs representing the baseline run Array of SARIF logs representing the current run A SARIF log with the merged set of results.

ResultMatchingComparer sorts Results for the Result Matching algorithm.

TrustMap determines how much to trust different Result attributes for matching. Trust is the product of how often values match and how unique the values were. An attribute which always has the same value will have very low trust. An attribute which never matches will have very low trust.

Return the matching trust of a given property.

Set name (Base, PartialFingerprints, Properties, etc) Property Name (valueFingerprint/v1) Value between zero and one indicating how much to trust this property for matching

Add a Result attribute to the map.

WhatComponent for a Result attribute used in baselining

Compare two TrustMaps to determine how many of the found values per property matched, to incorporate that into trust scoring.

TrustMap for the other Run we're baselining against

StatefulResultMatcher contains all of the state needed to compute matches between two batches of Results.

This class exists so that with a V2ResultMatcher in hand, you can call Match on it repeatedly without having to worry about resetting its internal state each time. All the state is encapsulated by the StatefulResultMatcher, which is discarded after each call to V2ResultMatcher.Match.

Match the 'What' properties of two ExtractedResults.

ExtractedResult to match ExtractedResult to match True if *any* 'What' property matches, False otherwise

WhatMap is used to look for unique 'What' properties across batches of Results. Each 'What' value is added to a Dictionary, specific to the Category (RuleId), Location specifier, and Attribute Name where that value was found.

Return the indices of results in this set and the other set which have a common trait which is unique in each set.

WhatMap for other Result set Index of this and Index of other Result where the two have a unique trait in common.

Compare the 'Where' properties of two ExtractedResults. They will compare equal if every PhysicalLocation Uri and Region position matches and all LogicalLocation FullyQualifiedName matches.

Compare the first Physical Location Uri of each Result

Compare Regions for 'where' sorting. Does not compare snippets or messages.

Choose a location (Uri or FullyQualifiedName) to represent this Result. It's the first Uri or FullyQualifiedName which was also seen in the other Run.

Cache is a simple LRU (least recently used) collection. The base class libraries don't offer one without an extra dependency.

Type of Keys in collection Type of Values being cached in collection

Construct a new Cache

Method to build a value from a key when it isn't in the cache Maximum number of items to keep in cache, zero for no limit

Returns the number of items currently cached

Returns the keys of items currently cached

Return value for a given key, either from the cache or after rebuilding it.

Key for which to retrieve value Value for key

Return whether the cache currently includes the value for the given key.

Key to check cache for True if value in cache, False otherwise

Clear current cache.

Interface exposed by objects that can hold properties of arbitrary types.

Base class for objects that can hold properties of arbitrary types.

Key/value pairs that provide additional information about the run.

Describes a single entry in a JSON property bag (a JSON object whose keys have arbitrary names and whose values may be any JSON values).

Initializes a new instance of the class.

The string representation of the JSON value of the property. true if the property is a string; otherwise false. This representation allows properties to be read from JSON into memory and then round-tripped back to JSON, without storing "live" Json.NET objects. Live JSON objects hold references to their parent container, which would consume a lot of memory for objects that are part of a large JSON file. The integer-value JSON property "n": 42 is represented by


            new SerializedPropertyInfo("42", JTokenType.Integer)

The string-valued JSON property "s": "abc" is represented by


            new SerializedPropertyInfo("\"abc\"", JTokenType.String)

The array-valued JSON property "a": [ 1, "b" ] is represented by


            new SerializedPropertyInfo("[ 1, \"b\" ]", JTokenType.Array)

The object-values JSON property "o": { "a": 1, "b": false } is represented by


            new SerializedPropertyInfo("{ \"a\": 1, \"b\": false }", JTokenType.Object)

Gets the string representation of the JSON value of the property.

Gets a value indicating whether the property is a string.

We need to know that because the needs to put an extra pair of quotes around strings before it writes them out.

Defines methods to support the comparison of objects of type SerializedPropertyInfo.

Defines methods to support the comparison of objects of type SerializedPropertyInfo for equality.

This class provides utilities common to the parsing of and objects from the raw request and response strings.

Ideally, this would have been a base class for both WebRequest and WebResponse. Unfortunately, every class in the SARIF SDK's object model derives from , so the .NET class inheritance point is already spent.

Enables a trace message that reports the elapsed time for the end-to-end scan.

Enables a trace message that reports the elapsed time for every rule, per scan target.

Enables a trace message that reports peak working set during analysis.

Enables a trace message that reports progress against each scan target.

Enables a trace message that summarizes all results and notification by id and severity.

This class is a file cache that can be used to populate regions with comprehensive data, to retrieve file text associated with a SARIF log, and to construct text snippets associated with region instances.

Creates a new object.

The initial capacity of the cache. An object that provides access to file system services.

Creates a object, based on an existing Region, in which all text-related properties have been populated.

For example, if the input Region specifies only the StartLine property, the returned Region instance will have computed and populated other text-related properties, such as properties, such as CharOffset, CharLength, etc. Region object that forms the basis of the returned Region object. URI of the artifact in which lies, used to retrieve from the cache the location of each newline in the artifact. Boolean that indicates if the region's Snippet property will be populated. An optional argument that, if present, contains the text contents of the file specified by . A Region object whose text-related properties have been fully populated.

Clear current cache.

Method to build cache entries which aren't already in the cache.

Uri.LocalPath for the file to load Cache entry to add to cache with file contents and NewLineIndex

This method will search in the environment variable for a specific file name. It will return the first file found.

Environment variable that we will look for Name of the file that we will look for in the environment variable An object that provides access to the file system. Path to the file name or empty string.

This method will search for a file name in a specific path.

Path where it will search. Name of the file that it will search An object that provides access to the file system. Path to the file name or empty string.

A wrapper class for accessing the file system.

Clients should use this class rather directly using the .NET file system classes, so they can mock the IFileSystem interface in unit tests.

Loads an assembly given its file name or path.

The name or path of the file that contains the manifest of the assembly. The loaded assembly.

Determines whether the given path refers to an existing directory on disk.

The path to test. true if path refers to an existing directory; false if the directory does not exist or an error occurs when trying to determine if the specified directory exists.

Gets or sets the fully qualified path of the current working directory.

A string containing a directory path.

Determines whether the specified file exists.

The file to check. true if the caller has the required permissions and path contains the name of an existing file; otherwise, false.

Returns an enumerable collection of directory full names in a specified path.

Thee relative or absolute path to the directory to search. This string is not case-sensitive. The search string to match against the names of directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is TopDirectoryOnly. An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern and search option.

Returns the names of subdirectories (including their paths) in the specified directory.

The relative or absolute path to the directory to search. This string is not case-sensitive. An array of the full names (including paths) of subdirectories in the specified path, or an empty array if no directories are found.

Returns the names of files (including their paths) that match the specified search pattern in the specified directory..

The relative or absolute path to the directory to search. This string is not case-sensitive. The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. An array of the full names (including paths) for the files in the specified directory that match the specified search pattern, or an empty array if no files are found.

Returns the date and time the specified file or directory was last written to.

The file or directory for which to obtain write date and time information. A DateTime structure set to the date and time that the specified file or directory was last written to.

Opens a binary file, reads all contents into a byte array, and then closes the file.

The file to open for reading. A byte array containing the contents of the file

Opens a text file, reads all lines of the file, and then closes the file.

The file to open for reading. A string array containing all lines of the file.

Opens a text file, reads all text in the file as a single string, and then closes the file.

The file to open for reading. A string containing all text in the file.

Uses to get the size of a file in bytes.

The fully qualified name or relative name of the file. A long representing the size of the file in bytes.

Opens a text file, reads all text in the file as a single string using the specified encoding, and then closes the file.

The file to open for reading. The encoding applied to the contents of the file. A string containing all text in the file.

Sets the date and time that the specified file was last written to.

The file for which to set the date and time information. A DateTime containing the value to set for the last write date and time of path. This value is expressed in local time.

Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten.

The file to write to. The bytes to write to the file.

Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten.

The file to write to. The string to write to the file.

Open an existing file for reading.

File System path of file to open Stream to read file

Create (or overwrite) a new file for writing.

File System path of file to open Stream to write file

Sets the specified of the file on the specified path.

The path to the file. A bitwise combination of the enumeration values.

Creates all directories and subdirectories in the specified path unless they already exist.

The directory to create. An object that represents the directory at the specified path. This object is returned regardless of whether a directory at the specified path already exists.

Deletes an empty directory from a specified path.

The name of the empty directory to remove. This directory must be writable and empty.

Deletes the specified file.

The name of the file to be deleted. Wildcard characters are not supported.

Returns an enumerable collection of file names in a specified path.

The relative or absolute path to the directory to search. This string is not case-sensitive. An enumerable collection of the full names (including paths) for the files in the directory the directory specified by path.

Returns an enumerable collection of full file names that match a search pattern in a specified path, and optionally searches subdirectories.

The relative or absolute path to the directory to search. This string is not case-sensitive. The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions. One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is TopDirectoryOnly. An enumerable collection of the full names (including paths) for the files in the directory specified by path and that match the specified search pattern and search option.

Reads the lines of a file.

The file to open for reading. All the lines of the file, or the lines that are the result of a query.

Uses to calculate the size of a file in bytes.

The fully qualified name or relative name of the file. A long representing the size of the file in bytes.

Uses or to determine whether a file or directory is a symbolic link.

The fully qualified name or relative path of the file or directory. A boolean value indicating whether the file or directory is a symbolic link.

Returns a representing the version information associated with the specified file.

The fully qualified path and name of the file to retrieve the version information for. A containing information about the file. If the file did not contain version information, the FileVersionInfo contains only the name of the file requested.

Combines an array of strings into a path.

An array of parts of the path. The combined path.

Returns the directory information for the specified path.

The path of a file or directory. Directory information for path, or null if path denotes a root directory or is null. Returns if path does not contain directory information.

Returns the absolute path for the specified path.

The path of a file or directory. The fully qualified location of , such as "C:\MyFile.txt".

Returns the file name of the specified path string without the extension.

The path of the file. The string returned by , minus the last period (.) and all characters following it.

Dispose pattern as required by style

Set to true to actually dispose

A wrapper class for accessing the .NET http client.

Clients should use this class rather directly using the .NET http client classes, so they can mock the IHttpClient interface in unit tests.

Allow HttpClient to be injected, can accepted httpclient with mocked HttpMessageHandler for easier unit testing

Send a GET request to the specified Uri as an asynchronous operation if cache doesn't have this Uri entry, otherwize return it from cache

The Uri the request is sent to. The task object representing the asynchronous operation.

Send a POST request to the specified Uri as an asynchronous operation.

The Uri the request is sent to. The HTTP request content sent to the server. The task object representing the asynchronous operation

Send a PUT request to the specified Uri as an asynchronous operation.

The Uri the request is sent to. The HTTP request content sent to the server. The task object representing the asynchronous operation.

Log a diagnostic result

Log a notification that describes a runtime condition detected by the tool.

The notification to log. The scan rule, if any, associated with the notification.

Log a notification that describes a condition relevant to the configuration of the tool.

The notification to log.

An interface for accessing the file system.

Clients wishing to access the file system should instantiate a FileSystem object rather than directly using the .NET file system and other classes, so they can mock the IFileSystem interface in unit tests.