C# Class Microsoft.CodeAnalysis.Sarif.Converters.FortifyIssue

A Fortify result element.
Show file Open project: Microsoft/sarif-sdk Class Usage Examples

Public Properties

Property Type Description
Abstract string
AbstractCustom string
Category string
CweIds ImmutableArray
InstanceId string
Kingdom string
PrimaryOrSink FortifyPathElement
Priority string
RuleId string
Source FortifyPathElement

Public Methods

Method Description
FortifyIssue ( string ruleId, string iid, string category, string kingdom, string abs, string abstractCustom, string priority, FortifyPathElement primaryOrSink, FortifyPathElement source, ImmutableArray cweIds ) : System

Initializes a new instance of the FortifyIssue class.

Parse ( XmlReader xmlReader, FortifyStrings strings ) : FortifyIssue

Parses a Fortify Result element from an XmlReader.

ParseCweIds ( string cweIdSource ) : ImmutableArray

Converts the CWE ID format from Fortify to a plain list of integers.

Method Details

FortifyIssue() public method

Initializes a new instance of the FortifyIssue class.
public FortifyIssue ( string ruleId, string iid, string category, string kingdom, string abs, string abstractCustom, string priority, FortifyPathElement primaryOrSink, FortifyPathElement source, ImmutableArray cweIds ) : System
ruleId string The Rule ID stored in the Fortify result.
iid string The Instance ID stored in the Fortify result.
category string The category of Fortify result.
kingdom string The kingdom of the Fortify result.
abs string The abstract (description) message of the Fortify result if present; otherwise, null.
abstractCustom string A custom user-provided abstract (description) message of the Fortify result if it is present; /// otherwise, null.
priority string The "friority" (which appears to be an intentional misspelling of "priority") of the Fortify /// result if present; otherwise, null.
primaryOrSink FortifyPathElement The primary location for the Fortify result; this will be the sink for data flow rules.
source FortifyPathElement Source for the flagged data flow if present; otherwise, null.
cweIds ImmutableArray List of CWE IDs stapled to the Fortify result, if present.
return System

Parse() public static method

Parses a Fortify Result element from an XmlReader.
public static Parse ( XmlReader xmlReader, FortifyStrings strings ) : FortifyIssue
xmlReader System.Xml.XmlReader The from which an element containing a Fortify result shall be /// consumed. When this method returns, this is positioned on the following element.
strings FortifyStrings Strings used in processing a Fortify report.
return FortifyIssue

ParseCweIds() public static method

Converts the CWE ID format from Fortify to a plain list of integers.
public static ParseCweIds ( string cweIdSource ) : ImmutableArray
cweIdSource string The string from which CWE IDs shall be parsed.
return ImmutableArray

Property Details

Abstract public property

The abstract (description) message of the Fortify result if present; otherwise, null.
public string Abstract
return string

AbstractCustom public property

A custom user-provided abstract (description) message of the Fortify result if it is present; otherwise, null.
public string AbstractCustom
return string

Category public property

The category of Fortify result.
public string Category
return string

CweIds public property

List of CWE IDs stapled to the Fortify result, if present.
public ImmutableArray CweIds
return ImmutableArray

InstanceId public property

The Instance ID stored in the Fortify result if present; otherwise, null.
public string InstanceId
return string

Kingdom public property

The kingdom of the Fortify result.
public string Kingdom
return string

PrimaryOrSink public property

The primary location for the Fortify result; this will be the sink for data flow rules.
public FortifyPathElement,Microsoft.CodeAnalysis.Sarif.Converters PrimaryOrSink
return FortifyPathElement

Priority public property

The "friority" (which appears to be an intentional misspelling of "priority") of the Fortify result if present; otherwise, null.
public string Priority
return string

RuleId public property

The Rule ID stored in the Fortify result if present; otherwise, null.
public string RuleId
return string

Source public property

Source for the flagged data flow if present; otherwise, null.
public FortifyPathElement,Microsoft.CodeAnalysis.Sarif.Converters Source
return FortifyPathElement