Sarif.Driver
This class contains argument splitting functionality.
Mimics CommandLineToArgvW's argument splitting behavior, plus bug fixes.
The command line to split into arguments.
The values of the arguments supplied in the input.
Attribute for branded version information.
Initializes a new instance of the class.
The branded version.
Gets the branded version for the assembly. For example, externally shipping assemblies are
typically branded with a year instead of the SDL version.
The branded version.
A wrapper for enumerables of disposable objects that ensures that they are
destroyed as they are produced.
This wrapper breaks several of the built in
extension methods that attempt to copy elements into backing collections, such as
. Callers must be
informed of the consequences of not being able to copy elements or references to elements
as usual.
Note however that most of these mechanisms are not safe to use if the underlying
type is disposable, because they remove elements from the source stream that the caller
would need to dispose.
Note that this class should only be used for enumerables that "stream" their
elements and produce new disposable values when reset or similar. If you create one of
these wrappers around a collection that actually owns the disposable item, such as
, enumerating the collection will destroy the collection's
contents (which is not what the caller expects).
The type wrapped in this enumerable.
Initializes a new instance of the class.
An enumerable implementation that this instance will wrap.
Gets an enumerator to walk a view of the underlying collection.
An enumerator that iterates over elements in this collection.
Gets an enumerator to walk a view of the underlying collection.
An enumerator that iterates over elements in this collection.
A view of a disposable object inside of a collection.
The type of disposable object in the collection.
Initializes a new instance of the
class that owns a value.
The value this view wraps.
Gets a non-owning reference to the element stored in this view.
The underlying value in this view.
Thrown if this view no longer owns
the underlying value.
Takes ownership of the underlying element stored in this view.
Thrown if this view no longer owns the
underlying value.
A the underlying value in this view.
If this instance owns the underlying value, destroys (calls
) on the underlying value.
Ensures the consistency of the command line options related to the location and format
of the output file, and adjusts the options for ease of use.
A object containing the command line options.
true if the options are internally consistent; otherwise false.
Ensures the consistency of the MultipleFilesOptionsBase command line options related to
the location of the output file, and adjusts the options for ease of use.
A object containing the relevant options.
true if the options are internally consistent; otherwise false.
At this time, this method does not actually do any validation. Unlike the case of
SingleFileOptionsBase, where you have to specify exactly one of --inline and
--output-file, it is _not_ necessary to specify --output-folder-path if --inline is
absent, because by default each transformed file is written to the path containing
corresponding input file.
However, similarly to the case of SingleFileOptionsBase, we _do_ want to set
--log ForceOverwrite whenever --log Inline is true, because there's no reason
to force the user to type "--log ForceOverwrite;Inline" when they've said
that they want to overwrite the input file
(see https://github.com/microsoft/sarif-sdk/issues/1642).
So we introduce this method for three reasons:
1) For symmetry with the SingleFileOptionsBase,
2) To DRY out the logic for making --log Inline and --log ForceOverwrite consistent, and
3) To leave an obvious place to put output file option consistency logic if it's
needed in future.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Target version must be 1 or 2.
Looks up a localized string similar to Exactly one of the '{0}' and '{1}' options must be present..
Looks up a localized string similar to A binary was not analyzed as the it does not appear to be a valid portable executable..
Looks up a localized string similar to Analysis completed successfully..
Looks up a localized string similar to Analysis finished but was not complete due to non-fatal runtime errors..
Looks up a localized string similar to Analysis halted prematurely due to a fatal execution condition..
Looks up a localized string similar to No analyzer paths specified.
Looks up a localized string similar to Attempted to access a DisposableEnumerable which is non-owning..
Looks up a localized string similar to No description available..
Looks up a localized string similar to The '{0}' and '{1}' options cannot be specified together..
Looks up a localized string similar to The value of the '{0}' option must be greater than or equal to zero..
Looks up a localized string similar to Invalid PREfast defect state..
Looks up a localized string similar to PREfast defects require a main SFA where the defect occurs.
Looks up a localized string similar to Probability must be between 0.0 and 1.0, inclusive; or be unset..
Looks up a localized string similar to Rank must be between 0 and 10, inclusive; or be unset..
Looks up a localized string similar to PREfast defects require descriptions with content..
Looks up a localized string similar to PREfast defects require content in their defect code..
Looks up a localized string similar to The function line number must be strictly positive; files begin at line 1..
Looks up a localized string similar to KeyEvent ids must be strictly positive..
Looks up a localized string similar to SequenceNumber must be positive, or 0 to disable sequence numbering..
Looks up a localized string similar to Application exited unexpectedly..
Looks up a localized string similar to An exception was raised during analysis:
{0}.
Looks up a localized string similar to The local element name was not set..
Returns a value indicating whether a set of output files can be created, and writes messages
to the error stream if any of them cannot.
A list of the paths to the output files.
true if the --log ForceOverwrite option was specified.
An object that provides access to the file system.
true if all the output files can be created; otherwise false.
Returns a value indicating whether the output file can be created, and writes a message
to the error stream if it cannot.
The path to the output file.
true if the --log ForceOverwrite option was specified.
An object that provides access to the file system.
true if the output file can be created; otherwise false.
Returns a value indicating whether the output file can be created.
The path to the output file.
true if the --log ForceOverwrite option was specified.
An object that provides access to the file system.
true if the output file can be created; otherwise false.
Constructs a description of a command line option.
The type that defines the property corresponding to the command line option.
The name of the property corresponding to the command line option.
A description of the specified command line option in the format "shortName", "longName",
or "shortName, longName", depending on which names are available.
The CommandLine package defines to mark
properties that correspond to command line options. CommandLine performs some validation,
but sometimes it is necessary to perform additional validation. In that case, it is
desirable for the validation message to refer to the invalid parameter in the same
format that CommandLine itself does.
A class containing common useful extension methods for .
Compares two sequences of elements lexicographically, using the element type's default
comparer.
The type of element in the sequences being compared.
The left hand side sequence to lexicographically compare.
The right hand side sequence to lexicographically compare.
If the range is lexicographically less than the range
, a negative value. Otherwise, if the range
is lexicographically less than the range
, a positive value. Otherwise, (the sequences are equal) 0.
Compares two sequences of elements lexicographically, using the supplied element comparer.
The type of element in the sequences being compared.
The left hand side sequence to lexicographically compare.
The right hand side sequence to lexicographically compare.
The comparer.
If the range is lexicographically less than the range
, a negative value. Otherwise, if the range
is lexicographically less than the range
, a positive value. Otherwise, (the sequences are equal) 0.
Removes elements from an array if they match a predicate.
The type of elements in the array.
The array to search for elements matching the specified predicate. If this parameter is null, no action is taken and false is returned.
The predicate to check against.
true if any elements were removed from ; otherwise, false.
Generates an enumerable collection in a random order.
The type stored in the enumerable collection.
The enumerable containing the original data to scramble.
The sequence in a scrambled order.
Generates an enumerable collection in a random order.
The type stored in the enumerable collection.
The enumerable containing the original data to scramble.
The random number generator to use.
The sequence in a scrambled order.
A wrapper class for accessing environment variables.
Clients should use this class rather than directly using the System.EnvironmentVariable
class, so they can mock the IEnvironmentVariables interface in unit tests.
Replaces the name of each environment variable embedded in the specified string with
the string equivalent of the value of the variable, then returns the resulting string.
A string containing the names of zero or more environment variables. Each environment
variable is quoted with the percent sign character (%).
A string with each environment variable replaced by its value.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to Line number supplied was out of range [1, numLinesInFile + 1).
Looks up a localized string similar to Attempted to access a DisposableEnumerable which is non-owning..
Looks up a localized string similar to Invalid PREfast defect state..
Looks up a localized string similar to PREfast defects require a main SFA where the defect occurs.
Looks up a localized string similar to Probability must be between 0.0 and 1.0, inclusive; or be unset..
Looks up a localized string similar to Rank must be between 0 and 10, inclusive; or be unset..
Looks up a localized string similar to PREfast defects require descriptions with content..
Looks up a localized string similar to PREfast defects require content in their defect code..
Looks up a localized string similar to The function line number must be strictly positive; files begin at line 1..
Looks up a localized string similar to KeyEvent ids must be strictly positive..
Looks up a localized string similar to SequenceNumber must be positive, or 0 to disable sequence numbering..
Looks up a localized string similar to The value cannot be negative..
Looks up a localized string similar to The value must be greater than or equal to 1..
Looks up a localized string similar to The local element name was not set..
An interface for accessing environment variables.
Clients wishing to access environment variables should instantiate an EnvironmentVariables
object rather than directly using the System.Environment class, so they can mock the
IEnvironmentVariables interface in unit tests.
Replaces the name of each environment variable embedded in the specified string with
the string equivalent of the value of the variable, then returns the resulting string.
A string containing the names of zero or more environment variables. Each environment
variable is quoted with the percent sign character (%).
A string with each environment variable replaced by its value.
Kinds of importance that can be applied to a .
This (and the SFA to which it is attached) is
essential to understand the defect.
This describes the defect, but may not be
absolutely necessary to understand its impact.
Murmur hash 3 implementation of IHashCalculator. See
http://www.codeproject.com/Articles/32829/Hash-Functions-An-Empirical-Comparison
http://code.google.com/p/smhasher/
http://code.google.com/p/smhasher/source/browse/trunk/MurmurHash3.cpp
This implementation is the x86_32 version. Note that we don't deal with the "tail" bits of the algorithm
because we allow only integer inputs.
The first murmur hash constant.
The second murmur hash constant.
The internal state of the hash.
Number of items inserted into the hash.
Equality operator.
The left hand side.
The right hand side.
true of is equal to ; otherwise, false.
Inequality operator.
The left hand side.
The right hand side.
true of is not equal to ; otherwise, false.
Adds item to the calculated hash.
The item to add to the calculated hash.
Adds multiple items to the calculated hash.
The items to add.
Adds multiple items to the calculated hash.
The items to add.
Indicates whether this instance and a specified object are equal.
Another object to compare to.
true if and this instance are the same type and
represent the same value; otherwise, false.
Returns the hash code for this instance.
A 32-bit signed integer that is the hash code for this instance.
Returns a human readable string describing this instance.
A human readable string describing this instance.
Adds item to the calculated hash.
The item to add to the calculated hash. If this parameter is
null, the effect will be the same as if its
function returns 0.
Adds a set of items to the calculated hash.
The items to add. If any item is null, the effect is the
same as if that item's returned null.
Mixes the given hash value.
Hash value to process.
The mixed hash value.
This function must be in an unchecked context.
Rotates left.
Hash value to process.
The amount by which shall be rotated.
The rotated value of .
Contains a function to make it less verbose to make key value pairs. Similar to C++'s
std::make_pair.
Makes a pair, with the generic type parameters determined using generic argument deduction.
Key type.
Value type.
The key to use in the new pair.
The value to use in the new pair.
A KeyValuePair{TKey,TValue} containing the supplied key and value.
Path extension functions.
Gets a path relative to the SdlCommon library.
The relative path to obtain to SdlCommon.dll.
The path relative to the SdlCommon library.
Try to get the directory containing a file or the directory itself if path is a directory.
file or directory
directory if possible, otherwise null
Unescapes a potentially quoted path.
Thrown when an invalid path is supplied.
The path to unescape.
An unescaped version of .
Replace invalid file name characters in given file name with specified valid character.
The file name to check if contains invalid file name characters.
The string to replace the invalid file name characters.
A valid file name string.
Throw when any argument is null.
Throw if the replacement contains invalid file name character.
Adds slashes to the temporary array.
The result temporary array.
[in,out] Zero-based index of where slashes are being added. On return, set to the next insertion index in .
The number of slashes to add.
Reference equals equality comparer.
Generic type compared.
The instance of equality comparer for T.
Prevents clients from constructing instances.
Tests if two T objects are considered equal.
Left T to be compared.
Right T to be compared.
true if the objects are considered equal, false if they are not.
Calculates the hash code for a given T.
The object to get a hash code for.
The hash code for .
"Rental" stream. Wraps a stream object, but prevents the client from calling dispose
on that stream object. This allows a stream to be passed, for example to TextReader or
TextWriter, without giving up ownership of the underlying stream.
The inner stream.
Initializes a new instance of the class.
The Stream to process.
When overridden in a derived class, gets a value indicating whether the current stream
supports reading.
true if the stream supports reading; otherwise, false.
When overridden in a derived class, gets a value indicating whether the current stream
supports seeking.
true if the stream supports seeking; otherwise, false.
When overridden in a derived class, gets a value indicating whether the current stream
supports writing.
true if the stream supports writing; otherwise, false.
When overridden in a derived class, gets the length in bytes of the stream.
A long value representing the length of the stream in bytes.
A class derived from Stream does not
support seeking.
Methods were called after the stream
was closed.
When overridden in a derived class, gets or sets the position within the current stream.
The current position within the stream.
An I/O error occurs.
The stream does not support seeking.
Methods were called after the stream
was closed.
When overridden in a derived class, clears all buffers for this stream and causes any
buffered data to be written to the underlying device.
An I/O error occurs.
When overridden in a derived class, reads a sequence of bytes from the current stream and
advances the position within the stream by the number of bytes read.
An array of bytes. When this method returns, the buffer contains the
specified byte array with the values between and
( + - 1) replaced by the bytes read from
the current source.
The zero-based byte offset in at which to
begin storing the data read from the current stream.
The maximum number of bytes to be read from the current stream.
The total number of bytes read into the buffer. This can be less than the number of bytes
requested if that many bytes are not currently available, or zero (0) if the end of the
stream has been reached.
The sum of and
is larger than the buffer length.
is null.
or
is negative.
An I/O error occurs.
The stream does not support reading.
Methods were called after the stream
was closed.
When overridden in a derived class, sets the position within the current stream.
A byte offset relative to the parameter.
A value of type indicating the
reference point used to obtain the new position.
The new position within the current stream.
An I/O error occurs.
The stream does not support seeking, such
as if the stream is constructed from a pipe or console output.
Methods were called after the stream
was closed.
When overridden in a derived class, sets the length of the current stream.
The desired length of the current stream in bytes.
An I/O error occurs.
The stream does not support both writing
and seeking, such as if the stream is constructed from a pipe or console output.
Methods were called after the stream
was closed.
When overridden in a derived class, writes a sequence of bytes to the current stream and
advances the current position within this stream by the number of bytes written.
An array of bytes. This method copies bytes
from to the current stream.
The zero-based byte offset in at which to
begin copying bytes to the current stream.
The number of bytes to be written to the current stream.
The sum of and
is greater than the buffer length.
is null.
or
is negative.
An I/O error occurs.
The stream does not support writing.
Methods were called after the stream
was closed.
Seeks the underlying stream back to the state it was in before this was
constructed. Satisfies the contract of the base class, System.IO.Stream.Dispose(bool).
Unused parameter.
Options that cut across all rules that are provided by a driver. Currently restricted to a
single setting that allows for rules to be explicitly disabled. In the future, this
same mechanism will be improved to allow configuration to alter the warning level
for a result.
Enable namespace import optimization.
EventSource is an ETW EventSource for Microsoft.CodeAnalysis.Sarif.PatternMatcher events, allowing performance tracing.
https://learn.microsoft.com/en-us/dotnet/core/diagnostics/eventsource-instrumentation
Gets a label that reflects the processing capability of this command. This
label will be used as a suffix for default log file names created during
execution. e.g., a ProcessingName value of 'merged' applied to an input
file named 'MyInput.sarif' will, by default, create an output log file named
'MyInput-merged.sarif'.
Calculate the file to load the configuration from.
Options
Configuration file path, or null if the built in configuration should be used.
Unknown state. Rule will raise all notifications according
to helpers invoked during execution state.
User has disabled a rule. This should always result in a tool
warning, in order to preserve knowledge that some portion of
analysis was disabled.
User has reduced all signal from a rule to warnings. Warnings
should always be persisted to reports but may not block
engineering processes.
User has elevated all failures from a check to errors.
User has reduced all signal from a rule to notes.
The SemanticVersion class implements Semantic Versioning based on the
http://semver.org/ summary 2.0.0
Major version.
Metadata which is not used for version comparison.
This contains the value after the plus sign as described below
Build metadata MAY be denoted by appending a plus sign and a series of dot separated
identifiers immediately following the patch or pre-release version.
Identifiers MUST comprise only ASCII alphanumerics and hyphen [0-9A-Za-z-].
Identifiers MUST NOT be empty.
Build metadata SHOULD be ignored when determining version precedence.
Thus two versions that differ only in the build metadata, have the same precedence.
Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, 1.0.0-beta+exp.sha.5114f85.
Minor version.
Patch version.
This is used in cases where the version had 4 numbers. This is a violation of Semantic Version spec, but
the retire data has cases of this so we will allow it, but make is read only.
This contains the value after the hyphen as described below.
A pre-release version MAY be denoted by appending a hyphen and a series of dot separated
identifiers immediately following the patch version. Identifiers MUST comprise only
ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty.
Numeric identifiers MUST NOT include leading zeroes.
Pre-release versions have a lower precedence than the associated normal version.
A pre-release version indicates that the version is unstable and might not satisfy
the intended compatibility requirements as denoted by its associated normal version.
Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92.
Construct Semantic version.
Construct version from a string.
Version string
Compares two prerelease values based on the SemanticVersion specification (identifier at a time).
A Series of dot separated identifiers to be compared.
A Series of dot separated identifiers to be compared.
returns 1 if left is greater than right, -1 if left is less than right, 0 if they are equal.
Compares Semantic Version according to the specification 2.0.0 at http://semver.org/
Object to compare this to.
returns 1 if this is greater than obj, -1 if this is less than obj, 0 if they are equal.
Operator > for version comparison.
Version on left side of expression.
Version on right side of expression.
Operator > for version comparison.
Version on left side of expression.
Version on right side of expression.
Operator == for version comparison.
Version on left side of expression.
Version on right side of expression.
Operator != for version comparison.
Version on left side of expression.
Version on right side of expression.
Override Equals for version comparison.
Version to compare.
Get the hash code for the object.
The hash code of the Semantic Version
Convert to a string.
Returns a string representation of this object.
Parse the version from a given string.
Version in Semantic Version format http://semver.org/
A SemanticVersion object.
Handle explicit conversion so the Json de-serializer will function.
Try to make a legal version to fix RetireData errors.
Parse the version from a given string.
Input version string in Semantic Version format.
SemanticVersion object.
Returns true if successful, false otherwise.
This partly implemented Skimmer comparer simply orders skimmers by their Ids and Names.
This provides for some basic sort ordering to help produce deterministically ordered analysis.
Extensions on the class.
Gets a null value for null or whitespace strings. Otherwise passes though the source string unchanged.
The string to check.
If is null or whitespace, null; otherwise .
Temporary directory class; implements to ensure an effort is made to
delete the temporary directory in the face of exceptions. If you only need a single file, use the
class instead.
Initializes a new instance of the class.
Gets the name of the generated directory.
The name of the generated directory.
Gets the full path to a file with the supplied name inside this temp directory.
File name of the file path to generate.
The current combined with .
Touches the given file in the temp directory.
File name of the file path to generate.
The full path to the file created or updated.
Writes text to the given file in the temp directory.
File name of the file path to generate.
The text to write.
The full path to the file created or updated.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged
resources. Makes a best-effort attempt to delete the temporary directory.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged
resources. Makes a best-effort attempt to delete the temporary directory.
Temporary file class; implements to ensure an effort is made to
delete the temporary file in the face of exceptions. If you need a directory or set of
files instead of a file, use the class instead.
Initializes a new instance of the class.
Initializes a new instance of the class where the file name has the indicated extension.
The requested extension.
Gets the name of the generated file.
The name of the generated file.
Creates temporary path name.
A temporary path name where a file is not present on the file system.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged
resources. Makes a best-effort attempt to delete the temporary file.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged
resources. Makes a best-effort attempt to delete the temporary file.
Extension methods applied to class XmlWriter.
Writes an element whose value is the supplied integer.
The writer to which an element shall be written.
The name of the element to be written.
The value of the resulting element.
Writes an element if the supplied value is not null or whitespace.
Thrown when is null.
Thrown when is not set.
The writer to which an element shall be written.
The name of the element to be written.
The element string if the element should be written; otherwise, null.