sarif

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2022 License: Unlicense Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {
	PropertyBag
	Index              *uint   `json:"index,omitempty"`
	AbsoluteAddress    *uint   `json:"absoluteAddress,omitempty"`
	RelativeAddress    *int    `json:"relativeAddress,omitempty"`
	OffsetFromParent   *int    `json:"offsetFromParent,omitempty"`
	Length             *int    `json:"length,omitempty"`
	Name               *string `json:"name,omitempty"`
	FullyQualifiedName *string `json:"fullyQualifiedName,omitempty"`
	Kind               *string `json:"kind,omitempty"`
	ParentIndex        *uint   `json:"parentIndex,omitempty"`
}

Address ...

func NewAddress 

func NewAddress() *Address

NewAddress ...

func (*Address) WithAbsoluteAddress 

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

WithAbsoluteAddress ...

func (*Address) WithFullyQualifiedName 

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

WithFullyQualifiedName ...

func (*Address) WithIndex 

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

WithIndex ...

func (*Address) WithKind 

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

WithKind ...

func (*Address) WithLength 

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

WithLength ...

func (*Address) WithName 

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

WithName ...

func (*Address) WithOffsetFromParent 

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

WithOffsetFromParent ...

func (*Address) WithParentIndex 

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

WithParentIndex ...

func (*Address) WithRelativeAddress 

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

WithRelativeAddress ...

type Artifact 

type Artifact struct {
	PropertyBag
	Location            *ArtifactLocation `json:"location,omitempty"`
	ParentIndex         *uint             `json:"parentIndex,omitempty"`
	Offset              *uint             `json:"offset,omitempty"`
	Length              int               `json:"length"`
	Roles               []string          `json:"roles,omitempty"`
	MimeType            *string           `json:"mimeType,omitempty"`
	Contents            *ArtifactContent  `json:"contents,omitempty"`
	Encoding            *string           `json:"encoding,omitempty"`
	SourceLanguage      *string           `json:"sourceLanguage,omitempty"`
	Hashes              map[string]string `json:"hashes,omitempty"`
	LastModifiedTimeUtc *string           `json:"lastModifiedTimeUtc,omitempty"`
	Description         *Message          `json:"description,omitempty"`
}

Artifact ...

func NewArtifact 

func NewArtifact() *Artifact

NewArtifact ...

func (*Artifact) WithContents 

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

WithContents ...

func (*Artifact) WithDescription 

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

WithDescription ...

func (*Artifact) WithEncoding 

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

WithEncoding ...

func (*Artifact) WithHashes 

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

WithHashes ...

func (*Artifact) WithLastModifiedTimeUtc 

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

WithLastModifiedTimeUtc ...

func (*Artifact) WithLength 

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

WithLength ...

func (*Artifact) WithLocation 

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

WithLocation ...

func (*Artifact) WithMimeType 

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

WithMimeType ...

func (*Artifact) WithOffset 

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

WithOffset ...

func (*Artifact) WithParentIndex 

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

WithParentIndex ...

func (*Artifact) WithRole 

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

WithRole ...

func (*Artifact) WithSourceLanguage 

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

WithSourceLanguage ...

type ArtifactChange 

type ArtifactChange struct {
	PropertyBag
	ArtifactLocation ArtifactLocation `json:"artifactLocation"`
	Replacements     []*Replacement   `json:"replacements"` //required
}

ArtifactChange ...

func NewArtifactChange 

func NewArtifactChange(artifactLocation *ArtifactLocation) *ArtifactChange

NewArtifactChange ...

func (*ArtifactChange) WithReplacement 

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

WithReplacement ...

type ArtifactContent 

type ArtifactContent struct {
	PropertyBag
	Text     *string                   `json:"text,omitempty"`
	Binary   *string                   `json:"binary,omitempty"`
	Rendered *MultiformatMessageString `json:"rendered,omitempty"`
}

ArtifactContent ...

func NewArtifactContent 

func NewArtifactContent() *ArtifactContent

NewArtifactContent ...

func (*ArtifactContent) WithBinary 

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

WithBinary ...

func (*ArtifactContent) WithRendered 

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

WithRendered ...

func (*ArtifactContent) WithText 

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

WithText ...

type ArtifactLocation 

type ArtifactLocation struct {
	PropertyBag
	URI         *string  `json:"uri,omitempty"`
	URIBaseId   *string  `json:"uriBaseId,omitempty"`
	Index       *uint    `json:"index,omitempty"`
	Description *Message `json:"description,omitempty"`
}

ArtifactLocation ...

func NewArtifactLocation 

func NewArtifactLocation() *ArtifactLocation

NewArtifactLocation ...

func NewSimpleArtifactLocation 

func NewSimpleArtifactLocation(uri string) *ArtifactLocation

NewSimpleArtifactLocation ...

func (*ArtifactLocation) WithDescription 

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

WithDescription ...

func (*ArtifactLocation) WithIndex 

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

WithIndex ...

func (*ArtifactLocation) WithUri 

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

WithUri ...

func (*ArtifactLocation) WithUriBaseId 

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

WithUriBaseId ...

type Fix 

type Fix struct {
	PropertyBag
	Description     *Message          `json:"description,omitempty"`
	ArtifactChanges []*ArtifactChange `json:"artifactChanges"` //	required
}

Fix ...

func NewFix 

func NewFix() *Fix

NewFix ...

func (*Fix) WithArtifactChange 

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

WithArtifactChange ...

func (*Fix) WithDescription 

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

WithDescription ...

type Invocation 

type Invocation struct {
	PropertyBag
	StartTimeUTC               *time.Time        `json:"startTimeUtc,omitempty"`
	EndTimeUTC                 *time.Time        `json:"endTimeUtc,omitempty"`
	ExecutionSuccessful        bool              `json:"executionSuccessful"`
	WorkingDirectory           *ArtifactLocation `json:"workingDirectory,omitempty"`
	ToolExecutionNotifications []*Notification   `json:"toolExecutionNotifications,omitempty"`
}

Invocation describes the runtime environment of the analysis tool run.

func (*Invocation) WithEndTimeUTC 

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

WithEndTimeUTC sets the instant when the invocation ended and returns the same Invocation.

func (*Invocation) WithStartTimeUTC 

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

WithStartTimeUTC sets the instant when the invocation started and returns the same Invocation.

func (*Invocation) WithToolExecutionNotifications added in v1.1.1 

func (i *Invocation) WithToolExecutionNotifications(notification *Notification) *Invocation

WithToolExecutionNotifications ...

func (*Invocation) WithWorkingDirectory 

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

WithWorkingDirectory sets the current working directory of the invocation and returns the same Invocation.

type Location 

type Location struct {
	PropertyBag
	Id               *uint                   `json:"id,omitempty"`
	PhysicalLocation *PhysicalLocation       `json:"physicalLocation,omitempty"`
	LogicalLocations []*LogicalLocation      `json:"logicalLocations,omitempty"`
	Message          *Message                `json:"message,omitempty"`
	Annotations      []*Region               `json:"annotations,omitempty"`
	Relationships    []*LocationRelationship `json:"relationships,omitempty"`
}

Location ...

func NewLocation 

func NewLocation() *Location

NewLocation ...

func NewLocationWithPhysicalLocation 

func NewLocationWithPhysicalLocation(physicalLocation *PhysicalLocation) *Location

NewLocationWithPhysicalLocation ...

func (*Location) WithAnnotation 

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

WithAnnotation ...

func (*Location) WithId 

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

WithId ...

func (*Location) WithMessage 

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

WithMessage ...

func (*Location) WithPhysicalLocation 

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

WithPhysicalLocation ...

func (*Location) WithRelationship 

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

WithRelationship ...

type LocationRelationship 

type LocationRelationship struct {
	PropertyBag
	Target      uint     `json:"target"`
	Kinds       []string `json:"kinds,omitempty"`
	Description *Message `json:"description,omitempty"`
}

LocationRelationship ...

func NewLocationRelationship 

func NewLocationRelationship(target int) *LocationRelationship

NewLocationRelationship ...

func (*LocationRelationship) WithDescription 

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

WithDescription ...

func (*LocationRelationship) WithKind 

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

WithKind ...

type LogicalLocation 

type LogicalLocation struct {
	PropertyBag
	Index              *uint   `json:"index,omitempty"`
	Name               *string `json:"name,omitempty"`
	FullyQualifiedName *string `json:"fullyQualifiedName,omitempty"`
	DecoratedName      *string `json:"decoratedName,omitempty"`
	Kind               *string `json:"kind,omitempty"`
	ParentIndex        *uint   `json:"parentIndex,omitempty"`
}

LogicalLocation ...

func NewLogicalLocation 

func NewLogicalLocation() *LogicalLocation

NewLogicalLocation ...

func (*LogicalLocation) WithDecoratedName 

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

WithDecoratedName ...

func (*LogicalLocation) WithFullyQualifiedName 

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

WithFullyQualifiedName ...

func (*LogicalLocation) WithIndex 

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

WithIndex ...

func (*LogicalLocation) WithKind 

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

WithKind ...

func (*LogicalLocation) WithName 

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

WithName ...

func (*LogicalLocation) WithParentIndex 

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

WithParentIndex ...

type Message 

type Message struct {
	PropertyBag
	Text      *string  `json:"text,omitempty"`
	Markdown  *string  `json:"markdown,omitempty"`
	Id        *string  `json:"id,omitempty"`
	Arguments []string `json:"arguments,omitempty"`
}

Message ...

func NewMarkdownMessage 

func NewMarkdownMessage(markdown string) *Message

NewMarkdownMessage ...

func NewMessage 

func NewMessage() *Message

NewMessage ...

func NewTextMessage 

func NewTextMessage(text string) *Message

NewTextMessage ...

func (*Message) WithArgument 

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

WithArgument ...

func (*Message) WithId 

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

WithId ...

func (*Message) WithMarkdown 

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

WithMarkdown ...

func (*Message) WithText 

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

WithText ...

type MultiformatMessageString 

type MultiformatMessageString struct {
	PropertyBag
	Text     *string `json:"text,omitempty"`
	Markdown *string `json:"markdown,omitempty"`
}

MultiformatMessageString ...

func NewMarkdownMultiformatMessageString added in v1.1.1 

func NewMarkdownMultiformatMessageString(markdown string) *MultiformatMessageString

NewMarkdownMultiformatMessageString ...

func NewMultiformatMessageString 

func NewMultiformatMessageString(text string) *MultiformatMessageString

NewMultiformatMessageString ...

func (*MultiformatMessageString) WithMarkdown 

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

WithMarkdown ...

type Notification added in v1.1.1 

type Notification struct {
	PropertyBag
	Level      *string     `json:"level,omitempty"`
	Message    Message     `json:"message"`
	Locations  []*Location `json:"locations,omitempty"`
	Properties Properties  `json:"properties,omitempty"`
}

Notification represents different Notifications in the SARIF spec

func NewNotification added in v1.1.1 

func NewNotification() *Notification

NewNotification ...

func (*Notification) AttachPropertyBag added in v1.1.1 

func (n *Notification) AttachPropertyBag(pb *PropertyBag)

AttachPropertyBag adds a property bag to a rule

func (*Notification) WithLevel added in v1.1.1 

func (n *Notification) WithLevel(level string) *Notification

WithLevel ...

func (*Notification) WithLocation added in v1.1.1 

func (n *Notification) WithLocation(location *Location) *Notification

WithLocation ...

func (*Notification) WithMessage added in v1.1.1 

func (n *Notification) WithMessage(message *Message) *Notification

WithMessage ...

func (*Notification) WithProperties added in v1.1.1 

func (n *Notification) WithProperties(properties Properties) *Notification

WithProperties specifies properties for a rule and returns the updated rule

type PhysicalLocation 

type PhysicalLocation struct {
	PropertyBag
	ArtifactLocation *ArtifactLocation `json:"artifactLocation,omitempty"`
	Region           *Region           `json:"region,omitempty"`
	ContextRegion    *Region           `json:"contextRegion,omitempty"`
	Address          *Address          `json:"address,omitempty"`
}

PhysicalLocation ...

func NewPhysicalLocation 

func NewPhysicalLocation() *PhysicalLocation

NewPhysicalLocation ...

func (*PhysicalLocation) WithAddress 

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

WithAddress ...

func (*PhysicalLocation) WithArtifactLocation 

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

WithArtifactLocation ...

func (*PhysicalLocation) WithContextRegion 

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

WithContextRegion ...

func (*PhysicalLocation) WithRegion 

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

WithRegion ...

type Properties 

type Properties map[string]interface{}

Properties ...

type PropertyBag 

type PropertyBag struct {
	Properties Properties `json:"properties,omitempty"`
}

PropertyBag ...

func NewPropertyBag 

func NewPropertyBag() *PropertyBag

NewPropertyBag ...

func (*PropertyBag) Add 

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

Add ...

func (*PropertyBag) AddBoolean 

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

AddBoolean ...

func (*PropertyBag) AddInteger 

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

AddInteger ...

func (*PropertyBag) AddString 

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

AddString ...

type Region 

type Region struct {
	PropertyBag
	StartLine      *int             `json:"startLine,omitempty"`
	StartColumn    *int             `json:"startColumn,omitempty"`
	EndLine        *int             `json:"endLine,omitempty"`
	EndColumn      *int             `json:"endColumn,omitempty"`
	CharOffset     *int             `json:"charOffset,omitempty"`
	CharLength     *int             `json:"charLength,omitempty"`
	ByteOffset     *int             `json:"byteOffset,omitempty"`
	ByteLength     *int             `json:"byteLength,omitempty"`
	Snippet        *ArtifactContent `json:"snippet,omitempty"`
	Message        *Message         `json:"message,omitempty"`
	SourceLanguage *string          `json:"sourceLanguage,omitempty"`
}

Region ...

func NewRegion 

func NewRegion() *Region

NewRegion ...

func NewSimpleRegion 

func NewSimpleRegion(startLine, endLine int) *Region

NewSimpleRegion ...

func (*Region) WithByteLength 

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

WithByteLength ...

func (*Region) WithByteOffset 

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

WithByteOffset ...

func (*Region) WithCharLength 

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

WithCharLength ...

func (*Region) WithCharOffset 

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

WithCharOffset ...

func (*Region) WithEndColumn 

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

WithEndColumn ...

func (*Region) WithEndLine 

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

WithEndLine ...

func (*Region) WithMessage 

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

WithMessage ...

func (*Region) WithSnippet 

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

WithSnippet ...

func (*Region) WithSourceLanguage 

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

WithSourceLanguage ...

func (*Region) WithStartColumn 

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

WithStartColumn ...

func (*Region) WithStartLine 

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

WithStartLine ...

type Replacement 

type Replacement struct {
	PropertyBag
	DeletedRegion   Region           `json:"deletedRegion"`
	InsertedContent *ArtifactContent `json:"insertedContent,omitempty"`
}

Replacement ...

func NewReplacement 

func NewReplacement(region *Region) *Replacement

NewReplacement ...

func (*Replacement) WithInsertedContent 

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

WithInsertedContent ...

type Report 

type Report struct {
	PropertyBag
	Version string `json:"version"`
	Schema  string `json:"$schema"`
	Runs    []*Run `json:"runs"`
}

Report is the encapsulating type representing a Sarif Report

func FromBytes 

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

FromBytes loads a Report from a byte array

func FromString 

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

FromString loads a Report from string content

func New 

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

New Creates a new Report or returns an error

func Open 

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

Open loads a Report from a file

func (*Report) AddRun 

func (sarif *Report) AddRun(run *Run)

AddRun allows adding run information to the current report

func (*Report) PrettyWrite 

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

PrettyWrite writes the JSON output with indentation

func (*Report) Write 

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

Write writes the JSON as a string with no formatting

func (*Report) WriteFile 

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

WriteFile will write the report to a file using a pretty formatter

type ReportingConfiguration added in v1.1.1 

type ReportingConfiguration struct {
	Enabled    bool         `json:"enabled,omitempty"`
	Level      interface{}  `json:"level,omitempty"`
	Parameters *PropertyBag `json:"parameters,omitempty"`
	Properties *PropertyBag `json:"properties,omitempty"`
	Rank       float64      `json:"rank,omitempty"`
}

ReportingConfiguration ...

type ReportingDescriptor added in v1.1.1 

type ReportingDescriptor struct {
	PropertyBag
	ID                   string                    `json:"id"`
	Name                 *string                   `json:"name,omitempty"`
	ShortDescription     *MultiformatMessageString `json:"shortDescription"`
	FullDescription      *MultiformatMessageString `json:"fullDescription,omitempty"`
	DefaultConfiguration *ReportingConfiguration   `json:"defaultConfiguration,omitempty"`
	HelpURI              *string                   `json:"helpUri,omitempty"`
	Help                 *MultiformatMessageString `json:"help,omitempty"`
	Properties           Properties                `json:"properties,omitempty"`
}

ReportingDescriptor specifies a Sarif ReportingDescriptor object

func (*ReportingDescriptor) AttachPropertyBag added in v1.1.1 

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

AttachPropertyBag adds a property bag to a rule

func (*ReportingDescriptor) WithDescription added in v1.1.1 

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

WithDescription specifies short description for a rule and returns the updated rule. Short description should be a single sentence that is understandable when visible space is limited to a single line of text.

func (*ReportingDescriptor) WithFullDescription added in v1.1.1 

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

WithFullDescription specifies full description for a rule and returns the updated rule. Full description should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

func (*ReportingDescriptor) WithHelp added in v1.1.1 

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

WithHelp specifies a help text for a rule and returns the updated rule

func (*ReportingDescriptor) WithHelpURI added in v1.1.1 

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

WithHelpURI specifies a helpURI for a rule and returns the updated rule

func (*ReportingDescriptor) WithMarkdownHelp added in v1.1.1 

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

WithMarkdownHelp specifies a help text for a rule and returns the updated rule

func (*ReportingDescriptor) WithName added in v1.1.1 

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

WithName specifies rule name that is understandable to an end user and returns the updated rule.

func (*ReportingDescriptor) WithProperties added in v1.1.1 

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

WithProperties specifies properties for a rule and returns the updated rule

func (*ReportingDescriptor) WithShortDescription added in v1.1.1 

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

WithShortDescription specifies short description for a rule and returns the updated rule. Short description should be a single sentence that is understandable when visible space is limited to a single line of text.

type ReportingDescriptorReference 

type ReportingDescriptorReference struct {
	PropertyBag
	Id            *string                 `json:"id,omitempty"`
	Index         *uint                   `json:"index,omitempty"`
	Guid          *string                 `json:"guid,omitempty"`
	ToolComponent *ToolComponentReference `json:"toolComponent,omitempty"`
}

ReportingDescriptorReference ...

func NewReportingDescriptorReference 

func NewReportingDescriptorReference() *ReportingDescriptorReference

NewReportingDescriptorReference ...

func (*ReportingDescriptorReference) WithGuid 

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

WithGuid ...

func (*ReportingDescriptorReference) WithId 

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

WithId ...

func (*ReportingDescriptorReference) WithIndex 

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

WithIndex ...

func (*ReportingDescriptorReference) WithToolComponentReference 

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

WithToolComponentReference ...

type Result 

type Result struct {
	PropertyBag
	Guid            *string                         `json:"guid,omitempty"`
	CorrelationGuid *string                         `json:"correlationGuid,omitempty"`
	RuleID          *string                         `json:"ruleId,omitempty"`
	RuleIndex       *uint                           `json:"ruleIndex,omitempty"`
	Rule            *ReportingDescriptorReference   `json:"rule,omitempty"`
	Taxa            []*ReportingDescriptorReference `json:"taxa,omitempty"`
	Kind            *string                         `json:"kind,omitempty"`
	Level           *string                         `json:"level,omitempty"`
	Message         Message                         `json:"message"`
	Locations       []*Location                     `json:"locations,omitempty"`
	AnalysisTarget  *ArtifactLocation               `json:"analysisTarget,omitempty"`
	// WebRequest			*webRequest						`json:"webRequest,omitempty"`
	// WebResponse			*webResponse					`json:"webResponse,omitempty"`
	Fingerprints        map[string]interface{} `json:"fingerprints,omitempty"`
	PartialFingerprints map[string]interface{} `json:"partialFingerprints,omitempty"`
	// CodeFlows			[]*codeFlows					`json:"codeFlows,omitempty"`
	// Graphs				[]*graphs						`json:"graphs,omitempty"`
	// GraphTraversals		[]*graphTraversals				`json:"graphTraversals,omitempty"`
	// Stacks				[]*stack						`json:"stacks,omitempty"`
	RelatedLocations []*Location    `json:"relatedLocations,omitempty"`
	Suppressions     []*Suppression `json:"suppressions,omitempty"`
	BaselineState    *string        `json:"baselineState,omitempty"`
	Rank             *float32       `json:"rank,omitempty"`
	// Attachments			[]*attachment					`json:"attachments,omitempty"`
	WorkItemUris    []string `json:"workItemUris,omitempty"` // can be null
	HostedViewerUri *string  `json:"hostedViewerUri,omitempty"`
	// Provenance			*resultProvenance				`json:"provenance,omitempty"`
	Fixes           []*Fix     `json:"fixes,omitempty"`
	OccurrenceCount *uint      `json:"occurrenceCount,omitempty"`
	Properties      Properties `json:"properties,omitempty"`
}

Result represents the results block in the sarif report

func (*Result) AttachPropertyBag 

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

AttachPropertyBag adds a property bag to a rule

func (*Result) WithAnalysisTarget 

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

WithAnalysisTarget ...

func (*Result) WithBaselineState 

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

WithBaselineState ...

func (*Result) WithCorrelationGuid 

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

WithCorrelationGuid ...

func (*Result) WithFingerPrints 

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

WithFingerPrints ...

func (*Result) WithFix 

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

WithFix ...

func (*Result) WithGuid 

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

WithGuid ...

func (*Result) WithHostedViewerUri 

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

WithHostedViewerUri ...

func (*Result) WithKind 

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

WithKind ...

func (*Result) WithLevel 

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

WithLevel ...

func (*Result) WithLocation 

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

WithLocation ...

func (*Result) WithMessage 

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

WithMessage ...

func (*Result) WithOccurrenceCount 

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

WithOccurrenceCount ...

func (*Result) WithPartialFingerPrints 

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

WithPartialFingerPrints ...

func (*Result) WithProperties 

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

WithProperties specifies properties for a rule and returns the updated rule

func (*Result) WithRank 

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

WithRank ...

func (*Result) WithRelatedLocation 

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

WithRelatedLocation ...

func (*Result) WithRule 

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

WithRule ...

func (*Result) WithRuleIndex 

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

WithRuleIndex ...

func (*Result) WithSuppression 

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

WithSuppression ...

func (*Result) WithTaxa 

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

WithTaxa ...

func (*Result) WithWorkItemUri 

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

WithWorkItemUri ...

type Run 

type Run struct {
	PropertyBag
	Tool        Tool          `json:"tool"`
	Invocations []*Invocation `json:"invocations,omitempty"`
	Artifacts   []*Artifact   `json:"artifacts,omitempty"`
	Results     []*Result     `json:"results"`
	Properties  Properties    `json:"properties,omitempty"`
}

Run type represents a run of a tool

func NewRun 

func NewRun(toolName, informationURI string) *Run

NewRun allows the creation of a new Run

func (*Run) AddArtifact 

func (run *Run) AddArtifact() *Artifact

AddArtifact adds an artifact to the run and returns a pointer to it

func (*Run) AddDistinctArtifact 

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

AddDistinctArtifact will handle deduplication of simple artifact additions

func (*Run) AddInvocation 

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

AddInvocation adds an invocation to the run and returns a pointer to it

func (*Run) AddProperty 

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

AddProperty ...

func (*Run) AddResult 

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

AddResult returns an existing Result or creates a new one and returns a pointer to it

func (*Run) AddRule 

func (run *Run) AddRule(ruleID string) *ReportingDescriptor

AddRule returns an existing ReportingDescriptor for the ruleID or creates a new ReportingDescriptor and returns a pointer to it

func (*Run) AttachPropertyBag 

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

AttachPropertyBag ...

func (*Run) DedupeArtifacts 

func (run *Run) DedupeArtifacts() error

DedupeArtifacts ...

func (*Run) GetResultByRuleId 

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

GetResultByRuleId finds the result for a ruleId and returns a pointer to it

func (*Run) GetRuleById 

func (run *Run) GetRuleById(ruleId string) (*ReportingDescriptor, error)

GetRuleById finds a rule by a given rule ID and returns a pointer to it

type RunOption 

type RunOption int

RunOption ... 

const IncludeEmptyResults RunOption = iota

IncludeEmptyResults ...

type Suppression 

type Suppression struct {
	PropertyBag
	Kind          string    `json:"kind,omitempty"`
	Status        *string   `json:"status,omitempty"`
	Location      *Location `json:"location,omitempty"`
	Guid          *string   `json:"guid,omitempty"`
	Justification *string   `json:"justification,omitempty"`
}

Suppression ...

func NewSuppression 

func NewSuppression(kind string) *Suppression

NewSuppression ...

func (*Suppression) WithGuid 

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

WithGuid ...

func (*Suppression) WithJustifcation 

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

WithJustifcation ...

func (*Suppression) WithLocation 

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

WithLocation ...

func (*Suppression) WithStatus 

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

WithStatus ...

type Tool 

type Tool struct {
	PropertyBag
	Driver *ToolComponent `json:"driver"`
}

Tool ...

type ToolComponent added in v1.1.1 

type ToolComponent struct {
	PropertyBag
	Name           string                 `json:"name"`
	Version        *string                `json:"version,omitempty"`
	InformationURI *string                `json:"informationUri"`
	Notifications  []*ReportingDescriptor `json:"notifications,omitempty"`
	Rules          []*ReportingDescriptor `json:"rules,omitempty"`
	Taxa           []*ReportingDescriptor `json:"taxa,omitempty"`
}

ToolComponent ...

func (*ToolComponent) WithVersion added in v1.1.1 

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

WithVersion specifies tool version, in whatever format it natively provides. Returns updated driver.

type ToolComponentReference 

type ToolComponentReference struct {
	PropertyBag
	Name  *string `json:"name"`
	Index *uint   `json:"index"`
	Guid  *string `json:"guid"`
}

ToolComponentReference ...

func NewToolComponentReference 

func NewToolComponentReference() *ToolComponentReference

NewToolComponentReference ...

func (*ToolComponentReference) WithGuid 

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

WithGuid ...

func (*ToolComponentReference) WithIndex 

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

WithIndex ...

func (*ToolComponentReference) WithName 

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

WithName ...

type Version 

type Version string

Version is the version of Sarif to use 

const Version210 Version = "2.1.0"

Version210 represents Version210 of Sarif

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.