sarif

package

Go to main page

Versions in this module

v1

v1.1.1

Dec 8, 2021

v1.1.0

Dec 8, 2021

Changes in this version

type MultiformatMessageString

+ func NewMarkdownMultiformatMessageString(markdown string) *MultiformatMessageString

+ type ReportingConfiguration struct

+ Enabled bool

+ Level interface{}

+ Parameters *PropertyBag

+ Properties *PropertyBag

+ Rank float64

+ type ReportingDescriptor struct

+ DefaultConfiguration *ReportingConfiguration

+ FullDescription *MultiformatMessageString

+ Help *MultiformatMessageString

+ HelpURI *string

+ ID string

+ Name *string

+ Properties Properties

+ ShortDescription *MultiformatMessageString

+ func (rule *ReportingDescriptor) AttachPropertyBag(pb *PropertyBag)

+ func (rule *ReportingDescriptor) WithDescription(description string) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithFullDescription(description *MultiformatMessageString) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithHelp(helpText string) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithHelpURI(helpURI string) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithMarkdownHelp(markdownText string) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithName(name string) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithProperties(properties Properties) *ReportingDescriptor

+ func (rule *ReportingDescriptor) WithShortDescription(description *MultiformatMessageString) *ReportingDescriptor

+ type ToolComponent struct

+ InformationURI *string

+ Name string

+ Notifications []*ReportingDescriptor

+ Rules []*ReportingDescriptor

+ Taxa []*ReportingDescriptor

+ Version *string

+ func (driver *ToolComponent) WithVersion(version string) *ToolComponent

v1.0.14

Dec 7, 2021

v1.0.12

Oct 31, 2021

v1.0.11

Jun 22, 2021

v1.0.10

Jun 7, 2021

v1.0.9

Jun 7, 2021

Changes in this version

type Result

+ Properties Properties

+ func (r *Result) AttachPropertyBag(pb *PropertyBag)

+ func (r *Result) WithProperties(properties Properties) *Result

v1.0.8

Jun 7, 2021

Changes in this version

type Run

+ func (run *Run) AddDistinctArtifact(uri string) *Artifact

v1.0.7

Jun 7, 2021

Changes in this version

type Report

+ func (sarif *Report) WriteFile(filename string) error

v1.0.6

Jun 7, 2021

Changes in this version

type Rule

+ func (rule *Rule) AttachPropertyBag(pb *PropertyBag)

type Run

+ func (run *Run) AddProperty(key string, value cty.Value)

v1.0.5

Jun 7, 2021

v1.0.4

Apr 27, 2021

v1.0.3

Apr 27, 2021

v1.0.2

Apr 27, 2021

Changes in this version

type Location

+ func NewLocationWithPhysicalLocation(physicalLocation *PhysicalLocation) *Location

+ type Properties map[string]interface

+ type PropertyBag struct

+ Properties Properties

+ func NewPropertyBag() *PropertyBag

+ func (pb *PropertyBag) Add(key string, value interface{})

+ func (pb *PropertyBag) AddBoolean(key string, value bool)

+ func (pb *PropertyBag) AddInteger(key string, value int)

+ func (pb *PropertyBag) AddString(key, value string)

type Run

+ Properties Properties

+ func (run *Run) AddProperties(key string, value cty.Value)

+ func (run *Run) AttachPropertyBag(pb *PropertyBag)

+ type RunOption int

+ const IncludeEmptyResults

v1.0.1

Apr 26, 2021

Changes in this version

type Driver

+ Version *string

+ func (driver *Driver) WithVersion(version string) *Driver

+ type Invocation struct

+ EndTimeUTC *time.Time

+ ExecutionSuccessful bool

+ StartTimeUTC *time.Time

+ WorkingDirectory *ArtifactLocation

+ func (i *Invocation) WithEndTimeUTC(endTime time.Time) *Invocation

+ func (i *Invocation) WithStartTimeUTC(startTime time.Time) *Invocation

+ func (i *Invocation) WithWorkingDirectory(workingDirectory *ArtifactLocation) *Invocation

type Rule

+ FullDescription *MultiformatMessageString

+ Name *string

+ func (rule *Rule) WithFullDescription(description *MultiformatMessageString) *Rule

+ func (rule *Rule) WithName(name string) *Rule

type Run

+ Invocations []*Invocation

+ func (run *Run) AddInvocation(executionSuccessful bool) *Invocation

v1.0.0

Apr 12, 2021

Changes in this version

+ type Address struct

+ AbsoluteAddress *uint

+ FullyQualifiedName *string

+ Index *uint

+ Kind *string

+ Length *int

+ Name *string

+ OffsetFromParent *int

+ ParentIndex *uint

+ RelativeAddress *int

+ func NewAddress() *Address

+ func (a *Address) WithAbsoluteAddress(absoluteAddress int) *Address

+ func (a *Address) WithFullyQualifiedName(fullyQualifiedName string) *Address

+ func (a *Address) WithIndex(index int) *Address

+ func (a *Address) WithKind(kind string) *Address

+ func (a *Address) WithLength(length int) *Address

+ func (a *Address) WithName(name string) *Address

+ func (a *Address) WithOffsetFromParent(offsetFromParent int) *Address

+ func (a *Address) WithParentIndex(parentIndex int) *Address

+ func (a *Address) WithRelativeAddress(relativeAddress int) *Address

+ type Artifact struct

+ Contents *ArtifactContent

+ Description *Message

+ Encoding *string

+ Hashes map[string]string

+ LastModifiedTimeUtc *string

+ Length int

+ Location *ArtifactLocation

+ MimeType *string

+ Offset *uint

+ ParentIndex *uint

+ Roles []string

+ SourceLanguage *string

+ func NewArtifact() *Artifact

+ func (a *Artifact) WithContents(artifactContent *ArtifactContent) *Artifact

+ func (a *Artifact) WithDescription(message *Message) *Artifact

+ func (a *Artifact) WithEncoding(encoding string) *Artifact

+ func (a *Artifact) WithHashes(hashes map[string]string) *Artifact

+ func (a *Artifact) WithLastModifiedTimeUtc(lastModified string) *Artifact

+ func (a *Artifact) WithLength(length int) *Artifact

+ func (a *Artifact) WithLocation(artifactLocation *ArtifactLocation) *Artifact

+ func (a *Artifact) WithMimeType(mimeType string) *Artifact

+ func (a *Artifact) WithOffset(offset int) *Artifact

+ func (a *Artifact) WithParentIndex(parentIndex int) *Artifact

+ func (a *Artifact) WithRole(role string) *Artifact

+ func (a *Artifact) WithSourceLanguage(sourceLanguage string) *Artifact

+ type ArtifactChange struct

+ ArtifactLocation ArtifactLocation

+ Replacements []*Replacement

+ func NewArtifactChange(artifactLocation *ArtifactLocation) *ArtifactChange

+ func (a *ArtifactChange) WithReplacement(replacement *Replacement) *ArtifactChange

+ type ArtifactContent struct

+ Binary *string

+ Rendered *MultiformatMessageString

+ Text *string

+ func NewArtifactContent() *ArtifactContent

+ func (a *ArtifactContent) WithBinary(binary string) *ArtifactContent

+ func (a *ArtifactContent) WithRendered(mms *MultiformatMessageString) *ArtifactContent

+ func (a *ArtifactContent) WithText(text string) *ArtifactContent

+ type ArtifactLocation struct

+ Description *Message

+ Index *uint

+ URI *string

+ URIBaseId *string

+ func NewArtifactLocation() *ArtifactLocation

+ func NewSimpleArtifactLocation(uri string) *ArtifactLocation

+ func (a *ArtifactLocation) WithDescription(message *Message) *ArtifactLocation

+ func (a *ArtifactLocation) WithIndex(index int) *ArtifactLocation

+ func (a *ArtifactLocation) WithUri(uri string) *ArtifactLocation

+ func (a *ArtifactLocation) WithUriBaseId(uriBaseId string) *ArtifactLocation

+ type Driver struct

+ InformationURI string

+ Name string

+ Rules []*Rule

+ type Fix struct

+ ArtifactChanges []*ArtifactChange

+ Description *Message

+ func NewFix() *Fix

+ func (f *Fix) WithArtifactChange(ac *ArtifactChange) *Fix

+ func (f *Fix) WithDescription(message *Message) *Fix

+ type Location struct

+ Annotations []*Region

+ Id *uint

+ LogicalLocations []*LogicalLocation

+ Message *Message

+ PhysicalLocation *PhysicalLocation

+ Relationships []*LocationRelationship

+ func NewLocation() *Location

+ func (l *Location) WithAnnotation(region *Region) *Location

+ func (l *Location) WithId(id int) *Location

+ func (l *Location) WithMessage(message *Message) *Location

+ func (l *Location) WithPhysicalLocation(physicalLocation *PhysicalLocation) *Location

+ func (l *Location) WithRelationship(locationRelationship *LocationRelationship) *Location

+ type LocationRelationship struct

+ Description *Message

+ Kinds []string

+ Target uint

+ func NewLocationRelationship(target int) *LocationRelationship

+ func (l *LocationRelationship) WithDescription(message *Message) *LocationRelationship

+ func (l *LocationRelationship) WithKind(kind string) *LocationRelationship

+ type LogicalLocation struct

+ DecoratedName *string

+ FullyQualifiedName *string

+ Index *uint

+ Kind *string

+ Name *string

+ ParentIndex *uint

+ func NewLogicalLocation() *LogicalLocation

+ func (l *LogicalLocation) WithDecoratedName(decoratedName string) *LogicalLocation

+ func (l *LogicalLocation) WithFullyQualifiedName(fullyQualifiedName string) *LogicalLocation

+ func (l *LogicalLocation) WithIndex(index int) *LogicalLocation

+ func (l *LogicalLocation) WithKind(kind string) *LogicalLocation

+ func (l *LogicalLocation) WithName(name string) *LogicalLocation

+ func (l *LogicalLocation) WithParentIndex(parentIndex int) *LogicalLocation

+ type Message struct

+ Arguments []string

+ Id *string

+ Markdown *string

+ Text *string

+ func NewMarkdownMessage(markdown string) *Message

+ func NewMessage() *Message

+ func NewTextMessage(text string) *Message

+ func (m *Message) WithArgument(argument string) *Message

+ func (m *Message) WithId(id string) *Message

+ func (m *Message) WithMarkdown(markdown string) *Message

+ func (m *Message) WithText(text string) *Message

+ type MultiformatMessageString struct

+ Markdown *string

+ Text string

+ func NewMultiformatMessageString(text string) *MultiformatMessageString

+ func (m *MultiformatMessageString) WithMarkdown(markdown string) *MultiformatMessageString

+ type PhysicalLocation struct

+ Address *Address

+ ArtifactLocation *ArtifactLocation

+ ContextRegion *Region

+ Region *Region

+ func NewPhysicalLocation() *PhysicalLocation

+ func (pl *PhysicalLocation) WithAddress(address *Address) *PhysicalLocation

+ func (pl *PhysicalLocation) WithArtifactLocation(artifactLocation *ArtifactLocation) *PhysicalLocation

+ func (pl *PhysicalLocation) WithContextRegion(contextRegion *Region) *PhysicalLocation

+ func (pl *PhysicalLocation) WithRegion(region *Region) *PhysicalLocation

+ type Region struct

+ ByteLength *int

+ ByteOffset *int

+ CharLength *int

+ CharOffset *int

+ EndColumn *int

+ EndLine *int

+ Message *Message

+ Snippet *ArtifactContent

+ SourceLanguage *string

+ StartColumn *int

+ StartLine *int

+ func NewRegion() *Region

+ func NewSimpleRegion(startLine, endLine int) *Region

+ func (r *Region) WithByteLength(byteLength int) *Region

+ func (r *Region) WithByteOffset(byteOffset int) *Region

+ func (r *Region) WithCharLength(charLength int) *Region

+ func (r *Region) WithCharOffset(charOffset int) *Region

+ func (r *Region) WithEndColumn(endColumn int) *Region

+ func (r *Region) WithEndLine(endLine int) *Region

+ func (r *Region) WithMessage(message *Message) *Region

+ func (r *Region) WithSnippet(snippet *ArtifactContent) *Region

+ func (r *Region) WithSourceLanguage(sourceLanguage string) *Region

+ func (r *Region) WithStartColumn(startColumn int) *Region

+ func (r *Region) WithStartLine(startLine int) *Region

+ type Replacement struct

+ DeletedRegion Region

+ InsertedContent *ArtifactContent

+ func NewReplacement(region *Region) *Replacement

+ func (r *Replacement) WithInsertedContent(artifactContent *ArtifactContent) *Replacement

+ type ReportingDescriptorReference struct

+ Guid *string

+ Id *string

+ Index *uint

+ ToolComponent *ToolComponentReference

+ func NewReportingDescriptorReference() *ReportingDescriptorReference

+ func (r *ReportingDescriptorReference) WithGuid(guid string) *ReportingDescriptorReference

+ func (r *ReportingDescriptorReference) WithId(id string) *ReportingDescriptorReference

+ func (r *ReportingDescriptorReference) WithIndex(index int) *ReportingDescriptorReference

+ func (r *ReportingDescriptorReference) WithToolComponentReference(toolComponentRef *ToolComponentReference) *ReportingDescriptorReference

+ type Result struct

+ AnalysisTarget *ArtifactLocation

+ BaselineState *string

+ CorrelationGuid *string

+ Fingerprints map[string]interface{}

+ Fixes []*Fix

+ Guid *string

+ HostedViewerUri *string

+ Kind *string

+ Level *string

+ Locations []*Location

+ Message Message

+ OccurrenceCount *uint

+ PartialFingerprints map[string]interface{}

+ Rank *float32

+ RelatedLocations []*Location

+ Rule *ReportingDescriptorReference

+ RuleID *string

+ RuleIndex *uint

+ Suppressions []*Suppression

+ Taxa []*ReportingDescriptorReference

+ WorkItemUris []string

+ func (r *Result) WithAnalysisTarget(target *ArtifactLocation) *Result

+ func (r *Result) WithBaselineState(state string) *Result

+ func (r *Result) WithCorrelationGuid(correlationGuid string) *Result

+ func (r *Result) WithFingerPrints(fingerPrints map[string]interface{}) *Result

+ func (r *Result) WithFix(fix *Fix) *Result

+ func (r *Result) WithGuid(guid string) *Result

+ func (r *Result) WithHostedViewerUri(hostedViewerUri string) *Result

+ func (r *Result) WithKind(kind string) *Result

+ func (r *Result) WithLevel(level string) *Result

+ func (r *Result) WithLocation(location *Location) *Result

+ func (r *Result) WithMessage(message Message) *Result

+ func (r *Result) WithOccurrenceCount(occurrenceCount int) *Result

+ func (r *Result) WithPartialFingerPrints(fingerPrints map[string]interface{}) *Result

+ func (r *Result) WithRank(rank float32) *Result

+ func (r *Result) WithRelatedLocation(location *Location) *Result

+ func (r *Result) WithRule(rdp *ReportingDescriptorReference) *Result

+ func (r *Result) WithRuleIndex(ruleIndex int) *Result

+ func (r *Result) WithSuppression(suppression *Suppression) *Result

+ func (r *Result) WithTaxa(rdp *ReportingDescriptorReference) *Result

+ func (r *Result) WithWorkItemUri(workItemUri string) *Result

+ type Rule struct

+ Help *TextBlock

+ HelpURI string

+ ID string

+ Properties map[string]string

+ ShortDescription *TextBlock

+ func (rule *Rule) WithDescription(description string) *Rule

+ func (rule *Rule) WithHelp(helpText string) *Rule

+ func (rule *Rule) WithHelpURI(helpURI string) *Rule

+ func (rule *Rule) WithProperties(properties map[string]string) *Rule

+ type Run struct

+ Artifacts []*Artifact

+ Results []*Result

+ Tool Tool

+ func NewRun(toolName, informationURI string) *Run

+ func (run *Run) AddArtifact() *Artifact

+ func (run *Run) AddResult(ruleID string) *Result

+ func (run *Run) AddRule(ruleID string) *Rule

+ func (run *Run) DedupeArtifacts() error

+ func (run *Run) GetResultByRuleId(ruleId string) (*Result, error)

+ func (run *Run) GetRuleById(ruleId string) (*Rule, error)

+ type Suppression struct

+ Guid *string

+ Justification *string

+ Kind string

+ Location *Location

+ Status *string

+ func NewSuppression(kind string) *Suppression

+ func (s *Suppression) WithGuid(guid string) *Suppression

+ func (s *Suppression) WithJustifcation(justification string) *Suppression

+ func (s *Suppression) WithLocation(location *Location) *Suppression

+ func (s *Suppression) WithStatus(status string) *Suppression

+ type TextBlock struct

+ Text string

+ func NewTextBlock(text string) *TextBlock

+ type Tool struct

+ Driver *Driver

+ type ToolComponentReference struct

+ Guid *string

+ Index *uint

+ Name *string

+ func NewToolComponentReference() *ToolComponentReference

+ func (t *ToolComponentReference) WithGuid(guid string) *ToolComponentReference

+ func (t *ToolComponentReference) WithIndex(index int) *ToolComponentReference

+ func (t *ToolComponentReference) WithName(name string) *ToolComponentReference

v0

v0.0.8

Mar 12, 2021

Changes in this version

type Report

+ func FromBytes(content []byte) (*Report, error)

v0.0.7

Feb 24, 2021

v0.0.6

Feb 20, 2021

Changes in this version

type Report

+ func FromString(content string) (*Report, error)

+ func Open(filename string) (*Report, error)

v0.0.5

Oct 27, 2020

Changes in this version

+ type Report struct

+ Runs []*models.Run

+ Schema string

+ Version string

+ func New(version Version) (*Report, error)

+ func (sarif *Report) AddRun(toolName, informationUri string) *models.Run

+ func (sarif *Report) PrettyWrite(w io.Writer) error

+ func (sarif *Report) Write(w io.Writer) error

+ type Version string

+ const Version210

Other modules containing this package

github.com/owenrumney/go-sarif/v2

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