Skip to content

2.1 Analyze Cmd Result Properties

Jump to bottom
Guy Acosta edited this page Jul 28, 2020 · 2 revisions

Analyze Results

The embedded object MetaData within the AnalyzeResult object represents the aggregated scan results providing several lists of potentially valuable items including a detailed enumerable list of MatchRecord items indicating the source location and matching rule and pattern that was used in the detection. See the complete definitions within the MetaData and MatchRecord class files respectively

MetaData class

Contains the analyze scanned meta data elements including roll up data for reporting purposes

  • MetaData.ApplicationName - Detected or derived project name
  • MetaData.SourcePath - Source path provided argument
  • MetaData.SourceVersion - Detected project source version
  • MetaData.Authors - Detected source authors
  • MetaData.Description - Detected source description
  • MetaData.LastUpdated - Last modified date for source code scanned
  • MetaData.DateScanned - Date of analyze scan
  • MetaData.FilesAnalyzed - Total number of files scanned successfully
  • MetaData.TotalFiles - Total number of files in source path
  • MetaData.FilesSkipped - Total number of skipped files based on supported formats
  • MetaData.FilesAffected - Total files with at least one result
  • MetaData.TotalMatchesCount - Total matches with supplied argument settings
  • MetaData.UniqueMatchesCount - Total unique matches by tag
  • MetaData.PackageTypes - List of detected package types
  • MetaData.AppTypes - List of detected application types
  • MetaData.UniqueTags - List of detected unique tags
  • MetaData.UniqueDependencies - List of detected unique code dependency includes
  • MetaData.Outputs - List of detected output types
  • MetaData.Targets - List of detected target types
  • MetaData.Languages - Dictionary of detected programming languages used and file count
  • MetaData.OSTargets - List of detected OS targets
  • MetaData.FileExtensions - LIst of detected file types (extension based)
  • MetaData.CloudTargets - List of detected cloud host targets
  • MetaData.CPUTargets - List of detected cpu targets
  • MetaData.TagCounters - List of detected tag counters i.e. metrics
  • MetaData.Matches - List of detailed MatchRecords from scan

MatchRecord class

Represents augmented record of result issue from rules engine

  • MatchRecord.Language - Language details for this match
  • MatchRecord.FileName - Filename of this match
  • MatchRecord.RuleId - Rule Id found in matching rule
  • MatchRecord.RuleName - Rule name found in matching rule
  • MatchRecord.RuleDescription - Rule description found in matching rule
  • MatchRecord.MatchingPattern - Matching pattern found in matching rule
  • MatchRecord.PatternType - Pattern type of matching pattern
  • MatchRecord.PatternConfidence - Pattern confidence in matching rule pattern
  • MatchRecord.Severity - Severity or importance value in matching rule
  • MatchRecord.Tags - Tags in matching rule
  • MatchRecord.Sample - Matching text for this record
  • MatchRecord.Excerpt - Matching surrounding context text for sample in this record
  • MatchRecord.StartLocationLine - Starting line location of the matching text
  • MatchRecord.StartLocationColumn - Starting column location of the matching text
  • MatchRecord.EndLocationLine - Ending line location of the matching text
  • MatchRecord.EndLocationColumn - Ending column of the matching text
Clone this wiki locally