sarif

package module

Go to main page

Versions in this module

v0

v0.1.1

Jul 12, 2026

Changes in this version

type Address

+ func NewAddress() Address

type Artifact

+ func NewArtifact() Artifact

type ArtifactLocation

+ func NewArtifactLocation() ArtifactLocation

type Attachment

+ func NewAttachment() Attachment

type Conversion

+ func NewConversion() Conversion

type Exception

+ func NewException() Exception

type ExternalProperties

+ func NewExternalProperties() ExternalProperties

type ExternalPropertyFileReference

+ func NewExternalPropertyFileReference() ExternalPropertyFileReference

type ExternalPropertyFileReferences

+ func NewExternalPropertyFileReferences() ExternalPropertyFileReferences

type Graph

+ func NewGraph() Graph

type GraphTraversal

+ func NewGraphTraversal() GraphTraversal

type Invocation

+ func NewInvocation() Invocation

type Location

+ func NewLocation() Location

type LocationRelationship

+ func NewLocationRelationship() LocationRelationship

type LogicalLocation

+ func NewLogicalLocation() LogicalLocation

type Message

+ func NewMessage() Message

type Node

+ func NewNode() Node

type Notification

+ func NewNotification() Notification

type Region

+ func NewRegion() Region

type ReportingConfiguration

+ func NewReportingConfiguration() ReportingConfiguration

type ReportingDescriptor

+ func NewReportingDescriptor() ReportingDescriptor

type ReportingDescriptorReference

+ func NewReportingDescriptorReference() ReportingDescriptorReference

type ReportingDescriptorRelationship

+ func NewReportingDescriptorRelationship() ReportingDescriptorRelationship

type Result

+ func NewResult() Result

type ResultProvenance

+ func NewResultProvenance() ResultProvenance

type Run

+ func NewRun() Run

type StackFrame

+ func NewStackFrame() StackFrame

type ThreadFlowLocation

+ func NewThreadFlowLocation() ThreadFlowLocation

type Tool

+ func NewTool() Tool

type ToolComponent

+ func NewToolComponent() ToolComponent

type ToolComponentReference

+ func NewToolComponentReference() ToolComponentReference

type WebRequest

+ func NewWebRequest() WebRequest

type WebResponse

+ func NewWebResponse() WebResponse

v0.1.0

Jul 9, 2026

Changes in this version

+ func Dump(log *Log, w io.Writer, pretty bool) error

+ func Marshal(log *Log, pretty bool) ([]byte, error)

+ func Schema() (*jsonschema.Schema, error)

+ func Valid(log *Log) bool

+ func Validate(log *Log) error

+ type Address struct

+ AbsoluteAddress int

+ FullyQualifiedName string

+ Index int

+ Kind string

+ Length int

+ Name string

+ OffsetFromParent int

+ ParentIndex int

+ Properties PropertyBag

+ RelativeAddress int

+ func (v *Address) UnmarshalJSON(data []byte) error

+ func (v Address) MarshalJSON() ([]byte, error)

+ type Artifact struct

+ Contents ArtifactContent

+ Description Message

+ Encoding string

+ Hashes map[string]string

+ LastModifiedTimeUtc string

+ Length int

+ Location ArtifactLocation

+ MimeType string

+ Offset int

+ ParentIndex int

+ Properties PropertyBag

+ Roles []string

+ SourceLanguage string

+ func (v *Artifact) UnmarshalJSON(data []byte) error

+ func (v Artifact) MarshalJSON() ([]byte, error)

+ type ArtifactChange struct

+ ArtifactLocation ArtifactLocation

+ Properties PropertyBag

+ Replacements []Replacement

+ func (v ArtifactChange) MarshalJSON() ([]byte, error)

+ type ArtifactContent struct

+ Binary string

+ Properties PropertyBag

+ Rendered MultiformatMessageString

+ Text string

+ func (v ArtifactContent) MarshalJSON() ([]byte, error)

+ type ArtifactLocation struct

+ Description Message

+ Index int

+ Properties PropertyBag

+ URI string

+ URIBaseID string

+ func (v *ArtifactLocation) UnmarshalJSON(data []byte) error

+ func (v ArtifactLocation) MarshalJSON() ([]byte, error)

+ type Attachment struct

+ ArtifactLocation ArtifactLocation

+ Description Message

+ Properties PropertyBag

+ Rectangles []Rectangle

+ Regions []Region

+ func (v *Attachment) UnmarshalJSON(data []byte) error

+ func (v Attachment) MarshalJSON() ([]byte, error)

+ type CodeFlow struct

+ Message Message

+ Properties PropertyBag

+ ThreadFlows []ThreadFlow

+ func (v CodeFlow) MarshalJSON() ([]byte, error)

+ type ConfigurationOverride struct

+ Configuration ReportingConfiguration

+ Descriptor ReportingDescriptorReference

+ Properties PropertyBag

+ func (v ConfigurationOverride) MarshalJSON() ([]byte, error)

+ type Conversion struct

+ AnalysisToolLogFiles []ArtifactLocation

+ Invocation Invocation

+ Properties PropertyBag

+ Tool Tool

+ func (v *Conversion) UnmarshalJSON(data []byte) error

+ func (v Conversion) MarshalJSON() ([]byte, error)

+ type Edge struct

+ ID string

+ Label Message

+ Properties PropertyBag

+ SourceNodeID string

+ TargetNodeID string

+ func (v Edge) MarshalJSON() ([]byte, error)

+ type EdgeTraversal struct

+ EdgeID string

+ FinalState map[string]MultiformatMessageString

+ Message Message

+ Properties PropertyBag

+ StepOverEdgeCount int

+ func (v EdgeTraversal) MarshalJSON() ([]byte, error)

+ type Exception struct

+ InnerExceptions []Exception

+ Kind string

+ Message string

+ Properties PropertyBag

+ Stack Stack

+ func (v *Exception) UnmarshalJSON(data []byte) error

+ func (v Exception) MarshalJSON() ([]byte, error)

+ type ExternalProperties struct

+ Addresses []Address

+ Artifacts []Artifact

+ Conversion Conversion

+ Driver ToolComponent

+ Extensions []ToolComponent

+ ExternalizedProperties PropertyBag

+ GUID string

+ Graphs []Graph

+ Invocations []Invocation

+ LogicalLocations []LogicalLocation

+ Policies []ToolComponent

+ Properties PropertyBag

+ Results []Result

+ RunGUID string

+ Schema string

+ Taxonomies []ToolComponent

+ ThreadFlowLocations []ThreadFlowLocation

+ Translations []ToolComponent

+ Version string

+ WebRequests []WebRequest

+ WebResponses []WebResponse

+ func (v *ExternalProperties) UnmarshalJSON(data []byte) error

+ func (v ExternalProperties) MarshalJSON() ([]byte, error)

+ type ExternalPropertyFileReference struct

+ GUID string

+ ItemCount int

+ Location ArtifactLocation

+ Properties PropertyBag

+ func (v *ExternalPropertyFileReference) UnmarshalJSON(data []byte) error

+ func (v ExternalPropertyFileReference) MarshalJSON() ([]byte, error)

+ type ExternalPropertyFileReferences struct

+ Addresses []ExternalPropertyFileReference

+ Artifacts []ExternalPropertyFileReference

+ Conversion ExternalPropertyFileReference

+ Driver ExternalPropertyFileReference

+ Extensions []ExternalPropertyFileReference

+ ExternalizedProperties ExternalPropertyFileReference

+ Graphs []ExternalPropertyFileReference

+ Invocations []ExternalPropertyFileReference

+ LogicalLocations []ExternalPropertyFileReference

+ Policies []ExternalPropertyFileReference

+ Properties PropertyBag

+ Results []ExternalPropertyFileReference

+ Taxonomies []ExternalPropertyFileReference

+ ThreadFlowLocations []ExternalPropertyFileReference

+ Translations []ExternalPropertyFileReference

+ WebRequests []ExternalPropertyFileReference

+ WebResponses []ExternalPropertyFileReference

+ func (v *ExternalPropertyFileReferences) UnmarshalJSON(data []byte) error

+ func (v ExternalPropertyFileReferences) MarshalJSON() ([]byte, error)

+ type Fix struct

+ ArtifactChanges []ArtifactChange

+ Description Message

+ Properties PropertyBag

+ func (v Fix) MarshalJSON() ([]byte, error)

+ type Graph struct

+ Description Message

+ Edges []Edge

+ Nodes []Node

+ Properties PropertyBag

+ func (v *Graph) UnmarshalJSON(data []byte) error

+ func (v Graph) MarshalJSON() ([]byte, error)

+ type GraphTraversal struct

+ Description Message

+ EdgeTraversals []EdgeTraversal

+ ImmutableState map[string]MultiformatMessageString

+ InitialState map[string]MultiformatMessageString

+ Properties PropertyBag

+ ResultGraphIndex int

+ RunGraphIndex int

+ func (v *GraphTraversal) UnmarshalJSON(data []byte) error

+ func (v GraphTraversal) MarshalJSON() ([]byte, error)

+ type Invocation struct

+ Account string

+ Arguments []string

+ CommandLine string

+ EndTimeUtc string

+ EnvironmentVariables map[string]string

+ ExecutableLocation ArtifactLocation

+ ExecutionSuccessful bool

+ ExitCode int

+ ExitCodeDescription string

+ ExitSignalName string

+ ExitSignalNumber int

+ Machine string

+ NotificationConfigurationOverrides []ConfigurationOverride

+ ProcessID int

+ ProcessStartFailureMessage string

+ Properties PropertyBag

+ ResponseFiles []ArtifactLocation

+ RuleConfigurationOverrides []ConfigurationOverride

+ StartTimeUtc string

+ Stderr ArtifactLocation

+ Stdin ArtifactLocation

+ Stdout ArtifactLocation

+ StdoutStderr ArtifactLocation

+ ToolConfigurationNotifications []Notification

+ ToolExecutionNotifications []Notification

+ WorkingDirectory ArtifactLocation

+ func (v *Invocation) UnmarshalJSON(data []byte) error

+ func (v Invocation) MarshalJSON() ([]byte, error)

+ type Location struct

+ Annotations []Region

+ ID int

+ LogicalLocations []LogicalLocation

+ Message Message

+ PhysicalLocation PhysicalLocation

+ Properties PropertyBag

+ Relationships []LocationRelationship

+ func (v *Location) UnmarshalJSON(data []byte) error

+ func (v Location) MarshalJSON() ([]byte, error)

+ type LocationRelationship struct

+ Description Message

+ Kinds []string

+ Properties PropertyBag

+ Target int

+ func (v *LocationRelationship) UnmarshalJSON(data []byte) error

+ func (v LocationRelationship) MarshalJSON() ([]byte, error)

+ type Log struct

+ InlineExternalProperties []ExternalProperties

+ Properties PropertyBag

+ Runs []Run

+ SchemaURI string

+ Version string

+ func Load(path string) (*Log, error)

+ func Parse(data []byte) (*Log, error)

+ func (v Log) MarshalJSON() ([]byte, error)

+ type LogicalLocation struct

+ DecoratedName string

+ FullyQualifiedName string

+ Index int

+ Kind string

+ Name string

+ ParentIndex int

+ Properties PropertyBag

+ func (v *LogicalLocation) UnmarshalJSON(data []byte) error

+ func (v LogicalLocation) MarshalJSON() ([]byte, error)

+ type Message struct

+ Arguments []string

+ ID string

+ Markdown string

+ Properties PropertyBag

+ Text string

+ func (v *Message) UnmarshalJSON(data []byte) error

+ func (v Message) MarshalJSON() ([]byte, error)

+ type MultiformatMessageString struct

+ Markdown string

+ Properties PropertyBag

+ Text string

+ func (v MultiformatMessageString) MarshalJSON() ([]byte, error)

+ type Node struct

+ Children []Node

+ ID string

+ Label Message

+ Location Location

+ Properties PropertyBag

+ func (v *Node) UnmarshalJSON(data []byte) error

+ func (v Node) MarshalJSON() ([]byte, error)

+ type Notification struct

+ AssociatedRule ReportingDescriptorReference

+ Descriptor ReportingDescriptorReference

+ Exception Exception

+ Level string

+ Locations []Location

+ Message Message

+ Properties PropertyBag

+ ThreadID int

+ TimeUtc string

+ func (v *Notification) UnmarshalJSON(data []byte) error

+ func (v Notification) MarshalJSON() ([]byte, error)

+ type PhysicalLocation struct

+ Address Address

+ ArtifactLocation ArtifactLocation

+ ContextRegion Region

+ Properties PropertyBag

+ Region Region

+ func (v PhysicalLocation) MarshalJSON() ([]byte, error)

+ type PropertyBag map[string]any

+ type Rectangle struct

+ Bottom float64

+ Left float64

+ Message Message

+ Properties PropertyBag

+ Right float64

+ Top float64

+ func (v Rectangle) MarshalJSON() ([]byte, error)

+ type Region struct

+ ByteLength int

+ ByteOffset int

+ CharLength int

+ CharOffset int

+ EndColumn int

+ EndLine int

+ Message Message

+ Properties PropertyBag

+ Snippet ArtifactContent

+ SourceLanguage string

+ StartColumn int

+ StartLine int

+ func (v *Region) UnmarshalJSON(data []byte) error

+ func (v Region) MarshalJSON() ([]byte, error)

+ type Replacement struct

+ DeletedRegion Region

+ InsertedContent ArtifactContent

+ Properties PropertyBag

+ func (v Replacement) MarshalJSON() ([]byte, error)

+ type ReportingConfiguration struct

+ Enabled bool

+ Level string

+ Parameters PropertyBag

+ Properties PropertyBag

+ Rank float64

+ func (v *ReportingConfiguration) UnmarshalJSON(data []byte) error

+ func (v ReportingConfiguration) MarshalJSON() ([]byte, error)

+ type ReportingDescriptor struct

+ DefaultConfiguration ReportingConfiguration

+ DeprecatedGuids []string

+ DeprecatedIDs []string

+ DeprecatedNames []string

+ FullDescription MultiformatMessageString

+ GUID string

+ Help MultiformatMessageString

+ HelpURI string

+ ID string

+ MessageStrings map[string]MultiformatMessageString

+ Name string

+ Properties PropertyBag

+ Relationships []ReportingDescriptorRelationship

+ ShortDescription MultiformatMessageString

+ func (v *ReportingDescriptor) UnmarshalJSON(data []byte) error

+ func (v ReportingDescriptor) MarshalJSON() ([]byte, error)

+ type ReportingDescriptorReference struct

+ GUID string

+ ID string

+ Index int

+ Properties PropertyBag

+ ToolComponent ToolComponentReference

+ func (v *ReportingDescriptorReference) UnmarshalJSON(data []byte) error

+ func (v ReportingDescriptorReference) MarshalJSON() ([]byte, error)

+ type ReportingDescriptorRelationship struct

+ Description Message

+ Kinds []string

+ Properties PropertyBag

+ Target ReportingDescriptorReference

+ func (v *ReportingDescriptorRelationship) UnmarshalJSON(data []byte) error

+ func (v ReportingDescriptorRelationship) MarshalJSON() ([]byte, error)

+ type Result struct

+ AnalysisTarget ArtifactLocation

+ Attachments []Attachment

+ BaselineState string

+ CodeFlows []CodeFlow

+ CorrelationGUID string

+ Fingerprints map[string]string

+ Fixes []Fix

+ GUID string

+ GraphTraversals []GraphTraversal

+ Graphs []Graph

+ HostedViewerURI string

+ Kind string

+ Level string

+ Locations []Location

+ Message Message

+ OccurrenceCount int

+ PartialFingerprints map[string]string

+ Properties PropertyBag

+ Provenance ResultProvenance

+ Rank float64

+ RelatedLocations []Location

+ Rule ReportingDescriptorReference

+ RuleID string

+ RuleIndex int

+ Stacks []Stack

+ Suppressions []Suppression

+ Taxa []ReportingDescriptorReference

+ WebRequest WebRequest

+ WebResponse WebResponse

+ WorkItemURIs []string

+ func (v *Result) UnmarshalJSON(data []byte) error

+ func (v Result) MarshalJSON() ([]byte, error)

+ type ResultProvenance struct

+ ConversionSources []PhysicalLocation

+ FirstDetectionRunGUID string

+ FirstDetectionTimeUtc string

+ InvocationIndex int

+ LastDetectionRunGUID string

+ LastDetectionTimeUtc string

+ Properties PropertyBag

+ func (v *ResultProvenance) UnmarshalJSON(data []byte) error

+ func (v ResultProvenance) MarshalJSON() ([]byte, error)

+ type Run struct

+ Addresses []Address

+ Artifacts []Artifact

+ AutomationDetails RunAutomationDetails

+ BaselineGUID string

+ ColumnKind string

+ Conversion Conversion

+ DefaultEncoding string

+ DefaultSourceLanguage string

+ ExternalPropertyFileReferences ExternalPropertyFileReferences

+ Graphs []Graph

+ Invocations []Invocation

+ Language string

+ LogicalLocations []LogicalLocation

+ NewlineSequences []string

+ OriginalURIBaseIDs map[string]ArtifactLocation

+ Policies []ToolComponent

+ Properties PropertyBag

+ RedactionTokens []string

+ Results []Result

+ RunAggregates []RunAutomationDetails

+ SpecialLocations SpecialLocations

+ Taxonomies []ToolComponent

+ ThreadFlowLocations []ThreadFlowLocation

+ Tool Tool

+ Translations []ToolComponent

+ VersionControlProvenance []VersionControlDetails

+ WebRequests []WebRequest

+ WebResponses []WebResponse

+ func (v *Run) UnmarshalJSON(data []byte) error

+ func (v Run) MarshalJSON() ([]byte, error)

+ type RunAutomationDetails struct

+ CorrelationGUID string

+ Description Message

+ GUID string

+ ID string

+ Properties PropertyBag

+ func (v RunAutomationDetails) MarshalJSON() ([]byte, error)

+ type SpecialLocations struct

+ DisplayBase ArtifactLocation

+ Properties PropertyBag

+ func (v SpecialLocations) MarshalJSON() ([]byte, error)

+ type Stack struct

+ Frames []StackFrame

+ Message Message

+ Properties PropertyBag

+ func (v Stack) MarshalJSON() ([]byte, error)

+ type StackFrame struct

+ Location Location

+ Module string

+ Parameters []string

+ Properties PropertyBag

+ ThreadID int

+ func (v *StackFrame) UnmarshalJSON(data []byte) error

+ func (v StackFrame) MarshalJSON() ([]byte, error)

+ type Suppression struct

+ GUID string

+ Justification string

+ Kind string

+ Location Location

+ Properties PropertyBag

+ State string

+ func (v Suppression) MarshalJSON() ([]byte, error)

+ type ThreadFlow struct

+ ID string

+ ImmutableState map[string]MultiformatMessageString

+ InitialState map[string]MultiformatMessageString

+ Locations []ThreadFlowLocation

+ Message Message

+ Properties PropertyBag

+ func (v ThreadFlow) MarshalJSON() ([]byte, error)

+ type ThreadFlowLocation struct

+ ExecutionOrder int

+ ExecutionTimeUtc string

+ Importance string

+ Index int

+ Kinds []string

+ Location Location

+ Module string

+ NestingLevel int

+ Properties PropertyBag

+ Stack Stack

+ State map[string]MultiformatMessageString

+ Taxa []ReportingDescriptorReference

+ WebRequest WebRequest

+ WebResponse WebResponse

+ func (v *ThreadFlowLocation) UnmarshalJSON(data []byte) error

+ func (v ThreadFlowLocation) MarshalJSON() ([]byte, error)

+ type Tool struct

+ Driver ToolComponent

+ Extensions []ToolComponent

+ Properties PropertyBag

+ func (v *Tool) UnmarshalJSON(data []byte) error

+ func (v Tool) MarshalJSON() ([]byte, error)

+ type ToolComponent struct

+ AssociatedComponent ToolComponentReference

+ Contents []string

+ DottedQuadFileVersion string

+ DownloadURI string

+ FullDescription MultiformatMessageString

+ FullName string

+ GUID string

+ GlobalMessageStrings map[string]MultiformatMessageString

+ InformationURI string

+ IsComprehensive bool

+ Language string

+ LocalizedDataSemanticVersion string

+ Locations []ArtifactLocation

+ MinimumRequiredLocalizedDataSemanticVersion string

+ Name string

+ Notifications []ReportingDescriptor

+ Organization string

+ Product string

+ ProductSuite string

+ Properties PropertyBag

+ ReleaseDateUtc string

+ Rules []ReportingDescriptor

+ SemanticVersion string

+ ShortDescription MultiformatMessageString

+ SupportedTaxonomies []ToolComponentReference

+ Taxa []ReportingDescriptor

+ TranslationMetadata TranslationMetadata

+ Version string

+ func (v *ToolComponent) UnmarshalJSON(data []byte) error

+ func (v ToolComponent) MarshalJSON() ([]byte, error)

+ type ToolComponentReference struct

+ GUID string

+ Index int

+ Name string

+ Properties PropertyBag

+ func (v *ToolComponentReference) UnmarshalJSON(data []byte) error

+ func (v ToolComponentReference) MarshalJSON() ([]byte, error)

+ type TranslationMetadata struct

+ DownloadURI string

+ FullDescription MultiformatMessageString

+ FullName string

+ InformationURI string

+ Name string

+ Properties PropertyBag

+ ShortDescription MultiformatMessageString

+ func (v TranslationMetadata) MarshalJSON() ([]byte, error)

+ type VersionControlDetails struct

+ AsOfTimeUtc string

+ Branch string

+ MappedTo ArtifactLocation

+ Properties PropertyBag

+ RepositoryURI string

+ RevisionID string

+ RevisionTag string

+ func (v VersionControlDetails) MarshalJSON() ([]byte, error)

+ type WebRequest struct

+ Body ArtifactContent

+ Headers map[string]string

+ Index int

+ Method string

+ Parameters map[string]string

+ Properties PropertyBag

+ Protocol string

+ Target string

+ Version string

+ func (v *WebRequest) UnmarshalJSON(data []byte) error

+ func (v WebRequest) MarshalJSON() ([]byte, error)

+ type WebResponse struct

+ Body ArtifactContent

+ Headers map[string]string

+ Index int

+ NoResponseReceived bool

+ Properties PropertyBag

+ Protocol string

+ ReasonPhrase string

+ StatusCode int

+ Version string

+ func (v *WebResponse) UnmarshalJSON(data []byte) error

+ func (v WebResponse) MarshalJSON() ([]byte, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL